Skip to main content

1E 9.x (on-premises)

Content Distribution client settings

Installer properties and configuration file settings for the Content Distribution client module of the 1E Client, which is supported only on Windows computers.

Note

Installer properties:

Module.Nomad.Enabled | MODULE.NOMAD.AUTHENTICATEDUSERS | MODULE.NOMAD.BLOCKSIZE | MODULE.NOMAD.CACHECLEANCYCLEHRS | MODULE.NOMAD.CACHECLEANSUBNETLOOKUP | MODULE.NOMAD.CACHEPATH | | MODULE.NOMAD.CACHESTATESYNCINTERVALMINUTES | MODULE.NOMAD.CERTISSUER | MODULE.NOMAD.CERTSUBJECT | MODULE.NOMAD.COMPATIBILITYFLAGS | MODULE.NOMAD.CONTENTPROVIDERONWIFI | MODULE.NOMAD.CONTENTREGISTRATION | MODULE.NOMAD.DEBUG | MODULE.NOMAD.DOREPORTINGENABLED | MODULE.NOMAD.DOWNLOADTIMEOUT | | MODULE.NOMAD.DPCACHECLEANUPENABLED | MODULE.NOMAD.DPNOTAVAILABLECODES | MODULE.NOMAD.ENFORCEQUOTAS | MODULE.NOMAD.GENERATEWEREVENTS | MODULE.NOMAD.HAACKTIMEOUTMINS | MODULE.NOMAD.LOCALSSDSTAGGER | MODULE.NOMAD.LOGNAME | MODULE.NOMAD.LOGPATH | MODULE.NOMAD.MADCAPSCOPE | MODULE.NOMAD.MAXALLOCREQUEST | MODULE.NOMAD.MAXCACHEDAYS | | MODULE.NOMAD.MAXCACHEDAYSTHRESHOLD | MODULE.NOMAD.MAXCACHESIZEMB | MODULE.NOMAD.MAXCONCURRENCY | MODULE.NOMAD.MAXDEVICESFROMAE | MODULE.NOMAD.MAXELECTIONRESPONSELOGGING | MODULE.NOMAD.MAXIMUMMEGABYTE | MODULE.NOMAD.MAXLOGSIZE | MODULE.NOMAD.MAXPACKAGEFAST | MODULE.NOMAD.MAXPACKAGERAS | MODULE.NOMAD.MAXPACKAGESLOW | MODULE.NOMAD.MAXPACKETSPERSECOND | MODULE.NOMAD.MAXPRECACHEDAYS | MODULE.NOMAD.MAXSTATUSFREQUENCY | | MODULE.NOMAD.MAXSTUCKCOUNT | MODULE.NOMAD.MAXSUCACHEDAYS | MODULE.NOMAD.MULTICASTSUPPORT | MODULE.NOMAD.NOHARDLINK | MODULE.NOMAD.NOMADINHIBITEDADSITES | MODULE.NOMAD.NOMADINHIBITEDSUBNETS | | MODULE.NOMAD.P2PDISQUALIFYMAXNUMPEERS | | MODULE.NOMAD.P2PDISQUALIFYMAXWINDOWMINS | MODULE.NOMAD.P2PENABLED | MODULE.NOMAD.P2PHTTPPORT | MODULE.NOMAD.P2PHTTPSPORT | MODULE.NOMAD.P2PPORT | MODULE.NOMAD.P2PSSLSETTINGS | MODULE.NOMAD.PERCENTAVAILABLEDISK | MODULE.NOMAD.PERMITTEDLSZSHARES | MODULE.NOMAD.PERMITUNCACHED | MODULE.NOMAD.PLATFORMURL | MODULE.NOMAD.POSTCOMPLETETIMEOUTHOURS | MODULE.NOMAD.PRECACHEPOLLBATCHSIZE | MODULE.NOMAD.PRECACHEPOLLMINUTES | MODULE.NOMAD.PRECOMPLETETIMEOUTHOURS | MODULE.NOMAD.RECYCLEDPDELAY | | MODULE.NOMAD.RANDOMIZEREMOTEPATHS | MODULE.NOMAD.SIGSFOLDER | MODULE.NOMAD.SITESSDSTAGGER | | MODULE.NOMAD.SITESSDMINPACKAGESIZEKB | MODULE.NOMAD.SPECIALNETSHARE | MODULE.NOMAD.SSDENABLED | MODULE.NOMAD.SSPBAENABLED | MODULE.NOMAD.STATUSMSGEVENTS | MODULE.NOMAD.SUCCESSCODES | | MODULE.NOMAD.SUPPORTWPAD | MODULE.NOMAD.USEFIPS | MODULE.NOMAD.WAKEUPBATCHSIZE | MODULE.NOMAD.WAKEUPENABLED | MODULE.NOMAD.WAKEUPMINPACKAGESIZEMB | MODULE.NOMAD.WLANBLIPSECS | MODULE.NOMAD.WLANPROFILELIST

Note

Configuration file settings:

Module.Nomad.Enabled

Note

The Content Distribution client module of 1E Client replaces the legacy NomadBranch component of Content Distribution.

When the 1E Client starts, and the Content Distribution client module is enabled, it will only initialize the Content Distribution client module if the OS version is a supported Windows version. The 1E Client will automatically remove any previous installation of NomadBranch, keeping relevant NomadBranch registry settings.

The 1E Client Content Distribution client module is not supported on:

  • Non-Windows devices

  • Legacy OS (that is OS which Microsoft no longer support including XP, Vista, Server 2008 etc.)

1E Client installers include a template configuration file that contains the more important settings with default values that match hard-coded default values. The configuration file is updated during installation and named 1E.Client.conf in the installation folder along with the 1E Client executable.

After installation, configuration file settings can be managed using 1E Client command-line parameters, Endpoint Troubleshooting configuration instructions, Endpoint Automation policies, Configuration Manager baselines or other means. Registry settings can also be managed by Windows Group Policy.

The following table shows the supported installer properties for the Content Distribution client module of the 1E Client.

Note

Each installer property listed below has a link to its corresponding registry value page.

Nomad client settings

Note

You must use UPPERCASE when specifying the name of any installer property in a mst transform file, and preferably when including them in a msiexec command-line.

Names of settings stored in the configuration file are not case-sensitive. Setting names stored in the registry may be case-sensitive and should be specified as shown.

Settings that have numeric values must be set using decimal integers, unless otherwise specified.

Installer property

Description

Module.Nomad.Enabled

Set this property to true to enable the Nomad client module. The default value is false.

Note

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

This setting does not have an associated Nomad registry entry and is stored in the 1E Client configuration file.

MODULE.NOMAD.AUTHENTICATEDUSERS

Determines which of the built-in security groups is granted read-only permissions to the Nomad cache.

Registry value

Default value

Notes

AuthenticatedUsers

1

Grants read-only access to the Nomad cache as follows:

  • 0 – Everyone built-in security group and the SMSNomadP2P& Nomad share account. This is the least restrictive option and is not valid with HTTP or HTTPS protocol and is treated as 2 (only the SMSNomadP2P& Nomad share account)

  • 1 – Authenticated Users built-in security group and the SMSNomadP2P& Nomad share account

  • 2 – Only the SMSNomadP2P& Nomad share account. This account has also been added to NTFS permission settings.

Unauthorised HTTP requests to access the caches are met with a 403 status code.

The Nomad share has more information about share permissions and NTFS security. The difference between Authenticated Users and Everyone depends on the OS version, but in general Everyone includes Authenticated Users plus Guest.

MODULE.NOMAD.BLOCKSIZE

Value (in bytes) for the minimum size of each block of data Nomad copies from the package source folder.

Click here to expand...

Value (in bytes) for the minimum size of each block of data Nomad copies from the package source folder.

Note

Any change to this value requires a manual service restart before it can take effect.

Registry value

Default value

Notes

BlockSize

131072(128KB)

Must be between 4096(4KB) to 4194304(4MB) inclusive.

  • The default block size is 128KB

  • The maximum block size is 4MB

  • Multicast environments can only use the default block size. If you define a larger value for multicast environments, Nomad automatically resets it to the default.

  • Clients use the block size defined in the registry and ignore the values from the LSZ

The Dynamic Block Size (DBS) feature increases block size on high-bandwidth links to get maximum efficiency, and reduces it on low-bandwidth links to reduce the impact. Using DBS, Nomad is able to automatically decide the appropriate block size for a given link bandwidth and also adjust it as needed during the download if the link conditions change. As a result, Nomad is far more efficient and faster on all types of connection bandwidths while retaining its minimal impact on other link traffic.

Note

DBS is enabled or disabled by configuring Bit 25 in the CompatibilityFlags registry. Setting Bit 25 disables DBS and clearing Bit 25 enables DBS.

In Nomad 7.0 onwards, the DBS feature is turned off by default for new installations, and not changed for upgrades.

Prior to v6.3 the default value of BlockSize registry setting was 32KB (0x8000). From v6.3 onwards the default is 128KB (0x20000).

The installer automatically sets this to 128KB for both fresh installs and upgrades from previous versions. The only exceptions to this are:

  • It will use the specified value if the BLOCKSIZE property is used in the installation command line or in a MST transform, when doing a fresh install or upgrade

  • It will retain the previous value of BLOCKSIZE if it was set to anything other than 32KB (the older default), when doing an upgrade.

MODULE.NOMAD.CACHECLEANCYCLEHRS

Determines the number of hours between automatically running the Nomad cache cleaner.

Click here to expand...

Determines the number of hours between automatically running the Nomad cache cleaner.

Registry value

Default value

Notes

CacheCleanCycleHrs

0 (turned off)

The first automatic cache clean runs randomly between 10 to 60 mins of service start up. Subsequent cache clean cycles run after the number of hours specified.

0 means feature turned off. No cache cleaning cycle would run. Changing this registry entry performs an internal restart.

The minimum value is 4.

The maximum value is 168 (Once a week)

Please refer to Cache management for details about other cache management settings.

MODULE.NOMAD.CACHECLEANSUBNETLOOKUP

If enabled, sets the cache clean subnet lookup.

Click here to expand...

If enabled, sets the cache clean subnet lookup.

Registry value

Type

Default value

Notes

CacheCleanSubnetLookup

REG_DWORD

1

Before deleting content, Nomad checks if it is on any other client in the same subnet, and will only delete local content if the same is present on at least one other client on the same subnet.

To disable subnet lookup, set the value to 0. Its value can be 0 or 1.

The default value is 1, subnet lookup is enabled.

New setting introduced in 8.0.

Please refer to Cache management for details about other cache management settings.

MODULE.NOMAD.CACHEPATH

Determines the value of :

  • NomadBranch\LocalCachePath - the location of local Nomad package cache

Click here to expand LocalCachePath...

The location of local Nomad package cache.

Registry value

Default value

Notes

LocalCachePath

%ALLUSERSPROFILE%\1E\NomadBranch\

There are two registry values called LocalCachePath that are used by Nomad.

  • The LocalCachePath REG_SZ registry value under the HKLM\Software\1E\NomadBranch key sets the path to the local Nomad package cache.

  • The LocalCachePath REG_SZ registry value under the HKLM\Software\1E\NomadBranch\NMDS key sets the path to the PBA package cache.

The path is created if it does not exist. If the drive letter does not exist, and it is not possible to create the specified path, %TEMP% is used. Default values are dependent on OS.

Known issue fixed in latest accumulated hotfix

The value for the installer property CACHEPATH requires a trailing backslash \. When Nomad is installed on a DP this location is also used for the LSZFiles vDir folder. If LocalCachePath does not contain a trailing backslash, then:

  • the LSZFILES folder is incorrectly created (LocalCachePathLSZFILES instead of LocalCachePath\LSZFILES)

  • IIS vDIR points to wrong folder (LocalCachePathLSZFILES instead of LocalCachePath\LSZFILES)

  • LSZGEN fails because it is attempting to store LSZ files to non-existent path (LocalCachePath\LSZFILES)

PBA cache is also derived from the same installer property MODULE.NOMAD.CACHEPATH, but it is stored in the registry value> CachePath in the NomadBranch\NMDS registry key.

  • NomadBranch\NMDS\CachePath - the location of the base peer backup assistant (PBS) share where user data is copied to

Click here to expand CachePath...

This value holds the location of the base peer backup assistant (PBS) share where user data is copied to.

Registry value

Default value

Notes

CachePath

<NomadCachePath>\NMDS

This REG_SZ registry value is found under the PBA registry key NomadBranch\NMDS. This parameter relies on the folder it points to as being configured as a share. In normal circumstances, this should not be modified from the default value.

The MODULE.NOMAD.CACHEPATH installer property also used to configure the location of the Nomad cache, which is stored in the registry value LocalCachePath. The location of the PBA cache is derived from the MODULE.NOMAD.CACHEPATH property, and is stored in the registry value CachePath in the NomadBranch\NMDS registry key.

MODULE.NOMAD.CACHESTATESYNCINTERVALMINUTES

Ensures the cache state of a device held on ContentDistribution is in sync with locally held data. This setting controls the Content Registration Sync Cycle feature.

Registry value

Default value

Notes

CacheStateSyncIntervalMinutes

1440 (1day)

Range: from 60 to 525600 (1Year).

The Content Registration Sync Cycle is available in the following versions of 1E Client, where the Nomad client registers pending and failed content registrations with ActiveEfficiency or Tachyon Platform. Please refer to Single Site Download: Improved resilience of content registration.

  • Nomad 8.0 in 1E Client 5.2 - uses Content Distribution in Tachyon Platform

  • Nomad 7.1 in 1E Client 5.2 - uses Content Distribution in Tachyon Platform

  • Nomad 7.0.200 in 1E Client 5.1 - uses ActiveEfficiency

  • Nomad 7.0.100 in 1E Client 5.0 - uses ActiveEfficiency

  • Nomad 7.0 in 1E Client 4.1 - uses ActiveEfficiency

MODULE.NOMAD.CERTISSUER

Defines one or more certificate issuers that Nomad will use to select the appropriate PKI certificate for the:

  • Configuration Manager (CM) client authentication certificate - used when downloading over HTTPS from Distribution Points and when communicating with Management Points during pre-caching

  • Nomad Server Authentication certificate - used to share content between peers over HTTPS

  • Client Authentication certificate - used for certificate-based client authentication when sharing content between peers over HTTPS.

In most cases Nomad will be able to identify a suitable certificate in the Local Computer Personal certificate store without needing to specify CertIssuer (refer to Peer copy over HTTP or HTTPS: Certificate Selection for more details). You should use CertIssuer if the CM client is not using PKI certificates and there are multiple Client Authentication certificates issued by different Certificate Authorities in the store, and if there is a chance some of those certificates may not be trusted by other peers or CM site systems.

Click here to expand...

Defines one or more certificate issuers that Nomad will use to select the appropriate PKI certificate for the:

  • Configuration Manager (CM) client authentication certificate - used when downloading over HTTPS from Distribution Points and when communicating with Management Points during pre-caching

  • Nomad Server Authentication certificate - used to share content between peers over HTTPS

  • Client Authentication certificate - used for certificate-based client authentication when sharing content between peers over HTTPS.

In most cases Nomad will be able to identify a suitable certificate in the Local Computer Personal certificate store without needing to specify CertIssuer (refer to Peer copy over HTTP or HTTPS: Certificate Selection for more details). You should use CertIssuer if the CM client is not using PKI certificates and there are multiple Client Authentication certificates issued by different Certificate Authorities in the store, and if there is a chance some of those certificates may not be trusted by other peers or CM site systems.

Registry value

Default value

Notes

CertIssuer

" "

Set this value to the name of the certificate issuer (Certificate Authority (CA)) that Nomad should use to select the appropriate PKI certificate. A case-insensitive substring-within-a-string match is performed.

If you have multiple CAs you can specify a:

  • Common sub-string (e.g. "CORPCA" would work for certificates issued by CORPCA1 or CORPCA2)

  • Comma-separated list of certificate issuers (both exact names or substrings are acceptable values). For example, "DigiCert,Thawte,Verisign" would work for certificates issued by DigiCert, DigiCert EV, Thawte or Verisign.

If you are only using HTTPS for downloading from an HTTPS DP (That is, not using HTTPS for peer-to-peer data transfer) you can leave this blank and set CertSubject instead.

MODULE.NOMAD.CERTSUBJECT

Defines one or more certificate subject names that Nomad uses to select the appropriate PKI certificate for authentication with Configuration Manager (CM) site systems configured to use HTTPS. It does not affect certificate selection for client authentication certificates used for peer-to-peer authentication or for selection of server authentication certificates.

In most cases Nomad will be able to identify a suitable certificate in the Local Computer Personal certificate store without the need to specify CertSubject (refer to Peer copy over HTTP or HTTPS: Certificate Selection for more details).

Click here to expand...

Defines one or more certificate subject names that Nomad uses to select the appropriate PKI certificate for authentication with Configuration Manager (CM) site systems configured to use HTTPS. It does not affect certificate selection for client authentication certificates used for peer-to-peer authentication or for selection of server authentication certificates.

In most cases Nomad will be able to identify a suitable certificate in the Local Computer Personal certificate store without the need to specify CertSubject (refer to Peer copy over HTTP or HTTPS: Certificate Selection for more details).

Registry value

Default value

Notes

CertSubject

" "

For downloads over HTTPS from the Distribution Point, set either the CertIssuer or CertSubject registry values. Set this value to the subject name of the certificate that Nomad should use to select the appropriate PKI certificate. The match has the following properties:

  • case-insensitive

  • a substring search is done, so if the text is set to ACME it will return certificates where ACME appears anywhere in the certificate's subject.

If you have multiple valid subject names you can specify a:

  • Common sub-string, for example "contoso.com" would work for certificates that have contoso.com anywhere in the subject name

  • Comma-separated list of subject names or sub-strings, for example, you can specify multiple subject domain suffixes, for example "contoso.com,abc.in".

For the installer property, configure either MODULE.NOMAD.CERTISSUER or MODULE.NOMAD.CERTSUBJECTinstaller properties for HTTPS downloads.

MODULE.NOMAD.COMPATIBILITYFLAGS

Determines different compatibility settings which relate to specific customer related functionality and should not generally be changed from the default value under normal conditions, unless advised.The installer property must be set to sum of the integer values for the required bits. For example, to disable hash value checking (1) and DelegatedLSZ checks and errors (131072), run msiexec /i 1E.Client-x64.msi MODULE.NOMAD.COMPATIBILITYFLAGS=131073 [other properties] /qn on the installer command-line.

Click here to expand...

Determines different compatibility settings which relate to specific customer related functionality and should not generally be changed from the default value under normal conditions, unless advised.

Registry value

Default value

Notes

CompatibilityFlags

0x1E18000A (504889354)

For Nomad in full OS, the registry value is set to the sum of the values for the required bits.

compatibilityflags_default_Normal_OS.png

The default value combines the following settings:

  • Bit 1 - 0x00000002 - Enable longer values for hashes

  • Bit 3 - 0x00000008 - Fix wrong IPs in election messages

  • Bit 19 - 0x00080000 - Enable full hash generation for SIS content on DPs

  • Bit 20 - 0x00100000 - Abort download on the Nomad client if an LsZ has mismatch is detected

  • Bit 25 - 0x02000000 - Turn off Dynamic Block Size

  • Bit 26 - 0x04000000 - Enable download of Windows 10 Express File Updates

  • Bit 27 - 0x08000000 - Enable download of Software Updates (including Windows 10 feature updates) from Microsoft Update - see note

  • Bit 28 - 0x10000000 - Enable support for byte-range downloads (e.g. Office 365 or delta content for updates) from Microsoft Update - see note

First bit is bit 0. The default in binary is: ‭0001 1110 0001 1000 0000 0000 0000 1010

Support for downloading updates from Microsoft Update

Setting bits 27 and/or 28 will enable Nomad to download content from Microsoft Update if the update has been deployed with Configuration Manager and the option If software updates are not available on distribution point in current, neighbor or site boundary, download content from Microsoft Update has been enabled on the Download Settings tab of the deployment. Nomad will not be used to download updates from Microsoft Update if the update is requested outside of a Configuration Manager Software Update Deployment (e.g. when using Windows Update for Business).

Note

Prior to 1E Client 4.1 (Nomad 7.0) the default was 0x00180000 (1572864):

  • Bit 19 - 0x00080000 - Enable full hash generation for SIS content on DPs

  • Bit 20 - 0x00100000 - Abort download on the Nomad client if an LsZ has mismatch is detected

0x00100002 (1048578)

For the task sequence action Install and configure Nomad in Windows PE, the registry value is set to the sum of the values for the required bits.

compatibilityflags_default_Win-PE.png

The default value combines the following settings:

  • Bit 1 - 0x00000002 - Enable longer values for hashes

  • Bit 20 - 0x00100000 - Abort download on the Nomad client if an LsZ has mismatch is detected

Note

Bit 1 - 0x00000002 (Enable longer values for hashes) is mandatory.

The installer property must be set to sum of the values for the required bits, and given in decimal notation. For example, the following installer command-line uses:

  • Default- 0x1E18000A

  • Bit 0 - 0x00000001 - Never check hashes of downloaded content

  • Bit 17 - 0x00020000 - Disable DelegatedLSZ checks and errors

  • Sum - 0x1E1A000B (505020427)

> msiexec /i 1E.Client-x64.msi MODULE.NOMAD.COMPATIBILITYFLAGS=505020427 [other properties] /qn

Bit

Hex

Decimal

Description

0

0x0001

1

Never check hashes of downloaded content.

1

0x0002

2

Enable longer values for hashes. This value is auto-enabled when the Configuration Manager client is detected.

You must manually configure this setting on any DP that does not have the Configuration Manager client installed.

Note

Prior to 1E Client 4.1 (Nomad 7.0) this was disabled (0) by default.

2

0x0004

4

Calculate CRCs as files are downloading.

3

0x0008

8

Fix wrong IPs in election messages.

On multi-homed machines sometimes the IP from a wrong adapter can get sent in the election messages resulting in peers failing to connect to the master. Enabling this flag causes Nomad to correct such IPs at the time when messages are received and thus prevent master connectivity issues.

4

0x0010

16

Determines compatibility with Nomad v3.x caches. Set this option once all Nomad v3.x installations have been upgraded.

5

0x0020

32

Disable all RDC data generation.

6

0x0040

64

Keep Packages that failed the CRC test during P2P or download from DP.

7

0x0080

128

Prevent computers using wireless connections from becoming fill-in multicast masters.

8

0x0100

256

Include LinkLocal IPv4 addresses.

9

0x0200

512

Include LinkLocal IPv6 addresses.

11

0x0800

2048

RESERVED

12

0x1000

4096

Do not automatically jump from HTTP to HTTPS during download from DP.

13

0x2000

8192

Always use HTTPS. (Use this setting when Configuration Manager is configured to use HTTPS-only communication for downloading content from Distribution Points)

14

0x4000

16384

RESERVED

15

0x8000

32768

RESERVED

16

0x00010000

65536

RESERVED (this flag is no longer used; previously this flag disabled a workaround for the issue described in Nomad post-installation tasks: IIS request filtering)

17

0x00020000

131072

Disable DelegatedLSZ checks and errors.

18

0x00040000

262144

Disable partial download when App-V streaming, i.e. download entire application.

19

0x00080000

524288

Enable full hash generation for SIS content when an LsZ file is generated on a DP. If this is not enabled, SIS content is trusted, and corrupted content may be downloaded. Enabled by default.

20

0x00100000

1048576

Abort download on the Nomad client if an LsZ hash mismatch is detected. If this is not set, when a Nomad client detects a hash mismatch it will re-request LsZ generation on the DP then try again, and get stuck in a loop if the SIS content is corrupt. Must be set on clients if Bit 19 is set on DPs. Enabled by default.

25

0x02000000

33554432

Turn off Dynamic Block Size. This flag is set by default, which means Dynamic Block Size is disabled by default.

Note

Prior to 1E Client 4.1 (Nomad 7.0) this bit was off, meaning Dynamic Block Size was enabled by default.

26

0x04000000

67108864

Enable download of Windows 10 Express update files. Enabled by default.

Note

This is a new setting in 1E Client 4.1 (Nomad 7.0) and Q20144 for NomadBranch 6.3.201.

27

0x08000000

134217728

Enable download of full file software updates from Microsoft Update when deployed through Configuration Manager. Enabled by default.

Note

This is a new setting in 1E Client 4.1 (Nomad 7.0) and Q20246 for NomadBranch 6.3.201.

28

0x10000000

268435456

Enable download of byte-range software updates (e.g. Express updates, O365 updates) from Microsoft Update when deployed through Configuration Manager. Enabled by default.

Note

This is a new setting in 1E Client 4.1 (Nomad 7.0) and Q20246 for NomadBranch 6.3.201.

30

0x40000000

1073741824

Enable SoftwareUpdate metadata validation. This is not enabled by default. It can be used to resolve rare issues related to SoftwareUpdates where the contents could be updated without any change in its ID or version. Please refer to Resolving SoftwareUpdate metadata validation for more details.

Note

This is a new setting in 1E Client 5.1 (Nomad 7.0.200).

MODULE.NOMAD.CONTENTPROVIDERONWIFI

Determines whether a device on a WLAN can become content provider. By default, only devices connected to a LAN can become content providers when using Single Site Download (SSD).

Note

This setting is only applicable to SSD and has no effect on P2P content transfers on the local subnet.

Click here to expand...

Determines whether a device on a WLAN can become content provider. By default, only devices connected to a LAN can become content providers when using Single Site Download (SSD).

Note

This setting is only applicable to SSD and has no effect on P2P content transfers on the local subnet.

Registry value

Default value

Notes

ContentProviderOnWifi

0

Values are:

  • 0 – Only devices connected to a LAN can be content providers

  • 1 – Devices connected to any network (including WLANs) can be content providers

MODULE.NOMAD.CONTENTREGISTRATION

Determines if content in Nomad's cache (packages, applications, software updates, boot images, etc.) is registered with Content Distribution. Content registration is necessary if a host is to be available as a Single Site Download (SSD) provider or can be woken up if a Nomad peer requires the content locally.

Click here to expand...

Determines if content in Nomad's cache (packages, applications, software updates, boot images, etc.) is registered with Content Distribution. Content registration is necessary if a host is to be available as a Single Site Download (SSD) provider or can be woken up if a Nomad peer requires the content locally.

Registry value

Default value

Notes

Platform\ContentRegistration

0

To enable content registration, update the value to 1 – it is found under the Platform\ContentDistribution

To enable SSD when you install Nomad, you must specify the MODULE.NOMAD.SSDENABLED installer property and ensure the Tachyon client is enabled by specifying SWITCH and BACKGROUNDCHANNELURL installer properties. If MODULE.NOMAD.SSDENABLED is specified during installation, the registry value of ContentRegistration is automatically set to 1.

If you want to enable SSD as a provider after installation, then you also need to configure the registry values for SSDEnabled and ContentRegistration, in addition to enabling the Tachyon client. The ContentDistribution registry setting is found under the Platform key.

In legacy versions of Nomad, Platform features were provided using ActiveEfficiency. This required the PlatformURL setting to be configured. This is no longer required. You will see that the PlatformURL registry is used, but this is configured automatically by Nomad on startup by querying the value that the Tachyon client is using (stored in the 1EClient.conf file).

MODULE.NOMAD.DEBUG

The level of messages logged in the Nomad logs for debugging purposes.

The installer property must be set to sum of the integer values for the required bits. For example, to set all three supported debug levels, run: msiexec /i 1E.Client-x64.msi MODULE.NOMAD.DEBUG=25 [other properties] /qn on the installer command-line.

Click here to expand...

The level of messages logged in the Nomad logs for debugging purposes.

Registry value

Default value

Notes

Debug

0x09 (9)

See the table below for customer supported values. The default is a combination of 0x01 (Minimal logging) and 0x08 (Registry changes). For example, to set maximum debugging, set bit 0, 3 and 4, which is a value of 0x19 hexadecimal or 25 decimal.

Values on the installer command-line must be provided in decimal. So to set maximum debugging you would use the following installer command-line:

> msiexec /i 1E.Client-x64.msi DEBUG=25 [other properties] /qn

Bit

Hex

Decimal

Description

0

0x01

1

Minimal logging.

1

0x02

2

RESERVED

2

0x04

4

RESERVED

3

0x08

8

Registry changes.

4

0x10

16

Additional debugging (should only be used if requested by 1E support).

MODULE.NOMAD.DOREPORTINGENABLED

Enables Delivery Optimization monitoring and reporting if ContentRegistration is enabled.

Click here to expand...

Enables Delivery Optimization monitoring and reporting if ContentRegistration is enabled.

Registry value

Default value

Notes

DeliveryOptimizationReportingEnabled

0

Enables monitoring of Delivery Optimization downloads and reporting them to Tachyon Platform (ContentDistribution).

Delivery Optimization monitoring and reporting is only supported in versions of Windows Server 2019 and Windows 10 Version 1909 onwards.

When it is enabled, DO download events get written to .etl files in the Nomad cache folder, for example: NomadDo-20210325-182415.etl.

And aggregated information about the downloads gets writtern to sqlite files Do.db and DoDownloadMonitor.db in LocalDb folder inside Nomad cache folder.

MODULE.NOMAD.DOWNLOADTIMEOUT

Sets the timeout in seconds after which a job will be cancelled if the download has not been successful.

Click here to expand...

Sets the timeout in seconds after which a job will be cancelled if the download has not been successful.

Registry value

Default value

Notes

DownloadTimeout

0

This parameter is associated with the distribution point resilience feature and is used in conjunction with the RecycleDPDelay registry value. If a value greater than zero is set, the download timeout will either use this or the Configuration Manager setting depending on which is the smaller value.

When the timeout is reached, the job package download is cancelled and a success is sent to the Configuration Manager client with the ERROR_MAXDURATION timeout error sent as the package status message.

The default is to use the Configuration Manager setting (28 days by default).

MODULE.NOMAD.DPCACHECLEANUPENABLED

Delete all obsolete LSZ files on the DP where the associated content is no longer present in ContentLib.

Click here to expand...

Delete all obsolete LSZ files on the DP where the associated content is no longer present in ContentLib.

Registry value

Default value

Notes

DpCacheCleanupEnabled

0 (turned off)

This entry controls the cached LSZ files cleaning feature. When turned on, this feature deletes all LSZ files in a Distribution Point (DP) cache where the associated content is not present in ContentLib.

The following table describes the values this entry may be set to:

Value

Description

0

The feature is turned off. This is the default.

1 (or greater)

The feature is turned on.

Please refer to Cache management for details about other cache management settings.

MODULE.NOMAD.DPNOTAVAILABLECODES

Determines which error codes will cause Nomad to retry a download using an alternative distribution point.

For example, the following would set Nomad to the default value on the 1E Client installer command-line:> msiexec /i 1E.Client-x64.msi MODULE.NOMAD.DPNOTAVAILABLECODES="0x205A,0x205D" [other properties] /qn

Click here to expand...

Determines which error codes will cause Nomad to retry a download using an alternative distribution point.

Registry value

Default value

Notes

DPNotAvailableCodes

0x205A, 0x205D

This registry entry contains a comma-separated list of return codes, see Nomad return codes for a list of the possible ones. If Nomad encounters one of these during download it will attempt a retry from an alternative DP. It gets the list of possible DPs from Configuration Manager. The two return codes set as default are the only ones that are applicable to DP availability:

  • 0x205A – in valid special package path (set using --pp)

  • 0x205D – DP path not found

Under normal circumstances, you would not change this from the default value. You may want to not allow failover to an alternative DP altogether, in which case you would set the value to " " in the registry. Or you may only want to failover if the DP path was not found, in which case you would set the value to 0x205D only.

This installer property should be set to a string containing the comma-separated hex values. For example the following sets Nomad to failover to the next DP only when the DP path was not found:

> msiexec /i 1E.Client-x64.msi DPNOTAVAILABLECODES="0x205D" [other properties] /qn

MODULE.NOMAD.ENFORCEQUOTAS

Determines whether Windows Disk Quotas (if configured) are enforced on the PBA share defined inCachePath.

Click here to expand...

Determines whether Windows Disk Quotas (if configured) are enforced on the PBA share defined inCachePath.

Registry value

Default value

Notes

EnforceQuotas

0x0 (0)

Enables quotas to be enforced but requires Windows Disk Quotas to be configured. If the size specified in the NMDS_POLL request causes the quota to be exceeded, the request fails and you get disk full error. This registry value is found under the PBA registry key NomadBranch\NMDS.

MODULE.NOMAD.GENERATEWEREVENTS

Determines whether Windows Error Reporting memory dumps should be sent to Microsoft Winqual.

Click here to expand...

Determines whether Windows Error Reporting memory dumps should be sent to Microsoft Winqual.

Registry value

Default value

Notes

GenerateWEREvents

1

If enabled and if Nomad experiences an unexpected failure, a dialog is displayed prompting the user to send the debug information to Winqual which is forwarded to 1E for continued quality improvements. Values are:

  • 0 disables this feature

  • 1 enables this feature

MODULE.NOMAD.HAACKTIMEOUTMINS

The time-out period in minutes for the Peer Backup Assistant - High Availability (deprecated) (PBA-HA) task sequence action. If a machine running this action does not receive an acknowledgement message within this period from the PBA host performing the additional backups, the action will fail.

Click here to expand...

The time-out period in minutes for the Peer Backup Assistant - High Availability (deprecated) (PBA-HA) task sequence action. If a machine running this action does not receive an acknowledgement message within this period from the PBA host performing the additional backups, the action will fail.

Registry value

Default value

Notes

HAACKTimeoutMins

20

Applies to synchronized backups only. The PBA tost sends the acknowledgement messages back to the machine running the task sequence approximately every 5% of the synchronized copy. This registry value is found under the PBA registry key NomadBranch\NMDS.

MODULE.NOMAD.LOCALSSDSTAGGER

Sets the site SSD query stagger duration (seconds).

Click here to expand...

Sets the site SSD query stagger duration (seconds).

Deployments to large numbers of clients (30,000 or more) generate significant network traffic from 1E Client to Content Distribution that may result in IIS 503 Overload errors on the server, causing content registrations and SSD requests to fail. LocalSsdStagger allows an elected subnet master to wait for a random configurable time before making a local SSD request. All peers in the subnet participating in the election would also synchronize and wait for the same time before copying from master machine.

Registry value

Type

Default value

Notes

LocalSsdStagger

REG_DWORD

5

Sets the local SSD query stagger duration in seconds. The stagger is 0 (disabled) by default.

The maximum value that can configured is 600 seconds (10 minutes).

There is no SSD staggering in WinPE.

Local SSD happens when only when network broadcast is disabled.

Note

Please consult 1E before changing this value.

This setting works in conjunction with SiteSsdStagger.

MODULE.NOMAD.LOGNAME

Name of the Nomad log file. This value is preserved upon upgrade. This property is combined with MODULE.NOMAD.LOGPATH to create registry value LogFileName. The default value is NomadBranch.log

MODULE.NOMAD.LOGPATH

Location of the Nomad log file. The path will be created if it does not exist. This value is preserved upon upgrade. Default values are dependent on OS. This property is combined with MODULE.NOMAD.LOGNAME to create the registry value LogFileName. The default location is: %ALLUSERSPROFILE%\1E\NomadBranch\LogFiles

MODULE.NOMAD.MADCAPSCOPE

The MADCAP scope for multicast.

Click here to expand...

The MADCAP scope for multicast.

Warning

The Multicast feature is not supported in the Tachyon 5.2 release. This feature is under consideration for re-design and may be available in future versions of Nomad.

Registry value

Default value

Notes

MultiCastMADCAPScope

SMSNomad

Values may be set using either of the formats in the table below.

Format

Description

<ScopeName>

<ScopeName> is the name of a scope defined in the DHCP (if you are using the Microsoft implementation of MADCAP). Use this format if you have multiple MADCAP servers. This method uses the time to live settings for the scope.

<MADCAP_ServerIP>

<MADCAP_Scope_IP>

<TTL>

  • <MADCAP_ServerIP> is the IP address of a specific MADCAP server

  • <MADCAP_ScopeIP> is the starting IP address for a MADCAP scope defined in the DHCP (if you are using the Microsoft implementation of MADCAP)

  • <TTL> is the time to live for the multicast packets

    Note

    Using a TTL greater than 1 is not recommended unless you have ensured that multicast traffic cannot leak back upstream through any intervening routers. The valid range for TTL is a number between 1 and 255

Nomad is also capable of performing control multicast without a MADCAP server installation on the network. In order to use this feature, the <MADCAP_ServerIP> must be set to 0.0.0.0. For example, the following supports MADCAP server not being present, with a scope of 239.0.9.0 and a time to live of 3.

0.0.0.0,239.0.9.0,3
MODULE.NOMAD.MAXALLOCREQUEST

Sets the maximum amount of space in MB that can be requested by each PBA client.

Click here to expand...

Sets the maximum amount of space in MB that can be requested by each PBA client.

Registry value

Default value

Notes

MaxAllocRequest

0xC8 (200)

Located under the PBA registry key NomadBranch\NMDS.

MODULE.NOMAD.MAXCACHEDAYS

When the Nomad cache cleaner runs, delete any application or package content that last triggered Nomad elections before the specified number of days ago.

Click here to expand...

When the Nomad cache cleaner runs, delete any application or package content that last triggered Nomad elections before the specified number of days ago.

Registry value

Default value

Notes

MaxCacheDays

0 (turned off)

Set to delete application or package content that last triggered Nomad elections before the specified number of days from the date the cache cleaner runs.

This ensures that only application or package content that have triggered elections recently will be kept in the cache.

0 means that application and package content will not be deleted automatically when the cache cleaner runs.

Please refer to Cache management for details about other cache management settings.

MODULE.NOMAD.MAXCACHEDAYSTHRESHOLD

This is the maximum number of days content is present on a client.

Click here to expand...

This is the maximum number of days content is present on a client.

Registry value

Type

Default value

Notes

MaxCacheDaysThreshold

REG_DWORD

0

This is the maximum number of days content is present on a client. If it's not zero, then content will be deleted without any other checks once it reaches the threshold. If the threshold has a value greater than zero and less than 30, Nomad uses the threshold of 30 days and creates an associated log.

Default value is 0.

New setting introduced in 8.0.

Please refer to Cache management for details about other cache management settings.

MODULE.NOMAD.MAXCACHESIZEMB

Provided for backward compatibility only – use PercentAvailableDisk instead. The value (in bytes) for the maximum size the cache is allowed to grow to, before automatic cache cleaning takes place.

Click here to expand...

Provided for backward compatibility only – use PercentAvailableDisk instead. The value (in bytes) for the maximum size the cache is allowed to grow to, before automatic cache cleaning takes place.

Registry value

Default value

Notes

MaxCacheSizeMB

0

There is no maximum value for this property. This method for determining the maximum size of the cache is an alternative to PercentAvailableDisk:

MODULE.NOMAD.MAXCONCURRENCY

Sets the maximum number of concurrent PBA sessions that may be in use on the host.

Click here to expand...

Sets the maximum number of concurrent PBA sessions that may be in use on the host.

Registry value

Default value

Notes

MaxConcurrency

0x3 (3)

Located under the PBA registry key NomadBranch\NMDS.

MODULE.NOMAD.MAXDEVICESFROMAE

The maximum number of devices with the content that Nomad can retrieve from Content Distribution in one call.

Click here to expand...

The maximum number of devices with the content that Nomad can retrieve from Content Distribution in one call.

Registry value

Default value

Notes

MaxDevicesFromAE

10

The maximum number of devices (i.e. machines) with the content (package, application or software update) that Nomad can retrieve from Content Distribution in one call. The maximum value is 20.

MODULE.NOMAD.MAXELECTIONRESPONSELOGGING

Defines the number of election responses Nomad will write to the log for a given election.

Click here to expand...

Defines the number of election responses Nomad will write to the log for a given election.

Registry value

Default value

Notes

MaxElectionResponseLogging

By default this REG_DWORD value is not present and all election responses are logged.

Add this REG_DWORD value and set it to the number of responses that Nomad should log for any given election.

Setting the value to 0 effectively turns off logging of any election responses.

Note

The value of MaxElectionResponseLogging specifies the number of election replies to be logged per election request. As an example, if MaxElectionResponseLogging = 5 and there are two election requests for the same package at different times, a maximum of 5 election responses will be logged for each elections (up to 10 election replies in total). If there are two concurrent election requests for the same package, the number of maximum election replies logged may vary from 5 to 10. In general, if MaxElectionResponseLogging = n and if there are m concurrent election requests for the same package, the number of maximum election replies logged may vary from n to m*n.

MODULE.NOMAD.MAXIMUMMEGABYTE

The maximum amount of space (in MB) that can be used for all the PBA shares combined on the host.

Click here to expand...

The maximum amount of space (in MB) that can be used for all the PBA shares combined on the host.

Registry value

Default value

Notes

MaximumMegaByte

0

A non-zero value enables PBA share.

This registry value is located under the PBA registry key NomadBranch\NMDS.

MODULE.NOMAD.MAXLOGSIZE

The maximum size (in bytes) of the Nomad log file. Default is 5MB.

Click here to expand...

The maximum size (in bytes) of the Nomad log file. Default is 5MB.

Registry value

Default value

Notes

MaxLogFileSize

5242880

When the log file reaches this size, it is renamed with a .LO_ extension and a new .LOG file is created. The .LO file is overwritten each time.

Note

The default has been increased from 1048576 (1MB) to 5242880 (5MB) for Nomad 7.0 onwards (1E Client 4.1).

Note

The installer property name is different to the registry name.

MODULE.NOMAD.MAXPACKAGEFAST

The maximum size (in bytes) of a package that Nomad attempts to cache on a Fast LAN (>500 kbps) connection.

Click here to expand...

The maximum size (in bytes) of a package that Nomad attempts to cache on a Fast LAN (>500 kbps) connection.

Registry value

Default value

Notes

MaxPackageSizeFastLAN

0

Works in conjunction with the RunUncachedPermittedFastLAN registry value.

Note

The installer property name is different to the registry name.

MODULE.NOMAD.MAXPACKAGERAS

The maximum size (in bytes) of a package that Nomad will attempt to cache on a RAS (<55 kbps) connection.

Click here to expand...

The maximum size (in bytes) of a package that Nomad will attempt to cache on a RAS (<55 kbps) connection.

Registry value

Default value

Notes

MaxPackageSizeRAS

0

Note

The installer property name is different to the registry name.

MODULE.NOMAD.MAXPACKAGESLOW

Maximum size (in bytes) of a package that Nomad attempts to cache on a Slow LAN (55-500 kbps) connection.

Click here to expand...

Maximum size (in bytes) of a package that Nomad attempts to cache on a Slow LAN (55-500 kbps) connection.

Registry value

Default value

Notes

MaxPackageSizeSlowLAN

0

Note

The installer property name is different to the registry name.

MODULE.NOMAD.MAXPACKETSPERSECOND

The maximum rate at which multicast packets are sent.

Click here to expand...

The maximum rate at which multicast packets are sent.

Warning

The Multicast feature is not supported in the Tachyon 5.2 release. This feature is under consideration for re-design and may be available in future versions of Nomad.

Registry value

Default value

Notes

MaxPacketsPerSecond

800

Modify this value with caution. If packets are sent too fast, machines will drop packets and multicast will not be effective - too slow and multicast works, but slowly. The default value is indicative of how this should be set.

MODULE.NOMAD.MAXPRECACHEDAYS

When the Nomad cache cleaner runs, delete any pre-cached content that last triggered Nomad elections before the specified number of days ago.

Click here to expand...

When the Nomad cache cleaner runs, delete any pre-cached content that last triggered Nomad elections before the specified number of days ago.

Registry value

Default value

Notes

MaxPreCacheDays

0 (turned off)

Set to delete pre-cached content that last triggered Nomad elections before the specified number of days from the date the cache cleaner runs.

This ensures that only pre-cached content that has triggered elections recently will be kept in the cache.

0 means that pre-cached content will not be deleted automatically when the cache cleaner runs.

Please refer to Cache management for details about other cache management settings.

MODULE.NOMAD.MAXSTATUSFREQUENCY

he minimum interval (in seconds) between sending transfer progress status messages, thereby governing the overall maximum frequency for sending the messages.

Click here to expand...

he minimum interval (in seconds) between sending transfer progress status messages, thereby governing the overall maximum frequency for sending the messages.

Registry value

Default value

Notes

MaxStatusFrequency

3600

Works in conjunction with the ++sm setting on the Nomad properties tab and the StatusMsgEvents registry values.

MODULE.NOMAD.MAXSTUCKCOUNT

Registry value to hold an integer determining the number of times Nomad attempts to copy content and gets stuck before aborting.

Click here to expand...

Registry value to hold an integer determining the number of times Nomad attempts to copy content and gets stuck before aborting.

If you update the registry, you must restart the Nomad service for you changes to take effect. We recommend backing up your registry before you do this.

Registry value

Default value

Notes

MaxStuckCount

100

The number of times Nomad attempts to copy content after failure (such as network outages, incomplete LSZ files, hash mismatches, election issues, connecting with peers) before it aborts the operation.

The range is 3 to 1000, but if the value is less than 3 or greater than 1000, it sets to the default of 100.

Warning

The MaxStuckCount value is an internal NomadBranch registry value. You should not change this value unless advised by 1E.

Do not use unless advised by 1E.

MODULE.NOMAD.MAXSUCACHEDAYS

When the Nomad cache cleaner runs, delete any software updates that last triggered Nomad elections before the specified number of days ago.

Click here to expand...

When the Nomad cache cleaner runs, delete any software updates that last triggered Nomad elections before the specified number of days ago.

Registry value

Default value

Notes

MaxSUCacheDays

0 (turned off)

Set to delete software updates that last triggered Nomad elections before the specified number of days from the date the cache cleaner runs.

This ensures that only software updates that have triggered elections recently will be kept in the cache.

0 means that software updates will not be deleted automatically when the cache cleaner runs.

Please refer to Cache management for details about other cache management settings.

MODULE.NOMAD.MULTICASTSUPPORT

The behavior of local multicast.

Click here to expand...

The behavior of local multicast.

Warning

The Multicast feature is not supported in the Tachyon 5.2 release. This feature is under consideration for re-design and may be available in future versions of Nomad.

Registry value

Default value

Notes

MulticastSupport

0x0 (0)

All machines in a single branch must be configured using the same value for this parameter.

If you are not using multicast, deploy the Nomad branch agent with the MULTICASTSUPPORT property set to 0 to reduce the noise in Nomad logs.

Prior to Nomad 7.0 multicast was enabled (0x1) by default. Now it is disabled (0x0) by default.

Bit

Hex

Decimal

Description

0x0

0

No Multicast– disables the feature.

0

0x1

1

Data Only Multicast – choose this for a standard Nomad multicast. Data refers to the content of the downloaded package.

Nomad control communications are broadcast as normal on the local subnet. Select this option for standard functionality.

1

0x2

2

Control Only Multicast – control information refers to the communications between Nomad enabled machines, especially for elections.

This may be used if there is more than one subnet in a single location to enable a single Nomad master to be elected for all the subnets.

0x3

3

Control and Data Multicast – data and control information is multicast.

Select this option if a branch has multiple subnets connected by high speed routers.

MODULE.NOMAD.NOHARDLINK

Determines whether hard links are used between the Nomad cache and the Configuration Manager cache.

Click here to expand...

Determines whether hard links are used between the Nomad cache and the Configuration Manager cache.

Registry value

Default value

Notes

NoHardlink

0

Values are:

  • 0 – hard links are used. The Nomad cache will link to the Configuration Manager cache so only a single copy of a package is held locally.

  • 1 – hard links are not used and results in the content being double-cached

For more detail about the Nomad Cache please refer to Nomad cache.

MODULE.NOMAD.NOMADINHIBITEDADSITES

Prevents Nomad from calling an election when it is connected to a specified AD site, meaning that each Nomad client on the listed AD sites will automatically become a Nomad master. This prevents P2P sharing, as each master downloads its own copy of the content.

Click here to expand...

Prevents Nomad from calling an election when it is connected to a specified AD site, meaning that each Nomad client on the listed AD sites will automatically become a Nomad master. This prevents P2P sharing, as each master downloads its own copy of the content.

Registry value

Default value

Notes

NomadInhibitedADSites

(empty)

A comma-separated list for each AD site to be inhibited. Useful for sites with:

  • a local DP

  • a VPN without isolation

For example, to inhibit three AD sites called site1, site2 and site3:

site1,site2,site3

Please refer to Design Considerations: Inhibiting subnets and sites.

MODULE.NOMAD.NOMADINHIBITEDSUBNETS

Prevents Nomad from calling an election when it is connected to a specified IP subnet, meaning that each Nomad client on the IP subnet automatically becomes a Nomad master. This prevents P2P sharing, as each master downloads its own copy of the content.

Click here to expand...

Prevents Nomad from calling an election when it is connected to a specified IP subnet, meaning that each Nomad client on the IP subnet automatically becomes a Nomad master. This prevents P2P sharing, as each master downloads its own copy of the content.

Registry value

Default value

Notes

NomadInhibitedSubnets

(empty)

A comma-separated list of each subnet to be inhibited in CIDR notation. Useful for sites with either of the following:

  • a local DP

  • a VPN without isolation

For example, to isolate two subnets:

10.2.0.0/16,192.168.9.0/24

Please refer to Design Considerations: Inhibiting subnets and sites.

MODULE.NOMAD.P2PDISQUALIFYMAXNUMPEERS

Defines the max number of devices which a device will disqualify during a peer-to-peer copy.

Click here to expand...

Defines the max number of devices which a device will disqualify during a peer-to-peer copy.

If you update the registry, you must restart the Nomad service for you changes to take effect. We recommend backing up your registry before you do this.

Registry value

Default value

Notes

P2PDisqualifyMaxNumPeers

5

A device does not further disqualify a peer if it has disqualified P2PDisqualifyMaxNumPeers number of peers within last P2PDisqualifyMaxWindowMins minutes.

Warning

The P2PDisqualifyMaxNumPeers value is an internal NomadBranch registry value. You should not change this value unless advised by 1E.

Do not use unless advised by 1E.

MODULE.NOMAD.P2PDISQUALIFYMAXWINDOWMINS

Defines the max number of minutes within which a device will disqualify a peer during a peer-to-peer copy.

Click here to expand...

Defines the max number of minutes within which a device will disqualify a peer during a peer-to-peer copy.

If you update the registry, you must restart the Nomad service for you changes to take effect. We recommend backing up your registry before you do this.

Registry value

Default value

Notes

P2PDisqualifyMaxWindowMins

60

A device does not further disqualify a peer if it has disqualified P2PDisqualifyMaxNumPeers number of peers within last P2PDisqualifyMaxWindowMins minutes.

Warning

The P2PDisqualifyMaxWindowMins value is an internal NomadBranch registry value. You should not change this value unless advised by 1E.

Do not use unless advised by 1E.

MODULE.NOMAD.P2PENABLED

Determines how the Nomad cache is accessed. Please refer to Nomad cache for more details.

The installer property must be set to sum of the integer values for the required bits. For example, the following would set Nomad to use connectionless P2P on the 1E Client installer command-line:

> msiexec /i 1E.Client-x64.msi MODULE.NOMAD.P2PENABLED=6 [other properties] /qn

Click here to expand...

Determines how the Nomad cache is accessed. Please refer to Nomad cache for more details.

Registry value

Default value

Notes

P2PEnabled

9

The default (Hex 0x0009) configures P2P to use SMB and Net Literal Names.

You can set more than one option at the same time by combining the bit values. See the table below for details.

Note

We recommend restarting the Nomad Branch service when you modify this parameter.

Bit

Hex

Decimal

Notes

0

0x0001

1

(Default) Use the SMB protocol to share its own cache, and create the NomadSHR file share upon the start of the Nomad service, unless the CustomShare option has been enabled in SpecialNetShare. When P2PEnabled is set in addition to Bit 5 (use HTTP) or Bit 6 (use HTTPS), Nomad will attempt to use HTTPS/HTTP and will fall-back to SMB if HTTPS/HTTP is unavailable on other peers. To disable SMB P2P, set this bit to 0.

1

0x0002

2

Enable connectionless P2P server.

2

0x0004

4

Enable connectionless P2P client.

3

0x0008

8

(Default) Use Net Literal Names when connecting to P2P shares. This causes Nomad to use the Nomad master's IP address when connecting to the share and is recommended when running wirelessly.

4

0x0010

16

Use FQDN when connecting to P2P shares. Recommended when using a multi-forest environment where computers from different forests may be present in the same subnet. This requires that reverse lookup for IP addresses is correctly configured and running. If this is not available Nomad will revert to using the IP address for connecting to the P2P shares.

5

0x0020

32

Use the HTTP protocol to share its own cache and access other caches.

6

0x0040

64

Use the HTTPS protocol to share its own cache and access other caches.

MODULE.NOMAD.P2PHTTPPORT

The HTTP port to use for peer copy.

Click here to expand...

The HTTP port to use for peer copy.

Registry value

Default value

Notes

P2PHttpPort

5080

Default HTTP port to use for peer copy. If you are using a custom port, ensure that all agents use the same custom port.

MODULE.NOMAD.P2PHTTPSPORT

The HTTPS port to use for peer copy.

Click here to expand...

Registry value

Default value

Notes

P2PHttpsPort

5443

Default HTTPS port to use for peer copy. If you are using a custom port, ensure that all agents use the same custom port.

MODULE.NOMAD.P2PPORT

Port used to broadcast election messages, for connectionless cache access and package status broadcasts.

Click here to expand...

Port used to broadcast election messages, for connectionless cache access and package status broadcasts.

Registry value

Default value

Notes

P2P_Port

1779

MODULE.NOMAD.P2PSSLSETTINGS

Defines server and client authentication options when using HTTPS for P2P content transfer (i.e. P2PEnabled 0x60 option is set).

Click here to expand...

Defines server and client authentication options when using HTTPS for P2P content transfer (i.e. P2PEnabled 0x60 option is set).

Registry value

Default value

Notes

P2PSslSettings

0

The default value (0) configures Nomad to use a self-signed certificate for server authentication and disables certificate-based client authentication.

P2PSslSettings is a numeric value where, when represented in binary, each bit represents a configurable option as defined in the table below. You can combine these options to derive the required value, for example setting P2PSslSettings to 3 (0x1 + 0x2) configures Nomad to use a PKI certificate for server authentication and also enables certificate-based authentication.

These options are only applicable if the HTTPS protocol has been enabled in the P2PEnabled setting.

If you are using PKI certificates you must deploy the certificates to all clients before enabling this option. Refer to Peer copy over HTTP or HTTPS for further details on using HTTPS and associated authentication.

Bit

Hex

Decimal

Notes

0

0x0001

1

If not set (0), use self-signed certificate for server (Master) authentication

If set (1), use PKI certificate for server (Master) authentication

1

0x0002

2

Enables certificate-based client authentication (Requires a PKI client authentication certificate)

Note

If this option is enabled and the Configuration Manager client is using self-signed client authentication certificates (or Nomad is being used outside of CM), you should specify CertIssuer to ensure Nomad uses the intended certificate.

MODULE.NOMAD.PERCENTAVAILABLEDISK

The limit on the Nomad cache. Specified as a percentage of the available disk space, it controls the automatic cache cleaning to ensure that the cache does not grow to a size whereby the percentage of available disk space is less than this value.

Click here to expand...

The limit on the Nomad cache. Specified as a percentage of the available disk space, it controls the automatic cache cleaning to ensure that the cache does not grow to a size whereby the percentage of available disk space is less than this value.

Registry value

Default value

Notes

PercentAvailableDisk

10

By default, the cache will not grow such that less that #837578-838502-maxcachesizemb10% of total disk space is available. The maximum value is 80. The cache will not grow beyond 20% of the total available disk space. This method for determining the maximum size of the cache is provided as an alternative to MaxCacheSizeMB:

MODULE.NOMAD.PERMITTEDLSZSHARES

Restricts Nomad LSZ file generation requests to a list of permitted package source locations.

Click here to expand...

Restricts Nomad LSZ file generation requests to a list of permitted package source locations.

Registry value

Default value

Notes

PermittedLSZShares

SMSPKG*$

SMS_DP_SMSPKG*$

A list of comma-separated package source locations. Enables increased security and is only used by the Nomad client installed on a distribution point. Nomad LSZ file generation requests will only be completed if the content location is listed. If you are using additional package source locations, you must manually add these to this registry value.

PermittedLSZShares can incorporate wildcard characters to provide flexible naming convention support.

If you leave the registry value blank, security checks on package source locations are not carried out.

Note

When Configuration Manager (specifically Distribution Point servers) is configured to use HTTPS only, you must also add NOCERT_SMS_DP_SMSPKG*$ and CCMTOKENAUTH_SMS_DP_SMSPKG*$ to the PermittedLSZShares registry value.

MODULE.NOMAD.PERMITUNCACHED

Determines where the download package is run from under certain conditions.

Click here to expand...

Determines where the download package is run from under certain conditions.

Registry value

Default value

Notes

RunUncachedPermittedFastLAN

0

Works in conjunction with MaxPackageSizeFastLAN (which needs to contain a value value greater than zero). Values are:

  • 0 – do not run package from the distribution point.

  • 1 – run package directly from the distribution point if there is either insufficient disk space to create the cache, or the maximum package threshold is exceeded but the connection is fast (>500kbps).

To ensure that the un-cached mode works correctly, set the Program Environment Properties to include the Drive mode/Require drive letter option.

MODULE.NOMAD.PLATFORMURL

The URL of the Tachyon Platform, specifically the Tachyon Background Channel, which provides a reverse proxy for the Content Distribution component of Tachyon Platform. Usually of the form https://<BackgroundChannelServer>:<BackgroundChannelPort>/Background/

Click here to expand...

Note

Platform features are now enabled by using the BackgroundChannelUrl instead of PlatformURL.

The URL of the Tachyon Platform, specifically the Tachyon Background Channel, which provides a reverse proxy for the Content Distribution component of Tachyon Platform. Usually of the form https://<BackgroundChannelServer>:<BackgroundChannelPort>/Background/

Registry value

Default value

Notes

PlatformURL

(empty)

Located under the following registry keys, depending on the component.

  • For NomadBranch, it is found under HKLM\Software\1E\NomadBranch\Platform

  • For NomadBranchAdminUIExt on 64-bit machines, it is found under HKLM\Software\Wow6432Node\1E\NomadAdminUI\Platform

  • For NomadBranchAdminUIExt on 32-bit machines, it is found under HKLM\Software\1E\NomadAdminUI\Platform

Warning

Do not configure this registry setting, it is automatically configured on service startup.

To enable SSD when you install Nomad, you must specify the MODULE.NOMAD.SSDENABLED installer property and ensure the Tachyon client is enabled by specifying SWITCH and BACKGROUNDCHANNELURL installer properties. If MODULE.NOMAD.SSDENABLED is specified during installation, the registry value of ContentRegistration is automatically set to 1.

If you want to enable SSD as a provider after installation, then you also need to configure the registry values for SSDEnabled and ContentRegistration, in addition to enabling the Tachyon client. The ContentDistribution registry setting is found under the Platform key.

In legacy versions of Nomad, Platform features were provided using ActiveEfficiency. This required the PlatformURL setting to be configured. This is no longer required. You will see that the PlatformURL registry is used, but this is configured automatically by Nomad on startup by querying the value that the Tachyon client is using (stored in the 1EClient.conf file).

MODULE.NOMAD.POSTCOMPLETETIMEOUTHOURS

The duration (in hours) after which the PBA share is deleted from the host.

Click here to expand...

The duration (in hours) after which the PBA share is deleted from the host.

Registry value

Default value

Notes

PostCompleteTimeoutHours

0xA8 (168)

Only applies to a PBA share after the NMDS_COMPLETE command has been run for it, otherwise the PreCompleteTimeoutHours value will apply. The intention is that an incomplete share will only be available for a short period of time, defined in PreCompleteTimeoutHours.

Once the NMDS_COMPLETE command is sent, it will be fixed for this longer time. When the share is deleted the folder and associated user will be removed.

This registry value is found under the PBA registry key NomadBranch\NMDS.

MODULE.NOMAD.PRECACHEPOLLBATCHSIZE

The number of notifications a client processes in one pre-cache poll cycle.

Click here to expand...

The number of notifications a client processes in one pre-cache poll cycle.

Registry value

Default value

Notes

PrecachePollBatchSize

20

Range is 1 to 500. If the value is greater than 500, it defaults to 500. If you set the value to 0, it defaults to 20.

MODULE.NOMAD.PRECACHEPOLLMINUTES

The interval (in minutes) between Nomad polling Content Distribution for new pre-cache jobs.

Click here to expand...

The interval (in minutes) between Nomad polling Content Distribution for new pre-cache jobs.

Registry value

Default value

Notes

PrecachePollMinutes

0x5A0 (1440)

Nomad clients normally start their polling cycle when the service starts-up, with a random delay to minimize the possibility of concurrent polls from different clients.

The range is 60 - 525600 (1 year). 0 disables polling

MODULE.NOMAD.PRECOMPLETETIMEOUTHOURS

The duration (in hours) after which PBA share is deleted from the host.

Click here to expand...

The duration (in hours) after which PBA share is deleted from the host.

Registry value

Default value

Notes

PreCompleteTimeoutHours

0x3 (3)

Located under the PBA registry key NomadBranch\NMDS, it only applies to a PBA share after the NMDS_POLL command has been run, but not the NMDS_COMPLETE command.

The intention is that an incomplete share will only be available for a short period of time. When the share is deleted the folder and associated user is removed.

MODULE.NOMAD.RECYCLEDPDELAY

The delay (in seconds) before restarting retries from the first DP after the whole list of available DPs have been tried.

Click here to expand...

The delay (in seconds) before restarting retries from the first DP after the whole list of available DPs have been tried.

Registry value

Default value

Notes

RecycleDPDelay

600

It is associated with the distribution point resilience feature and is used in conjunction with DownloadTimeout. The default equates to 10 minutes.

MODULE.NOMAD.RANDOMIZEREMOTEPATHS

Allows you to enable and disable the remote paths randomization for CM and pre-cache jobs.

Click here to expand...

Allows you to enable and disable the remote paths randomization for CM and pre-cache jobs.

When Nomad begins content download, its content is pulled from the same distribution point by every client. For example, If a site has four Distribution Points (DP), the first one in the list is always used for downloading. In a very large environment, this can put an unnecessary load on a single DP.

UsingRandomizeRemotePathsNomad can randomize the content location list.

Registry value

Type

Default value

Notes

RandomizeRemotePaths

REG_DWORD

0

By default, RandomizeRemotePaths is not present in the Nomad registry hive. To change the value, you need to create it and set your desired value.

You can enable and disable the remote paths randomization for either Configuration Manager (CM) or pre-cache jobs using the following bits:

Bit

Hex

Decimal

Notes

0

0x0001

1

Enable remote paths randomization for CM jobs.

1

0x0002

2

Enable remote paths randomization for Pre-cache jobs.

MODULE.NOMAD.SIGSFOLDER

The path to the Configuration Manager signature files.

Click here to expand...

The path to the Configuration Manager signature files.

Registry value

Default value

Notes

SigsFolder

C:\SMSSIG$

Relates to RDC integration and must point to the folder where the signature files are held for Configuration Manager. Wildcards are not allowed. For example:

E:\SMSSIG$

When it is not set, Nomad assumes that signature files location as C:\SMSSIG$, if it exists.

MODULE.NOMAD.SITESSDSTAGGER

Sets the site SSD query stagger duration (seconds).

Click here to expand...

Sets the site SSD query stagger duration (seconds).

Deployments to large numbers of clients (30,000 or more) generate significant network traffic from 1E Clients to ContentDistribution that may result in IIS 503 Overload errors on the server, causing content registrations and SSD requests to fail. SiteSsdStagger allows an elected subnet master to wait for a random configurable time before making a site SSD request. All peers in the subnet participating in the election would also synchronize and wait for the same time before copying from master machine.

Registry value

Type

Default value

Notes

SiteSsdStagger

REG_DWORD

0

Sets the site SSD query stagger duration in seconds. The stagger is 0 (disabled) by default.

The maximum value that can configured is 300 seconds (5 minutes).

There is no SSD staggering in WinPE.

Site SSD happens when broadcast is enabled or if local SSD is enabled and it does not return any devices from ActiveEfficiency.

Note

Please consult 1E before changing this value.

This setting works in conjunction with LocalSsdStagger.

MODULE.NOMAD.SITESSDMINPACKAGESIZEKB

Allows you to configure a minimum content size before making an SSD request.

Click here to expand...

Allows you to configure a minimum content size before making an SSD request.

Registry value

Type

Default value

Notes

SiteSSDMinPackageSizeKB

REG_DWORD

0

The default value is 0 which can be changed after installation when it will be an installer property.

There is no lower limit for this key, upper limit is 10240. If the registry value is greater than 10240, the agent will only consider 10240 and will log a warning.

Size of content is first taken from Job data, if that's not available it's taken from the LST file, if it's not present there, this key is ignored and an SSD request is made irrespective of size.

Note

This check is for site SSD, not for local SSD.

MODULE.NOMAD.SPECIALNETSHARE

Sets various special feature options related to the Nomad share.

The installer property must be set to sum of the integer values for the required bits. For example, to use the computer$ account for access to the Nomad share, and have custom share permissions, you would set the value for the SpecialNetShare registry entry to 129 (0x81 hex). This is shown in the following 1E Client installer command-line:

> msiexec /i 1E.Client-x64.msi MODULE.NOMAD.SPECIALNETSHARE=129 [other properties] /qn

Click here to expand...

Sets various special feature options related to the Nomad share.

Registry value

Default value

Notes

SpecialNetShare

0x2060 (8288)

You can set more than one option at the same time by combining the bit values. For example, to have custom share permissions and use the machine account for access to the Nomad share, set the value for SpecialNetShare to 129 (decimal value 1+128 or 0x0081 hex). See The Nomad share for more detail on configuration and security.

The default value in different versions has changed, based on feedback. Upgrading does not change the value unless explicitly set.

Nomad version

Default in MSI

Nomad 8.0 (1E Client 8.0)

0x2060 (8288)

  • Bit 5: Disables broadcast of download statistics

  • Bit 6: Enable Nomad FanOut

  • Bit 13: Use HTTP/S or SMB

Nomad 7.1 (1E Client 5.2)

Nomad 7.0 (1E Client 4.1 to 5.1)

0x2020 (8224)

  • Bit 5: Disables broadcast of download statistics

  • Bit 13: Use HTTP/S or SMB

Nomad 6.x

0x0000 (0)

  • No special features enabled.

The default used in all versions of Client Deployment Assistant (and earlier Endpoint Agent Installer) is 0x2070 (8304):

  • Bit 4: Enable Nomad hidden share as NomadSHR$

  • Bit 5: Disables broadcast of download statistics

  • Bit 6: Enable Nomad FanOut

  • Bit 13: Use HTTP/S or SMB

Bit

Hex

Decimal

Description

0x0000

0

No special features enabled.

0

0x0001

1

Custom Share Permissions: Administrators configure and manage custom share permissions. The service doesn't create the NomadSHR share on start-up, leaving the administrator to manually create it and set the permissions. It is also not deleted when the service stops and therefore existing share permissions are preserved.

1

0x0002

2

Enables support for IPv6: If the network supports both IPv6 and IPv4, enable support for both – set bit 1 but not bit 2.

2

0x0004

4

Disables support for IPv4: If the network supports only IPv6, disable IPv4 and set both bit 1 and bit 2.

3

0x0008

8

RESERVED

4

0x0010

16

The Nomad share is hidden and named NomadSHR$. When using a hidden share, all Nomad installations must be configured to use this option. See The Nomad share for more detail on configuration and security.

5

0x0020

32

Disables broadcast of download statistics. By default, this is disabled. If enabled, Nomad broadcasts download statistics to all peers when a download is complete.

Note

Prior to 1E Client 4.1 (Nomad 7.0) this was enabled (0) by default, now it is disabled (1) by default.

6

0x0040

64

Enables Nomad FanOut.

7

0x0080

128

The machine account is used when connecting to a peer client. The SMSNomadP2P& account is not created. Please refer to The Nomad share: Use Machine Account.

Note

Will not work if peers exist in untrusted domains or workgroups.

8

0x0100

256

RESERVED

9

0x0200

512

RESERVED

10

0x0400

1024

RESERVED

11

0x0800

2048

RESERVED

12

0x1000

4096

RESERVED (deprecated)

13

0x2000

8192

Use HTTP/S or SMB. Ensure that this is set if Nomad integration is used by Tachyon. HTTP/S is automatically used if CM client is detected.

Note

Prior to 1E Client 4.1 (Nomad 7.0) this was disabled (0) by default, now it is enabled (1) by default.

This setting should be enabled in baseline or other policies.

14

0x4000

16384

Web LSZ generation: enables the Nomad client on Configuration Manager standalone DPs to handle LSZ file generation requests coming from HTTP/HTTPS enabled clients.

Used when Nomad clients are configured with either of the following enabled:

  • Bit13 (0x2000) – Use HTTP/S or SMB

  • Bit 15 (0x8000) – Use HTTP/S only, not SMB

When enabled, the Nomad distribution point client creates a virtual folder called LSZFILES. The permissions for this are copied from the Configuration Manager SMS_DP_SMSPKGX$ share. By default, access to the LSZFILES folder requires SSL to be enabled. This is the case for Internet facing scenarios where local client access certificates will ensure authentication. If you are using HTTP instead of HTTPS, manually disable SSL on the LSZFILES web folder in order for the Nomad LSZ file generation process to work.

Only needs to be enabled when using HTTP or HTTPS on standalone DPs; it is not required on site server DPs because Nomad automatically configures Web LSZ generation on them.

15

0x8000

32768

Use HTTP/S only, not SMB: enables the Nomad client to download content using HTTPS or HTTP depending on the content location provided by Configuration Manager or Tachyon. The Nomad client will not use SMB to download content when this is enabled.

MODULE.NOMAD.SSDENABLED

Enables Single Site Download (SSD).

The installer property must be set to sum of the integer values for the required bits. For example, the following will turn the complete SSD functionality on.

> msiexec /i 1E.Client-x64.msi MODULE.NOMAD.SSDENABLED=3 [other properties] /qn

Click here to expand...

Enables Single Site Download (SSD).

Registry value

Default value

Notes

SSDEnabled

0

You can set more than one option at the same time by combining the bit values. For example, to enable clients to fetch downloads using SSD and provide them to peers, set the value to 3 (decimal value 1+2 or 0x3).

To enable clients to fetch downloads using site and local SSD and provide them to peers, set the value to 7.

To enable SSD when you install Nomad, you must specify the MODULE.NOMAD.SSDENABLED installer property and ensure the Tachyon client is enabled by specifying SWITCH and BACKGROUNDCHANNELURL installer properties. If MODULE.NOMAD.SSDENABLED is specified during installation, the registry value of ContentRegistration is automatically set to 1.

If you want to enable SSD as a provider after installation, then you also need to configure the registry values for SSDEnabled and ContentRegistration, in addition to enabling the Tachyon client. The ContentDistribution registry setting is found under the Platform key.

In legacy versions of Nomad, Platform features were provided using ActiveEfficiency. This required the PlatformURL setting to be configured. This is no longer required. You will see that the PlatformURL registry is used, but this is configured automatically by Nomad on startup by querying the value that the Tachyon client is using (stored in the 1EClient.conf file).

If your network is running over a WLAN or have devices on a wireless network you want to be content providers, set ContentProviderOnWifi=1.

Bit

Hex

Decimal

Description

0x0

0

SSD is disabled, the Nomad client takes no part in the SSD on the site.

0

0x1

1

SSD is enabled and the Nomad client fetches downloads using SSD. This setting on its own (without provider mode set) should be used with sensitive server weighting. Provider mode is where a peer gets content from another peer but cannot serve it (it cannot act as a master).

1

0x2

2

SSD is enabled and the Nomad client provides downloads to peers. Enabling this bit causes Nomad to register content with Content Distribution. In practice, this is unlikely to be used on its own. This is automatically disabled for WinPE installations (because cached content is only temporary).

2

0x4

4

Local SSD is enabled and the Nomad client fetches downloads from a local client (also known as a subnet peer master - the term used for local devices which have content but cannot be located during the normal election process because network broadcasts have been disabled) within the subnet.

The local SSD feature was introduced to supplement site SSD for clients on networks such as wireless where broadcasts are disabled, to prevent each client becoming its own master and downloading direct from the DP. In a SSD enabled environment, a master queries Content Distribution to get a list of devices on other subnets within the site that have content. With local SSD enabled, the master also queries for devices having content within local subnet. If any local peers with content are available, then the master downloads from them, otherwise it attempts to download from Site peers (other subnets in the site), and if the master still cannot find any peers, it downloads the content direct from the DP.

In version 7.0 and later, a master skips using local SSD if it sees broadcast messages from peers. This means clients in mixed network environments can be configured with the same SSDEnabled setting (with Local SSD enabled) and clients can move seamlessly between networks. When on a wireless network (where broadcasts are typically disabled) local SSD can be used. On LAN networks (where broadcasts are typically allowed) local SSD would be skipped because a master is elected and sees broadcast activity from peers.

This setting should only be used if networks have broadcasts being disabled (for example wireless networks) and clients are forced to download from the DP as they can't participate in an election.

Local SSD requires that a peer on the local subnet be configured to provide downloads to peers, that is at least one client on the subnet must be configured with Bit 1 enabled. To maintain consistency with typical Nomad peer sharing behavior where local SSD is not required, configure all clients with SSDEnabled=7. You'll also want to set ContentProviderOnWifi=1.

When enabled, the elected master:

  1. Queries Content Distribution to get a list of local devices having the content.

  2. Queries each of those devices to check if they are available and have the content. The list is ordered by percentage of content the device holds.

  3. Repeats the same process for devices on other subnets (existing SSD feature).

  4. Stores a list of subnets as well as site devices in memory.

  5. Cycles through the list in the following order:

    1. Subnet peer master (fetched from list of local devices from Content Distribution)

    2. Site master

    3. DP.

To distinguish between a master derived from Content Distribution and an election, the log records: Connection::SetDownloadSource = SubnetPeer (an elected peer) instead of Connection::SetDownloadSource = Peer (an SSD peer master).

MODULE.NOMAD.SSPBAENABLED

Enables the use of Single Site functionality for PBA data stores. See Single Site peer backup assistant for more details.

Click here to expand...

Enables the use of Single Site functionality for PBA data stores. See Single Site peer backup assistant for more details.

Registry value

Default value

Notes

SSPBAEnabled

0

Has a dependency on the Tachyon Platform PlatformURL. Values are:

  • 0 – disables single-site integration with ContentDistribution

  • 1 – enables single-site integration with ContentDistribution

MODULE.NOMAD.STATUSMSGEVENTS

Determines which Nomad events are reported using Configuration Manager status messages.

Click here to expand...

Determines which Nomad events are reported using Configuration Manager status messages.

Registry value

Default value

Notes

StatusMsgEvents

0x0

Nomad can send status messages through Configuration Manager based on specific download events which appear in its deployment status. They are provided mainly for advanced troubleshooting purposes, or for custom reporting solutions. From v7.1 onwards, they are no longer required for the Nomad Dashboard which now gets its status events directly via the Platform Content Distribution feature. However, you may have custom reporting in Configuration Manger that also use these messages, and you can configure this setting accordingly for this purpose.

These messages are controlled by the StatusMsgEvents registry value. This is a REG_SZ string data type and the format of the parameter must be a 64-bit value. Status messages are only sent when there is an active deployment.

Warning

Status message events should be used with caution as they could impact your Configuration Manager environment when scaled up to tens of thousands of machines.

For example, to set the request started, request completed, started copy and master changed events, update the StatusMsgEvents registry value to 0x80002060.

  • 0x0000000001 – SNO_EVT_START

  • 0x0000000002 – SNO_EVT_STOP

  • 0x0000000004 – SNO_EVT_ERROR

  • 0x0000000008 – SNO_EVT_PAUSED

  • 0x0000000010 – SNO_EVT_RESUMED

  • 0x0000000020 – SNO_EVT_REQUEST_STARTED

  • 0x0000000040 – SNO_EVT_REQUEST_COMPLETED

  • 0x0000000080 – SNO_EVT_SERVICE_RESET

  • 0x0000000100 – SNO_EVT_STARTED_CACHE_MANAGEMENT

  • 0x0000000200 – SNO_EVT_FINISHED_CACHE_MANAGEMENT

  • 0x0000000400 – SNO_EVT_STARTED_HASHCHECK

  • 0x0000000800 – SNO_EVT_FINISHED_HASHCHECK

  • 0x0000001000 – SNO_EVT_ELECTION_REQUEST

  • 0x0000002000 – SNO_EVT_MASTER_CHANGED

  • 0x0000004000 – SNO_EVT_FILLIN_MASTER_CHANGED

  • 0x0000008000 – SNO_EVT_MCAST_CENTRALSCHED

  • 0x0000010000 – SNO_EVT_MCAST_ERROR

  • 0x0000020000 – SNO_EVT_MCAST_COMPLETE

  • 0x0000040000 – SNO_EVT_SCHEDULER

  • 0x0000080000 – SNO_EVT_STARTED_TX_CENTRALMCAST

  • 0x0000100000 – SNO_EVT_STOPPED_TX_CENTRALMCAST

  • 0x0000200000 – SNO_EVT_STARTED_TX_ACTIVEMCAST

  • 0x0000400000 – SNO_EVT_STOPPED_TX_ACTIVEMCAST

  • 0x0000800000 – SNO_EVT_STARTED_TX_FILLINMCAST

  • 0x0001000000 – SNO_EVT_STOPPED_TX_FILLINMCAST

  • 0x0002000000 – SNO_EVT_STARTED_RX_CENTRALMCAST

  • 0x0004000000 – SNO_EVT_STOPPED_RX_CENTRALMCAST

  • 0x0008000000 – SNO_EVT_STARTED_RX_ACTIVEMCAST

  • 0x0010000000 – SNO_EVT_STOPPED_RX_ACTIVEMCAST

  • 0x0020000000 – SNO_EVT_STARTED_RX_FILLINMCAST

  • 0x0040000000 – SNO_EVT_STOPPED_RX_FILLINMCAST

  • 0x0080000000 – SNO_EVT_STARTED_COPY

  • 0x0100000000 – SNO_EVT_STOPPED_COPY

  • 0x0200000000 – SNO_EVT_WORKRATE_CHANGED

  • 0x0400000000 – SNO_EVT_WRONG_PKG_VERSION

  • 0x0800000000 – SNO_EVT_INFORMATIONAL

  • 0x1000000000 – SNO_EVT_FINALSTATS (see notes below)

  • 0x2000000000 – SNO_EVT_WAIT

  • 0x4000000000 – SNO_EVT_MAX_EVENTID

SNO_EVT_FINALSTATS notes

For success reporting, this message provides feedback on the status of the download. For example, it can show how much data was received using multicast as opposed to peer-to-peer copying. Turning this message on creates an extra status message per machine for each deployment. The format of the status message is:

Evt_FinalStats MD100067 1 170 59195038 170 59195038 0 59195038 0 0

Configuration Manager status messages are made up of insertion strings. The strings for the final stats event are:

InstrStr0

Nomad event string (internal reference)

N/A

InstrStr1

Package Id and Package version

MD100067 1

InstrStr2

Total number of files in package

170

InstrStr3

Total number of package bytes

59195038

InstrStr4

Number of files which are cached

170

InstrStr5

Bytes which are cached

59195038

InstrStr6

Bytes coped from a peer agent (P2P)

0

InstrStr7

Bytes copied from the DP

59195038

InstrStr8

Bytes received via local multicast

0

InstrStr9

Bytes received from a central multicast

0

If the package is already cached and is re-deployed with an unchanged package version, the final stats message will not be re-sent.

MODULE.NOMAD.SUCCESSCODES

A list of Nomad return codes that are translated as success to the Content Transfer Manager (CTM) component of the Configuration Manager client.

Click here to expand...

A list of Nomad return codes that are translated as success to the Content Transfer Manager (CTM) component of the Configuration Manager client.

Registry value

Default

Notes

SuccessCodes

0x206b, 0x2077, 0x103, 0xffffffff, 0x1, 0x70, 0x2050, 0x2051, 0x2052, 0x2053, 0x2054,0x2055, 0x2056, 0x2057, 0x2058, 0x205a, 0x205b, 0x205c, 0x205d, 0x205e, 0x2060, 0x2061,0x2062, 0x2063, 0x2064, 0x2065, 0x2066, 0x2067, 0x2068, 0x2069, 0x209A

This REG_SZ value contains a comma-delimited list of possible Nomad return codes that should be treated as a success and thereby prevent Configuration Manager from attempting to download the content itself or use another Alternate Content Provider (ACP). Any code returned by Nomad that is not on the list will be treated as a failure and trigger the Configuration Manager client to attempt to download the content using alternate means. Nomad also sends a status message to the Configuration Manager site containing its return code.

Strictly speaking the Nomad return codes are actually internal status codes, Nomad will only ever return success or failure to the Content Transfer Manager (CTM) component of the Configuration Manager client. When CTM receives a success it passes control to the ExecMgr component of the Configuration Manager client, which attempts to execute the deployment. ExecMgr will fail if Nomad did not download the content and make it available in the Configuration Manager cache. In this case, ExecMgr sends a status message (e.g. failed deployment) back to the Configuration Manager site.

If Nomad generates a return code that is not in the list, it passes a fail to the CTM component which causes the Configuration Manager client to try downloading the content itself using BITS, or use another Alternate Content Provider (ACP). This process may itself succeed or fail depending on the conditions that resulted in the original Nomad return code, and may have an undesirable impact on the network.

Note

The special code 0x9999 can be added to the list, or used on its own, to cause Nomad to always return a success to CTM. As a consequence this code is also known as "prevent failover to BITS".

Note

The SuccessCodes list need not be modified under normal circumstances, other than to add or remove the 0x9999 code.

The following table shows the possible Nomad return codes that can be set in the list:

Note

This list is subject to change with each release of Nomad, and provided for reference only.

Return Code

Description

Dec

Hex

‭-1

0xFFFFFFFF

Reserved.

1

0x0001

Reserved.

112

0x0070

Insufficient disk space to create the cache.

259

0x0103

Reserved.

8272

0x2050

The download has been suspended by APM.

8273

0x2051

The user has cancelled this download.

8274

0x2052

Invalid command line.

8275

0x2053

Command-line execution failure.

8276

0x2054

Internal Error.

8277

0x2055

The package exceeds the threshold for a RAS connection.

8278

0x2056

The package exceeds the threshold for a Slow LAN connection.

8279

0x2057

The package exceeds the threshold for a Fast LAN connection.

8280

0x2058

Reserved.

8281

0x2059

Unknown transport. Returned when an attempt is made to download a Software Update from an Internet location (like Microsoft Updates).

8282

0x205A

Invalid special package path (set using --pp).

8283

0x205B

Incorrect file hash.

8284

0x205C

Exited due to a kill request.

8285

0x205D

DP path not found.

8286

0x205E

The MaxBusyBackOff consecutive event threshold has been exceeded.

8287

0x205F

The service has stopped.

8288

0x2060

The advertisement has expired.

8289

0x2061

Reserved.

8290

0x2062

This is an unlicensed version of Nomad.

8291

0x2063

Invalid alternate cache path (set using --cp).

8292

0x2064

No Configuration Manager job data found in WMI.

8293

0x2065

Incorrect package hash.

8294

0x2066

MaxDuration or execution runtime for this program has been exceeded.

8295

0x2067

Reserved.

8296

0x2068

Incorrect package version.

8297

0x2069

Obsolete package version.

8298

0x206A

The BlockSize has been changed during download.

8299

0x206B

The "no progress" re-check threshold has been exceeded.

8300

0x206C

The parent process has terminated.

8301

0x206D

Duplicate download for the package.

8302

0x206E

The service was reset. This will occur if certain configuration parameters are changed during a download e.g. NomadInhibitedSubnets

8303

0x206F

Nomad inhibited.

8311

0x2077

Internal error LST incomplete.

8346

0x209A

Client certificate missing. Nomad is configured to use certificate-based client authentication but was unable to find an appropriate certificate.

MODULE.NOMAD.SUPPORTWPAD

Provides support for Web Proxy Auto-Discovery Protocol (WPAD).

Click here to expand...

Provides support for Web Proxy Auto-Discovery Protocol (WPAD).

Nomad always uses System level proxy if it has been set, irrespective of what SupportWPAD has been set to.

SupportWPAD was introduced in v7.1 and when disabled it does not change the default behavior, which is: If system level proxy is set then use it, otherwise access directly without proxy.

When SupportWPAD is enabled in Nomad, the behavior is:

  • If system level proxy is set then use it and do not try WPAD

  • If system level proxy is not set then fetch automatic proxy using WPAD and use it

  • If system level proxy is not set and failed to get automatic proxy using WPAD then try access directly without proxy.

How to know if a system level proxy has been set

netsh winhttp show proxy

Registry value

Default value

Notes

SupportWPAD

0

By default, the WPAD feature is disabled. To enable WPAD in Nomad, add registry key 'SupportWPAD' and set it to 1 at registry path HKLM/Software/1E/NomadBranch

To enable or disable the WPAD feature in Nomad:

  • Disable WPAD set SupportWPAD = 0

  • Enable WPAD set SupportWPAD= 1 (or non-zero value).

MODULE.NOMAD.USEFIPS

This installer property sets the Nomad EncryptionType registry entry.

Determines the type of encryption used by Nomad to encrypt its communications between Nomad peers.

Click here to expand...

Determines the type of encryption used by Nomad to encrypt its communications between Nomad peers.

Registry value

Default value

Notes

EncryptionType

0x0 (0)

Value are:

  • 0 – standard Nomad encryption

  • 1 – FIPS encryption

MODULE.NOMAD.WAKEUPBATCHSIZE

The maximum number of machines to wake up in a single call.

Click here to expand...

The maximum number of machines to wake up in a single call.

Warning

Nomad integration with WakeUp enables Nomad to share content from its devices that are holding particular content, even if those devices are offline. One reason why peers in the local subnet may not respond to the request even though they have content in their caches is that they are offline (shutdown, in hibernate or sleep mode). However, if WakeUp is integrated, the Nomad client would know which offline device has the content and can wake it up when it queried Content Distribution.

The wake-up list is maintained by Content Distribution and is the same list that Single Site Download (SSD) uses. Separate lists of peers are returned for the subnet and site. This feature requires Nomad SSD to be enabled, Content Distribution, and a NightWatchman infrastructure. The feature is enabled during the installation of the NightWatchman Management Center. Please refer toIntroducing Content Distribution for requirements.

Registry value

Default value

Notes

WakeUpBatchSize

10

Sets the maximum number of machines to wake up in one call, for subnet and site separately. (So up to twice this number of requests is sent in total if WakeUp is enabled for both subnet and site.) The next batch is launched, if necessary, after a re-election (usually a periodic election).

The value cannot be greater than MaxDevicesFromAE, and hence itself cannot be more than 20.

MODULE.NOMAD.WAKEUPENABLED

Enables WakeUp integration, see Integrating Nomad with WakeUp for more details.

Click here to expand...

Enables WakeUp integration, see Integrating Nomad with WakeUp for more details.

Warning

Nomad integration with WakeUp enables Nomad to share content from its devices that are holding particular content, even if those devices are offline. One reason why peers in the local subnet may not respond to the request even though they have content in their caches is that they are offline (shutdown, in hibernate or sleep mode). However, if WakeUp is integrated, the Nomad client would know which offline device has the content and can wake it up when it queried Content Distribution.

The wake-up list is maintained by Content Distribution and is the same list that Single Site Download (SSD) uses. Separate lists of peers are returned for the subnet and site. This feature requires Nomad SSD to be enabled, Content Distribution, and a NightWatchman infrastructure. The feature is enabled during the installation of the NightWatchman Management Center. Please refer toIntroducing Content Distribution for requirements.

Registry value

Default value

Notes

WakeUpEnabled

0

Determines the status of the WakeUp integration. If configured by the installer, it is disabled (0) by default. If integration is enabled, Nomad attempts to wake up dormant hosts that are known to have the requested content in their caches. The integration has a dependency on the PlatformURL.

To enable integration post-installation, for normal usage, set both bits 0 and 1 (0x3)

Bit

Hex

Decimal

Description

0x0

0

Disables WakeUp integration.

0

0x1

1

Enables WakeUp integration only for the local subnet.

1

0x2

2

Enables WakeUp integration only for the site.

0x3

3

Enables WakeUp integration for the site and the local subnet.

MODULE.NOMAD.WAKEUPMINPACKAGESIZEMB

The minimum size of content (in megabytes) that will cause a request for a wakeup. See Integrating Nomad with WakeUp for more details.

Click here to expand...

The minimum size of content (in megabytes) that will cause a request for a wakeup. See Integrating Nomad with WakeUp for more details.

Warning

Nomad integration with WakeUp enables Nomad to share content from its devices that are holding particular content, even if those devices are offline. One reason why peers in the local subnet may not respond to the request even though they have content in their caches is that they are offline (shutdown, in hibernate or sleep mode). However, if WakeUp is integrated, the Nomad client would know which offline device has the content and can wake it up when it queried Content Distribution.

The wake-up list is maintained by Content Distribution and is the same list that Single Site Download (SSD) uses. Separate lists of peers are returned for the subnet and site. This feature requires Nomad SSD to be enabled, Content Distribution, and a NightWatchman infrastructure. The feature is enabled during the installation of the NightWatchman Management Center. Please refer toIntroducing Content Distribution for requirements.

Registry value

Default value

Notes

WakeUpMinPackageSizeMB

1024

Any content below this size is downloaded from the DP as downloads from the DP for files this size will likely complete before any wakeups will have had a chance to finish. The value can be 0, in which case wakeups will always be attempted.

For example, if it is set to 512 and size of the content downloaded is 500 MB, a wake-up request (to site or subnet) is not be sent. Similarly, if size of the content is 600 MB, then wake-up requests (to site and subnet, determined by WakeupEnabled) is be sent.

Note

For standalone downloads (using SMSNomad.exe) and under WinPE, there has no effect as the size of the content cannot easily be determined. Wake-up requests are always sent in these instances.

MODULE.NOMAD.WLANBLIPSECS

The duration for temporarily disabling a wireless connection when a wired LAN connection becomes available, to provide time for the OS and Nomad to switch to the LAN connection. This is useful for OS versions and drivers that do not automatically switch to a preferred wired connection.

Click here to expand... The duration for temporarily disabling a wireless connection when a wired LAN connection becomes available, to provide time for the OS and Nomad to switch to the LAN connection. This is useful for OS versions and drivers that do not automatically switch to a preferred wired connection.

Registry value

Default value

Notes

WLanBlipSecs

0

The value must be 20 seconds or more.

Nomad provides extra stability by managing a machine's network connections as they move between a wireless and a wired LAN. Depending on the OS version or other factors, once an SMB or HTTP session is running on a wireless connection, it will remain on wireless even when a wired LAN becomes available. Nomad uses WLanBlipSecs to temporarily drop a wireless connection when it detects a wired LAN connection, to give time for the OS and Nomad to automatically switch to the LAN connection.

For example, if a Nomad master was initiated when a machine was on a wireless connection and a wired connection subsequently became available, Nomad disables the wireless adapter for a long enough period to enable a switchover to the wired connection. As a result of this, the IP address and the share path will change and peers will log error messages until each peer re-establishes its connection to the master and the new share location.

This feature is turned off by default.

Note

Other applications may be affected when switching from wireless to wired connection.

Irrespective of the WLanBlipSecs setting, you can also control which service set identifier (SSID) Nomad connects to by managing a list. To do this, update the NomadBranch WLanProfileList registry value with a comma-delimited list of SSIDs or use the wildcard (*) character for any SSID.

Examples:

WLanProfileList REG_SZ WIFIGAP,GUEST
WLanProfileList REG_SZ *
MODULE.NOMAD.WLANPROFILELIST

A list of wireless SSIDs to enable switching from wireless to wired LAN connections.

Click here to expand...

A list of wireless SSIDs to enable switching from wireless to wired LAN connections.

Registry value

Default value

Notes

WLanProfileList

A comma-delimited list of wireless SSIDs (* for any all) which enables Nomad to switch form wireless to a wired LAN connection when it becomes available.