-
Title
Script for the KACE Agent Toolkit (KAT) -
Description
It may become necessary to gather logs to troubleshoot a possible agent side issue. The KACE Agent Toolkit (KAT) is used by KACE Support technicians and DIY customers to diagnose and troubleshoot agents/endpoints.
If agents are communicating with the KACE Systems Management Appliance (SMA), it may be possible to run a script to gather the logs instead of running the utility locally.
-
Resolution
The information in the script(s) provided is known to work successfully; however, they have not been officially tested by our Quality Control.
If any of these instructions are changed and/or incorrectly used, intentionally or unintentionally, this solution becomes unsupported by our Support and Development.
Support and Development recommend always making a backup of the current database prior to execution of any script(s) that may modify it.
For customization of the KACE Systems Management Appliance (SMA), please contact our Professional Services Organization.
Please note that it is important to regularly update any script for the KACE Agent Toolkit (KAT) with the most recent executable. When a new executable is released for the KAT, it is usually to add or remove items from the kapture that are no longer or now necessary. Not keeping the script up-to-date may result in not having the necessary logs.
The below is an example of how to create the script for a Windows device. The same can be done for Linux and Mac using the proper installation and parameters. See the README.txt in the KAT for more detailed information. For more information about the KAT, see Using the KACE Agent Toolkit (KAT) (263376).
To create a script:
- Go to Settings | Support | Troubleshooting Tools | KAT | Download and download the latest version of the KAT
- Extract the zipped KAT file to another folder on your PC
- Go to Scripting | Choose Action | New and open a new script
- Name the script
- Leave as an Online Kscript
- Optional: In the Description or Notes, place the URL to this KB on how to create this script
- In the Deploy section, click Manage Operating Systems and choose only Windows
- Click on New Dependency
- Navigate to the installation file
- E.G.: Get the kapture.exe for a Windows device
- Upload the kapture.exe as a dependency
- In the Verify section, click Add
- Verify a file exists
- Directory: $(KACE_DEPENDENCY_DIR)
- File: kapture.exe
- Save Changes
- Verify a file exists
- In the On Success section, click Add
- Launch a program
- Directory: $(KACE_DEPENDENCY_DIR)
- File: kapture.exe
- Check box next to Wait for completion
- Parameters: -d -k -f KACE_KAT_logs.zip
- Save Changes
- Launch a program
- In the On Success section, click Add
- Upload a file
- Directory: $(KACE_DEPENDENCY_DIR)
- File: KACE_KAT_logs.zip
- Save Changes
- Upload a file
- In the Remediation section, click Add (optional step)
- Log message.
- Type: status
- Message: script failed
- Save Changes
- Log message.
- Save the script
Note: The above script can be run on demand, by adding the targeted test device and using Run Now. Once it is complete, the kapture state .zip file can be located in the Uploaded Files section of the device inventory page. Sending this zip file to KACE Support can assist with troubleshooting agent related issues.
Output directories C:\Windows\Temp (Windows) and /tmp (Linux and Mac) are used in the script and can be changed if desired. The script runs at a local system level, so if access to this directory is restricted changes may be necessary.
To obtain the logs uploaded by the script:
- Go to Inventory | Devices and click on the name of the desired device to open the Device Detail
- Scroll down to the Uploaded Files section and expand the section
- Click on the hyperlink of the desired file (KACE_KAT_logs.zip)
Note: Subsequent runs of the script(s) on the same device will overwrite the current uploaded file, unless the output file name is changed in the script(s).