PerformanceMonitor

To enable the network performance monitoring between NSGs in an NSG Group and NSG-UBRs in an NSG-UBR Group.

Overview

description string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
holdDownTimer integer
interval integer required   filterable   orderable  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
numberOfPackets integer required   filterable   orderable  
payloadSize integer filterable   orderable  
probeType enum (HTTP | IPSEC_AND_VXLAN | ONEWAY) filterable  
readOnly boolean filterable   orderable  
serviceClass enum (A | B | C | D | E | F | G | H) filterable   orderable  

API Resource

/performancemonitors/id
delete get put

Parents

/enterprises/id/performancemonitors
get post
/performancemonitors
get post
/ikegatewayconnections/id/performancemonitors
get put

Children

/performancemonitors/id/tiers
get put

Members

/performancemonitors/id/applicationperformancemanagements
get

Attributes documentation

description string filterable   orderable  
Discussion

Description of application group probe

Charateristics

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

holdDownTimer integer
Discussion

Probe Timeout in milliseconds

Charateristics

Default value: 1000
Min value: 1000
Max value: 90000
SDK attribute: holdDownTimer

interval integer required   filterable   orderable  
Discussion

interval in seconds

Charateristics

Default value: 3000
Min value: 1
Max value: 1818000
SDK attribute: interval

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of the application group probe

Charateristics

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

numberOfPackets integer required   filterable   orderable  
Discussion

number of packets

Charateristics

Default value: 1
Min value: 1
Max value: 9999
SDK attribute: numberOfPackets

payloadSize integer filterable   orderable  
Discussion

Payload size (This is a mandatory field if the networkProbeType = ONEWAY, and optional for probeType = HTTP,IPSEC_AND_VXLAN)

Charateristics

Default value: 137
Min value: 137
Max value: 1500
SDK attribute: payloadSize

probeType enum filterable  
Discussion

Type to be assigned to this probe

Charateristics

Allowed values: HTTP, IPSEC_AND_VXLAN, ONEWAY
Default value: ONEWAY
SDK attribute: probeType

readOnly boolean filterable   orderable  
Discussion

Determines whether this entity is read only. Read only objects cannot be modified or deleted.

Charateristics

Default value: false
SDK attribute: readOnly

serviceClass enum filterable   orderable  
Discussion

Class of service to be used. Service classes in order of priority are A, B, C, D, E, F, G, and H.

Charateristics

Allowed values: A, B, C, D, E, F, G, H
Default value: H
SDK attribute: serviceClass