Agent Registry Keys

Name:

BackEndIP

Type:

IP address or hostname

Default value:

performanceguard

Description:

IP address of the computer that runs the PerformanceGuard.

Name:

BackEndPort

Type:

Default value:

4001

Description:

TCP port that the PerformanceGuard collector accepts connections on.

Name:

FrontEndServerList

Type:

List of frontend server end-points

Default value:

Description:

This is the list of PerformanceGuard Front end servers that the agent will be using. The list consists of tuples of the form <{IP}:{port};{cost}>.
Example:
<192.168.114.67:4001;10><bamburu.organization.org: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 Collector it gets a new identifier. An ID provided by the backend server is always larger than zero.

Name:

DeliveryRate

Type:

Integer - seconds

Default value:

180

Description:

This is the time interval with which the agent contacts the PerformanceGuard frontend server.

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 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.
This key is never changed or created by the agent.

Name:

ModemConnection/NormalConnection

Type:

Boolean

Default value:

Description:

In order to minimize data sent from agent computers which are attached through a modem, it's possible to specify the parameter 'usesModem' which could be either true|false', in case it's specified True it enables special delivery support for this agent, that data should only be delivered to the backend collector when there is actually network data to transfer.

Name:

ForcedDeliveryRate

Type:

Integer - seconds

Default value:

0

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 BNF outlined in the following it will cause the agent service to be restarted periodically.
It has the following syntax (BNF)
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="fa19fc2d-b9d6-4688-9319-4a2ca5b177fd"><ac:plain-text-body><![CDATA[List ::= (\\[manu:
]*)*Time ::=\\[':'
]Hour ::= integerMin::= integerDay::= 'sun'

'mon'

'tue'

'wed'

'thu'

'fri'

'sat'
]]></ac:plain-text-body></ac:structured-macro>
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.

Name:

ConfigurationOK/ConfigurationNOK

Type:

Boolean

Default value:

ConfigurationNOK

Description:

This value is used by the agent to keep track of configurations. When is received from the collector, the agent will set the value to "ConfigurationNOK". When the agent successfully has send 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 send 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". 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:

0 (versions prior to 3.4 have a default value of 60)

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:

"# E2E Agent Sample Configuration"

Description:

The Configuration contains general parameters and parameters for the different reports. The parameters are described in the following section.

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 PerformanceGuardserver 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. 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:

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. The local host (127.0.0.1/8) should be included in order to support the system tray icon process that uses the agent web server to communicate with the agent. If this value is found in the registry, it overrules the configuration parameter from the server with the same name.

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
\nCMSMaxFiles=1120 \nCMSReportTime=180

Description:

CMS configuration string.

Name:

ReportLineFile

Type:

File name

Default value:

Description:

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.

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, this text was written at around 1399548600, which 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:

Restart error message.

Name:

ExtraIds

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:

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. This key is never changed or created by the agent.
Consult CapaSystems technical staff before you use/change this setting.

Name:

SocketReadTimeOut

Type:

Integer - milliseconds

Default value:

5000

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. This key is never changed or created by the agent.
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:

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. A value larger than zero enables the feature. 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:

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
This key is never changed or created by the agent.
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:

/customer/premitech

Description:

Path part of URL for use with HTTP based agent-server communication. 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:

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 key is set in the registry, the agent will try to create a log file and log errors in the file. This can be useful for examining the behavior of the agent e.g. during boot and shutdown of the instrumented computer. If a value is specified for the key it will be considered as the name of a folder, the agent will try to create the log files in the named folder first, then it will try the C:\Users\AppData\LocalLow\ folder, and finally the folder where the agent executable is located.
Log files are named GuardAgent--.log
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:

false

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.