networktocode / networktocode.nautobot / 4.5.0 / module / tenant Creates or removes tenants from Nautobot | "added in version" 1.0.0 of networktocode.nautobot" Authors: Amy Liebowitz (@amylieb)networktocode.nautobot.tenant (4.5.0) — module
Install with ansible-galaxy collection install networktocode.nautobot:==4.5.0
collections: - name: networktocode.nautobot version: 4.5.0
Creates or removes tenants from Nautobot
- 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 tenant_group: Very Special Tenants description: ABC Incorporated comments: '### This tenant is super cool' slug: tenant_abc tags: - tagA - tagB - tagC state: present
url: description: - 'The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)' required: true type: str name: description: - Name of the tenant to be created required: true type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot slug: description: - URL-friendly unique shorthand required: false type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot tags: description: - Any tags that this item may need to be associated with elements: raw required: false type: list version_added: 3.0.0 version_added_collection: networktocode.nautobot state: choices: - absent - present default: present description: - Use C(present) or C(absent) for adding or removing. type: str token: description: - The token created within Nautobot to authorize API access required: true type: str comments: description: - Comments for the tenant. This can be markdown syntax required: false type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot api_version: description: - API Version Nautobot REST API required: false type: str version_added: 4.1.0 version_added_collection: networktocode.nautobot description: description: - The description of the tenant required: false type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot query_params: description: - 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. elements: str required: false type: list version_added: 3.0.0 version_added_collection: networktocode.nautobot tenant_group: description: - Tenant group this tenant should be in required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot custom_fields: description: - Must exist in Nautobot and in key/value format required: false type: dict version_added: 3.0.0 version_added_collection: networktocode.nautobot validate_certs: default: true description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. required: false type: raw
msg: description: Message indicating failure or info about what has been achieved returned: always type: str tenant: description: Serialized object as created or already existent within Nautobot returned: on creation type: dict