netbox.netbox.netbox_cluster_group – Create, update or delete cluster groups within Netbox¶
Note
This plugin is part of the netbox.netbox collection (version 3.1.1).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_cluster_group
.
New in version 0.1.0: of netbox.netbox
Synopsis¶
Creates, updates or removes cluster groups from Netbox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
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 group within Netbox with only required information
netbox_cluster_group:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Cluster Group
state: present
- name: Delete cluster within netbox
netbox_cluster_group:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Cluster Group
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module: