cable¶

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot

Added in version 1.0.0.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis¶

Creates, updates or removes cables from Nautobot

Requirements¶

The following Python packages are needed on the host that executes this module:

pynautobot

Parameters¶

Parameter	Defaults / Choices	Comments
api_version str		API Version Nautobot REST API Version Added: 4.1.0
color str		The color of the cable Version Added: 3.0.0
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
id str		The UUID of the object to operate on Version Added: 5.13.0
label str		The label of the cable Version Added: 3.0.0
length int		The length of the cable Version Added: 3.0.0
length_unit str		The unit in which the length of the cable is measured Version Added: 3.0.0
query_params list / elements=str		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. Version Added: 3.0.0
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
status str		The status of the cable Required if I(state=present) and does not exist yet Version Added: 3.0.0
tags list / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
termination_a raw		The termination a Required if I(state=present) and the cable does not exist yet Version Added: 3.0.0
termination_a_type str	Choices: circuits.circuittermination, dcim.consoleport, dcim.consoleserverport, dcim.frontport, dcim.interface, dcim.powerfeed, dcim.poweroutlet, dcim.powerport, dcim.rearport	The type of the termination a Required if I(state=present) and the cable does not exist yet Version Added: 3.0.0
termination_b raw		The termination b Required if I(state=present) and the cable does not exist yet Version Added: 3.0.0
termination_b_type str	Choices: circuits.circuittermination, dcim.consoleport, dcim.consoleserverport, dcim.frontport, dcim.interface, dcim.powerfeed, dcim.poweroutlet, dcim.powerport, dcim.rearport	The type of the termination b Required if I(state=present) and the cable does not exist yet Version Added: 3.0.0
token str required		The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
type str		The type of the cable Version Added: 3.0.0
url str required		The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
validate_certs raw	Default: True	If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.

Notes¶

Note

Tags should be defined as a YAML list
This should be ran with connection C(local) and hosts C(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

    - name: Delete cable by id
      networktocode.nautobot.cable:
        url: http://nautobot.local
        token: thisIsMyToken
        id: 00000000-0000-0000-0000-000000000000
        state: absent

Return Values¶

Key	Data Type	Description	Returned
cable	dict	Serialized object as created or already existent within Nautobot	success (when I(state=present))
msg	str	Message indicating failure or info about what has been achieved	always

Authors¶

Tobias Groß (@toerb)