netbox.netbox.netbox_circuit – Create, update or delete circuits within Netbox
netbox.netbox.netbox_circuit – Create, update or delete circuits within Netbox
Note
This plugin is part of the netbox.netbox collection (version 2.0.0).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_circuit
.
New in version 0.1.0: of netbox.netbox
Synopsis
- Creates, updates or removes circuits from Netbox
Requirements
The below requirements are needed on the host that executes this module.
- pynetbox
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
data dictionary / required |
Defines the circuit configuration | ||
cid string / required |
The circuit id of the circuit | ||
circuit_type raw |
The circuit type of the circuit | ||
comments string |
Comments related to circuit | ||
commit_rate integer |
Commit rate of the circuit (Kbps) | ||
custom_fields dictionary |
must exist in Netbox | ||
description string |
Description of the circuit | ||
install_date string |
The date the circuit was installed. e.g. YYYY-MM-DD | ||
provider raw |
The provider of the circuit | ||
status raw |
The status of the circuit | ||
tags list / elements=string |
Any tags that the device may need to be associated with | ||
tenant raw |
The tenant assigned to the circuit | ||
netbox_token string / required |
The token created within Netbox to authorize API access | ||
netbox_url string / required |
URL of the Netbox instance resolvable by Ansible control host | ||
query_params list / elements=string |
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is 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 |
|
Use | |
validate_certs raw |
Default: "yes" |
If |
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_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_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_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 | Returned | Description |
---|---|---|
circuit 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)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netbox/netbox/netbox_circuit_module.html