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

color

string

added in 3.0.0 of networktocode.nautobot

The color of the cable

label

string

added in 3.0.0 of networktocode.nautobot

The label of the cable

length

integer

added in 3.0.0 of networktocode.nautobot

The length of the cable

length_unit

string

added in 3.0.0 of networktocode.nautobot

The unit in which the length of the cable is measured

Choices:

  • m

  • cm

  • ft

  • in

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

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.

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

status

string

added in 3.0.0 of networktocode.nautobot

The status of the cable

Required if state=present and does not exist yet

termination_a

raw / required

added in 3.0.0 of networktocode.nautobot

The termination a

termination_a_type

string / required

added in 3.0.0 of networktocode.nautobot

The type of the termination a

Choices:

  • circuits.circuittermination

  • dcim.consoleport

  • dcim.consoleserverport

  • dcim.frontport

  • dcim.interface

  • dcim.powerfeed

  • dcim.poweroutlet

  • dcim.powerport

  • dcim.rearport

termination_b

raw / required

added in 3.0.0 of networktocode.nautobot

The termination b

termination_b_type

string / required

added in 3.0.0 of networktocode.nautobot

The type of the termination b

Choices:

  • circuits.circuittermination

  • dcim.consoleport

  • dcim.consoleserverport

  • dcim.frontport

  • dcim.interface

  • dcim.powerfeed

  • dcim.poweroutlet

  • dcim.powerport

  • dcim.rearport

token

string / required

The token created within Nautobot to authorize API access

type

string

added in 3.0.0 of networktocode.nautobot

The type of the cable

Choices:

  • cat3

  • cat5

  • cat5e

  • cat6

  • cat6a

  • cat7

  • dac-active

  • dac-passive

  • mrj21-trunk

  • coaxial

  • mmf

  • mmf-om1

  • mmf-om2

  • mmf-om3

  • mmf-om4

  • smf

  • smf-os1

  • smf-os2

  • aoc

  • power

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

raw

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Default: “yes”

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

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

cable

dictionary

Serialized object as created or already existent within Nautobot

Returned: success (when state=present)

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Tobias Groß (@toerb)