netbox.netbox.netbox_circuit_termination – Create, update or delete circuit terminations 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_termination
.
New in version 0.1.0: of netbox.netbox
Synopsis¶
Creates, updates or removes circuit terminations 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 termination within Netbox with only required information
netbox_circuit_termination:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
circuit: Test Circuit
term_side: A
site: Test Site
port_speed: 10000
state: present
- name: Update circuit termination with other fields
netbox_circuit_termination:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
circuit: Test Circuit
term_side: A
upstream_speed: 1000
xconnect_id: 10X100
pp_info: PP10-24
description: "Test description"
state: present
- name: Delete circuit termination within netbox
netbox_circuit_termination:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
circuit: Test Circuit
term_side: A
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module: