networktocode.nautobot.circuit module – Create, update or delete circuits 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.

New in networktocode.nautobot 1.0.0

Synopsis

• Creates, updates or removes circuits from Nautobot

Requirements

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

• pynautobot

Parameters

Parameter	Comments
api_version :ansible-option-versionadded:`added in networktocode.nautobot 4.1.0`	API Version Nautobot REST API
cid :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	The circuit id of the circuit
circuit_type :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	The circuit type of the circuit
comments :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	Comments related to circuit
commit_rate :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	Commit rate of the circuit (Kbps)
custom_fields :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	Must exist in Nautobot and in key/value format
description :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	Description of the circuit
install_date :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	The date the circuit was installed. e.g. YYYY-MM-DD
provider :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	The provider of the circuit
query_params :ansible-option-versionadded:`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	Use present or absent for adding or removing. :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
status :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	The status of the circuit Required if state=present and does not exist yet
tags :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	Any tags that this item may need to be associated with
tenant :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	The tenant assigned to the circuit
token	The token created within Nautobot to authorize API access Can be omitted if the :ansenvvarref:`NAUTOBOT\_TOKEN` environment variable is configured.
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`

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 within Nautobot with only required information
      networktocode.nautobot.circuit:
        url: http://nautobot.local
        token: thisIsMyToken
        cid: Test Circuit
        provider: Test Provider
        circuit_type: Test Circuit Type
        status: active
        state: present

    - name: Update circuit with other fields
      networktocode.nautobot.circuit:
        url: http://nautobot.local
        token: thisIsMyToken
        data:
        cid: Test-Circuit-1000
        provider: Test Provider
        circuit_type: Test Circuit Type
        status: Active
        tenant: Test Tenant
        install_date: "2018-12-25"
        commit_rate: 10000
        description: Test circuit
        comments: "FAST CIRCUIT"
        state: present

    - name: Delete circuit within nautobot
      networktocode.nautobot.circuit:
        url: http://nautobot.local
        token: thisIsMyToken
        cid: Test-Circuit-1000
        state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
circuit	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)

Collection links