circuit_termination¶

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot

Added in version 1.0.0.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis¶

Creates, updates or removes circuit terminations from Nautobot

Requirements¶

The following Python packages are needed on the host that executes this module:

pynautobot

Parameters¶

Parameter	Defaults / Choices	Comments
api_version str		API Version Nautobot REST API Version Added: 4.1.0
circuit raw		The circuit to assign to circuit termination Required if I(state=present) and the circuit termination does not exist yet Version Added: 3.0.0
cloud_network raw		Connection to a cloud_network type Version Added: 5.4.0
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
description str		Description of the circuit termination Version Added: 3.0.0
id str		The UUID of the object to operate on Version Added: 5.13.0
location raw		The location the circuit termination will be assigned to Version Added: 3.0.0
port_speed int		The speed of the port (Kbps) Version Added: 3.0.0
pp_info str		Patch panel information Version Added: 3.0.0
provider_network raw		Connection to a provider_network type Version Added: 4.2.0
query_params list / elements=str		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. Version Added: 3.0.0
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
tags list / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
term_side str	Choices: A, Z	The side of the circuit termination Required if I(state=present) and the circuit termination does not exist yet Version Added: 3.0.0
token str required		The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
upstream_speed int		The upstream speed of the circuit termination Version Added: 3.0.0
url str required		The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
validate_certs raw	Default: True	If C(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 E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.
xconnect_id str		The cross connect ID of the circuit termination Version Added: 3.0.0

Notes¶

Note

Tags should be defined as a YAML list
This should be ran with connection C(local) and hosts C(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

    - name: Delete circuit termination by id
      networktocode.nautobot.circuit_termination:
        url: http://nautobot.local
        token: thisIsMyToken
        id: 00000000-0000-0000-0000-000000000000
        state: absent

Return Values¶

Key	Data Type	Description	Returned
circuit_termination	dict	Serialized object as created or already existent within Nautobot	success (when I(state=present))
msg	str	Message indicating failure or info about what has been achieved	always

Authors¶

Mikhail Yohman (@fragmentedpacket)