ProcessServer interface
Details of the Process Server.
Properties
agent |
Agent expiry date. |
agent |
The version of the scout component on the server. |
agent |
The agent version details. |
available |
The available memory. |
available |
The available space. |
cpu |
The percentage of the CPU load. |
cpu |
The CPU load status. |
friendly |
The Process Server's friendly name. |
health | The health of Process Server. NOTE: This property will not be serialized. It can only be populated by the server. |
health |
Health errors. |
host |
The agent generated Id. |
id | The Process Server Id. |
ip |
The IP address of the server. |
last |
The last heartbeat received from the server. |
machine |
The servers configured with this PS. |
mars |
The MARS communication status. NOTE: This property will not be serialized. It can only be populated by the server. |
mars |
The MARS registration status. NOTE: This property will not be serialized. It can only be populated by the server. |
memory |
The memory usage status. |
mobility |
The list of the mobility service updates available on the Process Server. |
os |
The OS type of the server. |
os |
OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. |
ps |
The PS service status. |
ps |
The process server stats refresh time. NOTE: This property will not be serialized. It can only be populated by the server. |
replication |
The number of replication pairs configured in this PS. |
space |
The space usage status. |
ssl |
The PS SSL cert expiry date. |
ssl |
CS SSL cert expiry date. |
system |
The percentage of the system load. |
system |
The system load status. |
throughput |
The throughput in bytes. NOTE: This property will not be serialized. It can only be populated by the server. |
throughput |
The throughput in MBps. NOTE: This property will not be serialized. It can only be populated by the server. |
throughput |
The throughput status. NOTE: This property will not be serialized. It can only be populated by the server. |
throughput |
The uploading pending data in bytes. NOTE: This property will not be serialized. It can only be populated by the server. |
total |
The total memory. |
total |
The total space. |
version |
Version status. |
Property Details
agentExpiryDate
Agent expiry date.
agentExpiryDate?: Date
Property Value
Date
agentVersion
The version of the scout component on the server.
agentVersion?: string
Property Value
string
agentVersionDetails
availableMemoryInBytes
The available memory.
availableMemoryInBytes?: number
Property Value
number
availableSpaceInBytes
The available space.
availableSpaceInBytes?: number
Property Value
number
cpuLoad
The percentage of the CPU load.
cpuLoad?: string
Property Value
string
cpuLoadStatus
The CPU load status.
cpuLoadStatus?: string
Property Value
string
friendlyName
The Process Server's friendly name.
friendlyName?: string
Property Value
string
health
The health of Process Server. NOTE: This property will not be serialized. It can only be populated by the server.
health?: string
Property Value
string
healthErrors
hostId
The agent generated Id.
hostId?: string
Property Value
string
id
The Process Server Id.
id?: string
Property Value
string
ipAddress
The IP address of the server.
ipAddress?: string
Property Value
string
lastHeartbeat
The last heartbeat received from the server.
lastHeartbeat?: Date
Property Value
Date
machineCount
The servers configured with this PS.
machineCount?: string
Property Value
string
marsCommunicationStatus
The MARS communication status. NOTE: This property will not be serialized. It can only be populated by the server.
marsCommunicationStatus?: string
Property Value
string
marsRegistrationStatus
The MARS registration status. NOTE: This property will not be serialized. It can only be populated by the server.
marsRegistrationStatus?: string
Property Value
string
memoryUsageStatus
The memory usage status.
memoryUsageStatus?: string
Property Value
string
mobilityServiceUpdates
The list of the mobility service updates available on the Process Server.
mobilityServiceUpdates?: MobilityServiceUpdate[]
Property Value
osType
The OS type of the server.
osType?: string
Property Value
string
osVersion
OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0.
osVersion?: string
Property Value
string
psServiceStatus
The PS service status.
psServiceStatus?: string
Property Value
string
psStatsRefreshTime
The process server stats refresh time. NOTE: This property will not be serialized. It can only be populated by the server.
psStatsRefreshTime?: Date
Property Value
Date
replicationPairCount
The number of replication pairs configured in this PS.
replicationPairCount?: string
Property Value
string
spaceUsageStatus
The space usage status.
spaceUsageStatus?: string
Property Value
string
sslCertExpiryDate
The PS SSL cert expiry date.
sslCertExpiryDate?: Date
Property Value
Date
sslCertExpiryRemainingDays
CS SSL cert expiry date.
sslCertExpiryRemainingDays?: number
Property Value
number
systemLoad
The percentage of the system load.
systemLoad?: string
Property Value
string
systemLoadStatus
The system load status.
systemLoadStatus?: string
Property Value
string
throughputInBytes
The throughput in bytes. NOTE: This property will not be serialized. It can only be populated by the server.
throughputInBytes?: number
Property Value
number
throughputInMBps
The throughput in MBps. NOTE: This property will not be serialized. It can only be populated by the server.
throughputInMBps?: number
Property Value
number
throughputStatus
The throughput status. NOTE: This property will not be serialized. It can only be populated by the server.
throughputStatus?: string
Property Value
string
throughputUploadPendingDataInBytes
The uploading pending data in bytes. NOTE: This property will not be serialized. It can only be populated by the server.
throughputUploadPendingDataInBytes?: number
Property Value
number
totalMemoryInBytes
The total memory.
totalMemoryInBytes?: number
Property Value
number
totalSpaceInBytes
The total space.
totalSpaceInBytes?: number
Property Value
number
versionStatus
Version status.
versionStatus?: string
Property Value
string