New in version 2.1.
Manages VRRP configuration on NX-OS switches.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| admin_state (added in 2.2)
| no | no shutdown |
| Used to enable or disable the VRRP process. |
| authentication | no | Clear text authentication string. |
||
| group | yes | VRRP 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 VRRP. |
||
| 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 | VRRP 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. |
||
| vip | no | VRRP virtual IP address. |
# ensure vrrp group 100 and vip 10.1.100.1 is on vlan10 - nxos_vrrp: interface=vlan10 group=100 vip=10.1.100.1 host=68.170.147.165 # ensure removal of the vrrp group config # vip is required to ensure the user knows what they are removing - nxos_vrrp: interface=vlan10 group=100 vip=10.1.100.1 state=absent host=68.170.147.165 # re-config with more params - nxos_vrrp: interface=vlan10 group=100 vip=10.1.100.1 preempt=false priority=130 authentication=AUTHKEY host=68.170.147.165
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 vrrp after module execution | always | dict | {'priority': '100', 'vip': '10.1.15.1', 'group': '150', 'admin_state': 'no shutdown', 'interval': '1', 'preempt': True, 'authentication': 'testing'} |
| 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', 'vrrp 150', 'address 10.1.15.1', 'authentication text testing', 'no shutdown'] |
| proposed | k/v pairs of parameters passed into module | always | dict | {'group': '150', 'authentication': 'testing', 'admin_state': 'no shutdown', 'vip': '10.1.15.1'} |
| existing | k/v pairs of existing vrrp info on the interface | dict | {} |
Note
VRRP 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
state=absent removes the VRRP group if it exists on the device.
Note
VRRP cannot be configured on loopback interfaces.
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_vrrp_module.html