[ Bottom of Page | Previous Page | Next Page | Contents ]
Displays and configures the registry keys created when the concurrent
login feature is installed on the endpoint. It can also unlock a workstation
that has been locked by mistake.
Syntax
wdepcem [-r | -g property | -s property]
Options
- -r
- Unlocks a workstation that has been locked by mistake.
- -g property
- Displays the setting defined for the specified registry key.
- -s property
- Defines a setting for the specified registry key, as follows:
- -e [true | false]
- Specifies whether the concurrent login feature is enabled. Supported
values are true, which means that the feature is enabled,
and false, which means that the feature is disabled.
The default value is true.
- -p [true | false]
- Specifies whether a message must be displayed on the endpoint to notify
the user that login is temporarily disabled. Supported values are true, which means that the dialog is displayed, and false which means that the dialog is not displayed. The default value
is true.
- -t timeout
- Specifies how many seconds the message must be displayed on the endpoint
if you set the -p option to true.
The default value is 10.
- -l popup_title
- Defines the title of the dialog box displayed on the endpoint if you
set the -p option to true. The
default value is SWDNotification.
- -L popup_msg
- Defines the text contained in the dialog box displayed on the endpoint
if you set the -p option to true.
The default value is: "Distribution in progress\r\nLogon temporarily disabled."
- -m [true | false]
- Specifies whether the user is allowed to log in to the workstation if
an error occurs during an attempt to pause the distribution. Supported values
are true, which means the user is not allowed to log
in, and false, which means the user is allowed to log
in. The default value is true.
- -M popup_msg
- Defines the text contained in the dialog box displayed on the endpoint
if the distribution cannot be paused and you set the -m option
to true. When customizing the message, you can use the
\r\n symbols for inserting a carriage return and the $(DIST_ID) variable which
is replaced at run time with the distribution ID. The default value is: "The
pause failed for distribution $(DIST_ID)\r\n Contact the system administrator."
- -x level
- Specifies the tracing level. Supported values are as follows:
- 0
- Traces are disabled. This is the default value.
- 1
- Standard tracing is enabled.
- 2
- Verbose tracing is enabled.
- -y pathname
- Specifies the full path and name of the trace files. The default value
is: $(system_drive)\SWDnotification.log.
- -s [true | false]
- Specifies whether the message displayed on the endpoint if you set the -p option to true, must be shown on
a new Windows(R) desktop. Supported values are true, which means a new Windows desktop is used, and false, which means the default desktop is used. The default value is true.
- -d max_shutdowns
- Defines the number of shutdown operations after which the user is allowed
to log in again. This key prevents the user from being irrecoverably logged
out of the workstation. The default value is 20.
- -o [0 | 1 | 2]
- Specifies which type of logoff must be performed. Supported values are
as follows:
- 0
- Performs a standard logoff. This is the default value.
- 1
- Performs a forced logoff ending all active processes.
- 2
- Performs a logoff ending also hung processes.
- -c [true | false]
- Specifies whether a message is displayed on the endpoint to notify the
user that the distribution has completed and login is allowed. Supported values
are true, which means the message is displayed, and false, which means the message is not displayed. The default
value is true.
- -b pathname
- Specifies the path to the application that manages the message to be
displayed if you set the -c option to true. Use this key if you modified the path where wcompmsg.exe is installed
or if you want to use a different application for managing the message.
- -u popup_title
- Defines the title of the dialog box displayed on the endpoint if you
set the -c option to true. The
default value is SWDNotification.
- -v popup_msg
- Defines the text contained in the dialog box displayed on the endpoint
if you set the -c option to true.
When customizing the message, you can use the \r\n symbols for inserting
a carriage return. The default value is: "Distribution complete\nLogon is
now permitted."
- -w [true | false]
- Specifies whether a message is displayed when you attempt to perform
a shutdown during a distribution for which shutdown has been disabled. You
must choose between performing a logoff immediately, performing a restart
immediately, or performing a logoff immediately and subsequently a shutdown
when the distribution completes. See also the - H option.
Supported values are true, which means the message is
displayed, and false, which means the message is not
displayed. The default value is true.
- -z shut_popup_msg
- Defines the text contained in the dialog box displayed on the endpoint
if you set the -w option to true.
When customizing the message, you can use the \n symbol for inserting a carriage
return. The default value is: "The machine will shut down when the distribution
completes."
- -B pathname
- Specifies the fully qualified path to the LCF_BINDIR.
- -C pathname
- Specifies the fully qualified path to the LCF_CACHEDIR.
- -D pathname
- Specifies the fully qualified path to the LCF_DATDIR.
- -U pathname
- Specifies the fully qualified path to the application which communicates
with the gateway.
- -W timeout
- Specifies the timeout in seconds for communicating with the gateway.
The default value is 120 seconds.
- -E popup_title
- Defines the title of the dialog box displayed on the endpoint if you
set the -w option to true and
the user attempts to perform a shutdown during a distribution for which shutdown
has been disabled. The default value is SWDNotification.
- -F popup_msg
- Defines the message contained in the dialog box displayed on the endpoint
if you set the -w option to true
and the user attempts to perform a shutdown during a distribution for which
shutdown has been disabled. When customizing the message, you can use the
\n symbol for inserting a carriage return. The default value is: "Please choose
one of the following"
- -G timeout
- Specifies a timeout in seconds for choosing between a logoff, a restart,
and a logoff and shutdown. If you set the timeout to 0,
the message is not displayed and the default action is performed. After the
timeout expires, the default action is performed. For more information on
the default action, see the -J option. The default
value is 0.
- -T logoff_str
- Defines the first option displayed in the message to request whether
a logoff should be performed. If you select this option, a logoff is performed
immediately. The default value is "Logoff".
- -H logoff_and_shut
- Defines the second option displayed in the message to request whether
a logoff and a shutdown should be performed. If you select this option, a
logoff is performed immediately and a shutdown is performed when the distribution
completes. The default value is "Logoff & shutdown when complete".
- -K restart_str
- Defines the third option displayed in the shutdown message to request
whether a restart should be performed. If you select this option, a restart
is performed immediately. The default value is "Restart".
- -J [1 | 2 | 3]
- Specifies the default action to be performed when the timeout expires
or is set to 0. Supported values are as follows:
- 1
- Performs a logoff immediately.
- 2
- Performs a logoff immediately and a shutdown when the distribution completes.
This is the default value.
- 3
- Performs a restart immediately.
- -P [true | false]
- Specifies whether a message must be displayed on the endpoint listing
the number of logins allowed on the workstation. You can define this key when
limited logins are allowed during the distribution. Supported values are true, which means the message is displayed, and false, which means the message is not displayed. The default value is true.
- -Q message
- Defines the message contained in the dialog box displayed on the endpoint
if you set the -P option to 1.
When customizing the message, you can use the \n symbol for inserting a carriage
return and the $(LEFT_LOGON) variable which is replaced at run time with the
number of allowed logins. The default value is: "The current distribution
has been paused\nYou can log on $(LEFT_LOGON) times."
Return Values
The wdepcem command returns one of the following:
- 0
- Indicates that wdepcem completed successfully.
- other than zero
- Indicates that wdepcem failed due to an error.
Examples
- To display the value set for the -p option, type
the following command:
wdepcem -g p
- To set the default action to be performed when the timeout expires so
that an immediate logoff is performed, type the following command:
wdepcem -s J 1
[ Top of Page | Previous Page | Next Page | Contents | ]