Parameters for Windows Agent Settings Package

The CCM Windows Agent V5.4 Settings package (dacnf01e.054) provides numerous additional parameters that you can set to expand the Windows Agent functionality.

The following tables describe each of the parameters and the names they display in the CCM Command Center. When first displayed in the Command Center the fields for all values are blank, but the CCM Windows Agent will recognize the underlying default values.

Action intervalct

Registry Key — ListenTime

Variable name in the .swp file — LISTENTIME

This parameter is enabled and applies only when Listen mode is set to Program runs in listen mode.

Display Value

Registry Key  Value

Description

30 minutes (Default)

30 (Default)

Thirty minute interval between polling the configuration server.

none (push only)

0

Ignores the action interval and the computer does not poll the server. After a push, jobs are immediately executed.

1 minute

1

One minute interval between polling the configuration server.

2 minutes

2

Two minute interval between polling the configuration server.

5 minutes

5

Five minute interval between polling the configuration server.

10 minute

10

Ten minute interval between polling the configuration server.

20 minutes

20

Twenty minute interval between polling the configuration server.

1 hour

60

One hour interval between polling the configuration server.

2 hours

120

Two hour interval between polling the configuration server.

 parameter is enabled and applies only when Listen mode is set to Program runs in s

Boot floppy preference

Registry Key — UnattendedFloppy

Variable name in .swp file — UNATTENDED FLOPPY

Applies only for Windows Agent jobs on a machine that does not have an internal boot PROM but relies on a boot floppy.

Display Value

Registry Key  Value

Description

Wait on user confirmation (Default)

0

if you have selected Ask User in the Boot and Security tab of the Add Computer or Edit Computer Properties dialog box, the Reboot dialog prompts the user to insert the boot floppy and waits for the user to cancel the dialog box or reboot the machine.

if you have not selected Ask User in the Boot and Security tab of the Add Computer or Edit Computer Properties dialog box, the Reboot dialog prompts the user to insert the boot floppy and waits for the user to reboot the machine.

Reboot after timeout of User confirmation time

1

If the boot floppy is present, the Reboot dialog box times out at the expiration of the defined User confirmation time and the machine is automatically rebooted.

If the boot floppy is not present, the Reboot dialog box times out at the expiration of the defined User confirmation time and the job fails.

 

Cancel the operating system login

Registry Key — LoginDialogCaption

Variable name in .swp file — LOGINDIALOGCAPTION

Display Value

Registry Key  Value

Description

“ “(Default)

“ “(Default)

Windows 9x only.

String for the operating system login dialog box caption.

The CCM Windows Agent automatically cancels the defined non-standard operating system login dialog box in order to execute a job.

Automatically defined in 9x operating system package enabling the CCM Windows Agent to start executing a CCM job.

 

Connect to server at startup

Registry Key — DelayFirstPoll

Variable name in .swp file — DELAY_FP

This parameter is used by the CCM Windows Agent to determine if the managed computer should initialize the CCM Notification service and obtain necessary managed computer and server information on startup

Display Value

Registry Key  Value

Description

Yes

0

Initial connection with CCM Servers occurs when the CCM Windows Agent starts.

No

“ “(Default)

Used in conjunction with the Action Interval parameter.

If the Action Interval is greater than 0, the Initial connection with CCM Servers is delayed until the first polling interval or until manual refresh.

If the Action Interval is 0, the Initial connection with CCM Servers is delayed until manual refresh.

 

Connect to server using

Registry Key — UseNameLookup

Variable name in .swp file — NAME_LOOKUP

Display Value

Registry Key  Value

Description

Server name

1
(Default)

Searches for and connects to the server by its server name.

IP address

0

Searches for and connects to the server by its IP address.

 

Continue job execution beyond action period

Registry Key — ContinueExecution

Variable name in .swp file — CONTINUEEXECUTION

Display Value

Registry Key  Value

Description

Continue within active time frame.

1
 

The CCM Windows Agent waits for the next active period before continuing execution of a job that has already been started.

Continue outside active time frame

0

Overrides the action period while jobs are active and continues execution even if the current time is not in the active period.

 

Disable run once commands

Registry key — DisableRunOnce

Variable name in .swp file — DISABLERUNONCE

Display Value

Registry Key  Value

Description

RunOnce section disabled (Default)

1
(Default)

Disables any run once command in a third-party software installation while smeclnt is logged on.

RunOnce section enabled

0

Allows run once commands in a third-party software installation to execute while smeclnt is logged on.

 

Display computer ID on CCM Windows Agent

Registry Key — ShowClientID

Variable name in .swp file — SHOWCLIENTID

Display Value

Registry Key  Value

Description

Do not show computer ID (Default)

0
(Default)

Does not display the computer ID in the title bar of the computer’s CCM Windows Agent window.

Show computer ID

1

Displays the computer ID in the title bar of the computer’s CCM Windows Agent window.

 

Error log size in KB

Registry Key — ErrorLogSize

Variable name in .swp file — ERRORLOGSIZE

Display Value

Registry Key  Value

Description

512(Default)

512 (Default)

Maximum allowed KB size of the error.log file.

You can type a value in this field of between 0 and 2048 KB.

 

If vendor files are not available

Registry Key — PrecheckScript

Variable name in .swp file — PRE_CHECK

This parameter is enabled and applies only when the Use as mobile computer? parameter is set to Yes.

Display Value

Registry Key  Value

Description

Start package execution anyway

0 (Default)

Starts the execution of the job even if the necessary vendor files are not available

Report error before package execution.

1

Does not start the job execution. Reports the missing vendor files.

 

Initial time between connection attempts

Registry Key — ConnectStartTime

Variable name in .swp file — CONNECTSTARTTIME

Display Value

Registry Key  Value

Description

10 (Default)

10 (Default)

Ten seconds between successive attempts to connect to the configuration server.

You can type any number of seconds in this field.

Used in conjunction with the following parameters:

  • Server retry limit

  • Maximum times between connection attempts

  • Number of retries before time to connect doubles

 

Listen mode

Registry Key — ListenMode

Variable name in .swp file — LISTENMODE.

Display Value

Registry Key  Value

Description

Program runs in listen mode (Default)

yes (Default)

The CCM Windows Agent reads the configuration server when started and continues listening if there is no job to execute. If there are jobs to execute it ends after the execution and keeps listening for further jobs.

Terminate program after job

no

The CCM Windows Agent reads the configuration server when started and ends if there is no job to execute. If there are jobs to execute it ends after the execution.

 

Logout user before package execution

Registry Key — RunAsLoggedOnUser

Variable name in .swp file — RUN_LOGGED_ON

Implemented for Windows NT, Windows 2000, and Windows XP only.This parameter overwrites the value set in the LOGOFFUSER entry in the script environment section of a package’s config.swp file and determines whether the package job will be executed with the user logged in or not.

Display Value

Registry Key  Value

Description

Yes

0
(Default)

Logs out the current user before executing the job.

No

1

Executes the job without logging out the current user.

 

Maximum time between connection attempts

Registry Key — ConnectMaxTime

Variable name in .swp file — CONNECTMAXTIME

Display Value

Registry Key  Value

Description

60 (Default)

60 (Default)

Maximum interval in minutes between attempts to connect to the configuration server.

You can type any number of minutes in this field.

Used in conjunction with the following parameters:

 

Message log size in KB

Registry Key — MessageLogSize

Variable name in .swp file — MESSAGELOGSIZE

Display Value

Registry Key  Value

Description

512 (Default)

512 (Default)

Maximum allowed KB size of the message.log file.

You can type a value in this field of between 0 - 64535 KB.

 

Number of retries before time to connect doubles

Registry Key — ConnectStartCount

Variable name in .swp file — CONNECTSTARTCOUNT

Display Value

Registry Key  Value

Description

5 (Default)

5 (Default)

Number of retries in the Initial time between connection attempts interval before the interval doubles.

You can type any natural numeric value in this field.

Used in conjunction with the following parameters

 

Reboot final during package execution

Registry Key — DelayReboots

Variable name in .swp file — DELAY_REBOOTS

Display Value

Registry Key  Value

Description

Execute in every package

0 (Default)

Processes "reboot final" commands in scripts normally.

Execute only after last package

1

Delays "reboot final" commands in scripts until all jobs have been executed.

 

Reboot instructions

Registry Key — ForceReboot

Variable name in .swp file — FORCEREBOOT

Display Value

Registry Key  Value

Description

No reboot (just log off current user) (Default)

0 (Default)

Logs the user off the computer after executing a job.

Reboot computer

1

Reboots the computer after executing all jobs.

 

Run in debug mode?

Registry Key — DebugMode

Variable name in .swp file — DEBUGMODE

Display Value

Registry Key  Value

Description

Run without debug
(Default)

no (Default)

Executes package scripts normally without interruption.

Run with debug

yes

Executes package scripts step by step. Useful for developing and testing package scripts.

 

Search locations

Registry Key — SearchLoc

Variable name in .swp file — SEARCHLOC

Sets the bit mask for the depot substitution location in an environment with an alternative Vendor File Depot. Used in conjunction with the Search priority parameter.

If the HKEY_LOCAL_MACHINES\Software\ csd\control\2.0\LocalServer does not exist, no search will be made. If the key does exist, searching and any substitutions will be attempted based on the following values.

Display Value

Registry Key  Value

Description

No search (Default)

0 (Default)

No search.

Local floppy and hard disks

1

Search local floppy and root directory of hard disks drives.

Use this value only if the intended depot resides at the root level of the directory. Otherwise use the Local servers from parameter for UNC path or local path to depot value listed below.

Local CD drives

2

Search local CD drives.

Local floppy, hard disk, and CD drives

3

Search local floppy, root directory of hard disk drives, and CD drives.

Local servers from parameter for UNC path or local path to depot

4

Search local servers from the key HKEY_LOCAL_MACHINE\Software\ csd\control\2.0\LocalServer.

You must specify the path to the depot.

Local floppy, hard disk drives, and local servers from parameter for UNC path or local path to depot5

5

Search local floppy, root directory of hard disk drives and local servers from the key HKEY_LOCAL_MACHINE\Software\ csd\control\2.0\LocalServer.

You must specify the path to the depot.

Local CD drives and local servers from parameter for UNC path or local path to depot

6

Search local CD drives and local servers from the key HKEY_LOCAL_MACHINE\Software\ csd\control\2.0\LocalServer.

Local floppy, hard disk, and CD drives, and local servers from parameter for UNC path or local path to depot

7

Search local floppy, root directory of hard disk drives, and CD drives and local servers from the key HKEY_LOCAL_MACHINE\Software\ csd\control\2.0\LocalServer.

 

Search priority

Registry Key — SearchPrior

Variable name in .swp file — SEARCHPRIOR

Sets the search priority implementation for substituting the alternative Vendor File Depot path. Used in conjunction with the Search locations parameter. See UNC path or local path to depot. Location types are represented in the following way:

Display Value

Registry Key  Value

Description

CD -> Server -> Floppy/Hard disk

 

0 (Default)

Sets search order to:

  • Local CD drive

  • UNC path or local path to depot

  • Local floppy drive or root directory of hard disk

CD -> Floppy/Hard disk -> Server

Local floppy and hard disks

Sets search order to:

  • Local CD drive

  • Local floppy drive or root directory of hard disk

  • UNC path or local path to depot

Server -> CD -> Floppy/Hard disk

2

Sets search order to:

  • UNC path or local path to depot

  • Local CD drive

  • Local floppy drive or root directory of hard disk

Server -> Floppy/Hard disk -> CD

3

Sets search order to:

  • UNC path or local path to depot

  • Local floppy drive or root directory of hard disk

  • Local CD drive

Floppy/Hard disk
>CD ->Server

4

Sets search order to:

  • Local floppy drive or root directory of hard disk

  • Local CD drive

  • UNC path or local path to depot

Floppy/Hard disk
->Server ->CD

5

Sets search order to:

  • Local floppy drive or root directory of hard disk

  • UNC path or local path to depot

  • Local CD drive

 

Server retry limit

Registry Key — ConnectTries

Variable name in .swp file — CONNECTTRIES

Display Value

Registry Key  Value

Description

Suppress Error Message (Default)

 

0 (Default)

Limitless failed attempts to connect to the configuration server. No Error Message displays.

5 Retries before Error Messages

5

Five failed attempts to connect the configuration server before an Error Message displays.

10 Retries before Error Messages

10

Ten failed attempts to connect the configuration server before an Error Message displays.

You can augment the Server retry limit parameter with the following additional parameters provided in the CCM Windows Agent Settings package:

 

Timeout during script execution (minutes)

Registry Key — ScriptTimeout

Variable name in .swp file — SCRIPTTIMEOUT

Display Value

Registry Key  Value

Description

120 (Default)

 

120 (Default)

The elapsed time in minutes before the CCM Windows Agent stops the execution of a package and sets the package status to “Timeout”. The time required to execute a package is a factor of the package type, the network bandwidth, and the speed of the machine.

You can type any value in minutes in this field.

 

Treatment of local software directories

Registry Key — KeepSWDir

Variable name in .swp file — KEEPSWDIR

Display Value

Registry Key  Value

Description

Keep local software directories
(Default)

1 (Default)

The CCM Windows Agent keeps copies of the software directories located in the computer’s integra/sw directory.

Remove local software directories

0

The CCM Windows Agent deletes the local copies of the software directories.

 

UNC path or local path to depot

Registry Key — LocalServer

Variable name in .swp file — LOCALSERVER

Display Value

Registry Key  Value

Description

“ “(Default)

 

“ “(Default)

Semi-colon separated list of valid Universal Naming Convention (UNC) paths on a remote machine. The entries in this search path are searched in the order they appear in the string.

Example:

LocalServer = \\Myserver\remotedepot;C:\mydepot

 

Unlock workstation during job execution

Registry Key — autounlockws

Variable name in .swp file — AUTOUNLOCKWS

Used for Windows NT, Windows 2000, and Windows XP managed computers. Determines if a locked managed computer should be unlocked by the CCM Windows Agent for the purpose of executing jobs.

Display Value

Registry Key  Value

Description

No

0 (Default)

If the CCM Windows Agent tries to execute jobs, a locked managed computer remains locked.

Yes

1

If the CCM Windows Agent tries to execute jobs, a locked managed computer will be unlocked.

 

Use as mobile client?

Registry Key value — MobileClient

Variable name in .swp file — MOBILECLIENT

Display Value

Registry Key  Value

Description

No (Default)

0 (Default)

Identifies the computer as a normal computer that is connected to the configuration over the LAN.

Yes

1

Identifies the computer as a dial-up computer that is connected to the configuration server over a modem.

This parameter is augmented by the If vendor files are not available parameter.

 

Use distributed depot servers only

Registry Key — NoDepotOnConfigSvr

Variable name in .swp file — NODEPOT_CS

This parameter is available only when you have entered a valid search path in the UNC path or local path to depot parameter.

Display Value

Registry Key  Value

Description

No (Default)

0 (Default)

The CCM Windows Agent first looks for alternative Vendor File Depot sources defined in the UNC path or local path to depot parameter.

If not found, the CCM Windows Agent next looks for the local CCM Package Depot on the CCM Configuration Server.

Yes

1

The CCM Windows Agent looks only for the alternative Vendor File Depot sources defined by the UNC path or local path to depot parameter.

 

User confirmation time

Registry Key — AnswerTime

Variable name in .swp file — ANSWERTIME

Display Value

Registry Key  Value

Description

10 minutes (Default)

10 (Default)

Ten minute interval before dialog automatically executes the default action. For example, ten minutes before the Reboot dialog restarts the computer.

1 minute

1

One minute interval before dialog automatically executes the default action.

2 minutes

2

Two minute interval before dialog automatically executes the default action.

5 minutes

5

Five minute interval before dialog automatically executes the default action.

20 minutes

20

Twenty minute interval before dialog automatically executes the default action.

30 minutes

30

Thirty minute interval before dialog automatically executes the default action.

1 hour

60

One hour interval before dialog automatically executes the default action.

2 hours

120

Two hour interval before dialog automatically executes the default action.

Wait on user confirmation

0

The default action does not execute unless and until the user confirms.

None

no

The job immediately executes without asking the user. No user confirmation dialog opens.

 

Use Background Copy Service

Registry Key value — RunBgcopySvc

Variable name in .swp file — RUN_BGCOPY

Implemented for Windows NT, Windows 2000, and Windows XP only. This parameter enables you to copy files to and remove files from a managed computer as a background activity without logging off the current user

Display Value

Registry Key  Value

Description

No (Default)

0 (Default)

No background copy activities are enabled.

Yes

1

Activates the instructions in a configuration file that dictates which files are to be copied or removed from the managed computer without logging off the user.

The Use Background Copy Service parameter is augmented by the following additional parameters.