netbox.netbox.netbox_cluster – Create, update or delete clusters within Netbox¶
Note
This plugin is part of the netbox.netbox collection (version 1.2.1).
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
Parameters¶
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_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:
Authors¶
Gaelle MANGIN (@gmangin)