HA Properties Configuration File Reference
It is highly recommended that you create a case through the Snow Support Portal to encrypt credentials set in the ha.properties file. Otherwise, you must secure file access so that the credentials cannot be read by anyone logging onto the application server.
Property | Description | Values |
---|---|---|
embotics.cluster.enabled | Indicates whether Commander is deployed as standalone or part of an application cluster. | Initially set to False. True / False |
hibernate.connection.username hibernate.connection.password | Read-only database credentials used by the passive node. Create a case through the Snow Support Portal to encrypt these credentials. | Initially set to None. Username and password pair providing read-only access to the Commander database. Must be a SQL user. |
embotics.cluster.dbuser embotics.cluster.dbpasswd | Database credentials used by the active node. Create a case through the Snow Support Portal to encrypt these credentials. | Initially set to None. Username and password pair providing full access to the Commander database. Must be a SQL user. |
embotics.cluster.rest.user embotics.cluster.rest.password | Commander credentials used by the passive node to check login capability on the active node. Create a case through the Snow Support Portal to encrypt these credentials. | Initially set to None. Username and password pair for a Commander user. |
embotics.cluster.rest.url | The address of the other node in the cluster, including port number if not the default 443. | Initially set to localhost. IP address or hostname for the other Commander node. Examples: |
embotics.cluster.service.id | A unique text string that differentiates nodes in the cluster from one another. Used to populate events in Commander for audit purposes. | Initially set to node_id_1. Any value can be used, if it will provide the information you need to identify the node when auditing logs or events at a later date. |
embotics.cluster.startupDelay | The time in milliseconds that Commander will wait before performing health checks. In the event both nodes start simultaneously, this setting prevents the passive node from taking the active node offline prematurely. | Initially set to 60000. Any numeric value can be used, but this value should always be greater than the time it takes for your Commander nodes to initialize, and greater than the other time configurations in the file. |
embotics.cluster.healthCheckInterval | The frequency in milliseconds with which the passive node will perform health checks against the active node, following the startup delay. | Initially set to 30000. Any numeric value can be used. |
embotics.cluster.errorRetryInterval | The frequency in milliseconds with which the passive node will perform health checks against the active node, following an error. | Initially set to 5000. Any numeric value can be used. |
embotics.cluster.heartBeatErrors | The number of heartbeat errors that must be observed before the passive node will activate. | Initially set to 3. Any numeric value can be used. |
embotics.cluster.loginErrors | The number of login errors that must be observed before the passive node will activate. | Initially set to 10. Any numeric value can be used. |
embotics.cluster.twoFactorErrors | The number of heartbeat errors and login errors that must be observed in the same health check before the passive node will activate. | Initially set to 2. Any numeric value can be used. |
embotics.cluster.heartBeatFrequency | The frequency in milliseconds with which this Commander node will generate heartbeats. | Initially set to 30000. Any numeric value can be used. |
embotics.cluster.quarantine.script | The path to the external script called to quarantine the node being deactivated. | Initially set to C:\\scripts\\ShutdownVM_VC.ps1 Any valid UNC path or file system path to the file. Any backslashes used in the path must be doubled. |
embotics.cluster.quarantine.continueOnFail | Indicates whether or not the passive node will continue to activate if the quarantine of the active node failed. | Initially set to False. True / False |