New in version 2.2.
Manages HSRP configuration on NX-OS switches.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| auth_string | no | Authentication string. |
||
| auth_type | no |
| Authentication type. |
|
| group | yes | HSRP group number. |
||
| host | yes | 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. |
||
| interface | yes | Full name of interface that is being managed for HSRP. |
||
| password | no | 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 | no | 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). |
|
| priority | no | HSRP priority. |
||
| provider | no | Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict. |
||
| ssh_keyfile | no | 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. |
||
| state | no | present |
| Specify desired state of the resource. |
| transport | yes | cli | 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_ssl | no |
| Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored. |
|
| username | no | Configures the username to use to authenticate the connection to the remote device. The value of username 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. |
||
| version | no | 2 |
| HSRP version. |
| vip | no | HSRP virtual IP address. |
# 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 # 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 auth_type=text auth_string=CISCO # removing 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
Common return values are documented here Common Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| end_state | k/v pairs of hsrp after module execution | always | dict | {'auth_type': 'text', 'group': '30', 'auth_string': 'cisco', 'preempt': 'disabled', 'priority': '100', 'vip': '10.30.1.1', 'version': '2', 'interface': 'vlan10'} |
| changed | check to see if a change was made on the device | always | boolean | True |
| updates | commands sent to the device | always | list | ['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1'] |
| proposed | k/v pairs of parameters passed into module | always | dict | {'vip': '10.30.1.1', 'version': '2', 'group': '30'} |
| existing | k/v pairs of existing hsrp info on the interface | dict | {} |
Note
HSRP feature needs to be enabled first on the system.
Note
SVIs must exist before using this module.
Note
Interface must be a L3 port before using this module.
Note
HSRP cannot be configured on loopback interfaces.
Note
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 more information on what this means please read Core Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_hsrp_module.html