networktocode.nautobot.circuit module – Create, update or delete circuits within Nautobot¶
Note
This module is part of the networktocode.nautobot collection (version 3.4.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install networktocode.nautobot
.
To use it in a playbook, specify: networktocode.nautobot.circuit
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates, updates or removes circuits from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
The circuit id of the circuit |
|
The circuit type of the circuit |
|
Comments related to circuit |
|
Commit rate of the circuit (Kbps) |
|
must exist in Nautobot |
|
Description of the circuit |
|
The date the circuit was installed. e.g. YYYY-MM-DD |
|
The provider of the circuit |
|
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. |
|
Use Choices:
|
|
The status of the circuit Required if state=present and does not exist yet |
|
Any tags that the device may need to be associated with |
|
The tenant assigned to the circuit |
|
The token created within Nautobot to authorize API access |
|
URL of the Nautobot instance resolvable by Ansible control host |
|
If Default: “yes” |
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 circuit within Nautobot with only required information
networktocode.nautobot.circuit:
url: http://nautobot.local
token: thisIsMyToken
cid: Test Circuit
provider: Test Provider
circuit_type: Test Circuit Type
status: active
state: present
- name: Update circuit with other fields
networktocode.nautobot.circuit:
url: http://nautobot.local
token: thisIsMyToken
data:
cid: Test-Circuit-1000
provider: Test Provider
circuit_type: Test Circuit Type
status: Active
tenant: Test Tenant
install_date: "2018-12-25"
commit_rate: 10000
description: Test circuit
comments: "FAST CIRCUIT"
state: present
- name: Delete circuit within nautobot
networktocode.nautobot.circuit:
url: http://nautobot.local
token: thisIsMyToken
cid: Test-Circuit-1000
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 |