networktocode.nautobot.tenant_group module – Creates or removes tenant groups from Nautobot

Note

This module is part of the networktocode.nautobot collection (version 4.1.1).

To install it, use: ansible-galaxy collection install networktocode.nautobot. You need further requirements to be able to use this module, see Requirements for details.

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

api_version

string

added in 4.1.0 of networktocode.nautobot

API Version Nautobot REST API

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 group to be created

parent_tenant_group

any

added in 3.1.0 of networktocode.nautobot

Name of the parent tenant group

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)

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

any

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Default: “true”

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

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

msg

string

Message indicating failure or info about what has been achieved

Returned: always

tenant_group

dictionary

Serialized object as created or already existent within Nautobot

Returned: on creation

Authors

  • Mikhail Yohman (@FragmentedPacket)