networktocode.nautobot.circuit_termination module – Create, update or delete circuit terminations within Nautobot

Note

This module is part of the networktocode.nautobot 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 networktocode.nautobot.

To use it in a playbook, specify: networktocode.nautobot.circuit_termination.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates, updates or removes circuit terminations from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

circuit

raw / required

added in 3.0.0 of networktocode.nautobot

The circuit to assign to circuit termination

description

string

added in 3.0.0 of networktocode.nautobot

Description of the circuit termination

port_speed

integer

added in 3.0.0 of networktocode.nautobot

The speed of the port (Kbps)

pp_info

string

added in 3.0.0 of networktocode.nautobot

Patch panel information

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

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.

site

raw

added in 3.0.0 of networktocode.nautobot

The site the circuit termination will be assigned to

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

term_side

string / required

added in 3.0.0 of networktocode.nautobot

The side of the circuit termination

Choices:

  • A

  • Z

token

string / required

The token created within Nautobot to authorize API access

upstream_speed

integer

added in 3.0.0 of networktocode.nautobot

The upstream speed of the circuit termination

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

raw

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Default: “yes”

xconnect_id

string

added in 3.0.0 of networktocode.nautobot

The cross connect ID of the circuit termination

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

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

  tasks:
    - name: Create circuit termination within Nautobot with only required information
      networktocode.nautobot.circuit_termination:
        url: http://nautobot.local
        token: thisIsMyToken
        circuit: Test Circuit
        term_side: A
        site: Test Site
        port_speed: 10000
        state: present

    - name: Update circuit termination with other fields
      networktocode.nautobot.circuit_termination:
        url: http://nautobot.local
        token: thisIsMyToken
        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 nautobot
      networktocode.nautobot.circuit_termination:
        url: http://nautobot.local
        token: thisIsMyToken
        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

dictionary

Serialized object as created or already existent within Nautobot

Returned: success (when state=present)

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Mikhail Yohman (@FragmentedPacket)