networktocode.nautobot.cable module – Create, update or delete cables 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.cable
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates, updates or removes cables from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
The color of the cable |
|
The label of the cable |
|
The length of the cable |
|
The unit in which the length of the cable is measured Choices:
|
|
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 cable Required if state=present and does not exist yet |
|
The termination a |
|
The type of the termination a Choices:
|
|
The termination b |
|
The type of the termination b Choices:
|
|
The token created within Nautobot to authorize API access |
|
The type of the cable Choices:
|
|
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 cable within Nautobot with only required information
networktocode.nautobot.cable:
url: http://nautobot.local
token: thisIsMyToken
termination_a_type: dcim.interface
termination_a:
device: Test Nexus Child One
name: Ethernet2/2
termination_b_type: dcim.interface
termination_b:
device: Test Nexus Child One
name: Ethernet2/1
status: active
state: present
- name: Update cable with other fields
networktocode.nautobot.cable:
url: http://nautobot.local
token: thisIsMyToken
termination_a_type: dcim.interface
termination_a:
device: Test Nexus Child One
name: Ethernet2/2
termination_b_type: dcim.interface
termination_b:
device: Test Nexus Child One
name: Ethernet2/1
type: mmf-om4
status: planned
label: label123
color: abcdef
length: 30
length_unit: m
state: present
- name: Delete cable within nautobot
networktocode.nautobot.cable:
url: http://nautobot.local
token: thisIsMyToken
termination_a_type: dcim.interface
termination_a:
device: Test Nexus Child One
name: Ethernet2/2
termination_b_type: dcim.interface
termination_b:
device: Test Nexus Child One
name: Ethernet2/1
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 |