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 |
---|---|
group of the cluster |
|
type of the cluster |
|
Comments that may include additional information in regards to the cluster |
|
must exist in Nautobot |
|
The name of the cluster |
|
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. |
|
Required if state=present and the cluster does not exist yet |
|
Use Choices:
|
|
Any tags that the cluster may need to be associated with |
|
Tenant the cluster will be assigned to. |
|
The token created within Nautobot to authorize API access |
|
URL of the Nautobot instance resolvable by Ansible control host |
|
If Default: “yes” |
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
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 |
---|---|
Serialized object as created or already existent within Nautobot Returned: success (when state=present) |
|
Message indicating failure or info about what has been achieved Returned: always |