DVQattest Agent Configuration Settings

Custom Script Configuration Parameters

The following table lists the various configuration settings that can be defined in the DVQattest Agent custom script.

Parameter	Description	Required	Notes
AgentName	The Agent display name. The name string can include template tokens that enable the Agent to construct its own name using various local identifiers. (See Agent Name Template Syntax.) If not defined, the Agent will assign itself a default name.	No	Max length: 64 characters Valid characters: a-z A-Z 0-9 $ * + ? ^ ! . = @ _ \| ~ - :
AgentDescription	An optional description for the Agent.	No	Max length: 256 characters Valid characters: a-z A-Z 0-9 $ * + ? ^ ! . = @ _ \| ~ - : <space>
DomainName	The Agent/Controller management domain name. Management domains are defined in the SQmediator Reporter and shared across Controllers. To connect to a Controller, the Agent must be assigned a domain name and passphrase matching one of the defined management domains. For more information on Agent/Controller management domains, please refer to the SQmediator Reporter Administration Guide.	Yes	Length: 6-64 characters Valid characters: a-z A-Z 0-9 $ * + ? ^ ! . = @ _ \| ~ - :
Passphrase	The Agent/Controller management domain passphrase.	Yes	Length: 8-64 characters Valid characters: a-z A-Z 0-9 # $ * + ? ^ ! . = @ _ \| ~ - :
OrganizationId	The Organization ID. Organization ID and Group ID are optional settings used to automatically associate a DVQattest Agent with a particular resource group and pool license key when the Agent connects to an SQmediator Controller. For more information on Organization ID and Group ID, please refer to the SQmediator Reporter Administration Guide.	No	Max length: 63 characters Valid characters: a-z A-Z 0-9
GroupId	The Organization Group ID.	No	Max length: 63 characters Valid characters: a-z A-Z 0-9
OutboundCtrlAddr	The IP address or Fully Qualified Domain Name (FQDN) for the SQmediator Controller.	Yes
OutboundCtrlPort	The SQmediator Controller port number for incoming Agent connections.	No	Default 40006.

Agent Name Template Syntax

The AgentName string can optionally contain one or more template tokens in the format ^^<token>, where <token> corresponds to one of the token codes listed in the table below. When an Agent is started, it will attempt to dynamically populate its name using the information represented by each token. Note that some information may not be available to the Agent.

Token	Description
a	Active Directory name
e	User email address
g	Last 8 characters of the host GUID
i	Organization Group ID
m	Machine name
n	Username portion of email address
o	Up to the first 8 characters of the Organization ID
p	Agent name prefix
s	2-character operating system code: an Android/Chromebook lx Linux mc macOS wn Windows
u	Username/identity

Tokens can optionally be separated by spaces, hyphens (-), forward slashes (/), backslashes (\), or underscores (_). For example:

Template String	Example Agent Name
^^o-^^s-^^g/^^u	myOrgID-mc-489A26E7/exampleuser
AcmeCorp_^^m-^^i_^^n	AcmeCorp_myMac-myGroupID_emailusername