netbox.netbox.netbox_circuit_termination module – Create, update or delete circuit terminations within NetBox¶
Note
This module is part of the netbox.netbox collection (version 3.10.0).
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_termination
.
New in netbox.netbox 0.1.0
Synopsis¶
Creates, updates or removes circuit terminations from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the circuit termination configuration |
|
The circuit to assign to circuit termination |
|
Description of the circuit termination |
|
Treat as if cable is connected Choices: |
|
The speed of the port (Kbps) |
|
Patch panel information |
|
The provider_network the circuit termination will be assigned to |
|
The site the circuit termination will be assigned to |
|
The side of the circuit termination Choices: |
|
The upstream speed of the circuit termination |
|
The cross connect ID of the circuit termination |
|
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: :ansible-option-default:`true` |
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.netbox.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.netbox.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.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:
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 |