CapaInstaller Agent Health Check
The CapaInstaller Agent Health Check keeps the agent healthy and up to date on every computer and server. The health check is the script CapaInstaller Health Check.vbs, which is installed in <Program Files>\CapaInstaller\Agent on each client. On the Management Server, the script is located in the Resources\Agent folder of the share.
When the health check runs
Section titled “When the health check runs”The health check runs automatically on the client:
- The CapaInstaller Stub Service (CIStub) runs the health check before it starts a scheduled agent run.
- The CapaInstaller Service Health Service (ciinstsvc) runs the health check if it hasn’t run for 24 hours. The service is installed on every computer and server during agent deployment.
You can also run the script manually or from an Active Directory startup script. See Run the health check from a startup script.
What the health check does
Section titled “What the health check does”When the health check is started by one of the CapaInstaller services, it does the following:
- Checks the CapaInstaller Service Health Service (ciinstsvc).
- Checks the CapaInstaller Scripting component.
- Checks that the
.cisextension is registered to use the VBScript engine. - Checks the CapaInstaller Stub Service (CIStub).
- Updates the agent files and service files from the Management Server.
- Checks the UUID of the computer. See Non-Unique UUID.
When the health check is started from the command line or from an Active Directory startup script, it only runs the component checks. It doesn’t download any files.
What happens when a check fails
Section titled “What happens when a check fails”If a component check fails, the health check repairs the component with the standard installation method.
If the component can’t be repaired, the health check reports the client as unhealthy to the Management Server. The client is then added to the static group Unhealthy Agents in Configuration Management, and the reason is written to the change log. When the client reports that it’s healthy again, it’s removed from the group.
Run the health check from a startup script
Section titled “Run the health check from a startup script”To run the health check from an Active Directory startup script, use this command:
cscript "\\<ServerName>\<ShareName>\Resources\Agent\CapaInstaller Health Check.vbs" \\<ServerName>\<ShareName>For example:
cscript "\\server01\CapaInstaller\Resources\Agent\CapaInstaller Health Check.vbs" \\server01\CapaInstallerCommand-line arguments
Section titled “Command-line arguments”| Argument | Description |
|---|---|
\\<ServerName>\<ShareName> |
The path to the Management Server. If it’s different from the current Management Server, the client is moved to this Management Server. |
/Debug |
Runs in debug mode and shows debug information. |
/Dontmove |
Doesn’t move the client to the specified Management Server. |
/Force |
Accepted for compatibility with older versions. The component checks always run, so this argument has no effect. |
/? |
Shows the command-line syntax. |
Example with debug information:
cscript "\\server01\CapaInstaller\Resources\Agent\CapaInstaller Health Check.vbs" \\server01\CapaInstaller /DebugLog files
Section titled “Log files”%windir%\Temp\CapaInstaller Healthcheck basecheck_Temp.Logholds the log of the component checks. Older logs are kept for seven days in%windir%\Temp\CIHealth.- When the client uses a file-share-based Management Server, the log of the component checks is also copied to
Units\Computers\HealthCheck\<computer name>.Logon the Management Server share. CapaInstaller Healthcheck.Login the CapaInstaller client log folder holds the log of the file update part of the health check.