cisco.nxos.nxos_hsrp – Manages HSRP configuration on NX-OS switches.
cisco.nxos.nxos_hsrp – Manages HSRP configuration on NX-OS switches.
Note
This plugin is part of the cisco.nxos collection (version 1.3.1).
To install it use: ansible-galaxy collection install cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_hsrp
.
New in version 1.0.0: of cisco.nxos
Synopsis
- Manages HSRP configuration on NX-OS switches.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
auth_string 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 string |
|
Authentication type. | |
group string / required |
HSRP group number. | ||
interface string / required |
Full name of interface that is being managed for HSRP. | ||
preempt string |
|
Enable/Disable preempt. | |
priority string |
HSRP priority or keyword 'default'. | ||
provider dictionary |
Deprecated Starting with Ansible 2.5 we recommend using Starting with Ansible 2.6 we recommend using This option will be removed in a release after 2022-06-01. For more information please see the NXOS Platform Options guide. A dict object containing connection details. | ||
auth_pass string |
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 | ||
authorize boolean |
|
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 | |
host string |
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 | ||
port integer |
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 | ||
timeout integer |
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 |
|
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 |
|
If | |
use_ssl boolean |
|
Configures the transport to use SSL if set to | |
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 | ||
validate_certs boolean |
|
If | |
state string |
|
Specify desired state of the resource. | |
version string |
Default: 1 |
HSRP version. | |
vip string |
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
cisco.nxos.nxos_hsrp:
group: 10
vip: 10.1.1.1
priority: 150
interface: vlan10
preempt: enabled
- name: Ensure HSRP is configured with following params on a SVI with clear text authentication
cisco.nxos.nxos_hsrp:
group: 10
vip: 10.1.1.1
priority: 150
interface: vlan10
preempt: enabled
auth_type: text
auth_string: CISCO
- name: Ensure HSRP is configured with md5 authentication and clear authentication
string
cisco.nxos.nxos_hsrp:
group: 10
vip: 10.1.1.1
priority: 150
interface: vlan10
preempt: enabled
auth_type: md5
auth_string: 0 1234
- name: Ensure HSRP is configured with md5 authentication and hidden authentication
string
cisco.nxos.nxos_hsrp:
group: 10
vip: 10.1.1.1
priority: 150
interface: vlan10
preempt: enabled
auth_type: md5
auth_string: 7 1234
- name: Remove HSRP config for given interface, group, and VIP
cisco.nxos.nxos_hsrp:
group: 10
interface: vlan10
vip: 10.1.1.1
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
commands list / elements=string |
always |
commands sent to the device
Sample: ['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1'] |
Authors
- Jason Edelman (@jedelman8)
- Gabriele Gerbino (@GGabriele)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_hsrp_module.html