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_cable
.
New in version 0.3.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 cable configuration | ||
color string | The color of the cable | ||
label string | The label of the cable | ||
length integer | The length of the cable | ||
length_unit string |
| The unit in which the length of the cable is measured | |
status string |
| The status of the cable | |
tags list / elements=raw | Any tags that the cable may need to be associated with | ||
termination_a raw / required | The termination a | ||
termination_a_type string / required |
| The type of the termination a | |
termination_b raw / required | The termination b | ||
termination_b_type string / required |
| The type of the termination b | |
type string |
| The type of the cable | |
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 cable within Netbox with only required information netbox_cable: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: termination_a_type: dcim.interface termination_a: device: Test Nexus Child One name: Ethernet2/2 termination_b_type: dcim.interface termination_b: device: Test Nexus Child One name: Ethernet2/1 state: present - name: Update cable with other fields netbox_cable: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: termination_a_type: dcim.interface termination_a: device: Test Nexus Child One name: Ethernet2/2 termination_b_type: dcim.interface termination_b: device: Test Nexus Child One name: Ethernet2/1 type: mmf-om4 status: planned label: label123 color: abcdef length: 30 length_unit: m tags: - foo state: present - name: Delete cable within netbox netbox_cable: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: termination_a_type: dcim.interface termination_a: device: Test Nexus Child One name: Ethernet2/2 termination_b_type: dcim.interface termination_b: device: Test Nexus Child One name: Ethernet2/1 state: absent
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
cable 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_cable_module.html