netbox.netbox.netbox_cluster module – Create, update or delete clusters within 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_cluster
.
New in netbox.netbox 0.1.0
Synopsis
Creates, updates or removes clusters from NetBox
Requirements
The below requirements are needed on the host that executes this module.
pynetbox
Parameters
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the cluster configuration |
|
group of the cluster |
|
type of the cluster |
|
Comments that may include additional information in regards to the cluster |
|
must exist in NetBox |
|
The description of the cluster |
|
The name of the cluster |
|
Required if state=present and the cluster does not exist yet |
|
Status of the cluster |
|
Any tags that the cluster may need to be associated with |
|
Tenant the cluster will be assigned to. |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
If 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 hostslocalhost
Examples
- name: "Test NetBox modules"
connection: local
hosts: localhost
gather_facts: false
tasks:
- name: Create cluster within NetBox with only required information
netbox.netbox.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.netbox.netbox_cluster:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Cluster
state: absent
- name: Create cluster with tags
netbox.netbox.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, site and status of an existing cluster
netbox.netbox.netbox_cluster:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Cluster
cluster_type: qemu
cluster_group: GROUP
site: SITE
status: planned
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 NetBox :ansible-option-returned-bold:`Returned:` success (when state=present) |
|
Message indicating failure or info about what has been achieved |