You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

netbox.netbox.netbox_tenant – Creates or removes tenants from NetBox

Note

This plugin is part of the netbox.netbox 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 netbox.netbox.

To use it in a playbook, specify: netbox.netbox.netbox_tenant.

New in version 0.1.0: of netbox.netbox

Synopsis

• Creates or removes tenants from NetBox

Requirements

The below requirements are needed on the host that executes this module.

• pynetbox

Parameters

Parameter	Comments
cert raw	Certificate path
data dictionary / required	Defines the tenant configuration
comments string	Comments for the tenant. This can be markdown syntax
custom_fields dictionary	must exist in NetBox
description string	The description of the tenant
name string / required	Name of the tenant to be created
slug string	URL-friendly unique shorthand
tags list / elements=raw	Any tags that the tenant may need to be associated with
tenant_group raw	Tenant group this tenant should be in
netbox_token string / required	The NetBox API token.
netbox_url string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params list / elements=string	This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment.
state string	The state of the object. Choices: present ← (default) absent
validate_certs raw	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a 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 NetBox module"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create tenant within NetBox with only required information
      netbox_tenant:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Tenant ABC
        state: present

    - name: Delete tenant within netbox
      netbox_tenant:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Tenant ABC
        state: absent

    - name: Create tenant with all parameters
      netbox_tenant:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          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

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 NetBox Returned: on creation

Authors

• Amy Liebowitz (@amylieb)