networktocode / networktocode.nautobot / 5.1.1 / module / device_redundancy_group Creates or removes device redundancy groups from Nautobot | "added in version" 5.1.0 of networktocode.nautobot" Authors: Joe Wesch (@joewesch)networktocode.nautobot.device_redundancy_group (5.1.1) — module
Install with ansible-galaxy collection install networktocode.nautobot:==5.1.1
collections: - name: networktocode.nautobot version: 5.1.1
Creates or removes device redundancy groups from Nautobot
- name: "Test Nautobot device_redundancy_group module" connection: local hosts: localhost gather_facts: False tasks: - name: Create device redundancy group within Nautobot with only required information networktocode.nautobot.device_redundancy_group: url: http://nautobot.local token: thisIsMyToken name: My Redundancy Group status: Active state: present - name: Create device redundancy group within Nautobot with all information networktocode.nautobot.device_redundancy_group: url: http://nautobot.local token: thisIsMyToken name: My Redundancy Group status: Active description: My Description failover_strategy: active-active secrets_group: "{{ my_secrets_group['key'] }}" tags: - My Tag custom_fields: my_field: my_value state: present vars: my_secrets_group: "{{ lookup('networktocode.nautobot.lookup', 'secrets-groups', api_endpoint=nautobot_url, token=nautobot_token, api_filter='name=\"My Secrets Group\"') }}" - name: Delete device redundancy group within nautobot networktocode.nautobot.device_redundancy_group: url: http://nautobot.local token: thisIsMyToken name: My Redundancy Group state: absent
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 device redundancy group required: true type: str version_added: 5.1.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 status: description: - The status of the device redundancy group - Required if I(state=present) and the device redundancy group does not exist yet required: false type: raw version_added: 5.1.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 description: description: - The description of the device redundancy group required: false type: str version_added: 5.1.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 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 secrets_group: description: - The secrets group of the device redundancy group required: false type: raw version_added: 5.1.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 failover_strategy: choices: - active-active - active-passive description: - The failover strategy of the device redundancy group required: false type: str version_added: 5.1.0 version_added_collection: networktocode.nautobot
device_redundancy_group: 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