Standalone Endpoint Server Configuration Version | 8.4+

After installing a standalone Endpoint server it needs to be configured to communicate with the Certero Application Server, Version 8.2 and prior used a configuration tool to specify the settings. From v8.4 onwards the settings are configured using PowerShell.

Prerequisites

Configure.ps1 is a PowerShell script that requires PowerShell version 5.1 or above to run. It can only be run on the same Endpoint Server that is being configured, and it will report an error if you try to run it on a machine which does not have the Endpoint Server software installed.

File Locations

By default, the script can be found in the Endpoint Server installation directory here:

The script reads and edits xml configuration files in a subdirectory here:

The script can be run from any working directory. The location of the xml files is determined from a registry key.

Built-in Assistance

The script uses standard PowerShell parameter types and you can get built-in help by executing

The script also has customized help which you can see with the ‘Help’ parameter:

PowerShell can also autocomplete parameter names. Start a command like this and press tab after the hyphen to cycle through parameter options:

Reading Configuration

To display the current configuration execute the script without any parameters:

The output looks like this example:

Current configuration:

Writing Configuration

To change a parameter, put a hyphen followed by the parameter name, and follow that with the new value. You can set more than one parameter in one execution of the script. This example shows two parameters being set at the same time:

Parameters

The list of parameters that can be configured are:

• TenantId (Guid): This is the tenant ID of the primary server.

• Hostname (String): This must be the host name of the primary server. Do not enter an IP address as the Endpoint will fail to connect to the primary server via an IP address.

• Port (Integer): This is http(s) port of the primary server.

• SslMode (String): This is the SSL mode of the connection to the primary server. The value is one of:

  • Enabled

  • Disabled

  • IgnoreInvalidCertificates

• FileLimit (Integer): This is the maximum number of data files before collection is forced.

• KeepFiles (Boolean): If True then uploaded data files will be retained.

• TenantsOnly (Boolean): If True then only clients that pass a valid TenantId can communicate with the primary server.

For example:

Parameters for Proxy Server

Some additional parameters are only applicable when using a proxy server to connect to the primary server. If you are not using a proxy server, then set the ProxyServer parameter to an empty string.

• ProxyAddress (String): If using a proxy server, then this is proxy server address. Leave blank if not connecting via a proxy server.

• ProxyAuthScheme (String): This is the authentication scheme for the proxy server. The value is one of:

  • None

  • Anonymous

  • Basic

  • Negotiate

  • Ntlm

• ProxyUsername (String): This parameter is only applicable when the authentication scheme has been set to Basic, Negotiate or Ntlm. This is the user name for the proxy server.

• ProxyPassword (String): This parameter is only applicable when the authentication scheme has been set to Basic, Negotiate or Ntlm. This is the password for the proxy server. Note the password is not shown when reading back the configuration.

Testing the Configuration

The script also allows the current configuration to be tested, by attempting to contact the primary server using the current configuration. Note that you cannot specify new configuration parameters at the same time as running a test. Set the configuration parameters first and then execute a test. To execute a test, use the ‘TestSettings’ switch as shown:

The output will either be “Connection successful” or a report of a connection error.