Skip to main content

Network Port

A Node object whose type is NETWORK_PORT. It represents a physical 10GbE port (copper or fiber) on the device.

Configuration

NetworkPortNodeConfig
{
"speed" : String
}
Member nameTypeDescription
speedStringSpeed configuration for the network port.

Is one of the following: SPEED_10G fixed 10Gbps speed Note: Supported only if supports_speed_10g status member of this node is true. SPEED_5G fixed 5Gbps speed Note: Supported only if the supports_speed_5g status member of this node is true. SPEED_2_5G fixed 2.5Gbps speed Note: Supported only if the supports_speed_2_5g status member of this node is true. AUTO_10G auto-negotiated up to 10Gbps speed Note: Supported only if the supports_auto_10g status member of this node is true. AUTO_5G auto-negotiated up to 5Gbps speed Note: Supported only if the supports_auto_5g status member of the node is true.

Status

NetworkPortNodeStatus
{
"active" : Boolean,
"speed" : Real,
"supports_speed_10g" : Boolean,
"supports_speed_5g" : Boolean,
"supports_speed_2_5g" : Boolean,
"supports_auto_10g" : Boolean,
"supports_auto_5g" : Boolean
}
Member nameTypeDescription
activeBooleanWhether the port is currently selected as active.

On dual-10GbE port devices with automatic switchover, only one port is active at a time.
speedRealThe current speed of the port in Gbps.
supports_speed_10gBooleanWhether the SPEED_10G speed configuration is supported.
supports_speed_5gBooleanWhether the SPEED_5G speed configuration is supported.
supports_speed_2_5gBooleanWhether the SPEED_2_5G speed configuration is supported.
supports_auto_10gBooleanWhether the AUTO_10G speed configuration is supported.
supports_auto_5gBooleanWhether the AUTO_5G speed configuration is supported.

Inputs

None

Example

As returned by get device:

{
"type": "NETWORK_PORT",
"index": 0,
"configuration": {
"speed": "AUTO_10G"
},
"status": {
"active": true,
"speed": 5.0,
"supports_speed_10g": true,
"supports_speed_5g": true,
"supports_speed_2_5g": true,
"supports_auto_10g": true,
"supports_auto_5g": true
},
"inputs": [

]
}