netbox.netbox.netbox_tenant – Creates or removes tenants from NetBox¶
Note
This plugin is part of the netbox.netbox collection (version 3.5.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¶
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
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
|