Steampunk Ansible Documentation - cisco.nxos.nxos_interface (3.2.0) - module - (deprecated, removed after 2022-06-01) Manages physical attributes of interfaces.

Install collection

Install with ansible-galaxy collection install cisco.nxos:==3.2.0

Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 3.2.0

Description

Manages physical attributes of interfaces of NX-OS switches.

Usage examples

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

- name: Remove all loopback interfaces
  cisco.nxos.nxos_interface:
    name: loopback
    state: absent

Scanned by Steampunk Spotter

- name: Remove all logical interfaces
  cisco.nxos.nxos_interface:
    interface_type: '{{ item }} '
    state: absent
  loop:
  - loopback
  - portchannel
  - svi
  - nve

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

- name: Admin down all loopback interfaces
  cisco.nxos.nxos_interface:
    name: loopback 0-1023
    admin_state: down

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

- name: Add interface using aggregate
  cisco.nxos.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

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

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

Inputs

mtu:
description:
- MTU for a specific interface. Must be an even number between 576 and 9216. Applicable
for ethernet interface only.
type: str

mode:
choices:
- layer2
- layer3
description:
- 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.
type: str

name:
aliases:
- interface
description:
- Full name of interface, i.e. Ethernet1/1, port-channel10.
type: str

delay:
default: 10
description:
- Time in seconds to wait before checking for the operational state on remote device.
This wait is applicable for operational state arguments.
type: int

speed:
description:
- Interface link speed. Applicable for ethernet interface only.
type: str

state:
choices:
- present
- absent
- default
default: present
description:
- Specify desired state of the resource.
type: str

duplex:
choices:
- full
- half
- auto
description:
- Interface link status. Applicable for ethernet interface only.
type: str

rx_rate:
description:
- Receiver rate in bits per second (bps).
- This is state check parameter only.
- Supports conditionals, see U(https://docs.ansible.com/ansible/latest/network/user_guide/network_working_with_command_output.html#conditionals-in-networking-modules)
type: str

tx_rate:
description:
- Transmit rate in bits per second (bps).
- This is state check parameter only.
- Supports conditionals, see U(https://docs.ansible.com/ansible/latest/network/user_guide/network_working_with_command_output.html#conditionals-in-networking-modules)
type: str

provider:
description:
- B(Deprecated)
- 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
- 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for NX-API.'
- This option will be removed in a release after 2022-06-01.
- For more information please see the U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html).
- HORIZONTALLINE
- A dict object containing connection details.
suboptions:
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode on the remote
device. If I(authorize) is false, then this argument does nothing. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
will be used instead.
type: str
authorize:
default: false
description:
- 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool
host:
description:
- 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.
type: str
password:
description:
- Specifies the password to use to authenticate the connection to the remote device. This
is a common argument used for either I(cli) or I(nxapi) transports. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
will be used instead.
type: str
port:
description:
- Specifies the port to use when building the connection to the remote device. This
value applies to either I(cli) or I(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).
type: int
ssh_keyfile:
description:
- Specifies the SSH key to use to authenticate the connection to the remote device. This
argument is only used for the I(cli) transport. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will
be used instead.
type: str
timeout:
description:
- 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).
type: int
transport:
choices:
- cli
- nxapi
default: cli
description:
- 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.
type: str
use_proxy:
default: true
description:
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be
ignored.
type: bool
use_ssl:
default: false
description:
- Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi),
otherwise this value is ignored.
type: bool
username:
description:
- 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 C(ANSIBLE_NET_USERNAME) will
be used instead.
type: str
validate_certs:
default: false
description:
- If C(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.
type: bool
type: dict

aggregate:
description: List of Interfaces definitions.
elements: dict
suboptions:
admin_state:
choices:
- up
- down
description:
- Administrative state of the interface.
type: str
delay:
description:
- Time in seconds to wait before checking for the operational state on remote
device. This wait is applicable for operational state arguments.
type: int
description:
description:
- Interface description.
type: str
duplex:
choices:
- full
- half
- auto
description:
- Interface link status. Applicable for ethernet interface only.
type: str
fabric_forwarding_anycast_gateway:
description:
- Associate SVI with anycast gateway under VLAN configuration mode. Applicable
for SVI interface only.
type: bool
interface_type:
choices:
- loopback
- portchannel
- svi
- nve
description:
- Interface type to be unconfigured from the device.
type: str
ip_forward:
choices:
- enable
- disable
description:
- Enable/Disable ip forward feature on SVIs.
type: str
mode:
choices:
- layer2
- layer3
description:
- 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.
type: str
mtu:
description:
- MTU for a specific interface. Must be an even number between 576 and 9216. Applicable
for ethernet interface only.
type: str
name:
description:
- Full name of interface, i.e. Ethernet1/1, port-channel10.
required: true
type: str
neighbors:
description:
- Check the operational state of given interface C(name) for LLDP neighbor.
- The following suboptions are available. This is state check parameter only.
elements: dict
suboptions:
host:
description:
- LLDP neighbor host for given interface C(name).
type: str
port:
description:
- LLDP neighbor port to which given interface C(name) is connected.
type: str
type: list
rx_rate:
description:
- Receiver rate in bits per second (bps).
- This is state check parameter only.
- Supports conditionals, see U(https://docs.ansible.com/ansible/latest/network/user_guide/network_working_with_command_output.html#conditionals-in-networking-modules)
type: str
speed:
description:
- Interface link speed. Applicable for ethernet interface only.
type: str
state:
choices:
- present
- absent
- default
description:
- Specify desired state of the resource.
type: str
tx_rate:
description:
- Transmit rate in bits per second (bps).
- This is state check parameter only.
- Supports conditionals, see U(https://docs.ansible.com/ansible/latest/network/user_guide/network_working_with_command_output.html#conditionals-in-networking-modules)
type: str
type: list

neighbors:
description:
- Check the operational state of given interface C(name) for LLDP neighbor.
- The following suboptions are available. This is state check parameter only.
elements: dict
suboptions:
host:
description:
- LLDP neighbor host for given interface C(name).
type: str
port:
description:
- LLDP neighbor port to which given interface C(name) is connected.
type: str
type: list

ip_forward:
choices:
- enable
- disable
description:
- Enable/Disable ip forward feature on SVIs.
type: str

admin_state:
choices:
- up
- down
default: up
description:
- Administrative state of the interface.
type: str

description:
description:
- Interface description.
type: str

interface_type:
choices:
- loopback
- portchannel
- svi
- nve
description:
- Interface type to be unconfigured from the device.
type: str

fabric_forwarding_anycast_gateway:
description:
- Associate SVI with anycast gateway under VLAN configuration mode. Applicable for
SVI interface only.
type: bool

Outputs

commands:
  description: command list sent to the device
  returned: always
  sample:
  - interface Ethernet2/3
  - mtu 1500
  - speed 10
  type: list