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

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. 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 Nautobot REST API

The circuit to assign to circuit termination

Description of the circuit termination

The location the circuit termination will be assigned to

The speed of the port (Kbps)

Patch panel information

Connection to a provider_network type

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

token

The token created within Nautobot to authorize API access

Can be omitted if the :ansenvvarref:`NAUTOBOT\_TOKEN` environment variable is configured.

The upstream speed of the circuit termination

url

The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)

Can be omitted if the :ansenvvarref:`NAUTOBOT\_URL` environment variable is configured.

validate_certs

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

Can be omitted if the :ansenvvar:`NAUTOBOT\_VALIDATE\_CERTS` environment variable is configured.

:ansible-option-default-bold:`Default:` :ansible-option-default:`true`

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:
          name: My Location
          parent: Parent Location
        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

Serialized object as created or already existent within Nautobot

: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)