netbox.netbox.netbox_region – Creates or removes regions from Netbox
netbox.netbox.netbox_region – Creates or removes regions from Netbox
Note
This plugin is part of the netbox.netbox collection (version 2.0.0).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_region
.
New in version 0.1.0: of netbox.netbox
Synopsis
- Creates or removes regions from Netbox
Requirements
The below requirements are needed on the host that executes this module.
- pynetbox
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
data dictionary / required |
Defines the region configuration | ||
name string / required |
Name of the region to be created | ||
parent_region raw |
The parent region this region should be tied to | ||
slug string |
The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided | ||
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 |
|
Use | |
validate_certs raw |
Default: "yes" |
If |
Notes
Note
- Tags should be defined as a YAML list
- This should be ran with connection
local
and hostslocalhost
Examples
- name: "Test Netbox region module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create tenant within Netbox with only required information
netbox_region:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: "Test Region One"
state: present
- name: Delete tenant within netbox
netbox_region:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Tenant Group ABC
state: absent
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
|
region dictionary |
on creation |
Serialized object as created or already existent within Netbox
|
Authors
- Mikhail Yohman (@FragmentedPacket)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netbox/netbox/netbox_region_module.html