Server installation properties
NightWatchman Enterprise server installation properties reference.
The NightWatchman Management Center installer contains various properties that can be set on the MSIEXEC command line. The table below lists the supported set:
Property |
Default value |
Notes |
---|---|---|
|
This is normally the Active Directory domain name, but can be name of a domain controller if needs require.This is used by the NightWatchman Management Center to manage security permissions for NightWatchman Management Center console users. |
|
ADDLOCAL |
|
The NightWatchman Management Center components you want to install. You can specify more than one component on a single command-line by using a comma separated list. Component values are case sensitive.
|
|
Domain account or security group assigned to the Systems Administrator role in the NightWatchman Management Center Console. The domain account or security group must be in the Domain\sAMAccountName format. The Systems Administrator role has full administrator rights in the NightWatchman Management Center console and after installation can be used assign further permissions in the console. It is best practice to use a security group with the installer's account as a member. If this group is added to the server's local administrators group, its members will have full admin rights to the server and console. |
|
AEFEATUREHARDWARECATALOGDOWNLOAD |
|
The ActiveEfficiency synchronization with the 1E Cloud feature is now obsolete. |
AEFEATUREINVENTORYUPLOAD |
|
The ActiveEfficiencysynchronizationwith the 1E Cloud feature is now obsolete. |
AEFEATURESAVINGSUPLOAD |
|
The ActiveEfficiencysynchronizationwith the 1E Cloud feature is now obsolete. |
AEFEATUREWAKEUP |
|
Enables or disables the Nomad WakeUp feature. Values are case sensitive and must be used as shown:
|
AENOUI |
|
Determines if ActiveEfficiency is used. Values are:
|
AESERVERNAME |
|
Location of the ActiveEfficiency server. Must be the NetBIOS name for the server where ActiveEfficiency is installed. This is used by NightWatchman Management Center to manage integration with ActiveEfficiency to support. Values are:
|
<installdir>\Console |
Installation directory for the NightWatchman Management Center console. <installdir> is defined using the INSTALLDIR installer property. |
|
<installdir>\ConsoleService |
Installation directory for the console service. <installdir> is defined using the INSTALLDIR installer property. |
|
|
Currency used for energy tariffs in the NightWatchman reports. This must be set to the currency code for the required currency. For example, to display US dollars in the reports: CURRENCYCODE=USD |
|
DATABASENAME |
AgilityFrameworkReporting |
Name of the Agility Framework Reporting database. If a non-default name is specified, the name is also appended to the name of each of the SQL Agent jobs created by the installer in the same SQL Server instance as the database. Using the default name does not append anything to the names of the jobs. |
0 |
Determines if any existing Agility Framework Reporting database is dropped during installation. Values are:
|
|
0 |
Use this property with value 1 only if TLS 1.0 is disabled. When this is set to 1, SQL Server Native Client 11.0 must be installed. Values are:
|
|
4 |
Sets the size of the organization where the NightWatchman Management Center is being installed. Values are:
|
|
C:\Program Files\1E\ NightWatchmanManagementCenter |
Sets the base installation directory for the NightWatchman Management Center. |
|
|
Directory for the NightWatchman Management Center log files. |
|
<installdir> |
Installation directory for the NightWatchman Management Center Report Console. <installdir> is defined using the INSTALLDIR installer property. |
|
|
Host header for the NightWatchman Management Center Report Console. You need to use this name when browsing to the report console. In order to use the name once it has been set, you need to have defined the appropriate DNS settings to dereference it to the IP address of the server hosting the Report Console web site. For example, to set the installer property for the Report Console host header to 1EReports: REPORTCONSOLEHOSTHEADER=1EReports |
|
80 |
IIS port to be used for the NightWatchman Management Center Report Console. |
|
|
IP address for the NightWatchman Management Center Report console. |
|
|
Location of the console service, used when installing the NightWatchman Management Center Console on a different computer to the Console Service. This is specified as the server name where the console service is installed. |
|
|
Location for the SQL Server database instance. Permitted formats are:
|
|
|
Determines if 1E Web WakeUp uses strict authorization when performing wake ups. When strict authorization is enabled, you need to add entries to the Agility Framework database that lists the user names and computers the user is allowed to wake up. Values are:
|
|
|
Password for the console service account. |
|
|
Console service account in the format: Domain\Account. For more detail about this account, please refer to Console service account. If the installation account has appropriate permissions, the installer automatically grants the service account the permissions it needs. However, if you intend to use the NightWatchman Management Center console to implement remote wake-ups, you must manually set additional WMI permissions to the service account for the WakeUp namespaces, as described in Accounts needed to install the WakeUp server. |
|
|
Use FIPS for encrypting NightWatchman Management Center communications. Ensure that the same setting is made for all NightWatchman Management Center, WakeUp Server and 1E Agent components.
|
|
<installdir>\WebService |
Installation directory for the NightWatchman Management Center Web Service. <installdir> is defined using the INSTALLDIR installer property. |
|
|
Host header for the NightWatchman Management Center Web service. This is the server name used to locate the Web service. The customized name is used in all the NightWatchman clients and WakeUp agents when locating the Web service. In order to use the name once it has been set, you need to have defined the appropriate DNS settings to dereference it to the IP address location of the server hosting the Web service. For example, to set the installer property for the Report console host header to 1EWebService: WEBSERVICEHOSTHEADER=1EWebService |
|
|
IIS port for the NightWatchman Management Center Web service. You must use this port in all NightWatchman clients and WakeUp agents when locating the Web Service. |
|
|
IP address for the NightWatchman Management Center Web service. The default value is: the standard IIS IP address. You must use this IP address in all NightWatchman clients and WakeUp agents when locating the Web Service. |
The following tables describe the installer properties relevant to each NightWatchman Management Center component:
General installer properties
Property |
Notes |
---|---|
Base installation directory for the NightWatchman Management Center components. |
|
Location for the NightWatchman Management Center log files. |
|
Currency that will be used for energy tariffs in the NightWatchman reports. |
Database installer properties
Property |
Notes |
---|---|
Location of the SQL server where the NightWatchman Management Center database is installed. |
|
Drops the existing Agility Framework Reporting database before installing the new NightWatchman Management Center database. |
|
Size of the organization where the NightWatchman Management Center is being installed. This changes specific running parameters in the NightWatchman Management Center database. |
|
To install the database, ADDLOCAL needs to be set to a value that includes the text 'Database'. The values are case sensitive. For example, to just install the database, run: Copy
|
|
If TLS 1.0 is disabled then use this property with value 1. When this is set to 1, SQL Server Native Client 11.0 will be used so it must be installed. |
Console Service installer properties
Property |
Notes |
---|---|
Location for the Active Directory server. |
|
To install the console service, ADDLOCAL needs to be set to a value that includes the text ' ConsoleService'. The values are case sensitive. For example, to just install the Console service, run: Copy
or to just install the Import Wizard, run: Copy
|
|
Primary NightWatchman Management Center administrator account. This must be in the format: Domain\User or Domain\Group. |
|
Installation directory for the NightWatchman Management Center console service. |
|
Location for the NightWatchman Management Center log files. |
|
Location for the SQL server instance. |
|
Password of the service account for the console service. |
|
User name of the service account for the console service. This must in the format: Domain\User. |
NightWatchman Console installer properties
Property |
Notes |
---|---|
To install the NightWatchman console, ADDLOCAL needs to be set to a value that includes the text 'Console'. The values are case sensitive. For example, to just install the NightWatchman console, run: Copy
|
|
Installation directory for the NightWatchman console. |
|
Location for the NightWatchman Management Center log files. |
|
Location for the Console service component when installing the NightWatchman console remotely. |
Report Console installer properties
The following installer properties configure the NightWatchman Management Center Report Console, refer to NightWatchman Management Center installer properties for details.
Property |
Notes |
---|---|
To install the Report console, ADDLOCAL needs to be set to a value that references any of its sub-components. The values are case sensitive. for example, to install the Reports sub-component, run: Copy
|
|
Location for the NightWatchman Management Center log files. |
|
Installation directory for the NightWatchman Management Center Report console. |
|
Location for the SQL server instance. |
|
Host header for the NightWatchman Management Center Report console. |
|
IIS port to be used for the NightWatchman Management Center Report console. |
|
IP address for the NightWatchman Management Center Report console. |
Web Service installer properties
The following installer properties configure the NightWatchman Management Center Web Service:
Property |
Notes |
---|---|
To install the Web Service, ADDLOCAL needs to be set to a value that includes the text 'WebService'. The values are case sensitive. For example, to just install the Web service, run: Copy
|
|
Location for the NightWatchman Management Center log files. |
|
Location for the SQL server instance. |
|
Use FIPS encryption for NightWatchman Management Center communications. |
|
Installation directory for the NightWatchman Management Center Web service. |
|
Host header for the NightWatchman Management Center Web service. |
|
IIS port to be used for the NightWatchman Management Center Web service. |
|
IP address for the NightWatchman Management Center Web service. |
The following table shows the WakeUp Server installation switches which enable configuration of certain WakeUp console parameters at install time.
Property |
Default value |
Notes |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ADDLOCAL |
|
Allows you to install the WakeUp console extensions silently. Assumes the Configuration Manager console is already installed.
|
||||||||||||
AFREPORTING |
OFF |
The reporting state.
|
||||||||||||
AGENTTCP_PORT |
1776 |
Listening port used by the WakeUp server to communicate with the 1E Agents. The value for this property must be the same for the WakeUp server and all Agents. |
||||||||||||
5 |
Delay (in seconds) between each batch of wake-up requests transmitted to a 1E Agent system. |
|||||||||||||
CHECKPOLICYREFRESHINNAME |
0 |
Determines whether policy refreshes are sent depending on specific text included in the Configuration Manager deployment name and/or comment.
|
||||||||||||
CHECKWAKEUPINNAME |
0 |
Determines whether wakeups are sent depending on specific text included in the Configuration Manager deployment name and/or comment.
If this option is enabled (1) then any Software Updates Assignment in Configuration Manager that you want to associate with WakeUp must have WakeUpsEnabled text in the name or comment. |
||||||||||||
CERTIFICATENAME |
|
Sets the name for the TLS certificate template used for secure communications when running Intel AMT service in enterprise mode. |
||||||||||||
DEBUG |
13 |
The debug level for the WakeUp server. |
||||||||||||
0 |
Encryption level used in communications between WakeUp Servers and Agents.
When configuring this option you will need to ensure that the same setting is made for all WakeUp Server and 1E Agent components. Partial (mixed) encryption is allowed only on WakeUp Servers in scenarios where there is mixture of Agents configured as 0 and 2, for example during an upgrade or migration. When all Agents are configured the same, then you should modify the WakeUp Server setting. If USEFIPS is enabled, it overrides ENCRYPTIONLEVEL and both WakeUp and NightWatchman components uses FIPS, requiring all NightWatchman and WakeUp server components and Agents to use FIPS. |
|||||||||||||
FEEDBACKENABLED |
1 |
Enables or disables 1E Agent reporting on advertisement status. If FEEDBACKENABLED is disabled, WakeUp reports will be unavailable.
|
||||||||||||
HTTP |
HTTP |
WakeUp server supports only HTTP for reporting to the NightWatchman Management Center. If REPORTING is ON and clients are using HTTPS to report to the NightWatchman Management Center, you must configure the NightWatchman Management Center Web service to use both HTTP and HTTPS. |
||||||||||||
INSTALLDIR |
C:\Program Files\1E\WakeUpSvr\ |
Optional parameter that determines the installation directory. 32Bit Machines: C:\Program Files\1E\WakeUpSvr\ 64Bit Machines: C:\Program Files(x86)\1E\WakeUpSvr\ |
||||||||||||
LOGFILENAME |
WakeUpSvr.log |
Specifies the name of the log file. |
||||||||||||
LOGPATH |
%ALLUSERSPROFILE%\1E\ WakeUpSvr\ |
Path to the log file. |
||||||||||||
LOGVIEWPATH |
|
Specifies the path to a log viewer. This is used to define the path to an alternative log viewer to such as TRACE32. |
||||||||||||
MAGICPACKET_PORT |
1776 |
Sets the UDP port used to send wakeup broadcasts. |
||||||||||||
MAGICPACKETDELAY |
10 |
The time delay in milliseconds between sending Magic Packets. |
||||||||||||
100 |
The maximum numbers of wakeup requests that is forwarded to a 1E Agent system in a single hit. |
|||||||||||||
MAXCONNECTIONS |
16 |
The maximum number of connections that the WakeUp Server attempts to open at any given time. MAXCONNECTIONS is relevant only if TCP/IP agent communication is used. There is an inbuilt maximum limit of 64. |
||||||||||||
MAXLOGFILESIZE |
1048576 bytes (1 MB) |
Maximum size (in bytes) for the log file. Once the file reaches the specified size, a copy will be made with a .lo_ extension in the same directory as the original file. A new log file is then created. |
||||||||||||
MAXPINGSPERBURST |
256 |
Number of ping packets to generate in a single burst. MAXPINGSPERBURST requires that the server is installed in multi-agent mode. |
||||||||||||
MAXWAKEUPSPERPOLL |
1000 |
Maximum number of magic packets to be sent per poll interval. This is based on the maximum number of systems likely to require waking in one hour of advertisement processing. This figure also depends on the poll interval and is set in order to make it possible to process all outstanding wakeup requests within one hour.
|
||||||||||||
MINREADVERTTIME |
60 |
Minimum time (in seconds) before the same advertisement is reprocessed. This timer is only relevant if short poll intervals are required. |
||||||||||||
MINREWAKEUPTIME |
20 |
Minimum time (in seconds) between wakeups of the same machine. For example, a system may be a member of two or more collections and may have more than one advertisement due. MINREWAKEUPTIME prevents a system from receiving multiple magic packets when it has already been awakened. MINREWAKEUPTIME is not applicable to manual wakeups. |
||||||||||||
NOAUTOTHROTTLE |
0 |
Auto throttle automatically increases the number of wakeups per polling cycle if the wakeup list grows to the point where all systems cannot be processed within one hour.
|
||||||||||||
NOTZSUPPORT |
1 |
Determines whether all wakeups occur relative to the client or Configuration Manager Server time.
|
||||||||||||
PIDKEY |
30-day evaluation license key |
The WakeUp Server license key obtained obtained from Sales. The default behavior if PIDKEY is not defined is a 30-day evaluation license, after which the WakeUp Server service will not start. |
||||||||||||
PINGBURSTDELAY |
2 |
Delay (in seconds) between successive ping bursts. The server must be installed in multi-agent mode. |
||||||||||||
PINGTIMEOUT |
1 |
Ttime (in seconds) to wait for a response from the 1E Agents. The server must be installed in multi-agent mode. |
||||||||||||
POLLINTERVALSECS |
600 |
Time (in seconds) between reporting spooler directory scans. WakeUp looks for new reporting messages added since the last spooler directory scan, if the Agility Framework server was unavailable at the last scan. |
||||||||||||
POLLTIME |
120 |
Time (in seconds) between database scans. This parameter is also used to define the period between wakeups. WakeUp will look for new advertisements added since the last database scan and will action them according to the other WakeUp Server settings. |
||||||||||||
PWMI |
0 |
Determines the state of the installer Apply WMI Namespace checkbox.
Do not use the PWMI property unless WMIACCOUNT is also specified. This is because the checkbox will always be enabled if this property is used. |
||||||||||||
REPEATCOUNT |
0 |
Number of times to repeat sending Magic Packets. If you suspect that your network is prone to dropping datagram packets you should try different configurations for the REPEATCOUNT and REPEATDELAY settings. Otherwise, these should be left at their default values. |
||||||||||||
REPEATDELAY |
0 |
Delay (in seconds) before resending a repeated magic packet. If you suspect that your network is prone to dropping datagram packets you should try different configurations for the REPEATCOUNT and REPEATDELAY settings. Otherwise, these should be left at their default values. |
||||||||||||
REPORTING |
ON |
The reporting state. May be set to:
REPORTING=ON and REPORTINGSERVER are mandatory when using NightWatchman Management Center so that the WakeUp Server is registered. |
||||||||||||
REPORTINGSERVER |
|
When using HTTP for communications, set this parameter to the FQDN (recommended) or NetBIOS name of the server hosting the NightWatchman Management Center Web Service. REPORTING=ON and REPORTINGSERVER are mandatory when using NightWatchman Management Center so that the WakeUp Server is registered. If HTTP is not using standard port 80 then specify the port number after the server name: REPORTINGSERVER="ACMESERVER.ACME.COM:8080" |
||||||||||||
SCENARIO |
C |
The WakeUp installation scenario. Option C is strongly recommended
|
||||||||||||
|
When using HTTPS for communications, set this parameter to the FQDN (recommended) or NetBIOS name of the server where the NightWatchman Management Center Web Service component secure site has been installed. If HTTPS is not using standard port 443 then specify the port number after the server name: SECUREREPORTINGSERVER="ACMESERVER.ACME.COM:7433" This property is used only by the WakeUp Agent component of WakeUp Server. |
|||||||||||||
SERVERCOMPONENTS |
|
Selects whether to install the WakeUp Server service component. This option should not be used unless directed by 1E Support.
|
||||||||||||
SERVERTYPE |
SMS is selected if the installer detects it is running on a Configuration Manager Site server and able to connect to an SMS Provider. |
The WakeUp service type to install.
|
||||||||||||
SPOOLDIR |
%ALLUSERSPROFILE%\1E\ Reporting\WakeUp\ |
The location of the WakeUp spooler directory, where NightWatchman Management Center Reporting messages are stored before being sent to the NightWatchman Management Center Web Service. SPOOLDIR should not need to be modified under normal circumstances. |
||||||||||||
SUBCOLLSENABLED |
0 |
Determines if sub collections are included when processing advertisements.
|
||||||||||||
SUBNETRESCAN |
30 |
Time (in minutes) to wait before the WakeUp Server rescans the subnet to detect 1E Agents. The server must is installed in multi-agent mode. |
||||||||||||
SVCPASSWORD |
|
Sets the password for the WakeUp Intel AMT service account. |
||||||||||||
SVCUSER |
|
The service account for the WakeUp Intel AMT service depending on the value for the AMTMODE switch.
|
||||||||||||
TCP_PORT |
1777 |
The listening port used by the 1E Agents to communicate with the WakeUp Server. This must be different to the AGENTTCP_PORT value and must be the same for the WakeUp Server and all Agents. |
||||||||||||
0 |
Controls the use of FIPS for encrypting communications for both WakeUp and NightWatchman components.
When configuring this option you will need to ensure that the same setting is made for all NightWatchman Management Center, WakeUp Server and 1E Agent components. If USEFIPS is enabled it will override ENCRYPTIONLEVEL . |
|||||||||||||
|
Sets the password for the WakeUp service, used when installing a distributed Configuration Manager configuration where the Configuration Manager Provider is remote from the Configuration Manager server. |
|||||||||||||
|
Sets the user name for the WakeUp service, used when installing a distributed Configuration Manager configuration where the Configuration Manager Provider is remote from the Configuration Manager server. |
|||||||||||||
WEBWAKEUPSTATUSBYPING |
1 |
The method used by Web WakeUp when determining whether a computer has been awoken. Requires a 6.0.500 or later 1E Agent to be installed on the target computer
|
||||||||||||
|
The AD account or group that is granted administrator rights to the WakeUp Server WMI namespace. This namespace is used by the WakeUp Server Console, the NightWatchman Management Center Console Service and any custom scripts that use the WakeUp Server API. If required, it should be set in the following format: Domain\User The WakeUp Server installer grants the WMIACCOUNT (account or group) full rights to the root\N1E namespace on the WakeUp Server, and in order to allow remote connections, adds the same to the Distributed COM Users local group. For more detail see Accounts needed to install the WakeUp server. When installing WakeUp Server in silent or non-interactive mode, then it is necessary to specify the PWMI property to 1 in addition to the WMIACCOUNT property. |
User-configurable installer properties that control 1E Web WakeUp behaviour is detailed below. Because Web WakeUp is integrated with the NightWatchman Management Center and WakeUp Server to perform its functions, configuration options are available in all three installers.
WebWakeUp.msi installer properties
Property |
Default value |
Notes |
---|---|---|
ACTIVEXINTEGRATION |
0 |
Selects the Enable ActiveX Integration Checkbox in the installation dialog.
|
ENABLERDP |
0 |
Displays the Remote Desktop button when waking a machine from the Web WakeUp web page.
|
IISHOSTHEADER |
|
Host header for the Web WakeUp website. You must use this name when browsing to WebWakeUp Web site. In order to use the name once it has been set you will need to have defined the appropriate DNS settings to dereference it to the IP address of the server hosting the Web WakeUp web site. For example, the following installer property sets the Web WakeUp host header to the name 1EWebWakeUp IISHOSTHEADER=1EWebWakeUp |
IISPORT |
80 |
IIS port to be used for the Web WakeUp Web site. |
IISIPADDRESS |
|
IP address for the Web WakeUp Web site. |
INSTALLDIR |
C:\Program Files\1E\Web WakeUp |
Base installation directory for the Web WakeUp Web site. |
LOGPATH |
|
Sets the directory for the Web WakeUp log file. |
SERVICELOCATION |
localhost |
Location for the NightWatchman Console service. This must be set to the name of the server where the NightWatchman Console service is installed. |
WakeUpSvr.msi installer properties
The following table shows the user-configurable Web WakeUp related installer properties in the WakeUpSvr.msi installer.
Property |
Default value |
Notes |
---|---|---|
WEBWAKEUPSTATUSBYPING |
1 |
Method used by 1E Web WakeUp when determining whether a computer has been awoken. Values are:
|
NightWatchmanManagementCenter.msi installer properties
The following table shows the user-configurable Web WakeUp related installer properties available in the NightWatchmanManagementCenter.msi installer.
Property |
Default value |
Notes |
---|---|---|
STRICTAUTHORIZATION |
1 |
Determines if 1E Web WakeUp uses strict authorization when performing wake-ups. When strict authorization is enabled you will need to add entries to the Agility Framework database that specifies the user accounts that are allowed to use Web WakeUp and specifies which computers these users can wake. Values are:
Requires a 6.0.500 1E Agent to be installed on the target computer |