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.23.0).

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 netbox.netbox. You need further requirements to be able to use this module, see Requirements for details.

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

New in netbox.netbox 0.1.0

Synopsis

• Creates, updates or removes circuit terminations from NetBox

Requirements

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

• pynetbox

Parameters

Parameter	Comments
cert	Certificate path
data	Defines the circuit termination configuration
circuit	The circuit to assign to circuit termination
description	Description of the circuit termination
mark_connected :ansible-option-versionadded:`added in netbox.netbox 3.5.0`	Treat as if cable is connected :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
port_speed	The speed of the port (Kbps)
pp_info	Patch panel information
provider_network	The provider_network the circuit termination will be assigned to. This parameter is used with NetBox versions before 4.2.0.
site	The site the circuit termination will be assigned to. This parameter is used with NetBox versions before 4.2.0.
term_side	The side of the circuit termination :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"A"` :ansible-option-choices-entry:`"Z"`
termination_id :ansible-option-versionadded:`added in netbox.netbox 4.2.0`	The ProviderNetwork, Location, Site, Region, or SiteGroup ID of the circuit termination will be assigned to. This parameter is used with NetBox versions >= 4.2.0.
termination_type :ansible-option-versionadded:`added in netbox.netbox 4.2.0`	The type the circuit termination will be assigned to. This parameter is used with NetBox versions >= 4.2.0. :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"dcim.site"` :ansible-option-choices-entry:`"dcim.location"` :ansible-option-choices-entry:`"dcim.region"` :ansible-option-choices-entry:`"dcim.sitegroup"` :ansible-option-choices-entry:`"circuits.providernetwork"`
upstream_speed	The upstream speed of the circuit termination
xconnect_id	The cross connect ID of the circuit termination
headers	Dictionary of headers to be passed to the NetBox API.
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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.
state	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :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 local and hosts localhost

Examples

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

  tasks:
    - name: Create circuit termination within NetBox version 4.2.0 or later with only required information
      netbox.netbox.netbox_circuit_termination:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          circuit: Test Circuit
          term_side: A
          termination_id: 1
          termination_type: dcim.site
          port_speed: 10000
        state: present

    - name: Create circuit termination within NetBox versions earlier than 4.2.0 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 here, the following are the fields unique to this module:

Key	Description
circuit_termination	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present)
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Mikhail Yohman (@FragmentedPacket)

Collection links