Documentation

nxos_vpc - Manages global VPC configuration

New in version 2.2.

Synopsis

  • Manages global VPC configuration

Options

parameter required default choices comments
auto_recovery
yes
  • true
  • false
Enables/Disables auto recovery
delay_restore
no
manages delay restore command and config value in seconds
domain
yes
VPC domain
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.
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.
peer_gw
yes
  • true
  • false
Enables/Disables peer gateway
pkl_dest
no
Destination (remote) IP address used for peer keepalive link
pkl_src
no
Source IP address used for peer keepalive link
pkl_vrf
no management
VRF used for peer keepalive link
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).
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.
role_priority
no
Role priority for device. Remember lower is better.
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
yes
  • present
  • absent
Manages desired state of the resource
system_priority
no
System priority device. Remember they must match between peers.
timeout
(added in 2.3)
no 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
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
  • yes
  • 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. 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.

Examples

# configure a simple asn
- nxos_vpc:
    domain: 100
    role_priority: 1000
    system_priority: 2000
    pkl_dest: 192.168.100.4
    pkl_src: 10.1.100.20
    peer_gw: true
    auto_recovery: true
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Return Values

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

name description returned type sample
end_state k/v pairs of VPC configuration after module execution always dict {'domain': '100', 'system_priority': '2000', 'role_priority': '1000', 'auto_recovery': True, 'pkl_vrf': 'management', 'peer_gw': True, 'pkl_dest': '192.168.100.4', 'pkl_src': '10.1.100.20'}
changed check to see if a change was made on the device always boolean True
updates commands sent to the device always list ['vpc domain 100', 'peer-keepalive destination 192.168.100.4 source 10.1.100.20 vrf management', 'auto-recovery', 'peer-gateway']
proposed k/v pairs of parameters passed into module always dict {'domain': '100', 'system_priority': '2000', 'role_priority': '1000', 'auto_recovery': True, 'pkl_vrf': 'management', 'peer_gw': True, 'pkl_dest': '192.168.100.4', 'pkl_src': '10.1.100.20'}
existing k/v pairs of existing VPC configuration dict {'domain': '100', 'system_priority': '2000', 'role_priority': '1000', 'auto_recovery': True, 'pkl_vrf': 'management', 'delay_restore': None, 'peer_gw': True, 'pkl_dest': '192.168.100.2', 'pkl_src': '10.1.100.20'}


Notes

Note

  • The feature vpc must be enabled before this module can be used
  • If not using management vrf, vrf must be globally on the device before using in the pkl config
  • Although source IP isn’t required on the command line it is required when using this module. The PKL VRF must also be configured prior to using this module.
  • Both pkl_src and pkl_dest are needed when changing PKL VRF.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.