sweep utility parameters

The following table describes the sweep parameters:

Parameter

Description

-U userName

Control-M/EM owner database user name

Log on is achieved by providing either a user name and password combination or a password file name.

-P password

Control-M/EM owner database user password

-PF passwordFile

Flat file that contains an unencrypted user name and password on separate lines in the following format:

user=user_name

password=password

-S serverName

Control-M/EM GUI server logical name

-Local

Deletes all obsolete jobs and folders from the Control-M/EM database only.

  • You cannot use the -Sync and -Test flags when using -Local.
  • You can use -Local and -Force to delete obsolete jobs and folders from modified or locked folders in the Control-M/EM database.

Log sweep_sync.txt is not updated when the utility is activated with -Local.

If -Local is not used, the sweep utility behaves as it did before version 6.3.01, deleting jobs from both the Control-M/EM and Control-M/Server databases.

-Date YYYYMMDD date

A date in YYYYMMDD format (for example, 20080915), which sets the selection criteria for obsolete jobs. Default: two days before the current date

-Timeout
maxSeconds

Maximum time in seconds to wait for pending callbacks to return with responses to UPLOAD and remote DELETE requests. Default: 900 seconds (15 minutes).

-Test

This flag causes the sweep utility to scan all job definitions and generate the sweep_obsolete.txt file, which consists of a report of the current obsolete jobs and folders, without actually deleting the jobs.

-Sync

A flag for synchronizing all non-synchronized folders, listed in the sweep_sync.txt file, by rerunning the commands that previously failed, in order to synchronize the Control-M and EM databases.

-Cyclic maxFiles

The maximum number of cyclic files for sweep execution log (up to 500 messages each). Default: The execution log is written to one sequential log file without a timestamp.

-H | -Help

Displays the usage.

-Force

This flag causes the sweep utility to scan all folders, including those that are modified or locked, for obsolete jobs. Use -Force only when you are certain there are no definitions in the Control-M/Server database that were not previously downloaded into the Control-M/EM database.

-Interval milliseconds

This flag sets the time to wait between executing the DELETE and UPLOAD commands (in milliseconds).

It may be required to avoid time-out problems in Gateway or Control-M. By default, there is no interval.

Parent Topic

sweep