MonitoringPort

Encapsulates the port information for system monitoring entity.

Overview

access boolean
description string
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

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

Children

/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

Format: free
SDK attribute: access

description string
Discussion

Optional port description.

Charateristics

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

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

Format: free
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

Charateristics

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

resilient boolean filterable   orderable  
Discussion

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

Charateristics

Format: free
SDK attribute: resilient

state enum
Discussion

The current state of the port.

Charateristics

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