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

Note

This module is part of the netbox.netbox collection (version 3.20.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 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

Certificate path

data

Defines the region configuration

Must exist in NetBox and in key/value format

The description of the region

name

Name of the region to be created

parent_region

The parent region this region should be tied to

slug

The slugified version of the name or custom slug.

This is auto-generated following NetBox rules if not provided

Any tags that the region may need to be associated with

netbox_token

The NetBox API token.

netbox_url

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

query_params

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

validate_certs

If no, SSL certificates will not be validated.

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

: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 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

Message indicating failure or info about what has been achieved

:ansible-option-returned-bold:`Returned:` always

region

Serialized object as created or already existent within NetBox

:ansible-option-returned-bold:`Returned:` on creation

Authors

  • Mikhail Yohman (@FragmentedPacket)