networktocode.nautobot.circuit_type module – Create, update or delete circuit types within Nautobot¶
Note
This module is part of the networktocode.nautobot collection (version 4.5.0).
To install it, use: ansible-galaxy collection install networktocode.nautobot
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: networktocode.nautobot.circuit_type
.
New in networktocode.nautobot 1.0.0
Synopsis¶
Creates, updates or removes circuit types from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
API Version Nautobot REST API |
|
The name of the circuit type |
|
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/utils.py and provides control to users on what may make an object unique in their environment. |
|
The slugified version of the name or custom slug. This is auto-generated following Nautobot rules if not provided |
|
Use Choices: |
|
The token created within Nautobot to authorize API access |
|
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) |
|
If Default: :ansible-option-default:`true` |
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples¶
- name: "Test Nautobot modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create type within Nautobot with only required information
networktocode.nautobot.circuit_type:
url: http://nautobot.local
token: thisIsMyToken
name: Test Circuit Type
state: present
- name: Delete circuit type within nautobot
networktocode.nautobot.circuit_type:
url: http://nautobot.local
token: thisIsMyToken
name: Test Circuit Type
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Serialized object as created or already existent within Nautobot Returned: success (when state=present) |
|
Message indicating failure or info about what has been achieved Returned: always |