circuit_type_module.rst

orphan

networktocode.nautobot.circuit_type module -- Create, update or delete circuit types within Nautobot

Note

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

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

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

ansible-version-added

New in networktocode.nautobot 1.0.0

Synopsis

• Creates, updates or removes circuit types from Nautobot

Requirements

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

• pynautobot

Parameters

ansible-option-table

Parameter	Comments
ansible-option-title api_version ansible-option-type-line string added in networktocode.nautobot 4.1.0	API Version Nautobot REST API
ansible-option-title description ansible-option-type-line string added in networktocode.nautobot 3.0.0	The decription of the the circuit type.
ansible-option-title name ansible-option-type-line string / required added in networktocode.nautobot 3.0.0	The name of the circuit type
ansible-option-title query_params ansible-option-type-line 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.
ansible-option-title state ansible-option-type-line string	Use present or absent for adding or removing. ansible-option-line Choices: "absent" "present" ← (default)
ansible-option-title token ansible-option-type-line string / required	The token created within Nautobot to authorize API access Can be omitted if the NAUTOBOT\_TOKEN environment variable is configured.
ansible-option-title url ansible-option-type-line string / required	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the NAUTOBOT\_URL environment variable is configured.
ansible-option-title validate_certs ansible-option-type-line any	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 NAUTOBOT\_VALIDATE\_CERTS environment variable is configured. ansible-option-line 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 type within Nautobot with only required information
      networktocode.nautobot.circuit_type:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Circuit Type
        state: present

    - name: Delete circuit type within nautobot
      networktocode.nautobot.circuit_type:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Circuit Type
        state: absent

Return Values

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

ansible-option-table

Key	Description
ansible-option-title circuit_type ansible-option-type-line dictionary	Serialized object as created or already existent within Nautobot ansible-option-line Returned: success (when state=present)
ansible-option-title msg ansible-option-type-line string	Message indicating failure or info about what has been achieved ansible-option-line Returned: always

Authors

• Mikhail Yohman (@FragmentedPacket)

Collection links

Issue Tracker Repository (Sources)