netbox_circuit_termination_module.rst

orphan:

netbox.netbox.netbox_circuit_termination module -- Create, update or delete circuit terminations within NetBox

Note

This module is part of the netbox.netbox collection (version 3.12.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_circuit_termination_module_requirements>` for details.

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

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

New in netbox.netbox 0.1.0

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Creates, updates or removes circuit terminations 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 circuit termination configuration
.. rst-class:: ansible-option-title circuit .. rst-class:: ansible-option-type-line any / required	The circuit to assign to circuit termination
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string	Description of the circuit termination
.. rst-class:: ansible-option-title mark_connected .. rst-class:: ansible-option-type-line boolean added in netbox.netbox 3.5.0	Treat as if cable is connected .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
.. rst-class:: ansible-option-title port_speed .. rst-class:: ansible-option-type-line integer	The speed of the port (Kbps)
.. rst-class:: ansible-option-title pp_info .. rst-class:: ansible-option-type-line string	Patch panel information
.. rst-class:: ansible-option-title provider_network .. rst-class:: ansible-option-type-line any	The provider_network the circuit termination will be assigned to
.. rst-class:: ansible-option-title site .. rst-class:: ansible-option-type-line any	The site the circuit termination will be assigned to
.. rst-class:: ansible-option-title term_side .. rst-class:: ansible-option-type-line string / required	The side of the circuit termination .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"A"` :ansible-option-choices-entry:`"Z"`
.. rst-class:: ansible-option-title upstream_speed .. rst-class:: ansible-option-type-line integer	The upstream speed of the circuit termination
.. rst-class:: ansible-option-title xconnect_id .. rst-class:: ansible-option-type-line string	The cross connect ID of the circuit termination
.. 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: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
.. 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 circuit termination within NetBox with only required information
      netbox.netbox.netbox_circuit_termination:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          circuit: Test Circuit
          term_side: A
          site: Test Site
          port_speed: 10000
        state: present

    - name: Update circuit termination with other fields
      netbox.netbox.netbox_circuit_termination:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          circuit: Test Circuit
          term_side: A
          upstream_speed: 1000
          xconnect_id: 10X100
          pp_info: PP10-24
          description: "Test description"
        state: present

    - name: Delete circuit termination within netbox
      netbox.netbox.netbox_circuit_termination:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          circuit: Test Circuit
          term_side: A
        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 circuit_termination .. 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

• Mikhail Yohman (@FragmentedPacket)

Collection links

Issue Tracker Repository (Sources)