ansible / ansible.builtin / v2.9.24 / module / icx_interface Manage Interface on Ruckus ICX 7000 series switches | "added in version" 2.9 of ansible.builtin" Authors: Ruckus Wireless (@Commscope) preview | supported by communityansible.builtin.icx_interface (v2.9.24) — module
pip
Install with pip install ansible==2.9.24
This module provides declarative management of Interfaces on ruckus icx devices.
- name: enable ethernet port and set name icx_interface: name: ethernet 1/1/1 description: interface-1 stp: true enabled: true
- name: disable ethernet port 1/1/1 icx_interface: name: ethernet 1/1/1 enabled: false
- name: enable ethernet port range, set name and speed. icx_interface: name: ethernet 1/1/1 to 1/1/10 description: interface-1 speed: 100-full enabled: true
- name: enable poe. Set class. icx_interface: name: ethernet 1/1/1 power: by_class: 2
- name: configure poe limit of interface icx_interface: name: ethernet 1/1/1 power: limit: 10000
- name: disable poe of interface icx_interface: name: ethernet 1/1/1 power: enabled: false
- name: set lag name for a range of lags icx_interface: name: lag 1 to 10 description: test lags
- name: Disable lag icx_interface: name: lag 1 enabled: false
- name: enable management interface icx_interface: name: management 1 enabled: true
- name: enable loopback interface icx_interface: name: loopback 10 enabled: true
- name: Add interface using aggregate 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 icx_interface: name: ethernet 1/1/10 state: up tx_rate: ge(0) rx_rate: le(0)
- name: Check neighbors intent arguments icx_interface: name: ethernet 1/1/10 neighbors: - port: 1/1/5 host: netdev
stp: description: - enable/disable stp for the interface type: bool name: description: - Name of the Interface. 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 argument which are I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate). type: int power: description: - Inline power on Power over Ethernet (PoE) ports. suboptions: by_class: choices: - '0' - '1' - '2' - '3' - '4' description: - The range is 0-4 - The power limit based on class value for given interface C(name) type: str enabled: default: false description: - enable/disable the poe of the given interface C(name) type: bool limit: description: - 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 C(name) type: str priority: choices: - '1' - '2' - '3' description: - The range is 1 (highest) to 3 (lowest) - The priority for power management or given interface C(name) type: str type: dict speed: choices: - 10-full - 10-half - 100-full - 100-half - 1000-full - 1000-full-master - 1000-full-slave - 10g-full - 10g-full-master - 10g-full-slave - 2500-full - 2500-full-master - 2500-full-slave - 5g-full - 5g-full-master - 5g-full-slave - auto description: - Interface link speed/duplex type: str state: choices: - present - absent - up - down default: present description: - State of the Interface configuration, C(up) means present and operationally up and C(down) means present and operationally C(down) type: str enabled: default: true description: - Interface link status type: bool rx_rate: description: - Receiver rate in bits per second (bps). - This is state check parameter only. - Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html) type: str tx_rate: description: - Transmit rate in bits per second (bps). - This is state check parameter only. - Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html) type: str aggregate: description: - List of Interfaces definitions. suboptions: check_running_config: description: - 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. type: bool delay: description: - Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate). type: int description: description: - Name of the description. type: str enabled: description: - Interface link status type: bool name: description: - Name of the Interface. type: str neighbors: description: - Check the operational state of given interface C(name) for CDP/LLDP neighbor. - The following suboptions are available. suboptions: host: description: - CDP/LLDP neighbor host for given interface C(name). type: str port: description: - CDP/LLDP neighbor port to which given interface C(name) is connected. type: str type: list power: description: - Inline power on Power over Ethernet (PoE) ports. suboptions: by_class: choices: - '0' - '1' - '2' - '3' - '4' description: - The range is 0-4 - The power limit based on class value for given interface C(name) type: str enabled: description: - enable/disable the poe of the given interface C(name) type: bool limit: description: - 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 C(name) type: str priority: choices: - '1' - '2' - '3' description: - The range is 1 (highest) to 3 (lowest) - The priority for power management or given interface C(name) type: str type: dict rx_rate: description: - Receiver rate in bits per second (bps). - This is state check parameter only. - Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html) type: str speed: choices: - 10-full - 10-half - 100-full - 100-half - 1000-full - 1000-full-master - 1000-full-slave - 10g-full - 10g-full-master - 10g-full-slave - 2500-full - 2500-full-master - 2500-full-slave - 5g-full - 5g-full-master - 5g-full-slave - auto description: - Interface link speed/duplex type: str state: choices: - present - absent - up - down description: - State of the Interface configuration, C(up) means present and operationally up and C(down) means present and operationally C(down) type: str stp: description: - enable/disable stp for the interface type: bool tx_rate: description: - Transmit rate in bits per second (bps). - This is state check parameter only. - Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html) type: str type: list neighbors: description: - Check the operational state of given interface C(name) for CDP/LLDP neighbor. - The following suboptions are available. suboptions: host: description: - CDP/LLDP neighbor host for given interface C(name). type: str port: description: - CDP/LLDP neighbor port to which given interface C(name) is connected. type: str type: list description: description: - Name of the description. type: str check_running_config: default: true description: - 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. type: bool
commands: description: The list of configuration mode commands to send to the device. returned: always sample: - interface ethernet 1/1/1 - port-name interface-1 - state present - speed-duplex 100-full - inline power priority 1 type: list