Note
This plugin is part of the netbox.netbox collection (version 3.3.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
.
To use it in a playbook, specify: netbox.netbox.netbox_circuit_termination
.
New in version 0.1.0: of netbox.netbox
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
cert raw | Certificate path | ||
data dictionary / required | Defines the circuit termination configuration | ||
circuit raw / required | The circuit to assign to circuit termination | ||
description string | Description of the circuit termination | ||
port_speed integer | The speed of the port (Kbps) | ||
pp_info string | Patch panel information | ||
site raw | The site the circuit termination will be assigned to | ||
term_side string / required |
| The side of the circuit termination | |
upstream_speed integer | The upstream speed of the circuit termination | ||
xconnect_id string | The cross connect ID of the circuit termination | ||
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 present or absent for adding or removing. | |
validate_certs raw | Default: "yes" | If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Note
local
and hosts localhost
- 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
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
circuit_termination 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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netbox/netbox/netbox_circuit_termination_module.html