ansible.builtin.nxos_hsrp (v2.8.11) — module

Manages HSRP configuration on NX-OS switches.

| "added in version" 2.2 of ansible.builtin"

Authors: Jason Edelman (@jedelman8), Gabriele Gerbino (@GGabriele)

preview | supported by network

Install Ansible via pip

Install with pip install ansible==2.8.11

Description

Manages HSRP configuration on NX-OS switches.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure HSRP is configured with following params on a SVI
  nxos_hsrp:
    group: 10
    vip: 10.1.1.1
    priority: 150
    interface: vlan10
    preempt: enabled
    host: 68.170.147.165
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure HSRP is configured with following params on a SVI
        with clear text authentication
  nxos_hsrp:
    group: 10
    vip: 10.1.1.1
    priority: 150
    interface: vlan10
    preempt: enabled
    host: 68.170.147.165
    auth_type: text
    auth_string: CISCO
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure HSRP is configured with md5 authentication and clear
        authentication string
  nxos_hsrp:
    group: 10
    vip: 10.1.1.1
    priority: 150
    interface: vlan10
    preempt: enabled
    host: 68.170.147.165
    auth_type: md5
    auth_string: "0 1234"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure HSRP is configured with md5 authentication and hidden
        authentication string
  nxos_hsrp:
    group: 10
    vip: 10.1.1.1
    priority: 150
    interface: vlan10
    preempt: enabled
    host: 68.170.147.165
    auth_type: md5
    auth_string: "7 1234"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove HSRP config for given interface, group, and VIP
  nxos_hsrp:
    group: 10
    interface: vlan10
    vip: 10.1.1.1
    host: 68.170.147.165
    state: absent

Inputs

    
vip:
    description:
    - HSRP virtual IP address or keyword 'default'

group:
    description:
    - HSRP group number.
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Specify desired state of the resource.

preempt:
    choices:
    - enabled
    - disabled
    description:
    - Enable/Disable preempt.

version:
    choices:
    - '1'
    - '2'
    default: 1
    description:
    - HSRP version.

priority:
    description:
    - HSRP priority or keyword 'default'.

auth_type:
    choices:
    - text
    - md5
    description:
    - Authentication type.

interface:
    description:
    - Full name of interface that is being managed for HSRP.
    required: true

auth_string:
    description:
    - Authentication string. If this needs to be hidden(for md5 type), the string should
      be 7 followed by the key string. Otherwise, it can be 0 followed by key string or
      just key string (for backward compatibility). For text type, this should be just
      be a key string. if this is 'default', authentication is removed.

Outputs

commands:
  description: commands sent to the device
  returned: always
  sample:
  - interface vlan10
  - hsrp version 2
  - hsrp 30
  - ip 10.30.1.1
  type: list