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

Note

This plugin is part of the netbox.netbox collection (version 3.3.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
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Creates or removes tenants from Netbox

Requirements

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

pynetbox

Parameters

Parameter		Choices/Defaults	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 token created within Netbox to authorize API access
netbox_url string / required			URL of the Netbox instance resolvable by Ansible control host
query_params list / elements=string			This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is 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		Choices: absent present ←	Use `present` or `absent` for adding or removing.
validate_certs raw		Default: "yes"	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

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

Authors

Amy Liebowitz (@amylieb)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netbox/netbox/netbox_tenant_module.html