netbox.netbox.netbox_device_bay module – Create, update or delete device bays within NetBox
Note
This module is part of the netbox.netbox collection (version 3.7.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
Parameters
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the device bay configuration |
|
The description of the device bay. This is supported on v2.6+ of NetBox |
|
The device the device bay will be associated to. The device type must be “parent”. |
|
The ddevice that will be installed into the bay. The device type must be “child”. |
|
The name of the device bay |
|
Any tags that the device bay may need to be associated with |
|
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: “yes” |
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:
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 |
Authors
Mikhail Yohman (@FragmentedPacket)