netbox.netbox.netbox_circuit_type – Create, update or delete circuit types within NetBox

Note

This plugin is part of the netbox.netbox collection (version 3.4.0).

To install it use: ansible-galaxy collection install netbox.netbox.

To use it in a playbook, specify: netbox.netbox.netbox_circuit_type.

New in version 0.1.0: of netbox.netbox

Synopsis

• Creates, updates or removes circuit types from NetBox

Requirements

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

• pynetbox

Parameters

Parameter		Choices/Defaults	Comments
cert raw			Certificate path
data dictionary / required			Defines the circuit type configuration
	name string / required		The name of the circuit type
	slug string		The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided
netbox_token string / required			The NetBox API token.
netbox_url string / required			The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params list / elements=string			This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment.
state string		Choices: present ← absent	The state of the object.
validate_certs raw		Default: "yes"	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates.

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

Examples

- name: "Test NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create type within NetBox with only required information
      netbox_circuit_type:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Circuit Type
        state: present

    - name: Delete circuit type within netbox
      netbox_circuit_type:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Circuit Type
        state: absent

Return Values

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

Key	Returned	Description
circuit_type dictionary	success (when state=present)	Serialized object as created or already existent within NetBox
msg string	always	Message indicating failure or info about what has been achieved

Authors

• Mikhail Yohman (@FragmentedPacket)