networktocode.nautobot.cluster module – Create, update or delete clusters within Nautobot

Note

This module is part of the networktocode.nautobot 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 networktocode.nautobot.

To use it in a playbook, specify: networktocode.nautobot.cluster.

New in version 1.0.0: of networktocode.nautobot

Synopsis

• Creates, updates or removes clusters from Nautobot

Requirements

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

• pynautobot

Parameters

Parameter	Comments
cluster_group raw added in 3.0.0 of networktocode.nautobot	group of the cluster
cluster_type raw added in 3.0.0 of networktocode.nautobot	type of the cluster
comments string added in 3.0.0 of networktocode.nautobot	Comments that may include additional information in regards to the cluster
custom_fields dictionary added in 3.0.0 of networktocode.nautobot	must exist in Nautobot
name string / required added in 3.0.0 of networktocode.nautobot	The name of the cluster
query_params list / elements=string added in 3.0.0 of networktocode.nautobot	This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/utils.py and provides control to users on what may make an object unique in their environment.
site raw added in 3.0.0 of networktocode.nautobot	Required if state=present and the cluster does not exist yet
state string	Use present or absent for adding or removing. Choices: absent present ← (default)
tags list / elements=raw added in 3.0.0 of networktocode.nautobot	Any tags that the cluster may need to be associated with
tenant raw added in 3.0.0 of networktocode.nautobot	Tenant the cluster will be assigned to.
token string / required	The token created within Nautobot to authorize API access
url string / required	URL of the Nautobot instance resolvable by Ansible control host
validate_certs raw	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Default: “yes”

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

Examples

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

  tasks:
    - name: Create cluster within Nautobot with only required information
      networktocode.nautobot.cluster:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Cluster
        cluster_type: libvirt
        state: present

    - name: Delete cluster within nautobot
      networktocode.nautobot.cluster:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Cluster
        state: absent

    - name: Create cluster with tags
      networktocode.nautobot.cluster:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Another Test Cluster
        cluster_type: libvirt
        tags:
          - Schnozzberry
        state: present

    - name: Update the group and site of an existing cluster
      networktocode.nautobot.cluster:
        url: http://nautobot.local
        token: thisIsMyToken
        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	Description
cluster dictionary	Serialized object as created or already existent within Nautobot Returned: success (when state=present)
msg string	Message indicating failure or info about what has been achieved Returned: always

Authors

• Gaelle MANGIN (@gmangin)

Collection links

Issue Tracker Repository (Sources)