Encapsulates the port information for system monitoring entity.
| access |
| description |
| dpdkEnabled |
| embeddedMetadata |
| entityScope |
| externalID |
| lastStateChange |
| name |
| resiliencyState |
| resilient |
| state |
| uplink |
This object has no members.
Flag to indicate that it is a access port or network port.
SDK attribute: access
Optional port description.
Format: free
Min length: 1
Max length: 255
SDK attribute: description
Flag to indicate if an ACCESS port is DPDK Enabled or not.
SDK attribute: dpdkEnabled
Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.
SDK attribute: embeddedMetadata
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
Last port state change timestamp.
SDK attribute: lastStateChange
Name for the port.
Format: free
Min length: 1
Max length: 255
SDK attribute: name
None
Allowed values: backup, master, none
SDK attribute: resiliencyState
Flag to indicate if an ACCESS port is resilient or not.
SDK attribute: resilient
The current state of the port.
Allowed values: ADMIN_DOWN, DOWN, UP
SDK attribute: state
Flag to indicate that is an uplink or downlink port.
SDK attribute: uplink