networktocode.nautobot.circuit_termination module – Create, update or delete circuit terminations 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_termination
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates, updates or removes circuit terminations from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
The circuit to assign to circuit termination |
|
Description of the circuit termination |
|
The speed of the port (Kbps) |
|
Patch panel information |
|
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 site the circuit termination will be assigned to |
|
Use Choices:
|
|
The side of the circuit termination Choices:
|
|
The token created within Nautobot to authorize API access |
|
The upstream speed of the circuit termination |
|
URL of the Nautobot instance resolvable by Ansible control host |
|
If Default: “yes” |
|
The cross connect ID of the circuit termination |
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 termination within Nautobot with only required information
networktocode.nautobot.circuit_termination:
url: http://nautobot.local
token: thisIsMyToken
circuit: Test Circuit
term_side: A
site: Test Site
port_speed: 10000
state: present
- name: Update circuit termination with other fields
networktocode.nautobot.circuit_termination:
url: http://nautobot.local
token: thisIsMyToken
circuit: Test Circuit
term_side: A
upstream_speed: 1000
xconnect_id: 10X100
pp_info: PP10-24
description: "Test description"
state: present
- name: Delete circuit termination within nautobot
networktocode.nautobot.circuit_termination:
url: http://nautobot.local
token: thisIsMyToken
circuit: Test Circuit
term_side: A
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 |