New in version 2.2.
| Removed in Ansible: | |
|---|---|
| version: 2.5 | |
| Why: | Replaced with common *_system network modules. |
| Alternative: | Use nxos_system’s system_mtu option. To specify an interfaces MTU use nxos_interface. |
Parameter |
Choices/Defaults |
Comments |
|---|---|---|
|
interface
|
|
Full name of interface, i.e. Ethernet1/1.
|
|
mtu
|
|
MTU for a specific interface. Must be an even number between 576 and 9216.
|
|
provider
|
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli.This option is only required if you are using NX-API.
For more information please see the NXOS Platform Options guide.
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. |
|
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
(added in 2.5) |
|
If
no, the environment variables http_proxy and https_proxy will be ignored. |
|
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
|
|
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
|
|
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.
|
|
state
|
|
Specify desired state of the resource.
|
|
sysmtu
|
|
System jumbo MTU. Must be an even number between 576 and 9216.
|
Note
# Ensure system mtu is 9126
- nxos_mtu:
sysmtu: 9216
host: "{{ inventory_hostname }}"
username: "{{ un }}"
password: "{{ pwd }}"
# Config mtu on Eth1/1 (routed interface)
- nxos_mtu:
interface: Ethernet1/1
mtu: 1600
host: "{{ inventory_hostname }}"
username: "{{ un }}"
password: "{{ pwd }}"
# Config mtu on Eth1/3 (switched interface)
- nxos_mtu:
interface: Ethernet1/3
mtu: 9216
host: "{{ inventory_hostname }}"
username: "{{ un }}"
password: "{{ pwd }}"
# Unconfigure mtu on a given interface
- nxos_mtu:
interface: Ethernet1/3
mtu: 9216
host: "{{ inventory_hostname }}"
username: "{{ un }}"
password: "{{ pwd }}"
state: absent
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
|---|---|---|
|
changed
boolean
|
always |
check to see if a change was made on the device
Sample:
True
|
|
end_state
dict
|
always |
k/v pairs of mtu/sysmtu values after module execution
Sample:
{'sysmtu"': '9216', 'mtu': '1700'}
|
|
existing
dict
|
always |
k/v pairs of existing mtu/sysmtu on the interface/system
Sample:
{'sysmtu': '9216', 'mtu': '1600'}
|
|
proposed
dict
|
always |
k/v pairs of parameters passed into module
Sample:
{'mtu': '1700'}
|
|
updates
list
|
always |
command sent to the device
Sample:
['interface vlan10', 'mtu 1700']
|
This module is flagged as deprecated and will be removed in version { deprecated[‘removed_in’] | default(‘’) | string | convert_symbols_to_format }@. For more information see DEPRECATED.
Hint
If you notice any issues in this documentation you can edit this document to improve it.