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

Note

This plugin is part of the netbox.netbox 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 netbox.netbox.

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

New in version 0.1.0: of netbox.netbox

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 Choices/Defaults Comments
cert
raw
Certificate path
data
dictionary / required
Defines the circuit termination configuration
circuit
raw / required
The circuit to assign to circuit termination
description
string
Description of the circuit termination
port_speed
integer
The speed of the port (Kbps)
pp_info
string
Patch panel information
provider_network
raw
The provider_network the circuit termination will be assigned to
site
raw
The site the circuit termination will be assigned to
term_side
string / required
    Choices:
  • A
  • Z
The side of the circuit termination
upstream_speed
integer
The upstream speed of the circuit termination
xconnect_id
string
The cross connect ID of the circuit termination
netbox_token
string / required
The NetBox API token.
netbox_url
string / required
The URL of the NetBox instance.
Must be accessible by the Ansible control host.
query_params
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.
state
string
    Choices:
  • present ←
  • absent
The state of the object.
validate_certs
raw
Default:
"yes"
If no, SSL certificates will not be validated.
This should only be used on personally controlled sites using a self-signed certificates.

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_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_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_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 Returned Description
circuit_termination
dictionary
success (when state=present)
Serialized object as created or already existent within NetBox

msg
string
always
Message indicating failure or info about what has been achieved



Authors

  • Mikhail Yohman (@FragmentedPacket)