netbox.netbox.netbox_cable – Create, update or delete cables within Netbox¶
Note
This plugin is part of the netbox.netbox collection (version 3.1.1).
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
Synopsis¶
Creates, updates or removes cables 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 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module: