cisco.nxos.nxos_hsrp_interfaces module – HSRP interfaces resource module

Note

This module is part of the cisco.nxos collection (version 11.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_hsrp_interfaces.

New in cisco.nxos 10.1.0

Synopsis

• Resource module to configure HSRP on interfaces.

Parameters

Parameter	Comments
config list / elements=dictionary	A dictionary of HSRP configuration options to add to interface
bfd string	Enable/Disable HSRP Bidirectional Forwarding Detection (BFD) on the interface. Deprecated, Use standby.bfd instead, the facts would always render bfd information as a part of standby configuration This option has been deprecated and will be removed in a release after 2028-06-01. Choices: "enable" "disable"
name string	The name of the interface.
standby dictionary	Standby options generic, not idempotent when version 1 (HSRP)
bfd boolean	Enable HSRP BFD Choices: false true
delay dictionary	HSRP initialization delay
minimum integer	Delay at least this long
reload integer	Delay after reload
mac_refresh integer	Refresh MAC cache on switch by periodically sending packet from virtual mac address
use_bia dictionary	HSRP uses interface’s burned in address (does not work with mac address)
scope boolean	Scope interface option (hsrp use-bia scope interface) Choices: false true
set boolean	Set use-bia only Choices: false true
version integer	HSRP version
standby_options list / elements=dictionary	Group number and group options for standby (HSRP)
authentication dictionary	Authentication configuration
key_chain string	Set key chain
key_string string	Set key string
password_text string	Password text valid for plain text and and key-string
follow string	Groups to be followed
group_name string	Redundancy name string
group_no integer	Group number
ip list / elements=dictionary	Enable HSRP IPv4 and set the virtual IP address
secondary boolean	Make this IP address a secondary virtual IP address Choices: false true
virtual_ip string	Virtual IP address
mac_address string	Virtual MAC address
preempt dictionary	Overthrow lower priority Active routers
minimum integer	Delay at least this long
reload integer	Delay after reload
sync integer	Wait for IP redundancy clients
priority dictionary	Priority level
level integer	Priority level value
lower integer	Set lower threshold value (forwarding-threshold)
upper integer	Set upper threshold value (forwarding-threshold)
timer dictionary	Overthrow lower priority Active routers
hello_interval integer	Hello interval in seconds
hold_time integer	Hold time in seconds
msec boolean	Specify hello interval in milliseconds Choices: false true
track list / elements=dictionary	Priority tracking
decrement integer	Priority decrement
object_no integer	Track object number
running_config string	This option is used only with state parsed. The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ‘^interface’. The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module’s argspec and the value is then returned in the parsed key within the result.
state string	The state the configuration should be left in The states rendered, gathered and parsed does not perform any change on the device. The state rendered will transform the configuration in config option to platform specific CLI commands which will be returned in the rendered key within the result. For state rendered active connection to remote host is not required. The state gathered will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the gathered key within the result. The state parsed reads the configuration from running_config option and transforms it into JSON format as per the resource module parameters and the value is returned in the parsed key within the result. The value of running_config option should be the same format as the output of command show running-config | section ^interface executed on device. For state parsed active connection to remote host is not required. Choices: "merged" ← (default) "replaced" "overridden" "deleted" "rendered" "gathered" "parsed"

Notes

Note

• Tested against NX-OS 10.4(2) Nexus 9000v.

• Feature bfd and hsrp, should be enabled for this module.

• Unsupported for Cisco MDS

Examples

# Using merged

# Before state:
# -------------
#
# switch# show running-config | section interface
# interface Vlan1
# interface Vlan10
# interface Vlan14
#   bandwidth 99999
# interface Vlan1000
# interface Ethernet1/1
# interface Ethernet1/2
# interface Ethernet1/3
# interface Ethernet1/4
# interface Ethernet1/5
# interface Ethernet1/6
# interface Ethernet1/7

- name: Merge provided configuration with device configuration
  cisco.nxos.nxos_hsrp_interfaces:
    config:
      - name: Ethernet1/1
        standby:
          bfd: true
          mac_refresh: 400
          version: 2
        standby_options:
          - authentication:
              key_string: SECUREKEY10
            group_name: VLAN10-GROUP
            group_no: 10
            ip:
              - secondary: true
                virtual_ip: 10.10.10.2
            mac_address: 00CC.10DD.10EE
    state: merged

# Task Output
# -----------
#
# before:
# - name: Vlan1
# - name: Vlan10
# - name: Vlan14
# - name: Vlan1000
# - name: Ethernet1/1
#   standby:
#     bfd: true
# - name: Ethernet1/2
# - name: Ethernet1/3
# - name: Ethernet1/4
# - name: Ethernet1/5
# - name: Ethernet1/6
# - name: Ethernet1/7
#  commands:
# - interface Ethernet1/1
# - hsrp version 2
# - hsrp mac-refresh 400
# - hsrp 10
# - mac-address 00CC.10DD.10EE
# - name VLAN10-GROUP
# - authentication md5 key-string SECUREKEY10
# - ip 10.10.10.2 secondary
# - interface Ethernet1/2
# - hsrp bfd
# - hsrp version 2
# - hsrp mac-refresh 400
# - hsrp 20
# - mac-address 00CC.10DD.10EF
# - name VLAN20-GROUP
# - authentication md5 key-chain SECUREKEY20
# - ip 10.10.10.3 secondary
#  after:
# - name: Vlan1
# - name: Vlan10
# - name: Vlan14
# - name: Vlan1000
# - name: Ethernet1/1
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_string: SECUREKEY10
#       group_name: VLAN10-GROUP
#       group_no: 10
#       ip:
#         - secondary: true
#           virtual_ip: 10.10.10.2
#       mac_address: 00CC.10DD.10EE
# - name: Ethernet1/2
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_chain: SECUREKEY20
#       group_name: VLAN20-GROUP
#       group_no: 20
#       ip:
#         - secondary: true
#           virtual_ip: 10.10.10.3
#       mac_address: 00CC.10DD.10EF
# - name: Ethernet1/3
# - name: Ethernet1/4
# - name: Ethernet1/5
# - name: Ethernet1/6
# - name: Ethernet1/7

# After state:
# ------------
#
# switch# show running-config | section interface
# interface Vlan1
# interface Vlan10
# interface Vlan14
#   bandwidth 99999
# interface Vlan1000
# interface Ethernet1/1
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 10
#     authentication md5 key-string SECUREKEY10
#     name VLAN10-GROUP
#     mac-address 00CC.10DD.10EE
#     ip 10.10.10.2 secondary
# interface Ethernet1/2
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 20
#     authentication md5 key-chain SECUREKEY20
#     name VLAN20-GROUP
#     mac-address 00CC.10DD.10EF
#     ip 10.10.10.3 secondary
# interface Ethernet1/3
# interface Ethernet1/4
# interface Ethernet1/5
# interface Ethernet1/6
# interface Ethernet1/7

# Using replaced

# Before state:
# -------------
#
# switch# show running-config | section interface
# interface Vlan1
# interface Vlan10
# interface Vlan14
#   bandwidth 99999
# interface Vlan1000
# interface Ethernet1/1
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 10
#     authentication md5 key-string SECUREKEY10
#     name VLAN10-GROUP
#     mac-address 00CC.10DD.10EE
#     ip 10.10.10.2 secondary
# interface Ethernet1/2
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 20
#     authentication md5 key-chain SECUREKEY20
#     name VLAN20-GROUP
#     mac-address 00CC.10DD.10EF
#     ip 10.10.10.3 secondary
# interface Ethernet1/3
# interface Ethernet1/4
# interface Ethernet1/5
# interface Ethernet1/6
# interface Ethernet1/7

- name: Replaces device configuration of listed interfaces with provided configuration
  cisco.nxos.nxos_hsrp_interfaces:
    config:
      - name: Ethernet1/1
        standby:
          bfd: true
          mac_refresh: 400
          version: 2
        standby_options:
          - authentication:
              key_string: SECUREKEY10
            group_name: VLAN11-GROUP
            group_no: 11
            mac_address: 00CC.10DD.10EE
      - name: Ethernet1/2
        standby:
          bfd: true
          mac_refresh: 400
          version: 2
        standby_options:
          - authentication:
              key_chain: SECUREKEY20
            group_name: VLAN20-GROUP
            group_no: 20
            mac_address: 00CC.10DD.10EF
    state: replaced

# Task Output
# -----------
#
#  before:
# - name: Vlan1
# - name: Vlan10
# - name: Vlan14
# - name: Vlan1000
# - name: Ethernet1/1
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_string: SECUREKEY10
#       group_name: VLAN10-GROUP
#       group_no: 10
#       ip:
#         - secondary: true
#           virtual_ip: 10.10.10.2
#       mac_address: 00CC.10DD.10EE
# - name: Ethernet1/2
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_chain: SECUREKEY20
#       group_name: VLAN20-GROUP
#       group_no: 20
#       ip:
#         - secondary: true
#           virtual_ip: 10.10.10.3
#       mac_address: 00CC.10DD.10EF
# - name: Ethernet1/3
# - name: Ethernet1/4
# - name: Ethernet1/5
# - name: Ethernet1/6
# - name: Ethernet1/7
#  commands:
# - interface Ethernet1/1
# - hsrp 11
# - mac-address 00CC.10DD.10EE
# - name VLAN11-GROUP
# - authentication md5 key-string SECUREKEY10
# - no hsrp 10
# - interface Ethernet1/2
# - hsrp 20
# - no ip 10.10.10.3 secondary
#  after:
# - name: Vlan1
# - name: Vlan10
# - name: Vlan14
# - name: Vlan1000
# - name: Ethernet1/1
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_string: SECUREKEY10
#       group_name: VLAN11-GROUP
#       group_no: 11
#       mac_address: 00CC.10DD.10EE
# - name: Ethernet1/2
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_chain: SECUREKEY20
#       group_name: VLAN20-GROUP
#       group_no: 20
#       mac_address: 00CC.10DD.10EF
# - name: Ethernet1/3
# - name: Ethernet1/4
# - name: Ethernet1/5
# - name: Ethernet1/6
# - name: Ethernet1/7


# After state:
# ------------
#
# switch# show running-config | section interface
# interface Vlan1
# interface Vlan10
# interface Vlan14
#   bandwidth 99999
# interface Vlan1000
# interface Ethernet1/1
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 11
#     authentication md5 key-string SECUREKEY10
#     name VLAN11-GROUP
#     mac-address 00CC.10DD.10EE
# interface Ethernet1/2
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 20
#     authentication md5 key-chain SECUREKEY20
#     name VLAN20-GROUP
#     mac-address 00CC.10DD.10EF
# interface Ethernet1/3
# interface Ethernet1/4
# interface Ethernet1/5
# interface Ethernet1/6
# interface Ethernet1/7

# Using overridden

# Before state:
# -------------
#
# switch# show running-config | section interface
# interface Vlan1
# interface Vlan10
# interface Vlan14
#   bandwidth 99999
# interface Vlan1000
# interface Ethernet1/1
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 10
#     authentication md5 key-string SECUREKEY10
#     name VLAN10-GROUP
#     mac-address 00CC.10DD.10EE
#     ip 10.10.10.2 secondary
# interface Ethernet1/2
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 20
#     authentication md5 key-chain SECUREKEY20
#     name VLAN20-GROUP
#     mac-address 00CC.10DD.10EF
#     ip 10.10.10.3 secondary

- name: Override device configuration of all interfaces with provided configuration
  cisco.nxos.nxos_hsrp_interfaces:
    config:
      - name: Ethernet1/1
        standby:
          bfd: true
          mac_refresh: 400
          version: 2
        standby_options:
          - authentication:
              key_string: SECUREKEY10
            group_name: VLAN11-GROUP
            group_no: 11
            mac_address: 00CC.10DD.10EE
      - name: Ethernet1/2
        standby:
          bfd: true
          mac_refresh: 400
          version: 2
        standby_options:
          - authentication:
              key_chain: SECUREKEY20
            group_name: VLAN20-GROUP
            group_no: 20
            mac_address: 00CC.10DD.10EF
    state: overridden

# Task Output
# -----------
#
#  before:
# - name: Vlan1
# - name: Vlan10
# - name: Vlan14
# - name: Vlan1000
# - name: Ethernet1/1
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_string: SECUREKEY10
#       group_name: VLAN10-GROUP
#       group_no: 10
#       ip:
#         - secondary: true
#           virtual_ip: 10.10.10.2
#       mac_address: 00CC.10DD.10EE
# - name: Ethernet1/2
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_chain: SECUREKEY20
#       group_name: VLAN20-GROUP
#       group_no: 20
#       ip:
#         - secondary: true
#           virtual_ip: 10.10.10.3
#       mac_address: 00CC.10DD.10EF
# - name: Ethernet1/3
# - name: Ethernet1/4
# - name: Ethernet1/5
# - name: Ethernet1/6
# - name: Ethernet1/7
#  commands:
# - interface Ethernet1/1
# - hsrp 11
# - mac-address 00CC.10DD.10EE
# - name VLAN11-GROUP
# - authentication md5 key-string SECUREKEY10
# - no hsrp 10
# - interface Ethernet1/2
# - hsrp 20
# - no ip 10.10.10.3 secondary
#  after:
# - name: Vlan1
# - name: Vlan10
# - name: Vlan14
# - name: Vlan1000
# - name: Ethernet1/1
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_string: SECUREKEY10
#       group_name: VLAN11-GROUP
#       group_no: 11
#       mac_address: 00CC.10DD.10EE
# - name: Ethernet1/2
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_chain: SECUREKEY20
#       group_name: VLAN20-GROUP
#       group_no: 20
#       mac_address: 00CC.10DD.10EF
# - name: Ethernet1/3
# - name: Ethernet1/4
# - name: Ethernet1/5
# - name: Ethernet1/6
# - name: Ethernet1/7

# After state:
# ------------
#
# switch# show running-config | section interface
# interface Vlan1
# interface Vlan10
# interface Vlan14
#   bandwidth 99999
# interface Vlan1000
# interface Ethernet1/1
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 11
#     authentication md5 key-string SECUREKEY10
#     name VLAN11-GROUP
#     mac-address 00CC.10DD.10EE
# interface Ethernet1/2
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 20
#     authentication md5 key-chain SECUREKEY20
#     name VLAN20-GROUP
#     mac-address 00CC.10DD.10EF
# interface Ethernet1/3
# interface Ethernet1/4
# interface Ethernet1/5
# interface Ethernet1/6
# interface Ethernet1/7


# Using deleted

# Before state:
# -------------
#
# switch# show running-config | section interface
# interface Vlan1
# interface Vlan10
# interface Vlan14
#   bandwidth 99999
# interface Vlan1000
# interface Ethernet1/1
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 10
#     authentication md5 key-string SECUREKEY10
#     name VLAN10-GROUP
#     mac-address 00CC.10DD.10EE
#     ip 10.10.10.2 secondary
# interface Ethernet1/2
#   no switchport
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 20
#     authentication md5 key-chain SECUREKEY20
#     name VLAN20-GROUP
#     mac-address 00CC.10DD.10EF
#     ip 10.10.10.3 secondary
# interface Ethernet1/3
# interface Ethernet1/4
# interface Ethernet1/5
# interface Ethernet1/6
# interface Ethernet1/7

- name: Delete or return interface parameters to default settings
  cisco.nxos.nxos_hsrp_interfaces:
    config:
      - name: Ethernet1/1
        standby:
          bfd: true
          mac_refresh: 400
          version: 2
        standby_options:
          - authentication:
              key_string: SECUREKEY10
            group_name: VLAN11-GROUP
            group_no: 11
            mac_address: 00CC.10DD.10EE
      - name: Ethernet1/2
        standby:
          bfd: true
          mac_refresh: 400
          version: 2
        standby_options:
          - authentication:
              key_chain: SECUREKEY20
            group_name: VLAN20-GROUP
            group_no: 20
            mac_address: 00CC.10DD.10EF
    state: deleted

# Task Output
# -----------
#
# before:
# - name: Vlan1
# - name: Vlan10
# - name: Vlan14
# - name: Vlan1000
# - name: Ethernet1/1
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_string: SECUREKEY10
#       group_name: VLAN10-GROUP
#       group_no: 10
#       ip:
#         - secondary: true
#           virtual_ip: 10.10.10.2
#       mac_address: 00CC.10DD.10EE
# - name: Ethernet1/2
#   standby:
#     bfd: true
#     mac_refresh: 400
#     version: 2
#   standby_options:
#     - authentication:
#         key_chain: SECUREKEY20
#       group_name: VLAN20-GROUP
#       group_no: 20
#       ip:
#         - secondary: true
#           virtual_ip: 10.10.10.3
#       mac_address: 00CC.10DD.10EF
# - name: Ethernet1/3
# - name: Ethernet1/4
# - name: Ethernet1/5
# - name: Ethernet1/6
# - name: Ethernet1/7
# commands:
# - interface Ethernet1/1
# - no hsrp bfd
# - no hsrp version 2
# - no hsrp mac-refresh 400
# - no hsrp 10
# - interface Ethernet1/2
# - no hsrp bfd
# - no hsrp version 2
# - no hsrp mac-refresh 400
# - no hsrp 20
# after:
# - name: Vlan1
# - name: Vlan10
# - name: Vlan14
# - name: Vlan1000
# - name: Ethernet1/1
# - name: Ethernet1/2
# - name: Ethernet1/3
# - name: Ethernet1/4
# - name: Ethernet1/5
# - name: Ethernet1/6

# After state:
# ------------
#
# switch# show running-config | section interface
# interface Vlan1
# interface Vlan10
# interface Vlan14
#   bandwidth 99999
# interface Vlan1000
# interface Ethernet1/1
#   no switchport
# interface Ethernet1/2
#   no switchport
# interface Ethernet1/3
# interface Ethernet1/4
# interface Ethernet1/5
# interface Ethernet1/6
# interface Ethernet1/7

# Using rendered

- name: Use rendered state to convert task input to device specific commands
  cisco.nxos.nxos_hsrp_interfaces:
    config:
      - name: Ethernet1/1
        description: outbound-intf
        mode: layer3
        speed: 100
      - name: Ethernet1/2
        mode: layer2
        enabled: true
        duplex: full
    state: rendered

# Task Output
# -----------
#
# rendered:
#  - interface Vlan1
#  - hsrp version 2
#  - hsrp 10
#  - timers msec 250 255
#  - authentication md5 key-chain test
#  - interface Vlan10
#  - hsrp bfd
#  - hsrp version 2
#  - hsrp mac-refresh 400
#  - hsrp 10
#  - mac-address 00CC.10DD.10EE
#  - name VLAN10-GROUP
#  - preempt delay minimum 15 reload 120 sync 10
#  - authentication md5 key-string SECUREKEY10
#  - ip 10.10.10.2 secondary
#  - interface Vlan14
#  - hsrp bfd
#  - hsrp version 2
#  - hsrp delay 22 123
#  - hsrp mac-refresh 300
#  - hsrp 14
#  - follow VLAN14-GROUP
#  - mac-address 00AA.14BB.14CC
#  - ip 192.168.14.1 secondary
#  - ip 192.168.14.2 secondary
#  - hsrp 15
#  - mac-address 00BB.14CC.15DD
#  - preempt delay minimum 10 reload 100 sync 5
#  - priority 22 forwarding-threshold lower 12 upper 22
#  - timers msec 456 33
#  - authentication md5 key-string SECUREKEY14
#  - interface Vlan1000
#  - hsrp 10
#  - mac-address 0423.4567.89AB
#  - name testhsr
#  - preempt delay minimum 33 reload 23 sync 22
#  - priority 22 forwarding-threshold lower 12 upper 22
#  - timers msec 456 33
#  - authentication md5 key-string testmesecurte
#  - ip 10.15.8.1 secondary


# Using parsed

# parsed.cfg
# ------------
#
# interface Vlan1
#   hsrp version 2
#   hsrp 10
#     authentication md5 key-chain test
#     timers msec 250  255
# interface Vlan10
#   hsrp bfd
#   hsrp version 2
#   hsrp mac-refresh 400
#   hsrp 10
#     authentication md5 key-string SECUREKEY10
#     name VLAN10-GROUP
#     mac-address 00CC.10DD.10EE
#     preempt delay minimum 15 reload 120 sync 10
#     ip 10.10.10.2 secondary
# interface Vlan14
#   bandwidth 99999
#   hsrp bfd
#   hsrp version 2
#   hsrp delay minimum 22 reload 123
#   hsrp mac-refresh 300
#   hsrp 14
#     follow VLAN14-GROUP
#     mac-address 00AA.14BB.14CC
#     ip 192.168.14.1 secondary
#     ip 192.168.14.2 secondary
#   hsrp 15
#     authentication md5 key-string SECUREKEY14
#     mac-address 00BB.14CC.15DD
#     preempt delay minimum 10 reload 100 sync 5
#     priority 22 forwarding-threshold lower 12 upper 22
#     timers msec 456  33
# interface Vlan1000
#   hsrp 10
#     authentication md5 key-string testmesecurte
#     name testhsr
#     mac-address 0423.4567.89AB
#     preempt delay minimum 33 reload 23 sync 22
#     priority 22 forwarding-threshold lower 12 upper 22
#     timers msec 456  33
#     ip 10.15.8.1 secondary

- name: Use parsed state to convert externally supplied config to structured format
  cisco.nxos.nxos_hsrp_interfaces:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Task output
# -----------
#
# {"parsed": [
#        {
#            "name": "Vlan1",
#            "standby": {
#                "version": 2
#            },
#            "standby_options": [
#                {
#                    "authentication": {
#                        "key_chain": "test"
#                    },
#                    "group_no": 10,
#                    "timer": {
#                        "hello_interval": 250,
#                        "hold_time": 255,
#                        "msec": true
#                    }
#                }
#            ]
#        },
#        {
#            "name": "Vlan10",
#            "standby": {
#                "bfd": true,
#                "mac_refresh": 400,
#                "version": 2
#            },
#            "standby_options": [
#                {
#                    "authentication": {
#                        "key_string": "SECUREKEY10"
#                    },
#                    "group_name": "VLAN10-GROUP",
#                    "group_no": 10,
#                    "ip": [
#                        {
#                            "secondary": true,
#                            "virtual_ip": "10.10.10.2"
#                        }
#                    ],
#                    "mac_address": "00CC.10DD.10EE",
#                    "preempt": {
#                        "minimum": 15,
#                        "reload": 120,
#                        "sync": 10
#                    }
#                }
#            ]
#        },
#        {
#            "name": "Vlan14",
#            "standby": {
#                "bfd": true,
#                "delay": {
#                    "minimum": 22,
#                    "reload": 123
#                },
#                "mac_refresh": 300,
#                "version": 2
#            },
#            "standby_options": [
#                {
#                    "follow": "VLAN14-GROUP",
#                    "group_no": 14,
#                    "ip": [
#                        {
#                            "secondary": true,
#                            "virtual_ip": "192.168.14.1"
#                        },
#                        {
#                            "secondary": true,
#                            "virtual_ip": "192.168.14.2"
#                        }
#                    ],
#                    "mac_address": "00AA.14BB.14CC"
#                },
#                {
#                    "authentication": {
#                        "key_string": "SECUREKEY14"
#                    },
#                    "group_no": 15,
#                    "mac_address": "00BB.14CC.15DD",
#                    "preempt": {
#                        "minimum": 10,
#                        "reload": 100,
#                        "sync": 5
#                    },
#                    "priority": {
#                        "level": 22,
#                        "lower": 12,
#                        "upper": 22
#                    },
#                    "timer": {
#                        "hello_interval": 456,
#                        "hold_time": 33,
#                        "msec": true
#                    }
#                }
#            ]
#        },
#        {
#            "name": "Vlan1000",
#            "standby_options": [
#                {
#                    "authentication": {
#                        "key_string": "testmesecurte"
#                    },
#                    "group_name": "testhsr",
#                    "group_no": 10,
#                    "ip": [
#                        {
#                            "secondary": true,
#                            "virtual_ip": "10.15.8.1"
#                        }
#                    ],
#                    "mac_address": "0423.4567.89AB",
#                    "preempt": {
#                        "minimum": 33,
#                        "reload": 23,
#                        "sync": 22
#                    },
#                    "priority": {
#                        "level": 22,
#                        "lower": 12,
#                        "upper": 22
#                    },
#                    "timer": {
#                        "hello_interval": 456,
#                        "hold_time": 33,
#                        "msec": true
#                    }
#                }
#            ]}

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
after dictionary	The resulting configuration after module execution. Returned: when changed Sample: "This output will always be in the same format as the module argspec.\n"
before dictionary	The configuration prior to the module execution. Returned: when state is merged, replaced, overridden, deleted or purged Sample: "This output will always be in the same format as the module argspec.\n"
commands list / elements=string	The set of commands pushed to the remote device. Returned: when state is merged, replaced, overridden, deleted or purged Sample: ["hsrp 14", "follow VLAN14-GROUP", "mac-address 00AA.14BB.14CC"]
gathered list / elements=string	Facts about the network resource gathered from the remote device as structured data. Returned: when state is gathered Sample: ["This output will always be in the same format as the module argspec.\n"]
parsed list / elements=string	The device native config provided in running_config option parsed into structured data as per module argspec. Returned: when state is parsed Sample: ["This output will always be in the same format as the module argspec.\n"]
rendered list / elements=string	The provided configuration in the task rendered in device-native format (offline). Returned: when state is rendered Sample: ["hsrp 14", "follow VLAN14-GROUP", "mac-address 00AA.14BB.14CC"]

Authors

• Chris Van Heuveln (@chrisvanheuveln)

• Sagar Paul (@KB-perByte)

Collection links

• Issue Tracker
• Repository (Sources)