netbox.netbox.netbox_device_bay – Create, update or delete device bays within Netbox
Note
This plugin is part of the netbox.netbox collection (version 1.2.0).
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
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| data dictionary / required | Defines the device bay configuration | ||
| description string | The description of the device bay. This is supported on v2.6+ of Netbox | ||
| device raw | The device the device bay will be associated to. The device type must be "parent". | ||
| installed_device raw | The ddevice that will be installed into the bay. The device type must be "child". | ||
| name string / required | The name of the device bay | ||
| tags list / elements=string | Any tags that the device bay may need to be associated with | ||
| 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. | |
Notes
Note
- Tags should be defined as a YAML list
- This should be ran with connection
localand 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 | Returned | Description |
|---|---|---|
| device_bay 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 |
Authors
- Mikhail Yohman (@FragmentedPacket)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netbox/netbox/netbox_device_bay_module.html