netbox.netbox.netbox_cluster_group – Create, update or delete cluster groups within NetBox¶
This plugin is part of the netbox.netbox collection (version 3.4.0).
To install it use:
ansible-galaxy collection install netbox.netbox.
To use it in a playbook, specify:
New in version 0.1.0: of netbox.netbox
Creates, updates or removes cluster groups from NetBox
The below requirements are needed on the host that executes this module.
Tags should be defined as a YAML list
This should be ran with connection
- 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
Common return values are documented here, the following are the fields unique to this module:
|success (when state=present)||
Serialized object as created or already existent within NetBox
Message indicating failure or info about what has been achieved