networktocode.nautobot.cable module – Create, update or delete cables within Nautobot
Note
This module is part of the networktocode.nautobot collection (version 5.3.1).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: networktocode.nautobot.cable.
New in networktocode.nautobot 1.0.0
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 |
|---|---|
API Version Nautobot REST API |
|
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 |
|
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 |
|
The status of the cable Required if state=present and does not exist yet |
|
The termination a |
|
The type of the termination a |
|
The termination b |
|
The type of the termination b |
|
The token created within Nautobot to authorize API access Can be omitted if the :ansenvvarref:`NAUTOBOT\_TOKEN` environment variable is configured. |
|
The type of the cable |
|
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the :ansenvvarref:`NAUTOBOT\_URL` environment variable is configured. |
|
If Can be omitted if the :ansenvvar:`NAUTOBOT\_VALIDATE\_CERTS` environment variable is configured. :ansible-option-default-bold:`Default:` :ansible-option-default:`true` |
Notes
Note
Tags should be defined as a YAML list
This should be ran with connection
localand 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 :ansible-option-returned-bold:`Returned:` success (when state=present) |
|
Message indicating failure or info about what has been achieved |