Skip to content

device_redundancy_group

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot
Added in version 5.1.0.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis

  • Creates or removes device redundancy groups from Nautobot

Requirements

The following Python packages are needed on the host that executes this module:

Parameters

Parameter Defaults / Choices Comments
api_version
str
API Version Nautobot REST API
Version Added: 4.1.0
custom_fields
dict
Must exist in Nautobot and in key/value format
Version Added: 3.0.0
description
str
The description of the device redundancy group
Version Added: 5.1.0
failover_strategy
str
Choices: active-active, active-passive The failover strategy of the device redundancy group
Version Added: 5.1.0
id
str
The UUID of the object to operate on
Version Added: 5.13.0
name
str
The name of the device redundancy group
Required if I(state=present) and the device redundancy group does not exist yet
Version Added: 5.1.0
query_params
list / elements=str
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.
Version Added: 3.0.0
secrets_group
raw
The secrets group of the device redundancy group
Version Added: 5.1.0
state
str
Default: present
Choices: absent, present
Use C(present) or C(absent) for adding or removing.
status
raw
The status of the device redundancy group
Required if I(state=present) and the device redundancy group does not exist yet
Version Added: 5.1.0
tags
list / elements=raw
Any tags that this item may need to be associated with
Version Added: 3.0.0
token
str
required
The token created within Nautobot to authorize API access
Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url
str
required
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)
Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
validate_certs
raw
Default: True
If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.

Notes

Note

  • Tags should be defined as a YAML list
  • This should be ran with connection C(local) and hosts C(localhost)

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"
        tags:
          - My Tag
        custom_fields:
          my_field: my_value
        state: present

    - name: Delete device redundancy group within nautobot
      networktocode.nautobot.device_redundancy_group:
        url: http://nautobot.local
        token: thisIsMyToken
        name: My Redundancy Group
        state: absent

    - name: Delete device redundancy group by id
      networktocode.nautobot.device_redundancy_group:
        url: http://nautobot.local
        token: thisIsMyToken
        id: 00000000-0000-0000-0000-000000000000
        state: absent

Return Values

Key Data Type Description Returned
device_redundancy_group dict Serialized object as created or already existent within Nautobot success (when I(state=present))
msg str Message indicating failure or info about what has been achieved always

Authors

  • Joe Wesch (@joewesch)