networktocode.nautobot.device_redundancy_group module – Creates or removes device redundancy groups from Nautobot
Note
This module is part of the networktocode.nautobot collection (version 5.2.0).
To install it, use: ansible-galaxy collection install networktocode.nautobot
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: networktocode.nautobot.device_redundancy_group
.
New in networktocode.nautobot 5.1.0
Synopsis
Creates or removes device redundancy groups from Nautobot
Requirements
The below requirements are needed on the host that executes this module.
pynautobot
Parameters
Parameter |
Comments |
---|---|
API Version Nautobot REST API |
|
Must exist in Nautobot and in key/value format |
|
The description of the device redundancy group |
|
The failover strategy of the device redundancy group Choices: |
|
The name of the device redundancy group |
|
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. |
|
The secrets group of the device redundancy group |
|
Use Choices: |
|
The status of the device redundancy group Required if state=present and the device redundancy group does not exist yet |
|
Any tags that this item may need to be associated with |
|
The token created within Nautobot to authorize API access |
|
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) |
|
If Default: :ansible-option-default:`true` |
Notes
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Serialized object as created or already existent within Nautobot Returned: success (when state=present) |
|
Message indicating failure or info about what has been achieved Returned: always |