Parameter |
Choices/Defaults |
Comments |
admin_state
|
|
Administrative state of the interface.
|
aggregate
(added in 2.5) |
|
List of Interfaces definitions.
|
delay
|
Default:
10
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
|
description
|
|
Interface description.
|
duplex
(added in 2.5) |
Choices:
- full
- half
auto ←
|
Interface link status. Applicable for ethernet interface only.
|
fabric_forwarding_anycast_gateway
bool
(added in 2.2) |
|
Associate SVI with anycast gateway under VLAN configuration mode. Applicable for SVI interface only.
|
interface_type
(added in 2.2) |
Choices:
- loopback
- portchannel
- svi
- nve
|
Interface type to be unconfigured from the device.
|
ip_forward
(added in 2.2) |
|
Enable/Disable ip forward feature on SVIs.
|
mode
|
|
Manage Layer 2 or Layer 3 state of the interface. This option is supported for ethernet and portchannel interface. Applicable for ethernet and portchannel interface only.
|
mtu
(added in 2.5) |
|
MTU for a specific interface. Must be an even number between 576 and 9216. Applicable for ethernet interface only.
|
name
required |
|
Full name of interface, i.e. Ethernet1/1, port-channel10.
aliases: interface
|
neighbors
(added in 2.5) |
|
Check the operational state of given interface name for LLDP neighbor.
The following suboptions are available. This is state check parameter only.
|
|
host
|
|
LLDP neighbor host for given interface name .
|
|
port
|
|
LLDP neighbor port to which given interface name is connected.
|
provider
|
|
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli .
This option is only required if you are using NX-API.
A dict object containing connection details.
|
|
username
|
|
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.
|
|
authorize
bool
(added in 2.5.3) |
|
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.
|
|
ssh_keyfile
|
|
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.
|
|
use_proxy
bool
(added in 2.5) |
|
If no , the environment variables http_proxy and https_proxy will be ignored.
|
|
auth_pass
(added in 2.5.3) |
Default:
"none"
|
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.
|
|
host
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.
|
|
timeout
(added in 2.3) |
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).
|
|
use_ssl
bool |
|
Configures the transport to use SSL if set to true only when the transport=nxapi , otherwise this value is ignored.
|
|
password
|
|
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.
|
|
validate_certs
bool |
|
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.
|
|
port
|
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).
|
|
transport
required |
Default:
"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.
|
rx_rate
(added in 2.5) |
|
Receiver rate in bits per second (bps).
This is state check parameter only.
|
speed
(added in 2.5) |
|
Interface link speed. Applicable for ethernet interface only.
|
state
|
Choices:
present ←
- absent
- default
|
Specify desired state of the resource.
|
tx_rate
(added in 2.5) |
|
Transmit rate in bits per second (bps).
This is state check parameter only.
|