networktocode.nautobot.tenant_group module – Creates or removes tenant groups from Nautobot¶
Note
This module is part of the networktocode.nautobot collection (version 3.4.0).
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 networktocode.nautobot
.
To use it in a playbook, specify: networktocode.nautobot.tenant_group
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates or removes tenant groups from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
The description of the tenant |
|
Name of the tenant group to be created |
|
Name of the parent tenant group |
|
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. |
|
URL-friendly unique shorthand |
|
Use Choices:
|
|
The token created within Nautobot to authorize API access |
|
URL of the Nautobot instance resolvable by Ansible control host |
|
Default: “yes” |
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples¶
- name: "Test Nautobot tenant group module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create tenant within Nautobot with only required information
networktocode.nautobot.tenant_group:
url: http://nautobot.local
token: thisIsMyToken
name: Tenant Group ABC
slug: "tenant_group_abc"
state: present
- name: Delete tenant within Nautobot
networktocode.nautobot.tenant_group:
url: http://nautobot.local
token: thisIsMyToken
name: Tenant ABC
state: absent
- name: Update tenant within Nautobot with a parent tenant group
networktocode.nautobot.tenant_group:
url: http://nautobot.local
token: thisIsMyToken
name: Tenant Group ABC
parent_tenant_group: Customer Tenants
slug: "tenant_group_abc"
state: present
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: on creation |