netbox.netbox.netbox_cluster – Create, update or delete clusters within NetBox

Note

This plugin is part of the netbox.netbox collection (version 3.4.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_cluster.

New in version 0.1.0: of netbox.netbox

Synopsis

  • Creates, updates or removes clusters from NetBox

Requirements

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

  • pynetbox

Parameters

Parameter Choices/Defaults Comments
cert
raw
Certificate path
data
dictionary / required
Defines the cluster configuration
cluster_group
raw
group of the cluster
cluster_type
raw
type of the cluster
comments
string
Comments that may include additional information in regards to the cluster
custom_fields
dictionary
must exist in NetBox
name
string / required
The name of the cluster
site
raw
Required if state=present and the cluster does not exist yet
tags
list / elements=raw
Any tags that the cluster may need to be associated with
tenant
raw
Tenant the cluster will be assigned to.
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
    Choices:
  • present ←
  • absent
The state of the object.
validate_certs
raw
Default:
"yes"
If no, SSL certificates will not be validated.
This should only be used on personally controlled sites using a self-signed certificates.

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create cluster within NetBox with only required information
      netbox_cluster:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Cluster
          cluster_type: libvirt
        state: present

    - name: Delete cluster within netbox
      netbox_cluster:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Cluster
        state: absent

    - name: Create cluster with tags
      netbox_cluster:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Another Test Cluster
          cluster_type: libvirt
          tags:
            - Schnozzberry
        state: present

    - name: Update the group and site of an existing cluster
      netbox_cluster:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Cluster
          cluster_type: qemu
          cluster_group: GROUP
          site: SITE
        state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
cluster
dictionary
success (when state=present)
Serialized object as created or already existent within NetBox

msg
string
always
Message indicating failure or info about what has been achieved



Authors

  • Gaelle MANGIN (@gmangin)