Parameter |
Choices/Defaults |
Comments |
access_vlan
|
|
Configure given VLAN in access port. If mode=access , used as the access VLAN ID.
|
aggregate
|
|
List of Layer-2 interface definitions.
|
auth_pass
|
|
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli and become: yes with become_pass .
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.
|
authorize
bool |
|
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli and become: yes .
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.
|
mode
|
|
Mode in which interface needs to be configured.
|
name
required |
|
Full name of the interface excluding any logical unit number, i.e. GigabitEthernet0/1.
aliases: interface
|
native_vlan
|
|
Native VLAN to be configured in trunk port. If mode=trunk , used as the trunk native VLAN ID.
|
provider
|
|
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli .
A dict object containing connection details.
|
|
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.
|
|
port
|
Default:
22
|
Specifies the port to use when building the connection to the remote device.
|
|
username
|
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
|
|
password
|
|
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
|
|
timeout
|
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.
|
|
ssh_keyfile
|
|
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
|
|
authorize
bool |
|
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.
|
|
auth_pass
|
|
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.
|
state
|
Choices:
present ←
- absent
- unconfigured
|
Manage the state of the Layer-2 Interface configuration.
|
trunk_allowed_vlans
|
|
List of allowed VLANs in a given trunk port. If mode=trunk , these are the only VLANs that will be configured on the trunk, i.e. "2-10,15".
|
trunk_vlans
|
|
List of VLANs to be configured in trunk port. If mode=trunk , used as the VLAN range to ADD or REMOVE from the trunk.
|