Previous Topic: ca_backup - UsageNext Topic: Global Job Options


ca_backup - Miscellaneous Options

The ca_backup command contains miscellaneous options that are used to display all associated options and define basic policies and parameters for Arcserve Backup to use during a backup process.

The ca_backup command includes the following miscellaneous options:

ca_backup
[-cahost <hostname>] -list
[-f <filename>]
[-clearconn]
[-waitForJobStatus [<polling interval(secs)>]]
[-help]
[-examples]
[-usage]
[allusage]

-cahost <hostname>

Identifies the name of the system hosting the operation.

If you want to execute the operation on a remote system, this switch must be included in the command.

If you want to execute this operation on your local system, this switch is not required and should not be included in the command.

Note: The [-cahost <hostname>] switch is optional. This switch is not needed if you are using these commands locally; however, a hostname is required if you are performing these commands remotely. The host specified by the ‑cahost switch can be a member server or primary server. However, Arcserve Backup will always add the job to the job queue of the primary server, and the primary server will then dispatch the job to the proper server (primary/member) according to this switch when the job is processed.

Note: If you installed Arcserve Backup using the "Arcserve Manager (Console)" mode, you must include the -cahost switch to execute this command from your local machine. Because this Console installation mode does not actually install all Arcserve Backup capabilities on your local machine, it is mandatory that -cahost be included when submitting this command remotely to the primary or member server containing Arcserve Backup or else the command will fail.

-list

Displays a list of all group names and corresponding media that is available for the backup job.

-f <filename>

Used to specify a file name that contains the switches and parameters for the command.

This switch overcomes the shell limitation of 1024 character input from command line. You can also use this switch to hide passwords by saving them in a file.

-waitForJobStatus [<polling interval (secs)>]

When specified, the ca_backup command will wait until the job is completed, and exit with a return code that indicates the success or fail outcome of the job.

The <polling interval> value defines how often (in seconds) the ca_backup utility checks the job status with the Queue services. The default polling interval is 60 seconds.

Note: This is useful for Unicenter NSM Scheduling (formerly known as TNG).

-help

Opens the ca_backup Help topic.

-examples

Opens a Help topic with ca_backup usage examples.

-usage

Displays a list of basic ca_backup commands.

allusage

Displays a list of all ca_backup commands and their switches.

More information:

ca_backup - Backup Manager Command

ca_backup - Return Codes

ca_backup - Examples