- orphan
Note
This module is part of the networktocode.nautobot collection (version 5.2.0).
To install it, use: ansible-galaxy collection install networktocode.nautobot
. You need further requirements to be able to use this module, see Requirements <ansible_collections.networktocode.nautobot.rack_group_module_requirements>
for details.
To use it in a playbook, specify: networktocode.nautobot.rack_group
.
ansible-version-added
New in networktocode.nautobot 1.0.0
- Creates, updates or removes racks groups from Nautobot
The below requirements are needed on the host that executes this module.
- pynautobot
ansible-option-table
Parameter | Comments |
---|---|
API Version Nautobot REST API |
|
The description of the rack group |
|
Required if state=present and the rack does not exist yet |
|
The name of the rack group |
|
The parent rack-group the rack group will be assigned to |
|
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. |
|
Use ansible-option-line Choices:
|
|
The token created within Nautobot to authorize API access |
|
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) |
|
If ansible-option-line Default: |
Note
- Tags should be defined as a YAML list - This should be ran with connection local
and hosts localhost
- name: "Test Nautobot modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create rack group within Nautobot with only required information
networktocode.nautobot.rack_group:
url: http://nautobot.local
token: thisIsMyToken
name: Test rack group
location: My Location
state: present
- name: Delete rack group within nautobot
networktocode.nautobot.rack_group:
url: http://nautobot.local
token: thisIsMyToken
name: Test Rack group
location:
name: My Location
parent: Parent Location
state: absent
Common return values are documented here <common_return_values>
, the following are the fields unique to this module:
ansible-option-table
Key | Description |
---|---|
Message indicating failure or info about what has been achieved ansible-option-line Returned: always |
|
Serialized object as created or already existent within Nautobot ansible-option-line Returned: success (when state=present) |
- Mikhail Yohman (@FragmentedPacket)