Package version:

Interface ProcessServer

Details of the Process Server.

interface ProcessServer {
    agentExpiryDate?: any;
    agentVersion?: string;
    agentVersionDetails?: VersionDetails;
    availableMemoryInBytes?: number;
    availableSpaceInBytes?: number;
    cpuLoad?: string;
    cpuLoadStatus?: string;
    friendlyName?: string;
    health?: string;
    healthErrors?: HealthError[];
    hostId?: string;
    id?: string;
    ipAddress?: string;
    lastHeartbeat?: any;
    machineCount?: string;
    marsCommunicationStatus?: string;
    marsRegistrationStatus?: string;
    memoryUsageStatus?: string;
    mobilityServiceUpdates?: MobilityServiceUpdate[];
    osType?: string;
    osVersion?: string;
    psServiceStatus?: string;
    psStatsRefreshTime?: any;
    replicationPairCount?: string;
    spaceUsageStatus?: string;
    sslCertExpiryDate?: any;
    sslCertExpiryRemainingDays?: number;
    systemLoad?: string;
    systemLoadStatus?: string;
    throughputInBytes?: number;
    throughputInMBps?: number;
    throughputStatus?: string;
    throughputUploadPendingDataInBytes?: number;
    totalMemoryInBytes?: number;
    totalSpaceInBytes?: number;
    versionStatus?: string;
}

Properties

agentExpiryDate? agentVersion? agentVersionDetails? availableMemoryInBytes? availableSpaceInBytes? cpuLoad? cpuLoadStatus? friendlyName? health? healthErrors? hostId? id? ipAddress? lastHeartbeat? machineCount? marsCommunicationStatus? marsRegistrationStatus? memoryUsageStatus? mobilityServiceUpdates? osType? osVersion? psServiceStatus? psStatsRefreshTime? replicationPairCount? spaceUsageStatus? sslCertExpiryDate? sslCertExpiryRemainingDays? systemLoad? systemLoadStatus? throughputInBytes? throughputInMBps? throughputStatus? throughputUploadPendingDataInBytes? totalMemoryInBytes? totalSpaceInBytes? versionStatus?

Properties

OptionalagentExpiryDate

agentExpiryDate?: any

Agent expiry date.

OptionalagentVersion

agentVersion?: string

The version of the scout component on the server.

OptionalagentVersionDetails

agentVersionDetails?: VersionDetails

The agent version details.

OptionalavailableMemoryInBytes

availableMemoryInBytes?: number

The available memory.

OptionalavailableSpaceInBytes

availableSpaceInBytes?: number

The available space.

OptionalcpuLoad

cpuLoad?: string

The percentage of the CPU load.

OptionalcpuLoadStatus

cpuLoadStatus?: string

The CPU load status.

OptionalfriendlyName

friendlyName?: string

The Process Server's friendly name.

Optional Readonlyhealth

health?: string

The health of Process Server. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalhealthErrors

healthErrors?: HealthError[]

Health errors.

OptionalhostId

hostId?: string

The agent generated Id.

Optionalid

id?: string

The Process Server Id.

OptionalipAddress

ipAddress?: string

The IP address of the server.

OptionallastHeartbeat

lastHeartbeat?: any

The last heartbeat received from the server.

OptionalmachineCount

machineCount?: string

The servers configured with this PS.

Optional ReadonlymarsCommunicationStatus

marsCommunicationStatus?: string

The MARS communication status. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlymarsRegistrationStatus

marsRegistrationStatus?: string

The MARS registration status. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalmemoryUsageStatus

memoryUsageStatus?: string

The memory usage status.

OptionalmobilityServiceUpdates

mobilityServiceUpdates?: MobilityServiceUpdate[]

The list of the mobility service updates available on the Process Server.

OptionalosType

osType?: string

The OS type of the server.

OptionalosVersion

osVersion?: string

OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0.

OptionalpsServiceStatus

psServiceStatus?: string

The PS service status.

Optional ReadonlypsStatsRefreshTime

psStatsRefreshTime?: any

The process server stats refresh time. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalreplicationPairCount

replicationPairCount?: string

The number of replication pairs configured in this PS.

OptionalspaceUsageStatus

spaceUsageStatus?: string

The space usage status.

OptionalsslCertExpiryDate

sslCertExpiryDate?: any

The PS SSL cert expiry date.

OptionalsslCertExpiryRemainingDays

sslCertExpiryRemainingDays?: number

CS SSL cert expiry date.

OptionalsystemLoad

systemLoad?: string

The percentage of the system load.

OptionalsystemLoadStatus

systemLoadStatus?: string

The system load status.

Optional ReadonlythroughputInBytes

throughputInBytes?: number

The throughput in bytes. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlythroughputInMBps

throughputInMBps?: number

The throughput in MBps. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlythroughputStatus

throughputStatus?: string

The throughput status. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlythroughputUploadPendingDataInBytes

throughputUploadPendingDataInBytes?: number

The uploading pending data in bytes. NOTE: This property will not be serialized. It can only be populated by the server.

OptionaltotalMemoryInBytes

totalMemoryInBytes?: number

The total memory.

OptionaltotalSpaceInBytes

totalSpaceInBytes?: number

The total space.

OptionalversionStatus

versionStatus?: string

Version status.

Settings

Member Visibility