Windows Registry Keys definitions for Roaming Clients

Locate Registry Keys

```
HKLM\Software\DNSFilterAgent\Agent
```
```
HKLM\Software\DNS Agent\Agent
```

Registry Key definitions

Use this table to understand Windows Roaming Client Registry settings, their values, and definitions. "Agent" refers to the Windows Roaming Client.

Registry Setting	Value	Description
`Address`	IPv4 address	IPv4 address listening by the agent. For example 127.0.0.1, 127.0.0.2, 127.0.0.3, 127.0.0.4
`AddressIPv6`	IPv6 address	IPv6 address listening by the agent. For example, ::1, 0:0:0:0:0:0:0:1
`ClientId`	GUID	Agent instance identifier used to identify a roaming client by back-end.
`CurrentValues`	base64 encoded string	Current DNS setting values backup in base64 encoded string format.
`CurrentValuesInstallerBackup`	base64 encoded string	DNS setting values backup obtained on agent installation in base64 encoded string format.
`DiagnosticsSharingEnabled`	`true` / `false` Default is `true`	If value is `true` then the agent allows to upload diagnostic results to the back-end. The value populates from App Dashboard settings.
`DNSDomainSuffixList`	comma delimited list Default is empty	Comma delimited list of custom DNS suffixes used to determine local domains. Can be entered into the local domains / resolvers section of windows roaming client settings.
`EnableHyperVSupport`	`true` / `false` Default is `true`	If value is `true` then the agent supports work with Hyper-V setup. Otherwise, there will be conflict between roaming client and Hyper-V.
`Hostname`	string Default is empty	Custom hostname (device name).
`IgnoreInconclusiveDNSResolution`	`true` / `false` Default is `false`	If value is `true` then the agent ignores unresolved SRV and SOA DNS queries and process them as resolved.
`IgnoreVpnInterfaces`	`true` / `false` Default is empty	Defines if VPN network adapters should be ignored by the agent. If value is `true` then VPN adapter will be ignored, otherwise no.
`IgnoreVpnInterfacesDescriptions`	comma delimited list	Comma delimited list of words in lower case which appear in VPN adapter description to identify VPN adapters.
`IgnoreVpnInterfacesNames`	comma delimited list	Comma delimited list of words in lower case which appear in VPN adapter name to identify VPN adapters.
`IgnoreVpnInterfacesServerValue`	`true` / `false` Default is `false`	Defines if VPN network adapters should be ignored by the agent. If value is `true` then VPN adapter will be ignored, otherwise no. This values populates from App Dashboard settings.
`IncludeLocalResolversEdnsRecords`	`true` / `false` Default is `true`	When this setting is set to `true`, the agent sends EDNS options (client ID, user ID and etc) to Local Resolvers specified in App Dashboard.
`InstallARPSystemComponent`	string Default is empty	ARPSYSTEMCOMPONENT argument used on agent installation. This value is used on a roaming client auto update.
`InterfaceInfo`	base64 encoded string	Original DNS setting values backup in base64 encoded string format obtained before setting DNS to loopback address by the agent.
`LastApiSync`	date and time in format yyyy-MM-dd HH:mm:ss Default is empty	Date and time of last Windows logged-on user account synchronization with the back-end.
`LastRemoteDiagnosticsRequest`	date and time in format yyyy-MM-dd HH:mm:ss Default is empty	Date and time of last remote diagnostic request triggered from App Dashboard.
`NetworkKey`	string	Site Secret key from App Dashboard used on agent installation.
`Registered`	`1` / `0`	Agent registration status: 1 - registered 0 - unregistered
`RemoteDiagnosticsEnabled`	`true` / `false` Default is `true`	If value is `true` then the agent allows to run remote diagnostic triggered from App Dashboard. The value populates from App Dashboard settings
`Status`	string	Agent status (deprecated).
`Tags`	string Default is empty	Custom tags associated with the specific agent.
`TrayIcon`	`enabled` / <any string> / empty Default is `enabled`	Defines if show tray icon or no. If value is `enabled` then the tray icon will be shown in tray, otherwise it will be hidden.
`UpstreamIpVersion`	`ipv4` / `ipv6` / `ipv6-ipv4` Default is empty	Defines IP version supported by the agent. Roaming client support IPv4, IPv6 or auto-detection of IP version with higher priority to IPv6. If value is empty then the agent supports IPv4 only.
`UpstreamOrder`	`udp` / `tcp` / `tcp-tls` Default is empty	Comma delimited of using upstreams in specific order. Default set of upstreams is `udp,tcp.tcp-tls`. Can be used any combination of upstreams delimited by comma. For example, `udp` `tcp,tcp-tls` `udp,tcp`
`Username`	string	Current Windows logged-on user account.
`Version`	string	The installed agent version.

How can we help you?

Search

In this article

Locate Registry Keys

Registry Key definitions

Comments