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

Note

This module is part of the networktocode.nautobot collection (version 5.0.1).

To install it, use: ansible-galaxy collection install networktocode.nautobot. You need further requirements to be able to use this module, see Requirements for details.

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

New in networktocode.nautobot 1.0.0

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
api_version string added in networktocode.nautobot 4.1.0	API Version Nautobot REST API
circuit any / required added in networktocode.nautobot 3.0.0	The circuit to assign to circuit termination
description string added in networktocode.nautobot 3.0.0	Description of the circuit termination
location any added in networktocode.nautobot 3.0.0	The location the circuit termination will be assigned to
port_speed integer added in networktocode.nautobot 3.0.0	The speed of the port (Kbps)
pp_info string added in networktocode.nautobot 3.0.0	Patch panel information
provider_network any added in networktocode.nautobot 4.2.0	Connection to a provider_network type
query_params list / elements=string added in networktocode.nautobot 3.0.0	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.
state string	Use present or absent for adding or removing. Choices: :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` ← (default)
term_side string / required added in networktocode.nautobot 3.0.0	The side of the circuit termination Choices: :ansible-option-choices-entry:`"A"` :ansible-option-choices-entry:`"Z"`
token string / required	The token created within Nautobot to authorize API access
upstream_speed integer added in networktocode.nautobot 3.0.0	The upstream speed of the circuit termination
url string / required	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Default: :ansible-option-default:`true`
xconnect_id string added in networktocode.nautobot 3.0.0	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
        location: "{{ location['key'] }}"
        port_speed: 10000
        state: present

    - name: Create circuit termination to Provider Network
      networktocode.nautobot.circuit_termination:
        url: http://nautobot.local
        token: thisIsMyToken
        circuit: Test Circuit
        term_side: Z
        provider_network:
          name: "Provider A"
        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)

Collection links

Issue Tracker Repository (Sources)