Deploying 1E Client on Windows

TeamViewer DEX Platform 26.1 Green checkmark | 1E Platform 23.11 | 1E Platform on-premises 9.x

Guidance for deploying 1E Client onto Windows computers, including installation and uninstallation.

To upgrade 1E Client, refer to Upgrading 1E Client
To reconfigure 1E Client, refer to Reconfiguring 1E Client

The 1E Client certificate auto-provision feature is not currently available as part of the interactive installation.

Requirements

Review Planning for 1E Client
After installation, review the Verifying - 1E Client page
For details of supported OS platforms, please refer to Common client requirements

1E Client does not have a license key. Even so, you must adhere to the terms of your license agreement.

Deployment choices

You must decide how you will configure the 1E Client and deploy to devices.

Use your existing software deployment tool: For example, Microsoft System Center Configuration Manager. Some organizations may require the 1E Client to be packaged prior to deployment.
Client Deployment Assistant: Designed to help install Windows versions of 1E Client and other 1E agents using Configuration Manager. It includes template transform files for each combination of client and agent for 32-bit and 64-bit platforms, and automatically creates collections and deployments in Configuration Manager, so that you only need to populate the collections. Refer to Client Deployment Assistant

For more information about configuring 1E Client properties during and after installation, refer to 1E Client configuration settings and installer properties.

Windows installation account

The 1E Client installer installs a service as local system, therefore the installation account for Windows clients must be capable of being elevated in order to run the installer. The simplest way of achieving this is for the account to have full local administrator rights (as a member of the localgroup administrators, either directly or indirectly).

Installing the 1E Client interactively

When running the MSI directly or using a command line, ensure the installation account has the required permissions.

Welcome

The welcome screen, click Next to continue.

End-User License Agreement

You must read and then accept this license information by clicking I accept the terms in the license agreement before you can continue with the installation. Once this is done click Next.

Installation Folder

Choose the folder where the 1E Client is installed, by default, this is set to %programfiles%\1E\Client\

You can browse to a new folder by clicking Change.... When you have set a folder, click Next.

1E platform connectivity

Configure how the 1E Client connects with the 1E Platform. If you are installing the 1E Client only to support Content Distribution, Shopping or WakeUp and do not have the 1E Platform installed, do not select Enable 1E Platform connectivity and click Next.

Setting	Description
Enable 1E Platform connectivity	Select this box to enable 1E.
Switch	Sets the name and port of the server where the 1E Switch is located. The default port is 443. If 1E and Content Distribution client features are not required then the connection to 1E Platform is not required, and both Switch and BackgroundChannelUrl settings must be set to none when doing a non-interactive (silent/quiet) install using installer properties on a command-line or in a MST transform file. When doing an interactive install then you must uncheck the Enable 1E checkbox. Client features are not required if the 1E Client is being installed only to support PXE Everwhere, Shopping, or WakeUp. They are only required for Content Distribution if using Content Distribution features of the 1E Platform. To connect to the 1E Platform then Switch will have one or more entries in the format: Switch=<SwitchName>:<SwitchPort> <SwitchName> is the DNS Name FQDN for one or more Switches. This is the same as the following except in a custom configuration where the Switch is installed on its own the: HTTPS Host Header specified on the Website Configuration screen of the 1E Server installer, which is the HTTPS binding for the 1E Web Site. Same as <BackgroundChannelServer>. DNS Name specified in the 1E Server's Web Certificate. <SwitchPort> is the Port number, which has default value of 443. Any other port number is used only in a complex configuration if advised by 1E. In systems where there are multiple DNS Names, there will be multiple entries using a semi-colon (;) as the delimiter between entries. For example: Switch=platform.acme.local:443;platform.acme.com:443 The URLs may differ for Multi-tenant SaaS.
Background Channel URL	Sets the fully qualified URL that the 1E Client will use to connect to the 1E background channel used to transfer large content. If 1E and Content Distribution client features are not required then the connection to 1E Platform is not required, and both Switch and BackgroundChannelUrl settings must be set to none when doing a non-interactive (silent/quiet) install using installer properties on a command-line or in a MST transform file. When doing an interactive install then you must uncheck the Enable 1E checkbox. Client features are not required if the 1E Client is being installed only to support PXE Everwhere, Shopping, or WakeUp. They are only required for Content Distribution if using Content Distribution features of the 1E Platform. To connect to the 1E Platform then BackgroundChannelUrl will have one or more entries in the format: BackgroundChannelUrl=https://<BackgroundChannelServer>:<BackgroundChannelPort>/Background/ <BackgroundChannelServer> is the DNS Name FQDN of the server, which is the same as the: HTTPS Host Header specified on the Website Configuration screen of 1E Server Setup, which is the HTTPS binding for the 1E website. Same as <SwitchName>, refer to SWITCH for details. DNS Name specified in the 1E Server's Web Certificate. <BackgroundChannelPort> is the Port number, which is the same as the: HTTPS Port specified on the Website Configuration screen of 1E Server Setup, which is the HTTPS binding for the 1E website. Default HTTPS port 443, the port can be omitted from the URL. In systems with multiple server and multiple DNS Names, there will be multiple entries on one line using a semi-colon (;) as the delimiter between entries. For example: BackgroundChannelUrl=https://platform.acme.local:443/Background/;https://platform.acme.com:443/Background/ The URLs may differ for Multi-tenant SaaS.
Default Stagger Range Seconds	Sets the scope for the random delay used by the 1E Client to prevent overburdening the 1E Background Channel. Some operations (including HTTPS downloads from the BackgroundChannel) are randomly time-staggered across 1E Platform clients. This property dictates the upper-limit on the default randomization period in seconds. Range is 0 to 3600. Default is 300. Use 0 to instruct 1E Platform client not stagger operations by default. Do not change this value unless advised by 1E. Only use 0 or a low value in systems that support less than 500 clients. This setting is not used for HTTPS downloads from the BackgroundChannel if NomadContentDownloadEnabled is true, because Content Distribution does the bandwidth management.

Content Distribution

When using Content Distribution with Configuration Manager you must enable Content Distribution on Configuration Manager clients and Distribution Points. You can also use the Content Distribution client with 1E to improve the efficiency of content downloads.

The 1E Client Content Distribution module replaces the NomadBranch client from previous versions of Content Distribution.

If you are licensed to use Content Distribution, you should enable it if you have enabled 1E Platform, so that you can take advantage of its content download features that intelligently manage bandwidth, and use its peers when downloading content from the Background Channel and other HTTP/S sources.

You do not require Configuration Manager in order for 1E Platform to use Content Distribution. Refer to Downloading client content and Content Distribution integration.

Setting	Description
Enable Content Distribution	Select this box to enable Content Distribution. Content Distribution is used to support efficient content download for Configuration Manager and 1E Platform. For 1E Platform, its Content Distribution content download feature is enabled by default but only used if Content Distribution is enabled. If Content Distribution is enabled, when the 1E Client starts it will upgrade any previous installation of the NomadBranch client.
Enable Platform features	Select this box to let you configure the Single-Site Download (SSD) options and WakeUp integration. Content Registration only: This configures Content Distribution to use Single Site Download to provide content to peers by registering the content it has in its cache in Content Distribution on the 1E Platform. In the registry SSDEnabled is set to 2 and ContentRegistration is set to 1. This also allows content to be reported in Content Distribution app dashboards and Device View. Typically, content registration should be enabled, unless there is a specific reason for a computer not to be a master. Content Registration is automatically disabled in WinPE. Single-Site Download (SSD) only: This configures Content Distribution to use Single Site Download and consume content hat has been registered in Content Distribution on the 1E Platform. SSD is used as a fallback if the client is unable to find content on the local subnet. In the registry SSDEnabled is set to 1 and ContentRegistration is set to 1. Content Distribution queries Content Distribution on the 1E Platform asking for peers that have registered content. Both enabled: This configures Content Distribution to use Single Site Download so that it can both consume and provide content, as well as report in the Content Distribution app and Device View. In the registry, SSDEnabled is set to 3 and ContentRegistration is set to 1. This is the recommended configuration unless there is a specific reason for a computer not to be a master. Content Registration is automatically disabled in WinPE. Neither enabled: The client does not participate in Single Site Download activities and does not report content details to Content Distribution. In the registry, SSDEnabled is set to 0 and ContentRegistration is set to 0. Enable 1E Platform features has no effect, and is ignored. If you need to enable reporting but prevent the Content Distribution client from acting as an SSD provider, then use installer properties or mst transform files to configure MODULE.NOMAD.SSDENABLED and MODULE.NOMAD.CONTENTREGISTRATION refer to SSDEnabled, ContentRegistration, and Single Site Download. WakeUp integration: If you Select WakeUp integration but not Single Site Download (SSD), any attempt to wake-up peers with particular content will only be on the local subnet. If Single Site Download (SSD) is also selected, Content Distribution will try to wake peers with particular content in neighboring subnets on the site if peers on the local subnet do not wake. The Platform settings are only available if you have enabled 1E. These settings do not affect other Platform features such as Pre-caching.
Use FIPS encryption	Selecting Use FIPS Encryption configures the Content Distribution module to use FIPS-encrypted encrypted communications. You must ensure that Content Distribution is configured with the same FIPS encryption setting on all your 1E Client.

Setting

Description

Enable Content Distribution

Select this box to enable Content Distribution.
Content Distribution is used to support efficient content download for Configuration Manager and 1E Platform. For 1E Platform, its Content Distribution content download feature is enabled by default but only used if Content Distribution is enabled.
If Content Distribution is enabled, when the 1E Client starts it will upgrade any previous installation of the NomadBranch client.

Enable Platform features

Select this box to let you configure the Single-Site Download (SSD) options and WakeUp integration.

Content Registration only: This configures Content Distribution to use Single Site Download to provide content to peers by registering the content it has in its cache in Content Distribution on the 1E Platform. In the registry SSDEnabled is set to 2 and ContentRegistration is set to 1. This also allows content to be reported in Content Distribution app dashboards and Device View.

Typically, content registration should be enabled, unless there is a specific reason for a computer not to be a master. Content Registration is automatically disabled in WinPE.
Single-Site Download (SSD) only: This configures Content Distribution to use Single Site Download and consume content hat has been registered in Content Distribution on the 1E Platform. SSD is used as a fallback if the client is unable to find content on the local subnet. In the registry SSDEnabled is set to 1 and ContentRegistration is set to 1.

Content Distribution queries Content Distribution on the 1E Platform asking for peers that have registered content.
Both enabled: This configures Content Distribution to use Single Site Download so that it can both consume and provide content, as well as report in the Content Distribution app and Device View. In the registry, SSDEnabled is set to 3 and ContentRegistration is set to 1.

This is the recommended configuration unless there is a specific reason for a computer not to be a master. Content Registration is automatically disabled in WinPE.
Neither enabled: The client does not participate in Single Site Download activities and does not report content details to Content Distribution. In the registry, SSDEnabled is set to 0 and ContentRegistration is set to 0.

Enable 1E Platform features has no effect, and is ignored.

If you need to enable reporting but prevent the Content Distribution client from acting as an SSD provider, then use installer properties or mst transform files to configure MODULE.NOMAD.SSDENABLED and MODULE.NOMAD.CONTENTREGISTRATION refer to SSDEnabled, ContentRegistration, and Single Site Download.

WakeUp integration: If you Select WakeUp integration but not Single Site Download (SSD), any attempt to wake-up peers with particular content will only be on the local subnet. If Single Site Download (SSD) is also selected, Content Distribution will try to wake peers with particular content in neighboring subnets on the site if peers on the local subnet do not wake.

The Platform settings are only available if you have enabled 1E. These settings do not affect other Platform features such as Pre-caching.

Use FIPS encryption

Selecting Use FIPS Encryption configures the Content Distribution module to use FIPS-encrypted encrypted communications.
You must ensure that Content Distribution is configured with the same FIPS encryption setting on all your 1E Client.

PXE Everywhere

If you are using PXE Everywhere 4.0, 8.0, 8.1, or Elastic SaaS you must enable PXE Everywhere. The 1E ClientPXE Everywhere Agent client module of the replaces the PXE Everywhere Agent from previous versions of PXE Everywhere.

Setting	Description
Enable PXE Everywhere	Select this box to enable PXE Everywhere Agent client module. If enabled, when the 1E Client starts it will attempt to automatically remove any previous installations of PXE Everywhere Agent. Other fields are only enabled if this box is selected.
PXE Everywhere Central URL	URL for the PXE Everywhere Central web service in the format: http://SERVER/PXELite/PXELiteConfiguration.asmx Where <SERVER> is the name of the server (or FQDN) where the PXE Everywhere Central web service is installed. The http prefix to the URL is case-sensitive and must be entered in all lower case letters. The URL is not verified by the installer, so you will need to ensure that the correct URL is entered.
Use FIPS Encryption	Selecting Use FIPS Encryption configures the PXE Everywhere Agent module to use FIPS encrypted communications. You must ensure that PXE Everywhere is configured with the same FIPS encryption setting on all your 1E Client.
Enable DHCP Snooping support	Enable this option if your network uses DHCP Snooping. You will also need to implement one or more PXE Everywhere Responders as described in DHCP Snooping.

Shopping

If you are using Shopping 6.0 or later, you must enable Shopping. The 1E Client Shopping module replaces the Shopping Agent from previous versions of Shopping.

Setting	Description
Enable Shopping	Select this box to enable Shopping Integration. Shopping must be enabled so that users of a computer can use the 1E Shopping self-service portal, and the 1E Virtual Assistant. If enabled, when the 1E Client starts it will attempt to automatically remove any previous installations of the 1E Shopping Agent.
Shopping Web Site URL	This field is only enabled if the Enable Shopping box is selected. Example: https://shopping.acme.local/Shopping This is the URL of the Shopping Central website, comprising: scheme: Either http or https. host header: DNS Name FQDN - this is the host header configured for the Shopping website, which is normally a DNS Name FQDN. port number: You do not have to provide this if using default port 80 or 443. path: This is always /Shopping. The URL is not verified by the installer, so you will need to ensure that the correct URL is entered.
Enable loopback for Edge and Windows App browsers	Enable this option if users will connect to the Shopping website using Edge or other Metro-style browsers. When users connect to the Shopping Portal, the website needs to get the latest details about the local computer. Shopping may already have details from the Configuration Manager database, but these need to be confirmed and updated. Browser standards only allow websites to get limited information about the user and computer, therefore the website needs to make loopback calls to the local computer via the Shopping client. The following browsers permit loopback calls by default: All versions of Chrome. All versions of Firefox. Non-Metro UI based Internet Explorer browsers (including legacy Internet Explorer). If your Shopping users are using Edge and Metro Internet Explorer browsers, you must enable a Loopback Exemption to allow these browsers to make loopback calls. Exemption affects the browser as a whole and is not just restricted to the Shopping website. Before enabling this option, Select your corporate security policy and be aware of the implications of allowing access between browsers and the local machine. By enabling loopback, you are only setting the Edge/Metro Internet Explorer browsers to the same level of security as other browsers which allow this setting already. If you are running an unattended install, you can use MODULE.SHOPPING.LOOPBACKEXEMPTIONENABLED for all OS but it only works on Windows 8, 8.1, 10 and Windows Server 2012 R2 and later. Shopping client only allows inbound connections to localhost (127.0.0.1) which prevents remote access.

Setting

Description

Enable Shopping

Select this box to enable Shopping Integration.

Shopping must be enabled so that users of a computer can use the 1E Shopping self-service portal, and the 1E Virtual Assistant.

If enabled, when the 1E Client starts it will attempt to automatically remove any previous installations of the 1E Shopping Agent.

Shopping Web Site URL

This field is only enabled if the Enable Shopping box is selected.

Example: https://shopping.acme.local/Shopping

This is the URL of the Shopping Central website, comprising:

scheme: Either http or https.
host header: DNS Name FQDN - this is the host header configured for the Shopping website, which is normally a DNS Name FQDN.
port number: You do not have to provide this if using default port 80 or 443.
path: This is always /Shopping.

The URL is not verified by the installer, so you will need to ensure that the correct URL is entered.

Enable loopback for Edge and Windows App browsers

Enable this option if users will connect to the Shopping website using Edge or other Metro-style browsers.

When users connect to the Shopping Portal, the website needs to get the latest details about the local computer. Shopping may already have details from the Configuration Manager database, but these need to be confirmed and updated.

Browser standards only allow websites to get limited information about the user and computer, therefore the website needs to make loopback calls to the local computer via the Shopping client. The following browsers permit loopback calls by default:

All versions of Chrome.
All versions of Firefox.
Non-Metro UI based Internet Explorer browsers (including legacy Internet Explorer).

If your Shopping users are using Edge and Metro Internet Explorer browsers, you must enable a Loopback Exemption to allow these browsers to make loopback calls. Exemption affects the browser as a whole and is not just restricted to the Shopping website. Before enabling this option, Select your corporate security policy and be aware of the implications of allowing access between browsers and the local machine. By enabling loopback, you are only setting the Edge/Metro Internet Explorer browsers to the same level of security as other browsers which allow this setting already.

If you are running an unattended install, you can use MODULE.SHOPPING.LOOPBACKEXEMPTIONENABLED for all OS but it only works on Windows 8, 8.1, 10 and Windows Server 2012 R2 and later.

Shopping client only allows inbound connections to localhost (127.0.0.1) which prevents remote access.

WakeUp

If you are using version 7.2.500 or later of NightWatchman Management Center or WakeUp Server you must install the 1E Client with this option enabled on client devices and on WakeUp server. The 1E Client WakeUp module replaces the WakeUp Agent from previous versions of the 1E Agent.

When installing on client devices, enable HTTP or HTTPS reporting in order for NightWatchman Management Center to track which subnet the client device is on when it powers down. The WakeUp module reports back subnet changes more frequently than the NightWatchman Agent.

WakeUp Server must be installed before installation of the WakeUp client. If WakeUp client is installed first the WakeUp Server installer only provides the WakeUp Administration console installation option.

When installing on a WakeUp Server, do not enable HTTP or HTTPS reporting, because that prevents the server from appearing as a client in the NightWatchman Management Center Admin Console. This will only disable Agent reporting whilst the WakeUp Server itself should have reporting enabled for reporting statistics.

Enter the DNS Name FQDN for the server hosting the NightWatchman Management Center Web Service, do not enter the full URL.

Setting	Description
Enable WakeUp	Select this box to enable WakeUp integration. WakeUp integration is required to enable 1E WakeUp capabilities on this device. If WakeUp Integration is enabled, when the 1E Client starts it will attempt to automatically remove any previous installation of the 1E WakeUp Agent. The 1E NightWatchman Agent is not affected.
Use FIPS encryption	Selecting Use FIPS Encryption configures the WakeUp module to use FIPS encrypted communications. You must ensure that the NightWatchman Management Center, WakeUp Server and 1E NightWatchman Agent components are all set to the same option.
Enable HTTP reporting	Select this box if the NightWatchman Management Center Web Service is configured to use HTTP and you want communications from the WakeUp module to use HTTP. Do not use this option when installing on a WakeUp Server. When selected you must set the DNS Name FQDN for the server hosting the NightWatchman Management Center Web Service in the edit field provided.
Enable HTTPS reporting	Select this box if the NightWatchman Management Center Web Service is configured to use HTTPS and you want communications from the WakeUp module to use HTTPS. Do not use this option when installing on a WakeUp Server. When selected you must set the DNS Name FQDN for the server hosting the NightWatchman Management Center Web Service in the edit field provided.
Use client certificate (from local certificate store) for HTTPS reporting	This box is only enabled when the Enable HTTPS reporting box is selected. You will need to Select this option if the NightWatchman Management Center Web Service has been configured to request a client certificate. The certificate is retrieved from the local certificate store and is found by providing a certificate issuer or certificate subject search text. The first certificate found that matches the text will be used to authenticate the client with the NightWatchman Management Center Web Service.
Match Certificate Issuer	This option is only enabled when the Use client certificate for HTTPS reporting box is selected. When selected this option sets the search in the local certificate store to match against the certificate issuer field of the certificate.
Match Certificate Subject	This option is only enabled when the Use client certificate for HTTPS reporting box is selected. When selected this option sets the search in the local certificate store to match against the certificate subject field of the certificate.
Search Text	This option is only enabled when the Use client certificate for HTTPS reporting box is selected. When enabled this edit field should be set to the search text used to locate and retrieve the client certificate from the local certificate store. This will be matched against either the certificate issuer or the certificate subject, depending on which option has been selected above.

Ready to Install the 1E Client

Once you have finished entering all the settings, you can begin the installation by clicking on the Install button on this screen.

InstallShield Wizard Completed

After the attempted installation the InstallShield Wizard Completed screen will display the results and give you the option to View the 1E Client installation log file. To exit the installer click the Finish button.

Installing the 1E Client by command-line

In most cases the 1E Client will be installed in quiet mode from the command line using a software deployment tool such as Configuration Manager.

The Client Deployment Assistant is designed to help install Windows versions of 1E Client and other 1E agents using Configuration Manager. It includes template transform files for each combination of client/agent for 32 and 64-bit platforms, and automatically creates collections and deployments in Configuration Manager so that you only need to populate the collections. Refer to Client Deployment Assistant.

Because the expected length of the 1E Client installer command line is likely to exceed the limit imposed by Configuration Manager you will need to use MST transform file(s) for this to work. Please contact your packaging team if you need help creating transform files.

The installer properties listed on this page are for the options visible in the interactive installer above:

1E Client - common settings.
1E Platform client
Content Distribution client
PXE Everywhere Agent
Shopping client
WakeUp client

Additional installer properties are available for:

Some Command-line examples are also provided below.

1E Client

The following are common settings for the 1E Client.

Installer property	Description
INSTALLDIR	Sets the installation folder. This value is not stored in the 1E Client configuration file. This value is stored as InstallationDirectory in the Windows registry under HKLM\SOFTWARE\1E\Client\ and must not be changed. Some client modules that run on Windows store their registry settings under their own keys in HKLM\SOFTWARE\1E. This installer property is for Windows only.

Installer property

Description

INSTALLDIR

Sets the installation folder.

This value is not stored in the 1E Client configuration file.
This value is stored as InstallationDirectory in the Windows registry under HKLM\SOFTWARE\1E\Client\ and must not be changed.
Some client modules that run on Windows store their registry settings under their own keys in HKLM\SOFTWARE\1E.

This installer property is for Windows only.

1E Platform client

When installing the full 1E Client (to be used with the 1E Platform), the following are typical installer properties to use. Additional installer properties are described on the Platform features of the 1E Client page.

As with other Windows installers, uninstallation will leave behind any files, folders and registry entries that were created after installation.

Installer property	Description
BACKGROUNDCHANNELURL	If 1E and Content Distribution client features are not required then the connection to 1E Platform is not required, and both Switch and BackgroundChannelUrl settings must be set to none when doing a non-interactive (silent/quiet) install using installer properties on a command-line or in a MST transform file. When doing an interactive install then you must uncheck the Enable 1E checkbox. Client features are not required if the 1E Client is being installed only to support PXE Everwhere, Shopping, or WakeUp. They are only required for Content Distribution if using Content Distribution features of the 1E Platform. To connect to the 1E Platform then BackgroundChannelUrl will have one or more entries in the format: BackgroundChannelUrl=https://<BackgroundChannelServer>:<BackgroundChannelPort>/Background/ <BackgroundChannelServer> is the DNS Name FQDN of the server, which is the same as the: HTTPS Host Header specified on the Website Configuration screen of 1E Server Setup, which is the HTTPS binding for the 1E website. Same as <SwitchName>, refer to SWITCH for details. DNS Name specified in the 1E Server's Web Certificate. <BackgroundChannelPort> is the Port number, which is the same as the: HTTPS Port specified on the Website Configuration screen of 1E Server Setup, which is the HTTPS binding for the 1E website. Default HTTPS port 443, the port can be omitted from the URL. In systems with multiple server and multiple DNS Names, there will be multiple entries on one line using a semi-colon (;) as the delimiter between entries. For example: BackgroundChannelUrl=https://platform.acme.local:443/Background/;https://platform.acme.com:443/Background/ The URLs may differ for Multi-tenant SaaS.
SWITCH	If 1E and Content Distribution client features are not required then the connection to 1E Platform is not required, and both Switch and BackgroundChannelUrl settings must be set to none when doing a non-interactive (silent/quiet) install using installer properties on a command-line or in a MST transform file. When doing an interactive install then you must uncheck the Enable 1E checkbox. Client features are not required if the 1E Client is being installed only to support PXE Everwhere, Shopping, or WakeUp. They are only required for Content Distribution if using Content Distribution features of the 1E Platform. To connect to the 1E Platform then Switch will have one or more entries in the format: Switch=<SwitchName>:<SwitchPort> <SwitchName> is the DNS Name FQDN for one or more Switches. This is the same as the following except in a custom configuration where the Switch is installed on its own the: HTTPS Host Header specified on the Website Configuration screen of the 1E Server installer, which is the HTTPS binding for the 1E Web Site. Same as <BackgroundChannelServer>. DNS Name specified in the 1E Server's Web Certificate. <SwitchPort> is the Port number, which has default value of 443. Any other port number is used only in a complex configuration if advised by 1E. In systems where there are multiple DNS Names, there will be multiple entries using a semi-colon (;) as the delimiter between entries. For example: Switch=platform.acme.local:443;platform.acme.com:443 The URLs may differ for Multi-tenant SaaS.
DEFAULTSTAGGERRANGESECONDS	Some operations (including HTTPS downloads from the BackgroundChannel) are randomly time-staggered across 1E clients. This property dictates the upper limit on the default randomization period in seconds. Range is 0 to 3600. Default is 300. Use 0 to instruct 1E client not stagger operations by default. Do not change this value unless advised by 1E. Only use 0 or a low value in systems that support less than 500 clients. This setting is not used for HTTPS downloads from the BackgroundChannel if NomadContentDownloadEnabled is true, because Content Distribution does the bandwidth management.

Installer property

Description

BACKGROUNDCHANNELURL

If 1E and Content Distribution client features are not required then the connection to 1E Platform is not required, and both Switch and BackgroundChannelUrl settings must be set to none when doing a non-interactive (silent/quiet) install using installer properties on a command-line or in a MST transform file. When doing an interactive install then you must uncheck the Enable 1E checkbox.

Client features are not required if the 1E Client is being installed only to support PXE Everwhere, Shopping, or WakeUp. They are only required for Content Distribution if using Content Distribution features of the 1E Platform.

To connect to the 1E Platform then BackgroundChannelUrl will have one or more entries in the format:

BackgroundChannelUrl=https://<BackgroundChannelServer>:<BackgroundChannelPort>/Background/

<BackgroundChannelServer> is the DNS Name FQDN of the server, which is the same as the:

HTTPS Host Header specified on the Website Configuration screen of 1E Server Setup, which is the HTTPS binding for the 1E website.
Same as <SwitchName>, refer to SWITCH for details.
DNS Name specified in the 1E Server's Web Certificate.

<BackgroundChannelPort> is the Port number, which is the same as the:

HTTPS Port specified on the Website Configuration screen of 1E Server Setup, which is the HTTPS binding for the 1E website.

Default HTTPS port 443, the port can be omitted from the URL.

In systems with multiple server and multiple DNS Names, there will be multiple entries on one line using a semi-colon (;) as the delimiter between entries. For example:

BackgroundChannelUrl=https://platform.acme.local:443/Background/;https://platform.acme.com:443/Background/

The URLs may differ for Multi-tenant SaaS.

SWITCH

To connect to the 1E Platform then Switch will have one or more entries in the format:

Switch=<SwitchName>:<SwitchPort>

<SwitchName> is the DNS Name FQDN for one or more Switches. This is the same as the following except in a custom configuration where the Switch is installed on its own the:

HTTPS Host Header specified on the Website Configuration screen of the 1E Server installer, which is the HTTPS binding for the 1E Web Site.
Same as <BackgroundChannelServer>.
DNS Name specified in the 1E Server's Web Certificate.

<SwitchPort> is the Port number, which has default value of 443. Any other port number is used only in a complex configuration if advised by 1E.

In systems where there are multiple DNS Names, there will be multiple entries using a semi-colon (;) as the delimiter between entries. For example:

Switch=platform.acme.local:443;platform.acme.com:443

The URLs may differ for Multi-tenant SaaS.

DEFAULTSTAGGERRANGESECONDS

Some operations (including HTTPS downloads from the BackgroundChannel) are randomly time-staggered across 1E clients. This property dictates the upper limit on the default randomization period in seconds.
Range is 0 to 3600. Default is 300.
Use 0 to instruct 1E client not stagger operations by default.

Do not change this value unless advised by 1E. Only use 0 or a low value in systems that support less than 500 clients.

This setting is not used for HTTPS downloads from the BackgroundChannel if NomadContentDownloadEnabled is true, because Content Distribution does the bandwidth management.

The BACKGROUNDCHANNELURL and SWITCH properties are mandatory. If you want to install the 1E Client with the 1E Client modules for Shopping or WakeUp enabled, and the full 1E Platform infrastructure has not been installed, you should set both of these properties to none.

However, note that during an upgrade of 1E Client, you must enable the connection to the 1E Platform, therefore you must define the BACKGROUNDCHANNELURL and SWITCH properties.

Disabling the connection to the 1E Platform is presently only possible for new installations of the 1E Client. If you wish to disable the connection following an upgrade, you must reconfigure the 1E Client once the upgrade has been completed. Refer to Reconfiguring 1E Client after installation.

Content Distribution client

When installing the 1E Client to support Content Distribution 7.0 or later, the following installer properties are available. Additional installer properties are described on the Content Distribution client settings page.

As with other Windows installers, uninstallation will leave behind any files, folders and registry entries that were created after installation.

Installer property	Description
MODULE.NOMAD.ENABLED	Content Distribution is used to support efficient content download for Configuration Manager and 1E Platform. For 1E Platform, the Content Distribution content download feature is enabled by default. If Content Distribution is enabled, when the 1E Client starts it will upgrade any previous installation of the NomadBranch client.
MODULE.NOMAD.PLATFORMURL	This installer property is no longer supported. The Content Distribution installer determines the location of servers from the platform client. Specifically, it communicates with Response Stack Switches and Background Channel.
MODULE.NOMAD.CONTENTREGISTRATION	Set to 1 to enable the Content Distribution client to act as a content provider across subnets when using Single Site Download.
MODULE.NOMAD.SSDENABLED	Set to 1 to enable Single-site download, which requires 1E Platform with Content Distribution. If you enable both Single-Site Download and Content Registration then Content Distribution will make its own content available to other Content Distribution peers. If you enable Single-Site Download but not Content Registration then Content Distribution will be able to fetch downloads from registered peers on other subnets but will not make its own content available.
MODULE.NOMAD.WAKEUPENABLED	Set to 1 to enable WakeUp integration, which requires an ActiveEfficiency Server. If you enable WakeUp integration but not Single Site Download, any attempt to wake-up peers with particular content will only be on the local subnet. If Single Site Download is also selected, Content Distribution will try to wake peers with particular content in neighboring subnets on the site if peers on the local subnet do not wake.
MODULE.NOMAD.USEFIPS	Set to 1 to configure the Content Distribution module to use FIPS encrypted communications. You must ensure that Content Distribution is configured with the same FIPS encryption setting on all your 1E Client.

Previous versions of Content Distribution required a license key (installer property PIDKEY). 1E Client and the Content Distribution client module do not require a license key. Even so, you must adhere to the terms of your license agreement.

PXE Everywhere Agent

When installing the 1E Client to support PXE Everywhere 24.5 or later, the following installer properties are available.

Installer property	Description
MODULE.PXEEVERYWHERE.ENABLED	Set this property to true to enable the PXE Everywhere Agent client module. The default value is false. If enabled, when the 1E Client starts it will attempt to automatically remove any previous installations of PXE Everywhere Agent.
MODULE.PXEEVERYWHERE.CONFIGSERVERURL	URL for the PXE Everywhere Central web service in the format: http://SERVER/PXELite/PXELiteConfiguration.asmx where <SERVER> is the name of the server (or FQDN) where the PXE Everywhere Central web service is installed. The http prefix to the URL is case-sensitive and must be entered in all lower case letters. The URL is not verified by the installer, so you will need to ensure that the correct URL is entered.
MODULE.PXEEVERYWHERE.USEFIPS	You must use the same FIPS encryption setting on all PXE Everywhere Agents. Use of FIPS compliant encryption for communications. 0 – use default encryption 1 – use FIPS encryption.
MODULE.PXEEVERYWHERE.DHCPPORT	This installer property is set to 2067 if Enable DHCP Snooping support is selected during an interactive installation of the 1E Client installer. This is the UDP port on which the PXE Everywhere Agent will listen for PXE requests. If DHCP Snooping is not being used, then this port must be 67 (default), and you do not need to install Responders. When manually installing the PXE Everywhere Agent, if the DHCP Snooping option is enabled in the installer UI, the default port is changed from 67 (43 hex) to 2067 (813 hex). If the MODULE.PXEEVERYWHERE.DHCPPORT installer property is used to specify a port other than 67, the installer UI assumes the DHCP Snooping option is enabled. If DHCP Snooping is being used, then DhcpPort on Agents must be the same value as AltPxeServerPort on Responders. The default value of AltPxeServerPort is 2067. If a value other than 2067 is specified as a custom port number on Agents, you will also need to manually create the AltPxeServerPort (and AltPxeClientPort) registry values on Responders, refer to AltPxeClientPort.

Shopping client

When installing the 1E Client to support Shopping v5.5 or later, the following installer properties are available.

Installer property	Description
MODULE.SHOPPING.ENABLED	Shopping must be enabled so that users of a computer can use the 1E Shopping self-service portal, the Windows Servicing Assistant, and the 1E Virtual Assistant. If enabled, when the 1E Client starts it will attempt to automatically remove any previous installations of the 1E Shopping Agent.
MODULE.SHOPPING.SHOPPINGCENTRALURL	Example: https://shopping.acme.local/Shopping This is the URL of the Shopping Central website, comprising: scheme: Either http or https. host header: DNS Name FQDN - this is the host header configured for the Shopping website, which is normally a DNS Name FQDN. port number: You do not have to provide this if using default port 80 or 443. path: This is always /Shopping.
MODULE.SHOPPING.LOOPBACKEXEMPTIONENABLED	Optional. Default value is false. Set this value to true if users are likely to use Microsoft Edge or other Metro browsers to access the Shopping website. The Shopping client requests this value from the Shopping Central website (admin console setting: Loopback exemption enabled). If the client fails to connect to the website, it defaults to using this local setting and retries later.

Installer property

Description

MODULE.SHOPPING.ENABLED

Shopping must be enabled so that users of a computer can use the 1E Shopping self-service portal, the Windows Servicing Assistant, and the 1E Virtual Assistant.

If enabled, when the 1E Client starts it will attempt to automatically remove any previous installations of the 1E Shopping Agent.

MODULE.SHOPPING.SHOPPINGCENTRALURL

Example: https://shopping.acme.local/Shopping

This is the URL of the Shopping Central website, comprising:

scheme: Either http or https.
host header: DNS Name FQDN - this is the host header configured for the Shopping website, which is normally a DNS Name FQDN.
port number: You do not have to provide this if using default port 80 or 443.
path: This is always /Shopping.

MODULE.SHOPPING.LOOPBACKEXEMPTIONENABLED

Optional. Default value is false. Set this value to true if users are likely to use Microsoft Edge or other Metro browsers to access the Shopping website.

The Shopping client requests this value from the Shopping Central website (admin console setting: Loopback exemption enabled). If the client fails to connect to the website, it defaults to using this local setting and retries later.

WakeUp client

When installing the 1E Client to support the WakeUp component of NightWatchman Enterprise v7.3 or later, the following are typical installer properties to use. Additional installer properties are described on the Wakeup client settings page.

Installer property	Description
MODULE.WAKEUP.ENABLED	Set this property to true to enable the WakeUp client module. The default value is false. Enabling this will also cause any installation of the 1E Agent's WakeUp component to be uninstalled the first time the 1E Client is started, leaving the NightWatchman component if that was installed. When true then you must also specify either the name of the NightWatchman Management Center reporting server, or that reporting is turned off. For details of these and all other installer properties, refer to Wakeup client settings.
MODULE.WAKEUP.USEFIPS	Set to 1 to force the WakeUp agent to use a FIPS-compliant algorithm for: WakeUp Reporting to the NightWatchman Management Center Web Service by setting UseFipsComplianceEncryption registry value to 1. Communication between WakeUp Agents and WakeUp Servers. It will override the MODULE.WAKEUP.ENCRYPTIONLEVEL installer property and set the EncryptionLevel registry value to 3. If enabled, then all components in the NightWatchman and WakeUp system must have FIPS enabled. EncryptionLevel and FIPS settings used by WakeUp do not affect other 1E Client communications.
MODULE.WAKEUP.REPORTING	Enables WakeUp reporting. Sets whether the Agent sends reporting messages to the NightWatchman Management Center Web Service. May be set to one of the following values: ON: Reporting is enabled and messages are forwarded to the NightWatchman server. It is mandatory to specify one of the following: MODULE.WAKEUP.REPORTINGSERVER or MODULE.WAKEUP.SECUREREPORTINGSERVER OFF: No information is reported to the server. When installing the 1E Client on a WakeUp Server, set MODULE.WAKEUP.REPORTING=OFF so that the server does not appear as a client in the NightWatchman Management Center Admin Console. This will only disable Agent reporting whilst the WakeUp Server will have reporting enabled for reporting statistics.
MODULE.WAKEUP.REPORTINGSERVER	Set this parameter to the FQDN (recommended) or NetBIOS name of the server hosting the NightWatchman Management Center Web Service. If HTTP is not using standard port 80 then specify the port number as part of the server name: MODULE.WAKEUP.REPORTINGSERVER="ACMESERVER.ACME.COM:8080" Mandatory when WakeUp reporting is enabled (default) and using HTTP for communications.
MODULE.WAKEUP.SECUREREPORTINGSERVER	Set this parameter to the FQDN (required) or NetBIOS name of the server where the NightWatchman Management Center Web Service component secure site has been installed. If HTTPS is not using standard port 443 then specify the port number as part of the server name: MODULE.WAKEUP.SECUREREPORTINGSERVER="ACMESERVER.ACME.COM:7433" Mandatory when WakeUp reporting is enabled (default) and using HTTP for communications.
MODULE.WAKEUP.CERTISSUER	Specify the text used to search for a client certificate in the client certificate store. Either MODULE.WAKEUP.CERTISSUER or MODULE.WAKEUP.CERTSUBJECT is mandatory when all the following are true: HTTPS communications is being used. MODULE.WAKEUP.SECUREREPORTINGSERVER is configured. SSL Settings for the NightWatchman Management Center Web Service is configured to require a client certificate. If this property is used, it will use the first certificate it finds where the specified text matches the certificate's Issuer CN.
MODULE.WAKEUP.CERTSUBJECT	Specify the text used to search for a client certificate in the client certificate store. Either MODULE.WAKEUP.CERTISSUER or MODULE.WAKEUP.CERTSUBJECT is mandatory when all the following are true: HTTPS communications is being used. MODULE.WAKEUP.SECUREREPORTINGSERVER is configured. SSL Settings for the NightWatchman Management Center Web Service is configured to require a client certificate. If this property is used, it will use the first certificate it finds where the specified text matches the certificate's Issuer CN.

Command-line examples

When installing 1E Client, you should include /l*vx for verbose logging to a log file. The following examples also use /qn for a non-interactive (silent/quiet) installation.

If you want to use the 1E Client certificate auto-provisioning feature for your command-line deployments refer to 1E Client certificate auto-provision.

Example command-line using a MST transform file

Copy

msiexec /i 1E.Client-x64.msi TRANSFORMS="1EClient.mst" /qn /l*vx C:\Windows\temp\1EClient-install.log

An MST typically only works with a specific version of an MSI, therefore you should test before using an old MST file. An MST may work with both 32 and 64-bit versions of an MSI, provided the MST does not contain any transforms that are platform-specific. Please contact your packaging team if you need help creating transform files.

The Client Deployment Assistant is designed to help install Windows versions of 1E Client and other 1E agents using Configuration Manager. It includes template transform files for each combination of client/agent for 32 and 64-bit platforms and automatically creates collections and deployments in Configuration Manager so that you only need to populate the collections.

Example which enables only 1E client

Example Windows 1E Client installer command-line with only the 1E Client features enabled, other client modules are not enabled. 1E uses HTTPS only.

Copy

msiexec /i 1E.Client-x64.msi ^
  SWITCH="tachyon.acme.local:443" ^
  BACKGROUNDCHANNELURL="https://tachyon.acme.local:443/Background/" ^
  /qn ^
  /l*vx C:\Windows\temp\1EClient-install.log

Example which enables only Content Distribution client

Example Windows 1E Client installer command-line with only Content Distribution module enabled, which also requires 1E client features to be enabled. 1E uses HTTPS only.

Copy

msiexec /i 1E.Client-x64.msi ^
  SWITCH="platform.acme.local:443" ^
  BACKGROUNDCHANNELURL="https://platform.acme.local:443/Background/" ^
  MODULE.NOMAD.ENABLED=true ^
  MODULE.NOMAD.CONTENTREGISTRATION=1 ^
  MODULE.NOMAD.SSDENABLED=1 ^
  /qn ^
  /l*vx C:\Windows\temp\1EClient-install.log

Example which enables only PXE Everywhere Agent

Example Windows 1E Client installer command-line with only PXE Everywhere Agent client module enabled, and 1E features disabled (by setting SWITCH and BACKGROUNDCHANNELURL to none). PXE Everywhere uses only HTTP.

Copy

msiexec /i 1E.Client-x64.msi ^
  SWITCH=none ^
  BACKGROUNDCHANNELURL=none ^
  MODULE.PXEEVERYWHERE.ENABLED=true ^
  MODULE.PXEEVERYWHERE.CONFIGSERVERURL="http://pxecentral.acme.local/PXELite/PXELiteConfiguration.asmx" ^
  /qn ^
  /l*vx C:\Windows\temp\1EClient-install.log

Example which enables only Shopping client

Example Windows 1E Client installer command-line with only Shopping client module enabled, and 1E features disabled (by setting SWITCH and BACKGROUNDCHANNELURL to none). Ensure you use HTTP or HTTPS as appropriate.

Copy

msiexec /i 1E.Client-x64.msi ^
  SWITCH=none ^
  BACKGROUNDCHANNELURL=none ^
  MODULE.SHOPPING.ENABLED=true ^
  MODULE.SHOPPING.SHOPPINGCENTRALURL="https://appstore.acme.local/shopping" ^
  MODULE.SHOPPING.LOOPBACKEXEMPTIONENABLED=true ^
  /qn ^
  /l*vx C:\Windows\temp\1EClient-install.log

Example which enables only WakeUp client

Example Windows 1E Client installer command-line with only WakeUp client module enabled, and 1E features disabled (by setting SWITCH and BACKGROUNDCHANNELURL to none).

Copy

msiexec /i 1E.Client-x64.msi ^
  SWITCH=none ^
  BACKGROUNDCHANNELURL=none ^
  MODULE.WAKEUP.ENABLED=true ^
  MODULE.WAKEUP.REPORTINGSERVER="nwmserver.acme.local" ^
  /qn ^
  /l*vx C:\Windows\temp\1EClient-install.log

Sysprep and OS images

The following steps are required if the 1E Client will be included in an OS image.

Stop the 1E Client service.
Stop the NomadBranch service (if Content Distribution is enabled).
Delete the logs folder and its contents. Default is %ALLUSERSPROFILE%\1E\Client
Delete the registry key and its contents HKLM\SOFTWARE\1E\Client
Delete the registry key and its contents HKLM\SOFTWARE\1E\Common
Other registry keys for clients may exist. Please refer to their product documentation for details of sysprepping them.
- HKLM\SOFTWARE\1E\NightWatchman
- HKLM\SOFTWARE\1E\NomadBranch
- HKLM\SOFTWARE\1E\PXEEverywhere
- HKLM\SOFTWARE\1E\WakeUpAgt

You can disable the services during image preparation and re-enable it as an OS Deployment step. The folder and registry keys will be automatically re-created when the services are restarted after the OS is deployed.

By default, the OS resolves %ALLUSERSPROFILE% to C:\ProgramData\

If you have 1E WakeUp client module enabled, or 1E NightWatchman Agent installed, refer to Installing the 1E NightWatchman Agent for Windows.

Uninstalling 1E Client

Manual uninstallation

1E Client can be uninstalled manually by using Windows Apps and Features (appwiz.cpl). A reboot is not normally required.

Disabling a feature or client module

Refer to Reconfiguring 1E Client for examples of how to use the -reconfigure command-line to reconfigure the 1E Client.

Uninstallation using the Windows Installer

1E Client can be uninstalled automatically by using a Windows Installer command line, where the {product code} is dependent on the version of the 1E Client. The example below also includes switches that prevent prompting and restart and creates a log file.

Copy

msiexec /x {BF6F5FA9-64C8-4B72-A6B6-14A582BF96B8} /qn /norestart /l*vx C:\Windows\temp\1EClient-uninstall.log

Tidy up after uninstallation

After the uninstallation of 1E Client, the following is left behind. As with other Windows installers, uninstallation will leave behind any files, folders, and registry entries that were created after installation.

HKLM\SOFTWARE\1E\Common and HKLM\SOFTWARE\1E\NightWatchman are used by the 1E NightWatchman Agent, previously part of the 1E Agent.

Location	Artifacts	Recommendation
Installation folder	None.
Logs folder	Log files remain. Refer to Log files for log file locations of 1E Client and its client modules.	The log files can be deleted or renamed. If not deleted, then a new installation that uses the same logs folder will continue to use the old log file.
Client\Persist folder remains.	Leave this folder which contains status information about current instructions. The Persist folder should be deleted only if you do not intend re-installing the 1E Client with 1E enabled, or when preparing OS images, refer to Sysprep and OS images for details.
1E client registry	HKLM\SOFTWARE\1E\Client\Persist	This registry exists if the 1E Platform client feature of the 1E Client is enabled. It is used to keep a record of hash values for its persistent storage files, which includes status information about current instructions. This registry key should be deleted only if you do not intend re-installing the 1E Client with 1E enabled, or when preparing OS images, refer to Sysprep and OS images for details.
Content Distribution Cache	%ALLUSERSPROFILE%\1E\NomadBranch	The folder should be deleted only if you do not intend re-installing the 1E Client with Content Distribution enabled. Downloaded content is retained so that if the Content Distribution client is re-enabled it will be scanned and re-registered, to make it available for peer sharing with other Content Distribution clients.