| orphan: |
|---|
Note
This module is part of the netbox.netbox collection (version 3.17.0).
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.
You need further requirements to be able to use this module,
see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_rack_module_requirements>` for details.
To use it in a playbook, specify: netbox.netbox.netbox_rack.
.. rst-class:: ansible-version-added
New in netbox.netbox 0.1.0
- Creates, updates or removes racks from NetBox
The below requirements are needed on the host that executes this module.
- pynetbox
.. tabularcolumns:: \X{1}{3}\X{2}{3}
| Parameter | Comments |
|---|---|
Certificate path |
|
Defines the rack configuration |
|
Asset tag that is associated to the rack |
|
Comments that may include additional information in regards to the rack |
|
must exist in NetBox |
|
Rack units will be numbered top-to-bottom .. rst-class:: ansible-option-line |
|
.. rst-class:: ansible-option-title description .. ansible-option-type-line:: :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` |
Description of the rack |
The unique rack ID assigned by the facility |
|
The location the rack will be associated to (NetBox 2.11+) |
|
.. rst-class:: ansible-option-title max_weight .. ansible-option-type-line:: :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` |
Maximum load capacity of the rack |
.. rst-class:: ansible-option-title mounting_depth .. ansible-option-type-line:: :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` |
The mounting depth of the rack |
The name of the rack |
|
The outer depth of the rack |
|
Whether the rack unit is in Millimeters or Inches and is required if outer_width/outer_depth is specified .. rst-class:: ansible-option-line |
|
The outer width of the rack |
|
The rack group the rack will be associated to (NetBox < 2.11) Will be removed in version 5.0.0 |
|
The rack role the rack will be associated to |
|
Serial number of the rack |
|
Required if state=present and the rack does not exist yet |
|
The status of the rack |
|
Any tags that the rack may need to be associated with |
|
The tenant that the device will be assigned to |
|
The type of rack .. rst-class:: ansible-option-line |
|
The height of the rack in rack units |
|
.. rst-class:: ansible-option-title weight .. ansible-option-type-line:: :ansible-option-type:`float` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` |
The weight of the rack |
.. rst-class:: ansible-option-title weight_unit .. ansible-option-type-line:: :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` |
The weight unit .. rst-class:: ansible-option-line |
The rail-to-rail width .. rst-class:: ansible-option-line |
|
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. .. rst-class:: ansible-option-line |
|
If This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`true` |
Note
- Tags should be defined as a YAML list
- This should be ran with connection
localand hostslocalhost
- name: "Test NetBox modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create rack within NetBox with only required information
netbox.netbox.netbox_rack:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test rack
site: Test Site
state: present
- name: Create rack within NetBox with only required information - Pre 2.11
netbox.netbox.netbox_rack:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test rack
site: Test Site
rack_group: Test Rack Group
state: present
- name: Create rack within NetBox with only required information - Post 2.11
netbox.netbox.netbox_rack:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test rack
site: Test Site
location: Test Location
state: present
- name: Delete rack within netbox
netbox.netbox.netbox_rack:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Rack
state: absent
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. tabularcolumns:: \X{1}{3}\X{2}{3}
| Key | Description |
|---|---|
Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line |
|
Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success (when state=present) |
- Mikhail Yohman (@FragmentedPacket)
.. ansible-links::
- title: "Issue Tracker"
url: "https://github.com/netbox-community/ansible_modules/issues"
external: true
- title: "Repository (Sources)"
url: "https://github.com/netbox-community/ansible_modules"
external: true