New in version 2.5.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| aggregate |
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 argument which are state with values
up/down. |
| description |
Description of Interface.
|
|
| duplex |
|
Interface link status
|
| enabled |
|
Interface link status.
|
| mtu |
Maximum size of transmit packet.
|
|
|
name
required |
Name of the Interface.
|
|
| purge |
|
Purge Interfaces not defined in the aggregate parameter. This applies only for logical interface.
|
| rx_rate |
Receiver rate in bits per second (bps).
This is state check parameter only.
Supports conditionals, see Conditionals in Networking Modules
|
|
| speed |
|
Interface link speed.
|
| state |
|
State of the Interface configuration,
up means present and operationally up and down means present and operationally down |
| tx_rate |
Transmit rate in bits per second (bps).
This is state check parameter only.
Supports conditionals, see Conditionals in Networking Modules
|
- name: configure interface
onyx_interface:
name: Eth1/2
description: test-interface
speed: 100 GB
mtu: 512
- name: make interface up
onyx_interface:
name: Eth1/2
enabled: True
- name: make interface down
onyx_interface:
name: Eth1/2
enabled: False
- name: Check intent arguments
onyx_interface:
name: Eth1/2
state: up
- name: Config + intent
onyx_interface:
name: Eth1/2
enabled: False
state: down
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
commands
list
|
always |
The list of configuration mode commands to send to the device.
Sample:
['interface ethernet 1/2', 'description test-interface', 'mtu 512', 'exit']
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.