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 string added in 3.0.0 of networktocode.nautobot	Comments for the tenant. This can be markdown syntax
custom_fields dictionary added in 3.0.0 of networktocode.nautobot	must exist in Nautobot
description string added in 3.0.0 of networktocode.nautobot	The description of the tenant
name string / required added in 3.0.0 of networktocode.nautobot	Name of the tenant to be created
query_params list / elements=string added in 3.0.0 of networktocode.nautobot	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.
slug string added in 3.0.0 of networktocode.nautobot	URL-friendly unique shorthand
state string	Use present or absent for adding or removing. Choices: absent present ← (default)
tags list / elements=raw added in 3.0.0 of networktocode.nautobot	Any tags that the tenant may need to be associated with
tenant_group raw added in 3.0.0 of networktocode.nautobot	Tenant group this tenant should be in
token string / required	The token created within Nautobot to authorize API access
url string / required	URL of the Nautobot instance resolvable by Ansible control host
validate_certs raw	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Default: “yes”

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

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
msg string	Message indicating failure or info about what has been achieved Returned: always
tenant dictionary	Serialized object as created or already existent within Nautobot Returned: on creation

Authors

• Amy Liebowitz (@amylieb)

Collection links

Issue Tracker Repository (Sources)