netbox.netbox.netbox_region module – Creates or removes regions from NetBox

Note

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

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

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

New in netbox.netbox 0.1.0

Synopsis

  • Creates or removes regions from NetBox

Requirements

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

  • pynetbox

Parameters

Parameter

Comments

cert

any

Certificate path

data

dictionary / required

Defines the region configuration

custom_fields

dictionary

added in netbox.netbox 3.5.0

Must exist in NetBox and in key/value format

description

string

added in netbox.netbox 3.5.0

The description of the region

name

string / required

Name of the region to be created

parent_region

any

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

tags

list / elements=any

added in netbox.netbox 3.5.0

Any tags that the region may need to be associated with

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

any

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using a self-signed certificates.

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 region module"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create region within NetBox with only required information
      netbox.netbox.netbox_region:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Test Region One"
        state: present

    - name: Delete region within netbox
      netbox.netbox.netbox_region:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Test Region One"
        state: absent

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

region

dictionary

Serialized object as created or already existent within NetBox

Returned: on creation

Authors

  • Mikhail Yohman (@FragmentedPacket)