community.network.icx_interface module – Manage Interface on Ruckus ICX 7000 series switches
Note
This module is part of the community.network collection (version 5.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.icx_interface
.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
DEPRECATED
- Removed in:
version 6.0.0
- Why:
This collection and all content in it is unmaintained and deprecated.
- Alternative:
Unknown.
Synopsis
This module provides declarative management of Interfaces on ruckus icx devices.
Aliases: network.icx.icx_interface
Parameters
Parameter |
Comments |
---|---|
List of Interfaces definitions. |
|
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter. Choices:
|
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values |
|
Name of the description. |
|
Interface link status Choices:
|
|
Name of the Interface. |
|
Check the operational state of given interface The following suboptions are available. |
|
CDP/LLDP neighbor host for given interface |
|
CDP/LLDP neighbor port to which given interface |
|
Inline power on Power over Ethernet (PoE) ports. |
|
The range is 0-4 The power limit based on class value for given interface Choices:
|
|
enable/disable the poe of the given interface Choices:
|
|
The range is 1000-15400|30000mW. For PoH ports the range is 1000-95000mW The power limit based on actual power value for given interface |
|
The range is 1 (highest) to 3 (lowest) The priority for power management or given interface Choices:
|
|
Receiver rate in bits per second (bps). This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules |
|
Interface link speed/duplex Choices:
|
|
State of the Interface configuration, Choices:
|
|
enable/disable stp for the interface Choices:
|
|
Transmit rate in bits per second (bps). This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules |
|
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter. Choices:
|
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values Default: |
|
Name of the description. |
|
Interface link status Choices:
|
|
Name of the Interface. |
|
Check the operational state of given interface The following suboptions are available. |
|
CDP/LLDP neighbor host for given interface |
|
CDP/LLDP neighbor port to which given interface |
|
Inline power on Power over Ethernet (PoE) ports. |
|
The range is 0-4 The power limit based on class value for given interface Choices:
|
|
enable/disable the poe of the given interface Default is false. Choices:
|
|
The range is 1000-15400|30000mW. For PoH ports the range is 1000-95000mW The power limit based on actual power value for given interface |
|
The range is 1 (highest) to 3 (lowest) The priority for power management or given interface Choices:
|
|
Receiver rate in bits per second (bps). This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules |
|
Interface link speed/duplex Choices:
|
|
State of the Interface configuration, Choices:
|
|
enable/disable stp for the interface Choices:
|
|
Transmit rate in bits per second (bps). This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules |
Notes
Note
Tested against ICX 10.1.
For information on using ICX platform, see the ICX OS Platform Options guide.
Examples
- name: Enable ethernet port and set name
community.network.icx_interface:
name: ethernet 1/1/1
description: interface-1
stp: true
enabled: true
- name: Disable ethernet port 1/1/1
community.network.icx_interface:
name: ethernet 1/1/1
enabled: false
- name: Enable ethernet port range, set name and speed
community.network.icx_interface:
name: ethernet 1/1/1 to 1/1/10
description: interface-1
speed: 100-full
enabled: true
- name: Enable poe. Set class
community.network.icx_interface:
name: ethernet 1/1/1
power:
by_class: 2
- name: Configure poe limit of interface
community.network.icx_interface:
name: ethernet 1/1/1
power:
limit: 10000
- name: Disable poe of interface
community.network.icx_interface:
name: ethernet 1/1/1
power:
enabled: false
- name: Set lag name for a range of lags
community.network.icx_interface:
name: lag 1 to 10
description: test lags
- name: Disable lag
community.network.icx_interface:
name: lag 1
enabled: false
- name: Enable management interface
community.network.icx_interface:
name: management 1
enabled: true
- name: Enable loopback interface
community.network.icx_interface:
name: loopback 10
enabled: true
- name: Add interface using aggregate
community.network.icx_interface:
aggregate:
- { name: ethernet 1/1/1, description: test-interface-1, power: { by_class: 2 } }
- { name: ethernet 1/1/3, description: test-interface-3}
speed: 10-full
enabled: true
- name: Check tx_rate, rx_rate intent arguments
community.network.icx_interface:
name: ethernet 1/1/10
state: up
tx_rate: ge(0)
rx_rate: le(0)
- name: Check neighbors intent arguments
community.network.icx_interface:
name: ethernet 1/1/10
neighbors:
- port: 1/1/5
host: netdev
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The list of configuration mode commands to send to the device. Returned: always Sample: |
Status
This module will be removed in version 6.0.0. [deprecated]
For more information see DEPRECATED.