networktocode.nautobot.rack module – Create, update or delete racks within Nautobot¶
Note
This module is part of the networktocode.nautobot collection (version 4.5.0).
To install it, use: ansible-galaxy collection install networktocode.nautobot
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: networktocode.nautobot.rack
.
New in networktocode.nautobot 1.0.0
Synopsis¶
Creates, updates or removes racks from Nautobot.
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
API Version Nautobot REST API |
|
Asset tag that is associated to the rack. |
|
Comments that may include additional information in regards to the rack. |
|
Must exist in Nautobot and in key/value format |
|
Rack units will be numbered top-to-bottom. Choices: |
|
The unique rack ID assigned by the facility. |
|
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. Choices: |
|
The outer width of the rack. |
|
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/utils.py and provides control to users on what may make an object unique in their environment. |
|
The rack group the rack will be associated to. |
|
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. |
|
Use Choices: |
|
The status of the rack Required if state=present and does not exist yet. |
|
Any tags that this item may need to be associated with |
|
The tenant that the device will be assigned to. |
|
The token created within Nautobot to authorize API access |
|
The height of the rack in rack units. |
|
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) |
|
If Default: :ansible-option-default:`true` |
|
The rail-to-rail width. Choices: |
Notes¶
Note
Tags should be defined as a YAML list.
This should be ran with connection
local
and hostslocalhost
.The module supports
check_mode
.
Examples¶
- name: "Test Nautobot modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create rack within Nautobot with only required information
networktocode.nautobot.rack:
url: http://nautobot.local
token: thisIsMyToken
name: Test rack
site: Test Site
status: active
state: present
- name: Delete rack within nautobot
networktocode.nautobot.rack:
url: http://nautobot.local
token: thisIsMyToken
name: Test Rack
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Message indicating failure or info about what has been achieved. Returned: always |
|
Serialized object as created or already existent within Nautobot. Returned: success (when state=present) |