Skip to content

Latest commit

 

History

History
1137 lines (619 loc) · 25.9 KB

netbox_cable_module.rst

File metadata and controls

1137 lines (619 loc) · 25.9 KB
Raw
orphan:

netbox.netbox.netbox_cable module -- Create, update or delete cables within NetBox

Note

This module is part of the netbox.netbox collection (version 3.13.0).

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_cable_module_requirements>` for details.

To use it in a playbook, specify: netbox.netbox.netbox_cable.

.. rst-class:: ansible-version-added

New in netbox.netbox 0.3.0

Synopsis

  • Creates, updates or removes cables from NetBox

Requirements

The below requirements are needed on the host that executes this module.

  • pynetbox

Parameters

.. rst-class:: ansible-option-table
Parameter Comments 
.. rst-class:: ansible-option-title

cert

.. rst-class:: ansible-option-type-line

any

Certificate path

 
.. rst-class:: ansible-option-title

data

.. rst-class:: ansible-option-type-line

dictionary / required

Defines the cable configuration

 
.. rst-class:: ansible-option-title

color

.. rst-class:: ansible-option-type-line

string

The color of the cable

 
.. rst-class:: ansible-option-title

comments

.. rst-class:: ansible-option-type-line

string

added in netbox.netbox 3.10.0

Comments related to the provider

 
.. rst-class:: ansible-option-title

custom_fields

.. rst-class:: ansible-option-type-line

dictionary

added in netbox.netbox 3.6.0

Must exist in NetBox

 
.. rst-class:: ansible-option-title

description

.. rst-class:: ansible-option-type-line

string

added in netbox.netbox 3.10.0

Description of the provider

 
.. rst-class:: ansible-option-title

label

.. rst-class:: ansible-option-type-line

string

The label of the cable

 
.. rst-class:: ansible-option-title

length

.. rst-class:: ansible-option-type-line

float

The length of the cable

 
.. rst-class:: ansible-option-title

length_unit

.. rst-class:: ansible-option-type-line

string

The unit in which the length of the cable is measured

.. rst-class:: ansible-option-line

Choices:

 
.. rst-class:: ansible-option-title

status

.. rst-class:: ansible-option-type-line

string

 
.. rst-class:: ansible-option-title

tags

.. rst-class:: ansible-option-type-line

list / elements=any

Any tags that the cable may need to be associated with

 
.. rst-class:: ansible-option-title

termination_a

.. rst-class:: ansible-option-type-line

any / required

The termination a

 
.. rst-class:: ansible-option-title

termination_a_type

.. rst-class:: ansible-option-type-line

string / required

 
.. rst-class:: ansible-option-title

termination_b

.. rst-class:: ansible-option-type-line

any / required

The termination b

 
.. rst-class:: ansible-option-title

termination_b_type

.. rst-class:: ansible-option-type-line

string / required

 
.. rst-class:: ansible-option-title

type

.. rst-class:: ansible-option-type-line

string

The type of the cable

.. rst-class:: ansible-option-line

Choices:

 
.. rst-class:: ansible-option-title

netbox_token

.. rst-class:: ansible-option-type-line

string / required

The NetBox API token.

 
.. rst-class:: ansible-option-title

netbox_url

.. rst-class:: ansible-option-type-line

string / required

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

 
.. rst-class:: ansible-option-title

query_params

.. rst-class:: ansible-option-type-line

list / elements=string

This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined

in plugins/module_utils/netbox_utils.py and provides control to users on what may make

an object unique in their environment.

 
.. rst-class:: ansible-option-title

state

.. rst-class:: ansible-option-type-line

string

The state of the object.

.. rst-class:: ansible-option-line

Choices:

 
.. rst-class:: ansible-option-title

validate_certs

.. rst-class:: ansible-option-type-line

any

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using a self-signed certificates.

.. rst-class:: ansible-option-line

Default: :ansible-option-default:`true`

Notes

Note

  • Tags should be defined as a YAML list
  • This should be ran with connection local and hosts localhost

Examples

- name: "Test NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create cable within NetBox with only required information
      netbox.netbox.netbox_cable:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          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: present

    - name: Update cable with other fields
      netbox.netbox.netbox_cable:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          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
          tags:
            - foo
        state: present

    - name: Delete cable within netbox
      netbox.netbox.netbox_cable:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          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 :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. rst-class:: ansible-option-table
Key Description 
.. rst-class:: ansible-option-title

cable

.. rst-class:: ansible-option-type-line

dictionary

Serialized object as created or already existent within NetBox

.. rst-class:: ansible-option-line

Returned: success (when state=present)

 
.. rst-class:: ansible-option-title

msg

.. rst-class:: ansible-option-type-line

string

Message indicating failure or info about what has been achieved

.. rst-class:: ansible-option-line

Returned: always

Authors

  • Tobias Groß (@toerb)

Collection links

Issue Tracker Repository (Sources)