netbox.netbox.netbox_device_bay – Create, update or delete device bays within NetBox¶
Note
This plugin is part of the netbox.netbox collection (version 3.5.1).
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_device_bay
.
New in version 0.1.0: of netbox.netbox
Synopsis¶
Creates, updates or removes device bays 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 device bay within NetBox with only required information
netbox_device_bay:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
device: Test Nexus One
name: "Device Bay One"
state: present
- name: Add device into device bay
netbox_device_bay:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
device: Test Nexus One
name: "Device Bay One"
description: "First child"
installed_device: Test Nexus Child One
state: absent
- name: Delete device bay within netbox
netbox_device_bay:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Device Bay One
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module: