Parameters for CCM Windows Agent Package

Following are the Windows Agent Package parameters that you can set when you deploy this package to a managed computer.

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.

 

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.

 

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" . Lcation 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.

 

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

 

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 in the CCM Windows Agent Settings package.

 

Use distributed depot servers only

Variable name in .swp file — WC_NODEPOT_CS

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.