nxos_hsrp – Manages HSRP configuration on NX-OS switches — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# nxos_hsrp – Manages HSRP configuration on NX-OS switches

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Manages HSRP configuration on NX-OS switches.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
auth_string - |  | 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.
auth_type - | Choices: text md5 | Authentication type.
group - / required |  | HSRP group number.
interface - / required |  | Full name of interface that is being managed for HSRP.
preempt - | Choices: enabled disabled | Enable/Disable preempt.
priority - |  | HSRP priority or keyword 'default'.
provider dictionary |  | Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli`. This option is only required if you are using NX-API. For more information please see the NXOS Platform Options guide. A dict object containing connection details.
| auth_pass string added in 2.5.3 |  | Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTH_PASS` will be used instead.
| authorize boolean added in 2.5.3 | Choices: no ← yes | Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTHORIZE` will be used instead.
| host string / required |  | Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
| password string |  | Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead.
| port integer | Default: "0 (use common port)" | Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
| ssh_keyfile string |  | Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
| timeout integer | Default: 10 | Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
| transport string / required | Choices: cli ← nxapi | Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
| use_proxy boolean added in 2.5 | Choices: no yes ← | If `no`, the environment variables `http_proxy` and `https_proxy` will be ignored.
| use_ssl boolean | Choices: no ← yes | Configures the transport to use SSL if set to `yes` only when the `transport=nxapi`, otherwise this value is ignored.
| username string |  | Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.
| validate_certs boolean | Choices: no yes ← | If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.
state - | Choices: present ← absent | Specify desired state of the resource.
version - | Choices: 1 2 Default: 1 | HSRP version.
vip - |  | HSRP virtual IP address or keyword 'default'

## Notes

Note

- Tested against NXOSv 7.3.(0)D1(1) on VIRL
- HSRP feature needs to be enabled first on the system.
- SVIs must exist before using this module.
- Interface must be a L3 port before using this module.
- HSRP cannot be configured on loopback interfaces.
- MD5 authentication is only possible with HSRPv2 while it is ignored if HSRPv1 is used instead, while it will not raise any error. Here we allow MD5 authentication only with HSRPv2 in order to enforce better practice.
- For information on using CLI and NX-API see the NXOS Platform Options guide
- For more information on using Ansible to manage network devices see the Ansible Network Guide
- For more information on using Ansible to manage Cisco devices see the Cisco integration page.

## Examples

    - 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

    - 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

    - 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"

    - 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"

    - 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

## Return Values

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

Key | Returned | Description
--- | --- | ---
commands list | always | commands sent to the device Sample: ['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- Jason Edelman (@jedelman8)
- Gabriele Gerbino (@GGabriele)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.