Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Summary

Excerpt

Installer and configuration settings for the WakeUp client module of the 1E Client supported only on Windows computers.


Info

Installer properties:

Multiexcerpt
MultiExcerptNameInstaller properties

Table of Contents
maxLevel4
minLevel4
absoluteUrltrue
exclude1E Client logs
typeflat
separatorpipe



Info

Configuration file settings:

Multiexcerpt
MultiExcerptNameConfigurationFileSettings
Table of Contents
maxLevel4
minLevel4
excludeMODULE.*
typeflat
printablefalse
separatorpipe




Advanced Panelboxes for Confluence
id1
titleOn this page:

Table of Contents
maxLevel3
minLevel2
indent20px
excludeSummary|On this page|In this section...
separatornewline


Multiexcerpt include
MultiExcerptNameManageSettings
PageWithExcerpt1E Client configuration settings and installer properties


Multiexcerpt
MultiExcerptNameWakeUpAgentRegistryNote


Note

The WakeUp client module of the 1E Client replaces the 1E Agent WakeUp components of the 1E Agent and 1E WakeUp Server.

If the WakeUp Server is configured in multi-agent mode (recommended) then the 1E Client must be installed with the WakeUp client module enabled on all in-scope devices.

When the 1E Client starts, and the WakeUp client module is enabled, it will only initialize the WakeUp client module if the OS version is Windows 7 or later. The 1E Client will automatically remove any previous installation of the WakeUp component from the 1E Agent, leaving behind the NightWatchman component, and keeping the WakeUp Agent registry settings. For NightWatchman v7.2.500 onwards the NightWatchman Agent has a separate installer, and its settings continue to be managed by the NightWatchman Management Center Web Service.

The WakeUp Server also requires a local WakeUp Agent, and therefore requires the 1E Client to be installed with the WakeUp client module enabled. The WakeUp Server is a 32-bit process and its registry entries are in the 32-bit WOW6432Node area. The 1E Client is a 64-bit process with its registry entries in the 64-bit area. When the 1E Client starts, if the WakeUp client module is enabled the 1E Client will automatically remove any previous installation of the WakeUp Agent component, leaving behind the WakeUp Server component, and moving the existing WakeUp Agent registry settings from the 32-bit to the 64-bit area of the registry.

WakeUp and the WakeUp client module of the 1E Client do not require a full Tachyon infrastructure; only the 1E Client is required, Tachyon Servers are not required. The full Tachyon infrastructure is required only if you are integrating NightWatchman with Tachyon.

The WakeUp client module of the 1E Client is not supported on:

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

The following legacy WakeUp features from the 1E Agent do not exist in the WakeUp client module:

  • 1E WakeUp Agent service - all WakeUp Agent features are now implemented as the WakeUp client module in the 1E Client service
  • Computer Health feature - is now obsolete



WakeUp client installation settings

The table below lists the configuration properties required to enable the WakeUp client required for integration with NightWatchman Enterprise v7.2.500 or later.

Multiexcerpt include
MultiExcerptNameCase-AnySettings
PageWithExcerpt1E Client settings

1E Client configuration settingInstallation defaultDescription

Module.WakeUp.Enabled
Anchor
MODULEWAKEUPENABLED
MODULEWAKEUPENABLED

false


Multiexcerpt
MultiExcerptNameModuleWakeUpEnabled

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

Enabling this will also cause any installation of the 1E Agent's WakeUp component to be uninstalled the first time the 1E Client is started, leaving the NightWatchman component if that was installed.

Note

When true then you must also specify either the name of the NightWatchman Management Center reporting server, or that reporting is turned off. For details of these and all other installer properties please refer to 151426267 WakeUp client settings.




Module.WakeUp.ManageFirewallRules
Anchor
MANAGEFIREWALLRULES
MANAGEFIREWALLRULES

true


Multiexcerpt
MultiExcerptNameWakeUpManageFirewallRules

Set this property to true to enable the Windows firewall domain rule. The default value is true.

A Windows firewall domain rule called 1E Client is removed/added each time the 1E Client is stop/started.



WakeUp client registry settings

Multiexcerpt
MultiExcerptNameWakeUpRegistryProperties

The table below lists additional settings for the WakeUp client module, which may be specified during installation of the 1E Client as Windows installer properties in upper-case. They are stored in the registry in mixed-case. They are not stored in the 1E Client configuration file, and cannot be reconfigured after installation using 1E Client command-line parameters. The registry values can be updated via group policy object (GPO) administrative templates or other means.

Note

The table indicates where installer properties have a different name to the registry setting. In some cases this is for backwards compatibility with previous 1E Agent installer properties.

In the descriptions below, the term WakeUp Agent is used to describe the WakeUp client module of the 1E Client. The terms Primary Agent and Alternate Agent are WakeUp roles.

Multiexcerpt include
MultiExcerptNameCase-AnySettings
PageWithExcerpt1E Client settings

1E Client installer property

Installation defaultDescriptionRegistry nameRegistry type

MODULE.WAKEUP.ADDITIONALSUBNETS
Anchor
ADDITIONALSUBNETS
ADDITIONALSUBNETS


Note

The registry value is not created unless the installation property is specified.



Multiexcerpt
MultiExcerptNameWakeUpAdditionalSubnets

Used only in dedicated agent mode. It enables the dedicated WakeUp Agent to register to awaken multiple subnets. It requires that directed subnet broadcasts are enabled in the routers between the agent and remote subnets. It takes a comma delimited list of subnets. Its use and format are described in WakeUp documentation for NightWatchman Enterprise: Configuring network access control security.


\AdditionalSubnetsREG_SZ

MODULE.WAKEUP.AGENTTCPPORT
Anchor
AGENTTCPPORT
AGENTTCPPORT

Note

The registry name is different to the installer property name (it has an underscore).


1776


Multiexcerpt
MultiExcerptNameWakeUpAgentTcpPort

The listening port used by the WakeUp Server to communicate with the WakeUp Agents. Default value is 1776 (decimal).

Note

The AgentTCP_Port value must be different to the TCP_Port value, and must be the same for the WakeUp Server and all Agents.



\AgentTCP_PortREG_DWORD

MODULE.WAKEUP.AGENTTO
Anchor
AGENTTO
AGENTTO




Multiexcerpt
MultiExcerptNameWakeUpAgentTo

Set to enable Dedicated Agent mode. This parameter should be set to the FQDN (recommended) or NetBIOS name of the WakeUp Server.

Default is empty to enable Multi-Agent mode. Dedicated Agent mode does not have Multi-Agent features.


\AgentToREG_SZ

MODULE.WAKEUP.ALLOWLASTMANSUSPEND
Anchor
ALLOWLASTMANSUSPEND
ALLOWLASTMANSUSPEND


1


Multiexcerpt
MultiExcerptNameWakeUpAllowLastManSuspend

Set to 0 if you want to allow a Primary or Alternate Agent to respect Microsoft power schemes and go to sleep.

Set to 1 (default) to prevent a Primary or Alternate Agent going to sleep.

Note

The value of this property is the opposite to what its name implies.



\AllowLastManSuspendREG_DWORD

MODULE.WAKEUP.CERTISSUER
Anchor
CERTISSUER
CERTISSUER



Multiexcerpt
MultiExcerptNameWakeUpCertIssuer

Specify the text used to search for a client certificate in the client certificate store.

Either MODULE.WAKEUP.CERTISSUER or MODULE.WAKEUP.CERTSUBJECT is mandatory when all the following are true:

  • HTTPS communications is being used
  • MODULE.WAKEUP.SECUREREPORTINGSERVER is configured
  • SSL Settings for the NightWatchman Management Center Web Service is configured to require a client certificate

If this property is used, it will use the first certificate it finds where the specified text matches the certificate's Issuer CN.


\Reporting\HTTPS\CertIssuerREG_SZ

MODULE.WAKEUP.CERTSUBJECT
Anchor
CERTSUBJECT
CERTSUBJECT



Multiexcerpt
MultiExcerptNameWakeUpCertSubject

Specify the text used to search for a client certificate in the client certificate store.

Either MODULE.WAKEUP.CERTISSUER or MODULE.WAKEUP.CERTSUBJECT is mandatory when all the following are true:

  • HTTPS communications is being used
  • MODULE.WAKEUP.SECUREREPORTINGSERVER is configured
  • SSL Settings for the NightWatchman Management Center Web Service is configured to require a client
    certificate

If this property is used, it will use the first certificate it finds where the specified text matches the certificate's Subject CN.


\Reporting\HTTPS\CertSubjectREG_SZ

MODULE.WAKEUP.DEBUG
Anchor
DEBUG
DEBUG

13


Multiexcerpt
MultiExcerptNameWakeUpDebug

Sets the level of debug information output to the WakeUp Agentlog file. Default value is 13 (decimal). Range is 1 to 255 (decimal).

You should only change this value if requested by 1E Support, and reset it back to 13 when investigation is completed.


\DebugREG_DWORD

MODULE.WAKEUP.DELAYCYCLESMSSECS
Anchor
DELAYCYCLESMSSECS
DELAYCYCLESMSSECS

16


Multiexcerpt
MultiExcerptNameWakeUpDelayCycleSmsSecs
Delay (in seconds) before the WakeUp Agent performs a policy refresh after receiving a policy refresh instruction from the WakeUp Server via the Primary Agent. This delay allows time for the ConfigMgr Management Point to be updated in instances where Advertisements are newly created. Default value is 16.


\DelayCycleSMSSecsREG_DWORD

MODULE.WAKEUP.ENCRYPTIONLEVEL
Anchor
ENCRYPTIONLEVEL
ENCRYPTIONLEVEL

0


Multiexcerpt
MultiExcerptNameWakeUpEncryptionLevel

The encryption level used in communications between WakeUp Agents and WakeUp Servers. This does not affect encryption used for WakeUp Reporting.

  • 0 – Disable WakeUp encryption (default)
  • 2 – Enable WakeUp encryption
  • 3 – Enable FIPS encryption
Note

If the MODULE.WAKEUP.USEFIPS installer property is set to 1 it will override the MODULE.WAKEUP.ENCRYPTIONLEVEL installer property and sets the EncryptionLevel registry value to 3, and also uses FIPS for WakeUp Reporting by setting the UseFipsComplianceEncryption registry value to 1.

When configuring this option you will need to ensure that the same setting is made for all WakeUp Agents and WakeUp Servers.

Care is required when migrating Agents from Off (0) to On (2) or the other way round, then the WakeUp Servers will need be configured to support both, by temporary use of of partial/mixed encryption (1). Once you are sure all Agents are configured to the same setting, then you should change the WakeUp Server to match the Agents' setting.

WakeUp does not support partial/mixed use of FIPS (3) and EncryptionLevel (0/2) therefore all NightWatchman and WakeUp Servers and Agents must be configured to use FIPS from the outset, or all changed at the same time.

EncryptionLevel and FIPS settings used by WakeUp do not affect other 1E Client communications.



\EncryptionLevelREG_DWORD

MODULE.WAKEUP.LASTMANENABLED
Anchor
LASTMANENABLED
LASTMANENABLED

1


Multiexcerpt
MultiExcerptNameWakeUpLastManEnabled
Determines if the WakeUp last man standing functionality is turned on or off.
  • 0 – turns last man standing functionality off
  • 1 – turns last man standing functionality on (default)


\LastManEnabledREG_DWORD

MODULE.WAKEUP.LOGFILENAME
Anchor
LOGFILENAME
LOGFILENAME

Note

The registry name is the same as the installer property name but contains a combination of LOGPATH and LOGFILENAME installer properties.


WakeUpAgt.log


Multiexcerpt
MultiExcerptNameWakeUpLogFileName
The name of the WakeUp Agent log file. This combines with LOGPATH to give the LogFileName registry value.


\LogFileNameREG_SZ

MODULE.WAKEUP.LOGPATH
Anchor
LOGPATH
LOGPATH

Note

See LOGFILENAME.


%ALLUSERSPROFILE%\1E\Agent


Multiexcerpt
MultiExcerptNameWakeUpLogPath
The location of the WakeUp Agent log file. This combines with LOGFILENAME to give the LogFileName registry value.



Note

See LOGFILENAME



MODULE.WAKEUP.MAGICPACKETDELAY
Anchor
MAGICPACKETDELAY
MAGICPACKETDELAY

1


Multiexcerpt
MultiExcerptNameWakeUpMagicPacketDelay
The delay (in milliseconds) between the WakeUp Agent sending subsequent Magic Packets. Default value is 1.


\MagicPacketDelayREG_DWORD

MODULE.WAKEUP.MAGICPACKETPORT
Anchor
MAGICPACKETPORT
MAGICPACKETPORT

Note

The registry name is different to the installer property name (it has an underscore).


1776


Multiexcerpt
MultiExcerptNameWakeUpMagicPacketPort
The UDP port used to send wake up broadcasts. Default value is 1776 (decimal).


\MagicPacket_PortREG_DWORD

MODULE.WAKEUP.MAXIMUMFILEAGESECS
Anchor
MAXIMUMFILEAGESECS
MAXIMUMFILEAGESECS

1209600 (14 days)


Multiexcerpt
MultiExcerptNameWakeUpMaximumFileAgeSecs
Sets the maximum age (in seconds) for the Agent to retain reporting information locally when the NightWatchman Management Center Web Service cannot be contacted. By default, this is set to 1209600 seconds (14 days). Any files older than that will not be submitted to the NightWatchman Management Center Reporting and will be deleted instead. This value need not be modified under normal circumstances.


\Reporting\MaximumFileAgeSecsREG_DWORD

MODULE.WAKEUP.MAXLOGFILESIZE
Anchor
MAXLOGFILESIZE
MAXLOGFILESIZE

1048576 (1MB)


Multiexcerpt
MultiExcerptNameWakeUpMaxLogFilesize

Maximum size (in bytes) for the WakeUp Agent log file. There are 5 rollover files numbered 1 (newest) to 5 (oldest) with the rollover number included as n.log

(In previous versions of WakeUp the .LOG file was renamed with a .LO_ extension and a new .LOG file is created. The .LO_ file is overwritten each time.)


\MaxLogFilesizeREG_DWORD

MODULE.WAKEUP.REFRESHHWINFOAFTERHOURS
Anchor
REFRESHHWINFOAFTERHOURS
REFRESHHWINFOAFTERHOURS

720 (30 days)


Multiexcerpt
MultiExcerptNameWakeUpRefreshHwInfoAfterHours

The frequency (in hours) for hardware inventory details to be sent to the NightWatchman server if WakeUp reporting is enabled (default) and MODULE.WAKEUP.SENDHARDWAREINFO=ON.

Range is from 24 to 999. The default is 720 (30 days).

If the NightWatchman Agent is also installed, it will send hardware inventory more frequently.


\Hardware\RefreshHwInfoAfterHoursREG_DWORD

MODULE.WAKEUP.REFRESHONSUBNETCHANGE
Anchor
REFRESHONSUBNETCHANGE
REFRESHONSUBNETCHANGE

ON


Multiexcerpt
MultiExcerptNameWakeUpRefreshOnSubnetChange
Triggers the local ConfigMgr client to do a Hardware Inventory Cycle when the WakeUp Agent detects a change of subnet.  The client in turn, updates the ConfigMgr Site inventory, thereby enabling the Site's WakeUp Server to have the latest subnet details.
  • ON – monitor subnet changes on both physical and wireless connections (default).
  • IGNOREWIRELESS – only monitor subnet changes on physical connections.
  • OFF – no action is taken when the subnet changes.
Tip

This is particularly useful where laptops move between offices. Typically, Wake-On-LAN is not supported over wireless, therefore IGNOREWIRELESS avoids the overhead of triggering a ConfigMgr hardware inventory for wireless changes. Use OFF only if you are sure computers will not change subnet, and you can rely on the normal ConfigMgr inventory cycle.

The WakeUp system relies on having the latest subnet details in order to wake computers. The WakeUp Agent updates the NightWatchman database with all subnet changes, because the NightWatchman server is designed to support frequent updates.


\RefreshOnSubnetChangeREG_SZ

MODULE.WAKEUP.REPEATCOUNT
Anchor
REPEATCOUNT
REPEATCOUNT

0


Multiexcerpt
MultiExcerptNameWakeUpRepeatCount

Number of times to repeat sending Magic Packets. Default is 0.

Note
If you suspect that your network is prone to dropping datagram packets you should try different configurations for RepeatCount and RepeatDelay . Otherwise, these should be left at their default values.



\RepeatCountREG_DWORD

MODULE.WAKEUP.REPEATDELAY
Anchor
REPEATDELAY
REPEATDELAY

0


Multiexcerpt
MultiExcerptNameWakeUpRepeatCount

Delay (in milliseconds) before resending a repeated Magic Packet. Default is 0.

Note
If you suspect that your network is prone to dropping datagram packets you should try different configurations for RepeatCount and RepeatDelay . Otherwise, these should be left at their default values.



\RepeatDelayREG_DWORD

MODULE.WAKEUP.REPORTING
Anchor
REPORTING
REPORTING

ON


Multiexcerpt
MultiExcerptNameWakeUpReporting

Enables WakeUp reporting. Sets whether the Agent sends reporting messages to the NightWatchman Management Center Web Service. May be set to one of the following values:

Tip

When installing the 1E Client on a WakeUp Server, set MODULE.WAKEUP.REPORTING=OFF so that the server does not appear as a client in the NightWatchman Management Center Admin Console. This will only disable Agent reporting whilst the WakeUp Server will have reporting enabled for reporting statistics.



\ReportingREG_SZ

MODULE.WAKEUP.REPORTINGSERVER
Anchor
REPORTINGSERVER
REPORTINGSERVER

Note

The registry name is different to the installer property name. The supplied value is converted into a full URL.




Multiexcerpt
MultiExcerptNameWakeUpReportingServer

Set this parameter to the FQDN (recommended) or NetBIOS name of the server hosting the NightWatchman Management Center Web Service.


Warning

Mandatory when WakeUp reporting is enabled (default) and using HTTP for communications.



Tip

If HTTP is not using standard port 80 then specify the port number as part of the server name:
MODULE.WAKEUP.REPORTINGSERVER="ACMESERVER.ACME.COM:8080"




\Reporting\HTTP\ServiceUrlREG_SZ

MODULE.WAKEUP.SECUREREPORTINGSERVER
Anchor
SECUREREPORTINGSERVER
SECUREREPORTINGSERVER

Note

The registry name is different to the installer property name. The supplied value is converted into a full URL.




Multiexcerpt
MultiExcerptNameWakeUpSecureReportingServer

Set this parameter to the FQDN (required) or NetBIOS name of the server where the NightWatchman Management Center Web Service component secure site has been installed.


Warning

Mandatory when WakeUp reporting is enabled (default) and using HTTPS for communications.


Tip

If HTTPS is not using standard port 443 then specify the port number as part of the server name:
MODULE.WAKEUP.SECUREREPORTINGSERVER="ACMESERVER.ACME.COM:7433"



\Reporting\HTTPS\ServiceUrlREG_SZ

MODULE.WAKEUP.SENDHARDWAREINFO
Anchor
SENDHARDWAREINFO
SENDHARDWAREINFO

Note

The registry name is different to the installer property name.


ON


Multiexcerpt
MultiExcerptNameWakeUpSendHardwareInfo

Enables hardware information messages to be sent to the NightWatchman server, if MODULE.WAKEUP.REPORTING=ON.

See also MODULE.WAKEUP.REFRESHHWINFOAFTERHOURS.


\Modules\HwInfoAgtREG_SZ

MODULE.WAKEUP.SPOOLDIR
Anchor
SPOOLDIR
SPOOLDIR

Note

The registry name is different to the installer property name.


%ALLUSERSPROFILE%\1E\Reporting\WakeUp\


Multiexcerpt
MultiExcerptNameWakeUpSpoolerDir
The location of the WakeUp spooler directory, where Reporting messages are stored before being sent to the NightWatchman Management Center Web Service. The location should not need to be modified under normal circumstances. Default value is%ALLUSERSPROFILE%\1E\Reporting\WakeUp\


\Reporting\SpoolerDirectoryREG_SZ

MODULE.WAKEUP.STAYONFROMSTANDBYMINS
Anchor
STAYONFROMSTANDBYMINS
STAYONFROMSTANDBYMINS

0


Multiexcerpt
MultiExcerptNameWakeUpStayOnFromStandbyMins

Set this to the number of minutes the Wakeup Agent keeps the OS awake after a wakeup. This is to allow sufficient window of time for multiple jobs to run.

If set to less than or equal to 0 (default) then the WakeUp Agent will keep the OS awake for 20 minutes. Set this this value to more than 20 to keep the OS awake for longer.


\StayOnFromStandbyMinsREG_DWORD

MODULE.WAKEUP.SUBNETOVERRIDE
Anchor
SUBNETOVERRIDE
SUBNETOVERRIDE



Note

The registry value is not created unless the installation property is specified.



Multiexcerpt
MultiExcerptNameWakeUpSubnetOverride

Contains a list of all unauthenticated subnets that correspond to the authenticated subnets for which the Agent is responsible. Its use and format are described in WakeUp documentation for NightWatchman Enterprise: Configuring network access control security.


\SubnetOverrideREG_SZ

MODULE.WAKEUP.TCPPORT
Anchor
TCPPORT
TCPPORT

Note

The registry name is different to the installer property name (it has an underscore).


1777


Multiexcerpt
MultiExcerptNameWakeUpTCPPort

The listening port used by the WakeUp Agents to communicate with the WakeUp Server. Default value is 1777 (decimal).

Note
The TCP_Port value must be different to the AgentTCP_Port value, and must be the same for the WakeUp Server and all Agents.



\TCP_PortREG_DWORD

MODULE.WAKEUP.USEFIPS
Anchor
USEFIPS
USEFIPS

Note

The registry name is different to the installer property name.


0


Multiexcerpt
MultiExcerptNameWakeUpUseFips

Set to 1 to force the WakeUp agent to use a FIPS-compliant algorithm for:

  • WakeUp Reporting to the NightWatchman Management Center Web Service by setting UseFipsComplianceEncryption registry value to 1.
  • Communication between WakeUp Agents and WakeUp Servers. It will override the MODULE.WAKEUP.ENCRYPTIONLEVEL installer property and set the EncryptionLevel registry value to 3.

If enabled, then all components in the NightWatchman and WakeUp system must have FIPS enabled.

EncryptionLevel and FIPS settings used by WakeUp do not affect other 1E Client communications.


\Reporting\UseFipsComplianceEncryptionREG_DWORD

MODULE.WAKEUP.WAKEDISPLAYAFTERSTANDBY
Anchor
WAKEDISPLAYAFTERSTANDBY
WAKEDISPLAYAFTERSTANDBY

0


Multiexcerpt
MultiExcerptNameWakeUpWakeDisplayAfterStandBy

Set to 1 to force the display to come on (assuming it has power) after it has been woken up.

This feature works in conjunction with MODULE.WAKEUP.STAYONFROMSTANDBYMINS.


\WakeDisplayAfterStandByREG_DWORD

MODULE.WAKEUP.WURESULTDELAY
Anchor
WURESULTDELAY
WURESULTDELAY

0


Multiexcerpt
MultiExcerptNameWakeUpWUResultDelay

The time (in seconds) the WakeUp Primary Agent allows for responses to magic packets before it tries to pings devices that have not yet responded with a WASAWAKE or JUSTWOKE and then report NOAGENT or FAILED to the WakeUp Server for reporting purposes. This is especially useful when trying to wake devices that do not have the WakeUp client module enabled. The delay should be set to how long it normally takes for devices to start up.

If set to 0 the WakeUp Server determines the time, but this can be overridden by changing the value on the WakeUp Primary Agent. In multi-agent mode, this effectively means all Agents.


\WUResultDelayREG_DWORD

Anchor
WakeUpModuleRegistryReadOnly
WakeUpModuleRegistryReadOnly
The following table is for WakeUp client module registry values that do not have Windows installer properties, and are not stored in the 1E Client configuration file.

Warning
These registry values are reserved for use by the WakeUp client module and must not be modified.


Registry nameRegistry typeDescription
\AgentRegInfoREG_SZUsed by the Primary and Alternate Agent to store information it has registered with the WakeUp Server.
\AltAgentMacAddressREG_BINARYUsed by the Primary and Alternate Agent to store each other’s MAC address details.
\InstallationDirectoryREG_SZUsed as a record of the installation folder, for backwards compatibility.
\MiniAgentToREG_SZUsed by the Primary and Alternate Agent to store the NetbiosName of the 1E Wakeup Server.
\PatchLevelREG_SZUsed to indicate the version of the most recent software patch installed.
\TachyonAgentVersionREG_SZUsed as a record of the 1E Client version that created the registry settings.