nxos_interface – Manages physical attributes of interfaces — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# nxos_interface – Manages physical attributes of interfaces

New in version 2.1.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Manages physical attributes of interfaces of NX-OS switches.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
admin_state - | Choices: up ← down | 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 boolean added in 2.2 | Choices: no yes | 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 | Choices: enable disable | Enable/Disable ip forward feature on SVIs.
mode - | Choices: layer2 layer3 | 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 dictionary |  | 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.
| auth_pass string added in 2.5.3 |  | 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 boolean added in 2.5.3 | Choices: no ← 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.
| host string / 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.
| password string |  | 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 integer | 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).
| ssh_keyfile string |  | 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.
| timeout integer 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).
| transport string / required | Choices: cli ← nxapi | 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_proxy boolean added in 2.5 | Choices: no yes ← | If `no`, the environment variables `http_proxy` and `https_proxy` will be ignored.
| use_ssl boolean | Choices: no ← yes | Configures the transport to use SSL if set to `yes` only when the `transport=nxapi`, otherwise this value is ignored.
| username string |  | 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.
| validate_certs boolean | Choices: no yes ← | 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.
rx_rate - added in 2.5 |  | Receiver rate in bits per second (bps). This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules
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. Supports conditionals, see Conditionals in Networking Modules

## Notes

Note

- Tested against NXOSv 7.3.(0)D1(1) on VIRL
- This module is also used to create logical interfaces such as svis and loopbacks.
- Be cautious of platform specific idiosyncrasies. For example, when you default a loopback interface, the admin state toggles on certain versions of NX-OS.
- The nxos_overlay_global `anycast_gateway_mac` attribute must be set before setting the `fabric_forwarding_anycast_gateway` property.
- For information on using CLI and NX-API see the NXOS Platform Options guide
- For more information on using Ansible to manage network devices see the Ansible Network Guide
- For more information on using Ansible to manage Cisco devices see the Cisco integration page.

## Examples

    - name: Ensure an interface is a Layer 3 port and that it has the proper description
      nxos_interface:
        name: Ethernet1/1
        description: 'Configured by Ansible'
        mode: layer3

    - name: Admin down an interface
      nxos_interface:
        name: Ethernet2/1
        admin_state: down

    - name: Remove all loopback interfaces
      nxos_interface:
        name: loopback
        state: absent

    - name: Remove all logical interfaces
      nxos_interface:
        interface_type: "{{ item }} "
        state: absent
      loop:
        - loopback
        - portchannel
        - svi
        - nve

    - name: Admin up all loopback interfaces
      nxos_interface:
        name: loopback 0-1023
        admin_state: up

    - name: Admin down all loopback interfaces
      nxos_interface:
        name: looback 0-1023
        admin_state: down

    - name: Check neighbors intent arguments
      nxos_interface:
        name: Ethernet2/3
        neighbors:
        - port: Ethernet2/3
          host: abc.mycompany.com

    - name: Add interface using aggregate
      nxos_interface:
        aggregate:
        - { name: Ethernet0/1, mtu: 256, description: test-interface-1 }
        - { name: Ethernet0/2, mtu: 516, description: test-interface-2 }
        duplex: full
        speed: 100
        state: present

    - name: Delete interface using aggregate
      nxos_interface:
        aggregate:
        - name: Loopback9
        - name: Loopback10
        state: absent

    - name: Check intent arguments
      nxos_interface:
        name: Ethernet0/2
        state: up
        tx_rate: ge(0)
        rx_rate: le(0)

## Return Values

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

Key | Returned | Description
--- | --- | ---
commands list | always | command list sent to the device Sample: ['interface Ethernet2/3', 'mtu 1500', 'speed 10']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- Jason Edelman (@jedelman8)
- Trishna Guha (@trishnaguha)

Hint

If you notice any issues in this documentation you can edit this document to improve it.