netbox.netbox.netbox_circuit module – Create, update or delete circuits within NetBox
Note
This module is part of the netbox.netbox collection (version 3.20.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 netbox.netbox
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netbox.netbox.netbox_circuit
.
New in netbox.netbox 0.1.0
Synopsis
Creates, updates or removes circuits from NetBox
Requirements
The below requirements are needed on the host that executes this module.
pynetbox
Parameters
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the circuit configuration |
|
The circuit id of the circuit |
|
The circuit type of the circuit |
|
Comments related to circuit |
|
Commit rate of the circuit (Kbps) |
|
must exist in NetBox |
|
Description of the circuit |
|
The date the circuit was installed. e.g. YYYY-MM-DD |
|
The provider of the circuit |
|
The status of the circuit |
|
Any tags that the device may need to be associated with |
|
The tenant assigned to the circuit |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: |
Notes
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples
- name: "Test NetBox modules"
connection: local
hosts: localhost
gather_facts: false
tasks:
- name: Create circuit within NetBox with only required information
netbox.netbox.netbox_circuit:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
cid: Test Circuit
provider: Test Provider
circuit_type: Test Circuit Type
state: present
- name: Update circuit with other fields
netbox.netbox.netbox_circuit:
netbox_url: http://netbox.local
netbox_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 netbox
netbox.netbox.netbox_circuit:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
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 |
---|---|
Serialized object as created or already existent within NetBox Returned: success (when state=present) |
|
Message indicating failure or info about what has been achieved Returned: always |