netbox.netbox.netbox_circuit – Create, update or delete circuits within Netbox¶
Note
This plugin is part of the netbox.netbox collection (version 3.1.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¶
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: