Monitor the listed URL endpoints for various Omnissa Access components to ensure a functional environment. Certain endpoints can also be used for load balancers to ensure the service is up for traffic.
Health Checks for Load Balancers
| Component | Health Check | Expected Return | Notes |
|---|---|---|---|
| Omnissa Access Service | /SAAS/API/1.0/REST/system/health/heartbeat | String: ok Http: 200 | Frequency every 30 seconds |
Android Mobile SSO - Certproxy: :5262/system/health | Http: 200 | Frequency every 30 seconds | |
iOS Mobile SSO - KDC: TCP half-open to port 88 | Connection | Frequency every 30 second | |
Certificate adapter: :7443/cas/API/1.0/REST/system/health | String: ok Http: 200 | Frequency every 30 second | |
| Omnissa Access connector earlier than 20.01 | /hc/API/1.0/REST/system/health/allOk | String: true Http: 200 | Frequency every 30 seconds |
| Omnissa Access connector 20.01 and later | https://hostname:portnumber/eks/healthNote: A load balancer is not applicable to the Directory Sync service or User Auth service. If the Kerberos Auth service is configured, it is the only enterprise service you need to configure behind a load balancer. To monitor the Kerberos Auth service, use the preceding end-point, where portnumber is a placeholder for the port number of the host. The default port number is 443. | String: true Http: 200 | Frequency every 30 seconds |
The health checks for load balancers return simple values for easy parsing by network equipment.
Additional Health Checks for Monitoring
The health checks listed here can be consumed by monitoring solutions that have the ability to parse data and create dashboards. Set the frequency to every 5 minutes.
Omnissa AccessService Monitoring and Health
URL call: /SAAS/jersey/manager/api/system/health
or
/SAAS/API/1.0/REST/system/health
Raw output:
{
"AnalyticsUrl":"unknown",
"OpensearchServiceOk":"true",
"EhCacheClusterPeers":"unknown",
"OpensearchMasterNode":"unknown",
"OpensearchIndicesCount":"unknown",
"OpensearchDocsCount":"unknown",
"AuditPollInterval":"0",
"AnalyticsConnectionOk":"true",
"EncryptionServiceVerified":"unknown",
"FederationBrokerStatus":"unknown",
"ServiceReadOnlyMode":"false",
"OpensearchUnassignedShards":"unknown",
"AuditWorkerThreadAlive":"true",
"BuildVersion":"3.3.0.0 Build xxxxxxx",
"AuditQueueSize":"0",
"DatabaseStatus":"unknown",
"HostName":"unknown",
"OpensearchNodesCount":"unknown",
"EncryptionStatus":"unknown",
"FederationBrokerOk":"true",
"EncryptionConnectionOk":"true",
"EncryptionServiceImpl":"unknown",
"ClusterId":"22f6e089-45df-41ab-9c8a-77f3e4589230",
"EhCacheClusterDiagnostics":"unknown",
"OpensearchNodesList":"unknown",
"DatabaseConnectionOk":"true",
"OpensearchHealth":"unknown",
"StatusDate":"2018-08-06 19:14:40 UTC",
"ClockSyncOk":"true",
"MaintenanceMode":"false",
"MessagingConnectionOk":"true",
"fipsModeEnabled":"true",
"ServiceVersion":"3.3.0",
"AuditQueueSizeThreshold":"null",
"IpAddress":"unknown",
"AuditDisabled":"false",
"AllOk":"true"
}
| "AllOk" | "true", "false" | Roll-up health check to monitor overall health of Omnissa Access services |
| "MessagingConnectionOk" | "true", "false" | Verifies that all message producers and consumers are connected to RabbitMQ |
| "DatabaseConnectionOk" | "true", "false" | Verifies the connection to the database |
| "EncryptionConnectionOk" | "true", "false" | Verifies that the connection to the encryption service is okay and the primary key store is okay |
| "AnalyticsConnectionOk" | "true", "false" | Verifies the connection to the analytics service |
| "FederationBrokerOk" | "true", "false" | Verifies the embedded auth adapters to ensure their subsystems are okay |
Note: The label "unknown" in the output indicates that the information is restricted. By default, sensitive information such as IP addresses and host names, is hidden. To display this information, see Displaying Additional Information in the Omnissa Access Health Check API.
URL call: /catalog-portal/services/health
This health check is specific for the user interface part of Omnissa Access.
Raw output:
{
"status": "UP",
"uiService": {
"status": "UP"
},
"apiService": {
"status": "UP"
},
"eucCacheEngine": {
"status": "UP"
},
"cacheEngineClient": {
"status": "UP"
},
"persistenceEngine": {
"status": "UP",
"database": "Microsoft SQL Server",
"hello": 1
},
"tenantPersistenceEngine": {
"status": "UP",
"database": "Microsoft SQL Server",
"hello": 1
},
"diskSpace": {
"status": "UP",
"total": 8460120064,
"free": 4898279424,
"threshold": 10485760
}
}
| "status" | "UP", "DOWN" | Roll-up health check to monitor overall health of the Omnissa Access user interface (UI) |
| "uiServer.status" | "UP", "DOWN" | UP if the main UI service is running |
| "apiService.status" | "UP", "DOWN" | UP if the main UI API service is running |
| "eucCacheEngine.status" | "UP", "DOWN" | UP if the Hazelcast cluster engine is running |
| "cacheEngineClient.status" | "UP", "DOWN" | UP if the Hazelcast client for the UI is running |
| "persistenceEngine.status" | "UP", "DOWN" | UP if the main database (SQL) is running |
| "tenantPersistenceEngine.status" | "UP", "DOWN" | UP if the main database (SQL) is running |
| "diskSpace.status" | "UP", "DOWN" | UP if the free disk space is greater than the threshold configured, 10 MB |
| "diskSpace.free" | Bytes | Space free in Bytes on the partition where the Omnissa Access UI is installed |
Was this page helpful?