Since the release of Passware Kit 2024.1 and Resource Manager introduction, certain changes have been made to Passware Kit Agents. Both Passware Kit Agent for Windows and Linux now use the same configuration file - PasswareKitAgentSettings.ini (previously Settings.ini for Windows and agent.conf for Linux).
By default, this file is located as follows:
- Windows: ...\User\AppData\Roaming\Passware\SearchAgent
- Linux: included in the provided tar.gz archive, located in the same folder as the Agent’s executable file
The file contains settings applied for Passware Kit Agent that are different from the defaults. The following examples illustrate the structure of the file:
Windows
[Acceleration]
Exclude = "cpu1, gpu1"
GpuOverheatTemperature = "97"
GpuPerformanceThreshold = "50"
[Dictionaries]
DictionaryPath = "C:\Users\John\AppData\Roaming\Passware\Passware Kit\Dictionaries\"
DictionaryPath = "C:\Users\John\AppData\Roaming\Passware\SearchAgent\Dictionaries\"
[General]
DisplayName = "LAB01-KT"
SettingsVersion = "2"
[Network]
AgentPort = "10778"
AssignMode = "manual"
ConnectionPassword = "NjkfELj9cOJFKHLguThN6A=="
ServerAddress = "LAB01@10.8.3.18"
Linux
[Dictionaries]
DictionaryPath = "/home/user/Applications/passware-kit-agent-64bit/Dictionary/"
DictionaryPath = "/tmp/pk-agent/Dictionaries/"
[General]
SettingsFolder = "/tmp/pk-agent/"
SettingsVersion = "2"
UpdatesFolder = "/tmp/pk-agent/updates/"
[Logging]
LogsFolder = "/tmp/pk-agent/"
[Network]
AssignMode = "manual"
ServerAddress = "192.168.1.106"
ServerPort = "10779"
Passware Tip: The default config file PasswareKitAgentSettings.default.ini, with all the values present and explained, can be created by launching Passware Kit Agent from the command line with the --default-settings argument.
Passware Tip: Storing large dictionaries directly on the Agent is recommended to prevent a reduction in recovery speed caused by transferring dictionaries from the PKF to the Agent.
Below is a table describing the available CLI arguments and setting values:
Setting | Default Value | CLI argument (short,long) |
Comments |
---|---|---|---|
GENERAL | |||
SettingsVersion | 2 | ||
SettingsFolder | /tmp/pk-agent/ | Linux, default | |
UpdatesFolder | /tmp/pk-agent/updates/ | Linux, default | |
DisplayName | display-name | Can be set to anything, machine name by default | |
Description | Can be set to anything | ||
IsAutoUpdateEnabled | true | ||
ACCELERATION | |||
Exclude | |||
GpuPerformanceThreshold | 100 | ||
DisableGpuOnUserActivity | false | ||
UserInactivityTimeout | 300 sec. | ||
GpuMemoryUsageLimit | Value is in bytes, i.e. 1073741824=1GB | ||
DisableGpuOnOverheat | true | We do not recommend changing this to prevent the GPU from a failure | |
GpuOverheatTemperature | 85 | Change according to your GPU’s max recommended value | |
NETWORK | |||
AssignMode | auto | assign-mode | Windows, Linux Can be changed to ‘manual’ |
BroadcastAddress | 255.255.255.255 | b, broadcast-address | Windows, Linux |
ConnectionPassword | - | set-password | Windows, Linux |
ServerAddress | - | r, server-address | Windows, Linux |
ServerPort | 10777 | s, server-port | Windows, Linux Zero disables auto discovery service |
AgentPort | 10776 | a, agent-port | Windows, Linux |
CompatibleAgentPort | 10555 | compatible-agent-port | Windows, Linux For Servers older than 2024v1 |
DICTIONARIES | |||
DictionaryPath | Multiple paths are permitted | ||
LOGGING | |||
LogsFolder | /tmp/pk-agent/ | Linux | |
LogFileName | passware-kit-agent.log | Linux |
The Agent settings can be modified directly in the Passware Kit (Server) under Tools | Resource Manager when the Agent is connected. The settings will be saved to PasswareKitAgentSettings.ini and applied upon the Agent’s next launch.
Passware Tip: Two environmental variables are available for the above mentioned settings:
- PASSWARE_GPU_MEMORY_USAGE_LIMIT for GpuMemoryUsageLimit
- PASSWARE_DICTIONARIES_PATH for DictionaryPath
For enhanced security and access control, a connection password can be set for the Agent. This password is encrypted within the PasswareKitAgentSettings.ini file. It can be modified through the Passware Kit (Server) or directly on the Agent using the ConnectionPassword argument.
Cloud Agents require a connection password for operation.
Additional CLI arguments:
Short name | Full name | Comment |
c | config | Windows, Linux |
f | force | Windows, Linux |
l | list-hardware | Linux |
m | minimize | Windows |
w | wait | Windows, Linux |
core-dump | Linux |
Comments
0 comments
Article is closed for comments.