Contents
-
Introducing NightWatchman Enterprise 7.3
-
How it works
-
Quick starts, evaluations and pilots
-
Implementation
-
Working with NightWatchman Enterprise
-
Troubleshooting
-
Training
-
Reference
-
Supported Platforms
-
Server Sizing
-
Communication ports
-
Server installation properties
- Agent installation properties
-
Server API reference
-
Windows 1E NightWatchman Agent scripting reference
-
Mac 1E Agent scripting reference
-
Extending the Console Query interface
-
NightWatchman Enterprise release information
-
Supported Platforms
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.
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.
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.
1E Client installer property | Installation default | Description | Registry name | Registry type |
---|---|---|---|---|
MODULE.WAKEUP.ADDITIONALSUBNETS | The registry value is not created unless the installation property is specified. | 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. | \AdditionalSubnets | REG_SZ |
MODULE.WAKEUP.AGENTTCPPORTThe registry name is different to the installer property name (it has an underscore). | 1776 | The listening port used by the WakeUp Server to communicate with the WakeUp Agents. Default value is 1776 (decimal). 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_Port | REG_DWORD |
MODULE.WAKEUP.AGENTTO | 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. | \AgentTo | REG_SZ | |
MODULE.WAKEUP.ALLOWLASTMANSUSPEND | 1 | 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. The value of this property is the opposite to what its name implies. | \AllowLastManSuspend | REG_DWORD |
MODULE.WAKEUP.CERTISSUER | Specify the text used to search for a client certificate in the client certificate store. Either MODULE.WAKEUP.CERTISSUER or MODULE.WAKEUP.CERTSUBJECT is mandatory when all the following are true:
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\CertIssuer | REG_SZ | |
MODULE.WAKEUP.CERTSUBJECT | Specify the text used to search for a client certificate in the client certificate store. Either MODULE.WAKEUP.CERTISSUER or MODULE.WAKEUP.CERTSUBJECT is mandatory when all the following are true:
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\CertSubject | REG_SZ | |
MODULE.WAKEUP.DEBUG | 13 | 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. | \Debug | REG_DWORD |
MODULE.WAKEUP.DELAYCYCLESMSSECS | 16 | 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. | \DelayCycleSMSSecs | REG_DWORD |
MODULE.WAKEUP.ENCRYPTIONLEVEL | 0 | The encryption level used in communications between WakeUp Agents and WakeUp Servers. This does not affect encryption used for WakeUp Reporting.
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. | \EncryptionLevel | REG_DWORD |
MODULE.WAKEUP.LASTMANENABLED | 1 | Determines if the WakeUp last man standing functionality is turned on or off.
| \LastManEnabled | REG_DWORD |
MODULE.WAKEUP.LOGFILENAMEThe registry name is the same as the installer property name but contains a combination of LOGPATH and LOGFILENAME installer properties. | WakeUpAgt.log | The name of the WakeUp Agent log file. This combines with LOGPATH to give the LogFileName registry value. | \LogFileName | REG_SZ |
MODULE.WAKEUP.LOGPATHSee LOGFILENAME. | %ALLUSERSPROFILE%\1E\Agent | The location of the WakeUp Agent log file. This combines with LOGFILENAME to give the LogFileName registry value. | See LOGFILENAME | |
MODULE.WAKEUP.MAGICPACKETDELAY | 1 | The delay (in milliseconds) between the WakeUp Agent sending subsequent Magic Packets. Default value is 1. | \MagicPacketDelay | REG_DWORD |
MODULE.WAKEUP.MAGICPACKETPORTThe registry name is different to the installer property name (it has an underscore). | 1776 | The UDP port used to send wake up broadcasts. Default value is 1776 (decimal). | \MagicPacket_Port | REG_DWORD |
MODULE.WAKEUP.MAXIMUMFILEAGESECS | 1209600 (14 days) | 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\MaximumFileAgeSecs | REG_DWORD |
MODULE.WAKEUP.MAXLOGFILESIZE | 1048576 (1MB) | 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.) | \MaxLogFilesize | REG_DWORD |
MODULE.WAKEUP.REFRESHHWINFOAFTERHOURS | 720 (30 days) | 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\RefreshHwInfoAfterHours | REG_DWORD |
MODULE.WAKEUP.REFRESHONSUBNETCHANGE | ON | 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.
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. | \RefreshOnSubnetChange | REG_SZ |
MODULE.WAKEUP.REPEATCOUNT | 0 | Number of times to repeat sending Magic Packets. Default is 0. 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. | \RepeatCount | REG_DWORD |
MODULE.WAKEUP.REPEATDELAY | 0 | Delay (in milliseconds) before resending a repeated Magic Packet. Default is 0. 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. | \RepeatDelay | REG_DWORD |
MODULE.WAKEUP.REPORTING | ON | 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:
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. | \Reporting | REG_SZ |
MODULE.WAKEUP.REPORTINGSERVERThe registry name is different to the installer property name. The supplied value is converted into a full URL. | Set this parameter to the FQDN (recommended) or NetBIOS name of the server hosting the NightWatchman Management Center Web Service. Mandatory when WakeUp reporting is enabled (default) and using HTTP for communications. If HTTP is not using standard port 80 then specify the port number as part of the server name: | \Reporting\HTTP\ServiceUrl | REG_SZ | |
MODULE.WAKEUP.SECUREREPORTINGSERVERThe registry name is different to the installer property name. The supplied value is converted into a full URL. | 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. Mandatory when WakeUp reporting is enabled (default) and using HTTPS for communications. If HTTPS is not using standard port 443 then specify the port number as part of the server name: | \Reporting\HTTPS\ServiceUrl | REG_SZ | |
MODULE.WAKEUP.SENDHARDWAREINFOThe registry name is different to the installer property name. | ON | Enables hardware information messages to be sent to the NightWatchman server, if MODULE.WAKEUP.REPORTING=ON. See also MODULE.WAKEUP.REFRESHHWINFOAFTERHOURS. | \Modules\HwInfoAgt | REG_SZ |
MODULE.WAKEUP.SPOOLDIRThe registry name is different to the installer property name. | %ALLUSERSPROFILE%\1E\Reporting\WakeUp\ | 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\SpoolerDirectory | REG_SZ |
MODULE.WAKEUP.STAYONFROMSTANDBYMINS | 0 | 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. | \StayOnFromStandbyMins | REG_DWORD |
MODULE.WAKEUP.SUBNETOVERRIDE | The registry value is not created unless the installation property is specified. | 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. | \SubnetOverride | REG_SZ |
MODULE.WAKEUP.TCPPORTThe registry name is different to the installer property name (it has an underscore). | 1777 | The listening port used by the WakeUp Agents to communicate with the WakeUp Server. Default value is 1777 (decimal). 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_Port | REG_DWORD |
MODULE.WAKEUP.USEFIPSThe registry name is different to the installer property name. | 0 | Set to 1 to force the WakeUp agent to use a FIPS-compliant algorithm for:
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\UseFipsComplianceEncryption | REG_DWORD |
MODULE.WAKEUP.WAKEDISPLAYAFTERSTANDBY | 0 | 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. | \WakeDisplayAfterStandBy | REG_DWORD |
MODULE.WAKEUP.WURESULTDELAY | 0 | 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. | \WUResultDelay | REG_DWORD |
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.
Registry name | Registry type | Description |
---|---|---|
\AgentRegInfo | REG_SZ | Used by the Primary and Alternate Agent to store information it has registered with the WakeUp Server. |
\AltAgentMacAddress | REG_BINARY | Used by the Primary and Alternate Agent to store each other’s MAC address details. |
\InstallationDirectory | REG_SZ | Used as a record of the installation folder, for backwards compatibility. |
\MiniAgentTo | REG_SZ | Used by the Primary and Alternate Agent to store the NetbiosName of the 1E Wakeup Server. |
\PatchLevel | REG_SZ | Used to indicate the version of the most recent software patch installed. |
\TachyonAgentVersion | REG_SZ | Used as a record of the 1E Client version that created the registry settings. |