networktocode / networktocode.nautobot / 4.5.0 / module / cluster Create, update or delete clusters within Nautobot | "added in version" 1.0.0 of networktocode.nautobot" Authors: Gaelle MANGIN (@gmangin)networktocode.nautobot.cluster (4.5.0) — module
Install with ansible-galaxy collection install networktocode.nautobot:==4.5.0
collections: - name: networktocode.nautobot version: 4.5.0
Creates, updates or removes clusters from Nautobot
- 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
url: description: - 'The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)' required: true type: str name: description: - The name of the cluster required: true type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot site: description: - Required if I(state=present) and the cluster does not exist yet required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot tags: description: - Any tags that this item may need to be associated with elements: raw required: false type: list version_added: 3.0.0 version_added_collection: networktocode.nautobot state: choices: - absent - present default: present description: - Use C(present) or C(absent) for adding or removing. type: str token: description: - The token created within Nautobot to authorize API access required: true type: str tenant: description: - Tenant the cluster will be assigned to. required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot comments: description: - Comments that may include additional information in regards to the cluster required: false type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot api_version: description: - API Version Nautobot REST API required: false type: str version_added: 4.1.0 version_added_collection: networktocode.nautobot cluster_type: description: - type of the cluster required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot query_params: description: - 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. elements: str required: false type: list version_added: 3.0.0 version_added_collection: networktocode.nautobot cluster_group: description: - group of the cluster required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot custom_fields: description: - Must exist in Nautobot and in key/value format required: false type: dict version_added: 3.0.0 version_added_collection: networktocode.nautobot validate_certs: default: true description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. required: false type: raw
cluster: description: Serialized object as created or already existent within Nautobot returned: success (when I(state=present)) type: dict msg: description: Message indicating failure or info about what has been achieved returned: always type: str