controller.properties
Edit the controller.properties file to create and configure global properties for the BigFix® Remote Control controller component to use during a remote control session with a target. The property values apply to the controller component that is used in sessions that are started from the server. The values are the same for every user who runs the controller.
For more information about configuring global controller properties for peer-to-peer remote control sessions, see Configuring global controller properties.
Users can also configure a set of properties locally by using the Configure Controller feature in the controller UI. The local property values override the global property values. For more information about configuring local properties, see Creating a local configuration for the controller.
To enforce the global property value, you can set a property to mandatory so that a user cannot edit the property in the Configuration Window in the controller UI. The mandatory global property overrides the local property. To set a mandatory property, you must manually edit the controller.propreties file. For more information about how to edit the file, see Editing the properties files.
- Open the controller.propreties file.
- For the property that you want to make mandatory, copy the property name and add
.mandatory = true to the end.
For example, to make the Enable Address History property mandatory so that it cannot be edited in the Configuration Window, set the following values:
enable.address.history=false
enable.address.history.mandatory=true - Save the file.
- Click .
The following options can be configured when you edit the controller.propreties file in the server UI.
Running tools on the target during a remote control session
Configure the properties by using the following definition formats.
prefix.ToolName =
Modifiable field | prefix.ToolName |
Field Description | Display name that is used in the Perform Action in target menu. Each defined tool name must have a different prefix. |
Possible Values | User Defined. For example,
tool01.ToolName=Command
Prompt The text, Command Prompt, is displayed in the Perform Action in target menu. |
Value Definition |
prefix.ToolName.$lang$=
Modifiable field | prefix.ToolName.$lang$ |
Field Description | Display name that is used in the Perform Action in target menu. Translation of display name. $lang$ is the ISO language code. |
Possible Values | User Defined. |
Value Definition |
prefix.ToolCommand=
Modifiable Field | prefix.ToolCommand |
Field Description | Command to run the tool, without parameters. |
Possible Values | User Defined. For example,
tool01.ToolCommand=[SystemFolder]\\control.exe The tool command can be a fully qualified path or just the file name. The file must be on the PATH environment variable of the logged in user. You can specify executable files but also files that are associated with an executable file. Do not use quotation marks, even with a path or file name that contain spaces. For example, tool01.ToolCommand=cmd.exe and tool01.ToolCommand=[SystemFolder]\\cmd.exe are equivalent. Note: When you use a
backslash in the path, you must enter two backslashes. You can use the following folder properties when you define Windows™ tools parameters. The target substitutes the values with the actual path on the target system.
Folder properties are not relevant for Linux™ targets. |
Value Definition |
prefix.ToolParameters =
Modifiable field | prefix.ToolParameters |
Field Description | Optional parameters for the command to run. |
Possible Values | User defined |
Value Definition |
prefix.ToolUser =
Modifiable Field | prefix.ToolUser |
Field Description | Determines which privileges or credentials the command is run with. |
Possible Values | <blank> or admin |
Value Definition |
|
Preconfigured tools
The following list of tools are preconfigured and can be edited by using the Edit properties files option.
tool01.ToolName = Control Panel
tool01.ToolCommand = [SystemFolder]\\control.exe
tool01.ToolParameters =
tool01.ToolUser =
tool02.ToolName = Command Prompt
tool02.ToolCommand = [SystemFolder]\\cmd.exe
tool02.ToolParameters =
tool02.ToolUser =
tool03.ToolName = Administrator Command Prompt
tool03.ToolCommand = [SystemFolder]\\cmd.exe
tool03.ToolParameters =
tool03.ToolUser = admin
tool04.ToolName = Task Manager
tool04.ToolCommand = [SystemFolder]\\taskmgr.exe
tool04.ToolParameters =
tool04.ToolUser =
tool05.ToolName = Windows™ Explorer
tool05.ToolCommand = [WindowsFolder]\\explorer.exe
tool05.ToolParameters =
tool05.ToolUser =
tool06.ToolName=Terminal
tool06.ToolCommand=/usr/bin/gnome-terminal
tool06.ToolParameters =
tool06.ToolUser =
tool07.ToolName=Control Panel
tool07.ToolCommand=/usr/bin/gnome-control-center
tool07.ToolParameters =
tool07.ToolUser =
Sending key sequences to the target during a session
Configuration settings to add custom key sequence shortcuts to the controller to inject on the target system during a remote control session. For more information about of the supported key codes, see Send key sequences to the target during a remote control session.keyX.KeySequenceName=
Modifiable field | keyX.KeySequenceName |
Field Description | Display name that is used in the Perform Action in target menu. Each defined key sequence name must have a different prefix. For more information, see Send key sequences to the target during a remote control session. X = 01 to n. |
Possible Values | User Defined. For example,
key01.KeySequenceName
= Inject F1 The text, Inject F1, is displayed in the Perform Action in target menu. |
Value Definition |
keyX.KeySequenceName.language=
Modifiable field | keyX.KeySequenceName.language |
Field Description | Translations for the display name. This property is optional. X = 1 to n |
Possible Values | User Defined. For example,
key01.KeySequenceName.es
= Inyectar F1 |
Value Definition |
keyX.KeySequenceValue=
Modifiable Field | keyX.KeySequenceValue |
Field Description | Macro sequence. The sequences of keys that are defined here are sent to the target system. X = 1 to n |
Possible Values | User Defined. For example,
key01.KeySequenceValue
= [F1] |
Value Definition |
End the session if audit messages cannot be uploaded to the server
Configuration setting to automatically end the session if audit messages cannot be uploaded to the server.abort.on.audit.fail=
Modifiable field | abort.on.audit.fail |
Field Description | During a managed remote control session, when Force session audit is enabled, if the controller fails to send an audit message to the server, the session ends. |
Possible Values | true or false |
Value Definition |
|