MonitoringPort

Encapsulates the port information for system monitoring entity.

Overview

access boolean
description string
dpdkEnabled boolean read only   filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastStateChange integer
name string filterable   orderable  
resiliencyState enum (backup | master | none) filterable   orderable  
resilient boolean filterable   orderable  
state enum (ADMIN_DOWN | DOWN | UP)
uplink boolean

API Resource

/monitoringports/id

Parents

/vrss/id/monitoringports
get
/hscs/id/monitoringports
get
/vscs/id/monitoringports
get

Children

/monitoringports/id/permissions
delete get post put
/monitoringports/id/metadatas
get post
/monitoringports/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

access boolean
Discussion

Flag to indicate that it is a access port or network port.


Charateristics

SDK attribute: access

description string
Discussion

Optional port description.


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: description

dpdkEnabled boolean read only   filterable   orderable  
Discussion

Flag to indicate if an ACCESS port is DPDK Enabled or not.


Charateristics

SDK attribute: dpdkEnabled

embeddedMetadata list read only   autogenerated  
Discussion

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.


Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

lastStateChange integer
Discussion

Last port state change timestamp.


Charateristics

SDK attribute: lastStateChange

name string filterable   orderable  
Discussion

Name for the port.


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

resiliencyState enum filterable   orderable  
Discussion

None


Charateristics

Allowed values: backup, master, none
SDK attribute: resiliencyState

resilient boolean filterable   orderable  
Discussion

Flag to indicate if an ACCESS port is resilient or not.


Charateristics

SDK attribute: resilient

state enum
Discussion

The current state of the port.


Charateristics

Allowed values: ADMIN_DOWN, DOWN, UP
SDK attribute: state