By default the PerformanceGuard agent uses registry values under the key:
HKEY_LOCAL_MACHINE\SOFTWARE\PremiTech\E2EAgent
If you run the 32-bit agent on 64-bit Windows, the key is HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\PremiTech\E2EAgent.
Note that OEM agents (see Agent OEM Versions) use different keys, and that the used key can be modified by using command line parameters to the agent. The agent can also read the values described here from a configuration file. See Agent Command Line Options for details.
All registry values are of the type REG_SZ, that is strings. If a value is entered as another type, for example DWORD, the PerformanceGuard agent will try to convert it to a string. The agent will then change the type of the value in the registry to REG_SZ.
Stop the PerformanceGuard Agent service while you change agent registry keys: The agent only reads the registry when it starts. This means that it won’t respond to changes made to the registry while it’s running. While the agent is running, it will periodically write the registry values. This means that changes that are made to the registry values will be lost. If you want to change registry values for the agent manually, you should therefore stop the agent while you make the changes.
|
|
| Name: |
BackEndIP |
| Type: |
IP address or hostname |
| Default value: |
performanceguard |
| Description: |
IP address or host name of the computer that runs the PerformanceGuard frontend server. The installation program sets this value. |
|
|
| Name: |
BackEndPort |
| Type: |
TCP port number [1:65535] |
| Default value: |
4001 |
| Description: |
TCP port that the PerformanceGuard frontend server accepts connections on. |
|
|
| Name: |
FrontEndServerList |
| Type: |
List of frontend server end-points |
| Default value: |
|
| Description: |
This is the list of PerformanceGuard frontend servers that the agent will be using. The list consists of tuples of the form <{IP or host name}:{port};{cost}>. If you leave out the port, the agent uses 4001. Example: <192.168.114.67:4001;10><pgfrontend.example.com:4001;10> The agent will select a frontend to connect to, preferring the ones with the lowest cost. For frontend servers with the same cost, an agent will prefer the same random frontend server until restarted. |
|
|
| Name: |
Id |
| Type: |
Integer |
| Default value: |
0 |
| Description: |
This is the agent identifier. The first time the agent connects to the PerformanceGuard frontend server it gets a new identifier. An ID provided by the backend server is always larger than zero. |
|
|
| Name: |
DeliveryRate |
| Type: |
Integer - seconds |
| Default value: |
0 |
| Description: |
This is the time interval with which the agent contacts the PerformanceGuard frontend server. The agent gets the value from the server when it connects (the server’s delivery interval, by default 180 seconds). |
|
|
| Name: |
ConnectionTries |
| Type: |
Integer - number of tries |
| Default value: |
5 |
| Description: |
If the agent has tried to contact the backend this many times without success it has to throw away the reports collected so far. This makes sure that the agent doesn’t deplete memory resources on the monitored computer. |
|
|
| Name: |
Encryption |
| Type: |
One of: 0, 1, -1 |
| Default value: |
-1 |
| Description: |
Controls how communication between the agent and the server is encrypted:
1. -1: The agent will allow both encrypted and unencrypted communication
2. 0: Communicate without encryption
3. 1: Only allow encrypted communication |
|
|
| Name: |
SpoofedClientMAC/NormalClientMAC |
| Type: |
Boolean |
| Default value: |
NormalClientMAC |
| Description: |
If this key is present the agent will report constructed MAC addresses and IP addresses as part of the static computer report. When using this the name of the base registry key is used to change certain properties of the agent. For an agent on computer Arne with real IP = 192.168.101.84 and a registry key like HKEY_LOCAL MACHINE\SOFTWARE\Premitech\A028, the contents of the StaticMachine report will be modified as follows:
1. Computername: Arne*-A028*
2. IP Address: 192.168.28.84
3. MAC Address: *5C-41-30-32-38-54 *(Ascii ‘_’,‘A’,‘0’,‘2’,‘8’ followed by 0x54 last byte from the IP adr.
4. Network : 192.168.28.0/*24 *(fixed length) The registry base name should be five characters or less and the last part should be a number. |
|
|
| Name: |
Promiscous/NoPromiscous |
| Type: |
Boolean |
| Default value: |
NoPromiscous |
| Description: |
If this key is present the agent will place the NIC in promiscuous mode. This means that all traffic present on the segment that the NIC is connected to will be filtered by the agent. This option is typically used with the SpoofedClientIP parameter. |
|
|
| Name: |
ModemConnection/NormalConnection |
| Type: |
Boolean |
| Default value: |
NormalConnection |
| Description: |
In order to minimize data sent from agent computers which are attached through a modem, it’s possible to set ModemConnection (alias: UsesModem). This enables special delivery support for the agent: data is only delivered to the backend collector when there is actually network data to transfer. |
|
|
| Name: |
ForcedDeliveryRate |
| Type: |
Integer - seconds |
| Default value: |
86400 (once a day) |
| Description: |
ForcedDeliveryRate will force data being sent to the backend at regular intervals even when there has been no traffic. This parameter is only effective when ModemConnection is set. |
|
|
| Name: |
AutoRestart |
| Type: |
See description |
| Default value: |
|
| Description: |
If AutoRestart has a value that can be parsed according to the syntax below, it will cause the agent service to be restarted periodically.
List ::= ( [Day] Time* )*
Time ::= Hour [':' Min]
Hour ::= integer
Min ::= integer
Day ::= 'sun' | 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat'
A time without a day applies to every day. All times are local times on the computer that has the agent installed. Example: 02:30 wed 05:00 sat 05:00 would restart the agent service every day at 02:30 and restart it at 05:00 on Wednesdays and Saturdays. If the value is present in the registry, it takes precedence over the Agent Service Restart configuration setting in the agent configuration (default sat 02:00). |
Encryption, ModemConnection, ForcedDeliveryRate and AutoRestart can either be set in the configuration as received from the collector or directly in the registry when the agent is first installed.
|
|
| Name: |
ConfigurationOK/ConfigurationNOK |
| Type: |
Boolean |
| Default value: |
ConfigurationOK |
| Description: |
This value is used by the agent to keep track of configurations. When a configuration is received from the collector, the agent will set the value to “ConfigurationNOK”. When the agent successfully has sent data to the collector, it will change the value to “ConfigurationOK”. When the agent starts it checks the value. If the value is ConfigurationOK the configuration is loaded and started normally. If the value is set to ConfigurationNOK the agent will wait for a new configuration to be sent from the collector. |
|
|
| Name: |
ConfigurationId |
| Type: |
Integer |
| Default value: |
0 |
| Description: |
This is the version number of the configuration. It’s sent to the backend each time reports are sent. |
|
|
| Name: |
MonitoredNicIP |
| Type: |
IP address |
| Default value: |
|
| Description: |
This value is used to force the agent to choose a specific Network Interface Card to monitor. Using this value disables the agent’s capability to change between NICs as connections come and go (see the option FollowRoutingChanges in the following). |
|
|
| Name: |
NicID |
| Type: |
Integer |
| Default value: |
|
| Description: |
Works in a similar way as MonitoredNicIP but based on the number of the NIC. The correct value can be found by using “view adapters” in the Agent Telnet Interface. The preferred way of forcing the agent to use a specific NIC is by using MonitoredNicIP. Note that the options NicID and FollowRoutingChanges (see the following) are mutually exclusive. |
|
|
| Name: |
FollowRoutingChanges/DontFollowRoutingChanges |
| Type: |
Bool |
| Default value: |
FollowRoutingChanges |
| Description: |
This option can be used to control if the agent should check for routing changes. If enabled, the agent will reconfigure itself if the IP address of the used NIC changes or if the MAC address of the default gateway changes. Note that the options FollowRoutingChanges and MonitoredNicIP or NicID are mutually exclusive. |
|
|
| Name: |
CitrixDelay |
| Type: |
Integer - milliseconds |
| Default value: |
250 |
| Description: |
This option controls the delay between an event is received from Citrix Presentation Server and when the PerformanceGuard agent will try to get information about newly created sessions. |
|
|
| Name: |
ServiceStartDelay |
| Type: |
Integer - seconds |
| Default value: |
1 (the installation program sets the value to 5) |
| Description: |
This parameter controls the amount of time that the agent waits before it starts doing anything. It has only effect when the agent is run as a Windows service. If the agent executable is invoked from the command line it starts immediately. |
|
|
| Name: |
GroupHint |
| Type: |
String |
| Default value: |
Can be set by the installation |
| Description: |
If this value is present, the agent will suggest to the collector that it’s placed in a group with the supplied name. When the suggestion has been sent to the collector once, the key is deleted. |
|
|
| Name: |
Version |
| Type: |
String |
| Default value: |
|
| Description: |
This key is set by the agent to a string describing the version of the agent. |
|
|
| Name: |
Configuration |
| Type: |
Configuration string |
| Default value: |
|
| Description: |
The Configuration contains general parameters and parameters for the different reports. The agent stores the configuration that it receives from the server here. See CapaInstaller Integration for an example. |
|
|
| Name: |
TelnetPort |
| Type: |
Integer |
| Default value: |
0 |
| Description: |
This is the TCP port that the agent offers its telnet interface on. If this value is set different from zero in the registry its value is used instead of the value of the configuration parameter from the server with the same name. |
|
|
| Name: |
TelnetClientList |
| Type: |
List of servers and networks |
| Default value: |
Empty |
| Description: |
This is a list of servers and networks that the agent will accept telnet connections from. If this value is found in the registry it overrules the configuration parameter from the PerformanceGuard server with the same name. |
|
|
| Name: |
WebServerPort |
| Type: |
Integer |
| Default value: |
0 |
| Description: |
This is the TCP port that the agent offers its HTTP interface on. The agent uses the registry value only if the configuration from the server doesn’t specify a port. If neither is set, the agent uses port 4007. The agent writes the port that it uses to this value. |
|
|
| Name: |
WebServerClientList |
| Type: |
List of servers and networks |
| Default value: |
Empty |
| Description: |
This is a list of servers and networks that the agent will accept HTTP connections from, in addition to the local host (127.0.0.1/8), which is always allowed. The agent uses the registry value only if the configuration from the server doesn’t specify a list. |
|
|
| Name: |
PCapTimeout |
| Type: |
Integer |
| Default value: |
5 |
| Description: |
Timeout for packet delivery from PGnpf.sys. |
|
|
| Name: |
PCapBufferSize |
| Type: |
Integer - KB |
| Default value: |
1024 |
| Description: |
Buffer size, in KB, for packet delivery from PGnpf.sys. |
|
|
| Name: |
CMSInterface |
| Type: |
Configuration string |
| Default value: |
CMSDir=CMS\
CMSMaxFiles=1120
CMSReportTime=180 |
| Description: |
Configuration string for the CapaInstaller integration. See CapaInstaller Integration. |
|
|
| Name: |
ReportLineFile |
| Type: |
File name |
| Default value: |
|
| Description: |
For testing only. Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
AbsResponseTimeout |
| Type: |
Integer - microseconds |
| Default value: |
500000000 |
| Description: |
Timeout in microseconds. |
|
|
| Name: |
ErrorConfigKeepPeriods |
| Type: |
Integer |
| Default value: |
2 |
| Description: |
Number of configuration periods to keep errors. See Agent Error Logging. |
|
|
| Name: |
FrontEndServerCheckInterval |
| Type: |
Integer - seconds |
| Default value: |
900 |
| Description: |
Seconds between forced check of non-cheapest front end server. |
|
|
| Name: |
LastStartupReportDate |
| Type: |
|
| Default value: |
0 |
| Description: |
Date, in UNIX time, for the last sent startup report. UNIX time, also known as Epoch, is based on the number of seconds that have elapsed since 00:00:00 UTC on 1st January 1970 (not counting leap seconds). For example, 1399548600 corresponds to 11:30:00 on 8th May 2014. Several UNIX time converters are available on the internet. |
|
|
| Name: |
LastStartupReportBriefDate |
| Type: |
|
| Default value: |
0 |
| Description: |
Date, in UNIX time, for the last sent brief startup report. |
|
|
| Name: |
LastLoginReportBriefDate |
| Type: |
|
| Default value: |
0 |
| Description: |
Date, in UNIX time, for the last sent brief login report. |
|
|
| Name: |
ServerClockOffset |
| Type: |
Integer - seconds |
| Default value: |
0 |
| Description: |
Offset between local clock and server clock in seconds. |
|
|
| Name: |
RestartReason |
| Type: |
|
| Default value: |
|
| Description: |
The reason for the last restart of the agent service that the agent initiated itself. See Multi Threaded Service. |
|
|
| Name: |
EkstraIds |
| Type: |
List of integers |
| Default value: |
|
| Description: |
This option is used to make a single agent simulate multiple agents. Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
SpoofedClientIP |
| Type: |
IP address or hostname |
| Default value: |
0.0.0.0 (not used) |
| Description: |
If this key is present, the agent will collect and process network traffic as if the supplied IP address was the local address. This is typically used with Promiscuous parameter. Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
SocketReadTimeOut |
| Type: |
Integer - milliseconds |
| Default value: |
6000 |
| Description: |
This parameter can be used to control the timeout that’s imposed on the communication with the collector process. It specifies the number of milliseconds that the agent will wait for replies from the collector. Values from 0 to 4294967294 milliseconds are supported. If 4294967295 is specified the agent will patiently wait forever. If the value is present in the registry, it takes precedence over the Socket timeout (ms) setting in the agent configuration. Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
SimulateCitrix/RealCitrix |
| Type: |
Boolean |
| Default value: |
RealCitrix |
| Description: |
If this is set to SimulateCitrix, the agent will generate simulated Citrix session and QOS data. The simulated data will be generated regardless of the presence of a MetaFrame server. Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
MultiClient/SingleClient |
| Type: |
Boolean |
| Default value: |
SingleClient |
| Description: |
This parameter controls a special ability of the agent to emulate multiple agents. It needs to be added manually to the registry if used. This key is never changed or created by the agent. Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
Debug/NoDebug |
| Type: |
Boolean |
| Default value: |
NoDebug |
| Description: |
If this key is present the agent will try to write some initialization debug information in the file “c:\agent.log”. This key is never changed or created by the agent. Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
NPFTimingMode |
| Type: |
Integer |
| Default value: |
-1 |
| Description: |
This key is used to manually control the timing base of the packet capture timing. Four different values are supported:
-1: Automatic mode, the agent selects the time base
0: Timestamps generated through KeQueryPerformanceCounter, less reliable on SMP/HyperThreading computers, precision = some microseconds
2: Timestamps generated through KeQuerySystemTime, more reliable on SMP/HyperThreading computers, precision = scheduling quantum (10/15 ms)
3: Timestamps generated through the i386 instruction RDTSC, less reliable on SMP/HyperThreading/SpeedStep computers, precision = some microseconds
Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
SMBtags/NoSMBTags |
| Type: |
Boolean |
| Default value: |
NoSMBTags |
| Description: |
For experimental use only. This key is never changed or created by the agent. Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
BackEndPath |
| Type: |
String |
| Default value: |
|
| Description: |
Path part of URL for use with HTTP based agent-server communication. For experimental use only. Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
TagDebugDir |
| Type: |
String |
| Default value: |
|
| Description: |
Disk folder path to a location that should be used for dumping a tag-parsing debug logging. If a value is specified for this key the agent will start logging information when it parses http tag filters. Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
LogErrorsToFile/DontLogErrorsToFile |
| Type: |
Name of folder |
| Default value: |
|
| Description: |
If the LogErrorsToFile value is set in the registry to the path of an existing folder, the agent will create a log file and log errors in the file. See Agent Error Logging for where the agent creates the file and how it’s named. Some special debugging type messages are only visible in the log file, that is they will never be visible in neither the error display on the agent web service nor transmitted to the PerformanceGuard frontend server. Among these are debugging messages for event processing. Consult CapaSystems technical staff before you use/change this setting. |
|
|
| Name: |
DoValidation/DontDoValidation |
| Type: |
Validate Startup reports (brief and full) |
| Default value: |
DontDoValidation |
| Description: |
If the DoValidation Key is set in the registry, the agent will validate generated startup-full and startup-brief reports. Validation of the reports consists of a number of sanity test of the data in the reports. If the reports don’t pass the tests an error is logged. The error contains an error bit-mask that details which tests has failed. For the startup-full report an additional textual error description is also generated. Consult CapaSystems technical staff before you use/change this setting. |
