Skip to main content

1E 23.11 (SaaS)

Installer properties

A list of installer properties included in the base MST files included with Client Deployment Assistant – for the 1E Client (which includes clients for 1E, Shopping, WakeUp and Content Distribution), and NightWatchman Agent.

Where the list indicates an installer property is in the AppImport.xml file, it means the CDA wizard will include add it to the MST transform file if it is not already there.

For details of additional installer properties available for each client, please refer to their respective product documentation, however any additional properties are not supported by the CDA Wizard, but can be manually added to a MST transform file as described in Advanced configuration.

1E Client installer properties - general

Note

These settings affect 1E Client and also affect 1E features of 1E Client.

Note

Settings shown in 1E Client mixed-case are stored in the configuration file. Settings in UPPERCASE are stored in the Windows registry.

Property

Default value

Notes

INSTALLDIR

%PROGRAMFILES%\1E\Client

Where to install the 1E Client. The registry name is InstallationDirectory which must not be changed after installation.

LogPath

%ALLUSERSPROFILE%\1E\Client\1E.Client.log

  • Log file path

  • Can be updated in AppImport.xml

This log is used by 1E Client, 1Efeatures, and Shopping client. Please refer to Log files

LoggingLevel

Info

  • Log level

  • Can be updated in AppImport.xml

REBOOT

ReallySuppress

Suppress the host from rebooting after installation.

The REBOOT property is not in the base MST but is in the install command-line for Nomad in the answer file.

1E Client installer properties - platform client

Property

Default value

Notes

Switch

tachyon.acme.local:4000

  • Switch

  • Can be updated in AppImport.xml

Note

Must have a value in order to enable platform client features.

Must be set to none if 1E feature are not required.

BackgroundChannelUrl

https://tachyon.acme.local:443/Background/

  • Background channel URL

  • Can be updated in AppImport.xml

Note

Must have a value in order to enable platform client features.

Must be set to none if 1E feature are not required.

DefaultStaggerRangeSeconds

300

  • Default stagger range in seconds

  • Can be updated in AppImport.xml

Module.Inventory.Enabled

true

  • Enable Inventory module

  • Can be updated in AppImport.xml

Module.Interaction.Enabled

true

  • Enable Interaction module (Client UI used for Surveys feature)

  • Can be updated in AppImport.xml

Module.Interaction.Port

7766

  • Port used by the Interaction module (Client UI)

  • Can be updated in AppImport.xml

Module.Interaction.DoNotDisturb

false

  • Enable the Interaction Do Not Disturb feature

  • Can be updated in AppImport.xml

Module.Interaction.NotificationIcon

true

  • Enable the Interaction Notification icon

  • Can be updated in AppImport.xml

Module.Interaction.SampleUserInteraction

true

  • Enable the Interaction sampling feature

  • Can be updated in AppImport.xml

AuthenticationPolicy

optional

  • Authentication policy

  • Can be updated in AppImport.xml

ConnectionKeepaliveTimeInSecondsMax

600

  • Maximum time for sending a keep-alive message to the Switch

  • Can be updated in AppImport.xml

ConnectionKeepaliveTimeInSecondsMin

120

  • Minimum time for sending a keep-alive message to the Switch

  • Can be updated in AppImport.xml

ConnectionRetryTimeInSecondsMax

900

  • Maximum time the Agent waits before trying to reconnect to a Switch after a connection failure

  • Can be updated in AppImport.xml

ConnectionRetryTimeInSecondsMin

30

  • Minimum time the Agent waits before trying to reconnect to a Switch after a connection failure

  • Can be updated in AppImport.xml

ConnectionTimeout

30

  • The maximum time in seconds that can elapse between initialising the connection and having a fully established websocket

  • Can be updated in AppImport.xml

CRLChecks

soft

  • Carry out CRL (certificate revolcation list) checks

  • Can be updated in AppImport.xml

CrlTimeoutInSeconds

3

Note

This setting is not supported as an installer property. It is in the AppImport.xml and in the base MST file for 1E Client, but is not used.

EnablePayloadCompression

true

  • Whether the Agent should attempt to compress payloads when responding to instructions

  • Can be updated in AppImport.xml

NomadContentDownloadEnabled

true

  • Whether to integrate with Content Distribution for content download

  • Can be updated in AppImport.xml

NomadContentDownloadTimeoutSecs

600

  • Time limit to wait for Content Distribution to download content before switching to 1E own download mechanism

  • Can be updated in AppImport.xml

SSL

TLSv1.2

  • Switch connection security

  • Can be updated in AppImport.xml

WorkerThreads

2

  • Number of instructions that will execute concurrently

  • Can be updated in AppImport.xml

1E Client installer properties - 1E Client client

Property

Default value

Notes

Module.Nomad.Enabled

false

  • Enable Content Distribution client module

  • Can be updated in AppImport.xml

MODULE.NOMAD.BLOCKSIZE

131072

Minimum size of each block of data Nomad copies from the package source folder.

  • Can be updated in AppImport.xml

  • Registry value: BlockSize

MODULE.NOMAD.DOREPORTINGENABLED

false

Delivery Optimization (DO) Reporting (disabled by default).

  • Can be updated in AppImport.xml

  • Registry value: DeliveryOptimizationReportingEnabled

MODULE.NOMAD.LOGPATH

[WindowsFolder]\CCM\Logs

Folder containing Nomad log file.

  • Can be updated in AppImport.xml

  • Registry value: LogFileName (registry folder plus file name)

Please refer to Log files.

MODULE.NOMAD.MAXLOGSIZE

5242880 (5 MB)

Maximum log size.

  • Can be updated in AppImport.xml (1MB, 5MB,10MB)

  • Registry value: MaxLogFileSize

MODULE.NOMAD.P2PENABLED

9

Peer-to-peer support (enabled with smb with net literal names by default).

  • Cannot be updated in AppImport.xml – ???

  • Registry value: P2PEnabled

MODULE.NOMAD.P2PHTTPPORT

5080

Default HTTP port to use for peer copy.

  • Can be updated in AppImport.xml

  • Registry value: P2PHttpPort

MODULE.NOMAD.P2PHTTPSPORT

5443

Default HTTPS port to use for peer copy.

  • Can be updated in AppImport.xml

  • Registry value: P2PHttpsPort

MODULE.NOMAD.MAXALLOCREQUEST

MODULE.NOMAD.MAXIMUMMEGABYTE

Disabled

Peer backup assistant support.

  • Can be updated in AppImport.xml (when enabled, both MAXALLOCREQUEST and MAXIMUMMEGABYTE = 5120)

  • Registry value: NMDS\MaxAllocRequest * NMDS\MaximumMegabyte

MODULE.NOMAD.SPECIALNETSHARE

  • Default value in MSI is: 0x2060 (8286) - revised 8.1

  • Default value used by CDA is: 0x2070 (8304)

  • Can be partly updated in AppImport.xml (Nomad hidden share & FanOut)

  • Registry value: SpecialNetShare

Bit

Hex

Decimal

Notes

4

0x0010

16

Enable Content Distribution hidden share as NomadSHR$.

5

0x0020

32

Disable broadcast of download statistics. When enabled, Content Distribution broadcasts download statistics to all peers when a download is complete.

6

0x0040

64

Enable Content Distribution FanOut.

13

0x2000

8192

Use HTTP/S or SMB. HTTP/S is automatically used if CM client is detected. Must be set if using CM2007 or if Content Distribution integration is used by Tachyon.

0x2070

8304

MODULE.NOMAD.SSDENABLED

3

Single-site download (enabled as both consumer and provider by default).

  • Can be updated in AppImport.xml

  • Registry value: SSDEnabled

MODULE.NOMAD.SSPBAENABLED

0

Single-site peer backup assistant (disabled by default).

  • Can be updated in AppImport.xml

  • Registry value: SSPBAEnabled

MODULE.NOMAD.STATUSMSGEVENTS

0x0

Status message events.

  • Cannot be updated in AppImport.xml – ???

  • Registry value: StatusMsgEvents

Please refer to Advanced configuration for how to use Orca to edit the base MST file to change this setting.

MODULE.NOMAD.SUCCESSCODES

Enabled

Prevent failover to BITS (0x9999 added to default SuccessCodes).

  • Can be updated in AppImport.xml

  • Registry value: SuccessCodes

MODULE.NOMAD.USEFIPS

false

Use FIPS encryption.

  • Can be updated in AppImport.xml - FIPSEncryption

  • Registry value: EncryptionType

MODULE.NOMAD.COMPATIBILITYFLAGS

1572864

  • Default value in MSI is: 0x2020

  • Default value used by CDA is: 0x2070

Enable compatibility checks.

  • Cannot be updated in AppImport.xml – ???

  • Registry value: CompatibilityFlags

MODULE.NOMAD.PLATFORMURL

MODULE.NOMAD.CONTENTREGISTRATION

User defined

ActiveEfficiency server.

  • Can be updated in AppImport.xml

  • Registry value: ActiveEfficiency\PlatformUrl

    ActiveEfficiency\ContentRegistration

1E Client installer properties - PXE Everywhere Agent

Property

Default value

Notes

Module.PXEEverywhere.Enabled

false

  • Enable PXE Everywhere Agent module

  • Can be updated in AppImport.xml

MODULE.PXEEVERYWHERE.CONFIGSERVERURL

http://pxe.contoso.com/PXELite/PXELiteConfiguration.asmx

  • Enable PXE Everywhere Agent module

  • Can be updated in AppImport.xml

MODULE.PXEEVERYWHERE.LOGPATH

[WindowsFolder]\CCM\Logs

  • Folder containing PXE Everywhere Agent log file.

  • Can be updated in AppImport.xml

MODULE.PXEEVERYWHERE.MAXLOGFILESIZE

10485760

  • Maximum size of the PXE Everywhere Agent log file.

  • Can be updated in AppImport.xml

WindowsADKLocation

C:\Program Files (x86)\Windows Kits\10\Assessment and Deployment Kit

  • This is not an installer property

  • Determines the location of the ADK files to allow CDA to build the PXE boot image

MODULE.PXEEVERYWHERE.USEFIPS

false

  • Enable FIPS encryption

  • Can be updated in AppImport.xml - FIPSEncryption

1E Client installer properties - Shopping client

Property

Default value

Notes

Module.Shopping.Enabled

false

  • Enable Shopping client module

  • Can be updated in AppImport.xml

Module.Shopping.ShoppingCentralUrl

(empty)

  • Shopping Web URL

  • Can be updated in AppImport.xml

Module.Shopping.LoopbackExemptionEnabled

false

  • Enable Edge / Windows app browser support

  • Can be updated in AppImport.xml

Module.Shopping.LocalhostUrl

(empty)

1E Client installer properties - WakeUp client

Property

Default value

Notes

Module.WakeUp.Enabled

false

  • Enable WakeUp client module

  • Can be updated in AppImport.xml

MODULE.WAKEUP.LOGPATH

[WindowsFolder]CCM\Logs

  • Set the path for the WakeUp Agent logfile

  • Can be updated in AppImport.xml

MODULE.WAKEUP.MAXLOGFILESIZE

5242880

  • Set the size of the WakeUp Agent logfile

  • Can be updated in AppImport.xml

MODULE.WAKEUP.REPORTING

OFF

  • Enable WakeUp status message reporting to a NightWatchman server

  • Can be updated in AppImport.xml

  • Can also be set in registry by setting HKLM\Software\1E\WakeUpAgt Reporting REG_SZ value to "ON"

MODULE.WAKEUP.REPORTINGSERVER

(empty)

  • Can be updated in AppImport.xml

  • Can also be set in registry by setting HKLM\Software\1E\WakeUpAgt\Reporting\HTTP ServiceUrl REG_SZ value

MODULE.WAKEUP.SECUREREPORTINGSERVER

(empty)

  • Can be updated in AppImport.xml

  • Can also be set in registry by setting HKLM\Software\1E\WakeUpAgt\Reporting\HTTPS ServiceUrl REG_SZ value

MODULE.WAKEUP.USEFIPS

0 (off)

  • Enable FIPS compliance in WakeUp module

  • Can be updated in AppImport.xml

  • Can also be set in registry by setting HKLM\Software\1E\WakeUpAgt\Reporting UseFipsComplianceEncryption REG_DWORD value to 1

1E NightWatchman Agent installer properties

Property

Default value

Notes

REBOOT

ReallySuppress

Suppress the host from rebooting after installation.

The REBOOT property is not in the base MST but is in the install command-line for PXE Everywhere in the answer file.