netbox_tenant_module.rst

orphan:

netbox.netbox.netbox_tenant module -- Creates or removes tenants from NetBox

Note

This module is part of the netbox.netbox collection (version 3.17.0).

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. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_tenant_module_requirements>` for details.

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

.. rst-class:: ansible-version-added

New in netbox.netbox 0.1.0

• 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

.. tabularcolumns:: \X{1}{3}\X{2}{3}

Parameter	Comments
.. rst-class:: ansible-option-title cert .. ansible-option-type-line:: :ansible-option-type:`any`	Certificate path
.. rst-class:: ansible-option-title data .. ansible-option-type-line:: :ansible-option-type:`dictionary` / :ansible-option-required:`required`	Defines the tenant configuration
.. rst-class:: ansible-option-title comments .. ansible-option-type-line:: :ansible-option-type:`string`	Comments for the tenant. This can be markdown syntax
.. rst-class:: ansible-option-title custom_fields .. ansible-option-type-line:: :ansible-option-type:`dictionary`	must exist in NetBox
.. rst-class:: ansible-option-title description .. ansible-option-type-line:: :ansible-option-type:`string`	The description of the tenant
.. rst-class:: ansible-option-title name .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required`	Name of the tenant to be created
.. rst-class:: ansible-option-title slug .. ansible-option-type-line:: :ansible-option-type:`string`	URL-friendly unique shorthand
.. rst-class:: ansible-option-title tags .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=any`	Any tags that the tenant may need to be associated with
.. rst-class:: ansible-option-title tenant_group .. ansible-option-type-line:: :ansible-option-type:`any`	Tenant group this tenant should be in
.. rst-class:: ansible-option-title netbox_token .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required`	The NetBox API token.
.. rst-class:: ansible-option-title netbox_url .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required`	The URL of the NetBox instance. Must be accessible by the Ansible control host.
.. rst-class:: ansible-option-title query_params .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`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.
.. rst-class:: ansible-option-title state .. ansible-option-type-line:: :ansible-option-type:`string`	The state of the object. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
.. rst-class:: ansible-option-title validate_certs .. ansible-option-type-line:: :ansible-option-type:`any`	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-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 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 :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. tabularcolumns:: \X{1}{3}\X{2}{3}

Key	Description
.. rst-class:: ansible-option-title msg .. ansible-option-type-line:: :ansible-option-type:`string`	Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always
.. rst-class:: ansible-option-title tenant .. ansible-option-type-line:: :ansible-option-type:`dictionary`	Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` on creation

Authors

• Amy Liebowitz (@amylieb)

Collection links

.. ansible-links::

  - title: "Issue Tracker"
    url: "https://github.com/netbox-community/ansible_modules/issues"
    external: true
  - title: "Repository (Sources)"
    url: "https://github.com/netbox-community/ansible_modules"
    external: true