networktocode.nautobot.tenant module – Creates or removes tenants 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
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates or removes tenants from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
Comments for the tenant. This can be markdown syntax |
|
must exist in Nautobot |
|
The description of the tenant |
|
Name of the tenant to be created |
|
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:
|
|
Any tags that the tenant may need to be associated with |
|
Tenant group this tenant should be in |
|
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 module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create tenant within Nautobot with only required information
networktocode.nautobot.tenant:
url: http://nautobot.local
token: thisIsMyToken
name: Tenant ABC
state: present
- name: Delete tenant within nautobot
networktocode.nautobot.tenant:
url: http://nautobot.local
token: thisIsMyToken
name: Tenant ABC
state: absent
- name: Create tenant with all parameters
networktocode.nautobot.tenant:
url: http://nautobot.local
token: thisIsMyToken
name: Tenant ABC
group: Very Special Tenants
description: ABC Incorporated
comments: '### This tenant is super cool'
slug: tenant_abc
tags:
- tagA
- tagB
- tagC
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 |