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

New in version 1.0.0: of networktocode.nautobot

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

cid

string / required

added in 3.0.0 of networktocode.nautobot

The circuit id of the circuit

circuit_type

raw

added in 3.0.0 of networktocode.nautobot

The circuit type of the circuit

comments

string

added in 3.0.0 of networktocode.nautobot

Comments related to circuit

commit_rate

integer

added in 3.0.0 of networktocode.nautobot

Commit rate of the circuit (Kbps)

custom_fields

dictionary

added in 3.0.0 of networktocode.nautobot

must exist in Nautobot

description

string

added in 3.0.0 of networktocode.nautobot

Description of the circuit

install_date

string

added in 3.0.0 of networktocode.nautobot

The date the circuit was installed. e.g. YYYY-MM-DD

provider

raw

added in 3.0.0 of networktocode.nautobot

The provider of the circuit

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.

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

status

raw

added in 3.0.0 of networktocode.nautobot

The status of the circuit

Required if state=present and does not exist yet

tags

list / elements=raw

added in 3.0.0 of networktocode.nautobot

Any tags that the device may need to be associated with

tenant

raw

added in 3.0.0 of networktocode.nautobot

The tenant assigned to the circuit

token

string / required

The token created within Nautobot to authorize API access

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”

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

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)