SymantecTM Backup Exec 2010

Command Line Applet

Symantec Legal Notice Copyright 2009 Symantec Corporation. All rights reserved. Symantec, Backup Exec, and the Symantec logo are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. Other names may be trademarks of their respective owners. The product described in this document is distributed under licenses restricting its use, copying, distribution, and decompilation/reverse engineering. No part of this document may be reproduced in any form by any means without prior written authorization of Symantec Corporation and its licensors, if any. THE DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. SYMANTEC CORPORATION SHALL NOT BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE INFORMATION CONTAINED IN THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE. The Licensed Software and Documentation are deemed to be commercial computer software and commercial computer software documentation as defined in FAR Sections 12.212 and DFARS Section 227.7202. Symantec Corporation 20330 Stevens Creek Boulevard Cupertino, CA 95014 http://www.symantec.com

Symantec Backup Exec Command Line Applet

Table of Contents
Updating scripts for use with this release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Command Line Applet requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Using the Command Line Applet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Using command line switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Switches used with all operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Backup job operations and switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Operations and switches for administrating jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Restore job operations and switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Operations and switches for viewing and responding to alerts . . . . . . . . . . . . . . . 44 Operations and switches for error-handling rules . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Operations and switches for managing media and devices . . . . . . . . . . . . . . . . . . . 51 Backup Exec services commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Logon account operations and switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Report operations and switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Operations for displaying network interface information . . . . . . . . . . . . . . . . . . . . 85 Database management operations and switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Setting default options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Using job script files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 Creating a backup job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 Creating a restore job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 Creating a catalog job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Creating a discovery job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Creating a duplicate backup job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 Creating a test run job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Creating a copy job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 Saving and launching the job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Using scripts and selection lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 Creating a selection list script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
3

Using Policy Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 Creating a policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Using job template script files within a policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 Creating a backup job template script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Creating a duplicate backup job template script file . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 Creating a synthetic full job template script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 Using a schedule script with device and media operations . . . . . . . . . . . . . . . . . . . . . 256 Understanding job status messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

Symantec Backup Exec Command Line Applet

Symantec Backup Exec Command Line Applet

The Backup Exec Command Line Applet is a convenient way to access some of the most useful features of Backup Exec from a command prompt. The Command Line Applet allows management of only one media server at a time, but allows for remote management of media servers within an enterprise. However, if the Central Admin Server Option (CASO) is installed, you can administer all servers managed by the central administration server. Backup Exec must be installed and running on a media server in order for the Command Line Applet to target it, but the Command Line Applet does not have to be run from a media server. The Command Line Applet uses functional command switches typed in a command prompt window to perform most Backup Exec functions and utilities. Note Backup Exec Command Line Applet is only backwards compatible for a previous release and dot releases of the same version of Backup Exec.

Updating scripts for use with this release

This release of the Backup Exec Command Line Applet provides improved output from command switches and includes support for new features and capabilities in Backup Exec. Symantec strongly recommends that you use the latest release of the Command Line Applet. You may need to update existing job scripts to take advantage of the improved command switch output. While you update and test your job scripts with this release of Backup Exec Command Line Applet, you can continue to use the previous version of the Command Line Applet.

Command Line Applet requirements

Command Line Applet requirements

The Backup Exec Command Line Applet works with a local or remote Backup Exec server installation. Minimum system requirements include:
Command Line Applet requirements Operating System You can find a list of compatible operating systems, platforms, and applications at the following URL: http://entsupport.symantec.com/umi/V-269-1 Processor Memory Disk Space Pentium system Required 16 MB RAM A minimum of 1 MB of hard disk space after Microsoft Windows is installed DVD-ROM

Other Hardware

Using the Command Line Applet

The Backup Exec Command Line Applet is installed with Backup Exec. After installation, to run the applet on another computer, copy bemcmd.exe to a computer that meets the minimum requirements and is running Windows RPC services. If you copy bemcmd.exe to another computer, the following files must exist on that computer:

beclass.dll becluster.dll BECrypto.dll besocket.dll bestdutl.dll libvxsigcomp2.dll msvcp71.dll msvcr71.dll serdll.dll vxcrypto.dll

Symantec Backup Exec Command Line Applet

Using command line switches

If these files do not already exist, copy them to the computer along with bemcmd.exe. To use the Command Line Applet, type bemcmd followed by a series of command switches in a command prompt window. The Command Line Applet will attempt to complete the requested task, and then return a value to the command prompt indicating success or failure. Backup Exec functions and utilities that you can run using the Command Line Applet include:

Run or cancel a previously created jobs. Create and run jobs for local or remote file selections, including databases on Microsoft Exchange, SQL, Lotus Domino, Oracle, UNIX, and SharePoint installations. Create selection lists. Create protection policies that include job templates and rules. Create, run, and monitor utility jobs.

Note This release of the Command Line Applet does not support submission of verify or rewind jobs.

Set default options for all jobs. Obtain job status and the number of scheduled, active, and completed jobs. Create media sets and drive pools. Perform drive utilities and get information about the status of drives. Start and stop Backup Exec system services. Retrieve information on and respond to job alerts. Determine if the media server is available on the network. View and print Backup Exec reports.

Note The Command Line Applet can target clustered media servers. The only limitation is that the Command Line Applet can target a device pool, but not a specific device in that device pool.

Using command line switches

To use the Command Line Applet on your computer, type the appropriate command line switch and any additional information required. For example, to run a previously created backup job named Operations Weekly, type the following at the command prompt:

Using command line switches

bemcmd -o1 -j"Operations Weekly" In this example, -o1 is the operation to submit the backup job. The command line switch -j specifies the name of the backup job. Because the job name contains spaces, quotation marks are required around the job name. The job Operations Weekly was previously created through the Backup Exec administration console. By default, the backup will be done on the computer where the Command Line applet is executed. To run this same job on a remote computer named Genesis, type the following at the command prompt: bemcmd -cGenesis -o1 -j"Operations Weekly" The command line switch -c specifies the name of the media server where the job is to be run. When connecting to a remote server, if you are required to provide a user name and password, type the following at the command prompt, substituting the text appearing in italics with the correct names: bemcmd -cGenesis -nuser_name -ppassword -o1 -j"Operations Weekly" If the value contains a space or a colon, enclose the value with quotation marks. If the switch contains more than one letter a colon must appear immediately after the switch or the switch itself must be enclosed in quotation marks. Switches that consist of only a single character do no require a colon after the switch. In each of the previous examples, a -1 is returned if the job fails. You can also track the status of the job submission by including the Verbose Output command line switch -v. Substitute the text that appears in italics next to the command, such as job name, with a value, such as the correct job name. For commands using Job IDs, this version of Backup Exec uses a globally unique identifier (GUID) in a 16-byte hex string format for each job. Note Command line switches appearing in BOLD are required.

Symantec Backup Exec Command Line Applet

Using command line switches

Switches used with all operations

The following command line switches can be used with all operations.
Command line switches for all operations Item -? Description Displays help on all command line operations, usage, and special switches. Displays help about a command line operation.

-?operation number -ooperation number -? -cmedia server

Specifies the name of the media server where the operation is to be performed. If a media server name is not specified, the local computer name is used by default. Directs all output to a specified logfile and to the console. You must specify the logfile name where the output is to be written. Appends all output to the specified logfile and to the console. You must specify the logfile name where the output is to be written. Specifies the user name credential for logging on to a remote Backup Exec server. If a user name is not specified, the current credential is used. Specifies the password credential for logging on to a remote Backup Exec server. If a password is not specified, the current password credential is used. Specifies the type of OS the server is running. The default is Windows. To specify a NetWare server, type -tNW. To specify a Windows server, type -tNT.

-llogfile

-la:logfile

-nuser name

-ppassword

-tBackup Exec server type

-v

Displays information detailing what has occurred while running the Command Line Applet and the specified option. This command is useful when tracing the sequence of events using the command line applet. Waits for the job to complete before exiting the program. The commands with switch -w return a 1 if successful or -1 on failure.

-w

Using command line switches Command line switches for all operations (continued) Item --deprecation Description Displays commands that are deprecated in Backup Exec. Returns a 1 if the command succeeds, a -1 if the command fails, or a 0 if the command partially succeeds. Displays category numbers that you append to the -? switch.

--category

Backup job operations and switches

You can run a previously created job or submit a new backup job using the commands presented in the following table. You can also create a backup job script file that the Command Line Applet can use instead of command line switches.
Backup job commands Operation Additional Switches Function Description

-o1

Run backup job

Runs a backup job that has been previously defined. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name or the job ID of the previously defined job that Backup Exec should run. Note If there are jobs with the same name, only one of the jobs will run. To ensure that the correct job runs, you should use the job ID instead of the job name to specify which job will run.

-jjob name or -ijob ID

-pr:priority

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. 10 Symantec Backup Exec Command Line Applet

Using command line switches Backup job commands (continued) Operation Additional Switches -w Function Description

Wait for job completion

Instructs the Command Line Applet to wait for the operation to complete before returning. Creates and runs a backup job for a specified list of files. This operation returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. Specifies the name Backup Exec will assign to this job. If you do not specify a name, a default name is generated. Specifies the name of the device Backup Exec should use for backup. When backing up a remote server, the device name will be the name of the remote server. Use this switch instead of the -d switch to indicate that this device name should be checked against the devices (and device pools) on the target server, and the job should only run if the device exists. If the device does not exist, and if the -v (verbose) switch is used, the following message appears: Device or Device Pool specified does not exist. Specifies a preferred server name or media server pool name for the job.

-o2

Create backup job

-jjob name

-ddevice name

-sd:device name

-sn:media server name or -pn:media server pool name

11

Using command line switches Backup job commands (continued) Operation Additional Switches -pr:priority Function Description

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium.

12

Symantec Backup Exec Command Line Applet

Using command line switches Backup job commands (continued) Operation Additional Switches Function Description

-sfile list or -sf:file name or -sl:selection list name

Required. Specifies a path to a group of files, the name of a file that contains a list (one per line) of files, or an existing selection list name to be backed up. The list should be comma delimited. Selections that end with a backslash indicate the selection is a directory. Selections that do not end with a backslash indicate the selection is a file. To back up System State, type "\\server name\System?State\*.*" after -s. Note To back up Shadow Copy Components on a Windows 2003 computer, type "\\server name\Shadow?Copy ?Components\*.*" after -s. By default, subdirectories will be recursed; to skip subdirectories during backup, the characters /n should appear before the comma separating the entries, and the last quotation mark. Include a space between the list of files and the /n entry. For example, "c:\winnt\*.* /n". If Unix files are included in the selections, the characters /u should appear before the comma separating the entries, and the last quotation mark. If the sudirectories are skipped during backup, the /n characters must precede the /u characters. If the /n characters are in the entry, include a space between the list of files and the /n entry. For example, "c:\winnt\*.* /n/u". The order in which resource selections are specified is the order in which the resources will be backed up. Note the following about the order in which selections can be backed up:

13

Using command line switches Backup job commands (continued) Operation Additional Switches Function Description You can order resources within a server, but you cannot alternate selections across servers. For example, you can select C: and D: from Server A followed by selections from Server B. However, you cannot order selections as C: from Server A and then C: from Server B and then D: from both servers. For any given server, System State or shadow copy components must be ordered last.

-mmedia set

Specifies the name of the media set Backup Exec should target. Specifies the media protection level:

-mp:media protection level

0 = Overwrite 1 = Append to media, overwrite if not available 2 = Append to media, terminate if not available

-r

Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec administration console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Specifies a list of items or the name of a file that contains a list of items to exclude from the backup job. List of server and logon accounts Specifies the server name and logon account GUIDs. The list should be comma delimited.

-w

-e or -ef:file name

-rl:

14

Symantec Backup Exec Command Line Applet

Using command line switches Backup job commands (continued) Operation Additional Switches -rf: Function Description

File name of Specifies the name of the file that contains server and logon the server name and logon account GUIDs. accounts The list should be comma delimited with a blank line at the end of the list. Back up server drive Creates and runs a backup job to back up the specified drive on the media server. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. Specifies the name that Backup Exec will assign to this job. Specifies the drive letter of the drive that Backup Exec should backup. If no drive letter is specified, the job will default to C: drive. When backing up a remote server, the device name will be the name of the remote server. Specifies a preferred server name or media server pool name for the job.

-o3

-jjob name

-ddrive name

-sn:media server name or -pn:media server pool name -pr:priority

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium.

15

Using command line switches Backup job commands (continued) Operation Additional Switches -r Function Description

Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning.

-w

-o6

Back up Creates and runs a backup job for Exchange Exchange Server Server. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. Note The Agent for Microsoft Exchange Server must be enabled from the media server in order for this command to work. -jjob name Specifies the name that Backup Exec will assign to this job. Required. Specifies the storage group to back up. Specifies a preferred server name or media server pool name for the job.

-sg:storage group -sn:media server name or -pn:media server pool name -pr:priority

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. 16 Symantec Backup Exec Command Line Applet

Using command line switches Backup job commands (continued) Operation Additional Switches -r Function Description

Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the Command Line Applet or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Creates and runs a backup job for SQL server. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. Note The Agent for Microsoft SQL Server must be enabled on the media server in order for this command to work.

-w

-o8

Back up SQL server

-jjob name

Specifies the name that Backup Exec will assign to this job. Specifies the name of the database to back up. Enter -db:*.* to back up the default instance on the local machine. Specifies the named instance to back up.

-db:database name

-ni:named instance -sn:media server name or -pn:media server pool name -svr:server name

Specifies a preferred server name or media server pool name for the job.

Specifies the name of the remote SQL server to back up.

17

Using command line switches Backup job commands (continued) Operation Additional Switches -pr:priority Function Description

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -r Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Places a Microsoft SQL Server database in either standby mode or in a loading state. Values are: 0 = None. 1 = Standby. Place database in standby mode. 2 = No recover. Place database in a loading state. -o17 Back up Lotus Notes server Creates and runs a backup job of the Lotus Notes server. Returns a 1 if the command succeeds or a -1 if the command fails. Specifies the name that Backup Exec will assign to this job. Required. Specifies the drive letter where Lotus Notes is installed.

-w

-lo:database mode

-jjob name

-ddrive name

18

Symantec Backup Exec Command Line Applet

Using command line switches Backup job commands (continued) Operation Additional Switches -tl:path Function Description

Specifies the complete path to the transaction log file. Specifies a preferred server name or media server pool name for the job.

-sn:media server name or -pn:media server pool name -pr:priority

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -r Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Creates and runs a backup job of the Oracle server. Returns a 1 if the command succeeds or -1 if the command fails. Note Only one SID can be specified per command. Use -si to indicate the SID name to back up. -jjob name Specifies the name that Backup Exec will assign to this job. Required. Specifies the SID name to back up. 19

-w

-o18

Back up Oracle server

-si:SID name

Using command line switches Backup job commands (continued) Operation Additional Switches -sn:media server name or -pn:media server pool name -pr:priority Function Description

Specifies a preferred server name or media server pool name for the job.

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -r Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the Command Line Applet or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Specifies the name of the device that Backup Exec should use for the alias backup.

-w

-ddevice name

20

Symantec Backup Exec Command Line Applet

Using command line switches Backup job commands (continued) Operation Additional Switches Function Description

-o24

Back up a Microsoft SharePoint Portal Server 2003

Creates and runs a backup job for the Microsoft SharePoint Portal Server 2003. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. The Agent for Microsoft SharePoint must be enabled on both the media server and the server on which SharePoint Portal Server is installed in order for this command to work. You must specify either the -wb switch or the -fm switch. If you specify either switch, the other is optional

-wb:web server name -fm:farm name

Required. Specifies the name of a Web server that belongs to the farm. Required. Specifies the SharePoint Portal Server farm to back up. Includes the Configuration database in the backup job. Includes the Single sign-on database in the backup job. Includes the Document Library store in the backup job. Specifies a list portal sites to back up. This list should be comma delimited. If you do not specify a list of portal sites, then all portal sites in the farm are backed up. You can display a list of portal sites if you use the -o26 switch.

-cf

-ss

-ds

-ps:portal site name

21

Using command line switches Backup job commands (continued) Operation Additional Switches -ws:Windows SharePoint Services sites Function Description

Specifies a list of Windows SharePoint Services site name to back up. This list should be comma delimited. If you do not specify a list of Windows SharePoint Services sites, then all Windows SharePoint Services sites in the farm are backed up. You can display a list of Windows SharePoint Services site names if you use the -o26 switch.

-dl:document library names

Specifies a list of backward compatible document libraries to back up. This list should be comma delimited. If you do not specify a list of backward compatible document libraries, then all backward compatible document libraries in the farm are backed up. You can display a list of document library names if you use the -o26 switch.

-jjob name

Specifies the name that Backup Exec will assign to this job. Specifies the priority for the job. Priority options include:

-pr:priority

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -ddevice name Specifies the name of the device Backup Exec should use for backup. When backing up a remote server, the device name will be the name of the remote server.

22

Symantec Backup Exec Command Line Applet

Using command line switches Backup job commands (continued) Operation Additional Switches -r Function Description

Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. If the job is a scheduled job (not a run now job), the -w is ignored. Specifies a preferred server name or media server pool name for the job.

-w

-sn:media server name or -pn:media server pool name -o28 Use Oracle Recovery Manager (RMAN) to back up an Oracle database -svr:server name

Use RMAN to create and run a backup job for an Oracle database. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails.

Required. Specifies the name of a server

on which Oracle runs.

-sid:Oracle SID -a -jjob name

Required. Specifies the Oracle server ID. Backup up all archived logs. Specifies the name that Backup Exec will assign to this job. Specifies the name of the device Backup Exec should use for backup. When backing up a remote server, the device name will be the name of the remote server.

-ddevice name

23

Using command line switches Backup job commands (continued) Operation Additional Switches -w Function Description

Wait for job completion

Instructs the Command Line Applet to wait for the operation to complete before returning. If the job is a scheduled job (not a run now job), the -w is ignored. Creates and runs a backup job for the Microsoft SharePoint Server 2007. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. The Agent for Microsoft SharePoint must be enabled on both the media server and the server on which SharePoint server is installed in order for this command to work. You must specify either the -wb switch or the -fm switch. If you specify either switch, the other is optional

-o52

Back up a Microsoft SharePoint Server 2007

-wb:web server name -fm:farm name

Required. Specifies the name of a web server that belongs to the farm. Required. Specifies the SharePoint server farm to back up. Includes the Configuration database in the backup job. Includes the Single sign-on database in the backup job. Backs up the central administration site. Specifies the name of the Web application. You can list multiple names.

-cf:

-ss:

-ca -wa:Web application name -sp: shared service provider name or -ssp shared service provider name 24

Specifies the name of the shared server provider. You can list multiple names.

Symantec Backup Exec Command Line Applet

Using command line switches Backup job commands (continued) Operation Additional Switches -si -gs -jjob name or -ijob ID Function Description

Backs up the shared instance. Backs up the global settings. Required. Specifies the name or the job ID of the previously defined job that Backup Exec should run. Note If there are jobs with the same name, only one of the jobs will run. To ensure that the correct job runs, you should use the job ID instead of the job name to specify which job will run.

-pr:priority

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -ddevice name Specifies the name of the device Backup Exec should use for backup. When backing up a remote server, the device name will be the name of the remote server. Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. If the job is a scheduled job (not a run now job), the -w is ignored.

-r

-w

25

Using command line switches Backup job commands (continued) Operation Additional Switches -e Function Description

Enables Backup Exec Granular Recovery Technology (GRT), which lets you restore individual items from tape. Specifies a preferred server name or media server pool name for the job.

-sn:media server name or -pn:media server pool name -o90 Launch job using job script file

Executes a job based on the contents of a script file. Return values depend on the type of script. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. For more information about Backup Job Script Files, see Using job script files on page 127.

-fscript file

Required. Specifies the name of the Backup Exec job script file. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. If the job is a scheduled job (not a run now job), the -w is ignored. Creates and maintains encryption keys.

-w

-o99

Manage an encryption key -kkey name

Required. Specifies the name of the encryption key. Required when creating a new key. Specifies a pass phrase for this key. For 128-bit AES encryption, the pass phrase must be at least eight characters. For 256-bit AES encryption, the pass phrase must be at least 16 characters.

-pp:pass phrase

26

Symantec Backup Exec Command Line Applet

Using command line switches Backup job commands (continued) Operation Additional Switches -em:encryption method Function Description

Specifies the encryption method to use. Values are as follows:

0 = None 1 = Software 2 = Hardware 3 = Hardware if available, otherwise software

Use this switch with the -dk parameter to configure the default encryption method for new backup or duplicate backup set jobs. To specify the encryption method, you must first set a default encryption key. If you type 2 or 3, the default key must be 256-bit encryption. If you enter the -dk parameter but not the -em parameter, then the encryption method defaults to software. -et:encryption type (128 or 256-bit) Specifies the encryption type to use for this key. Your choices are 128-bit AES or 256-bit AES. The 256-bit AES encryption provides a stronger level of security than 128-bit AES encryption. However, backup jobs may process more slowly with 256-bit AES encryption than with 128-bit AES encryption. -kt:key type Specifies the key type for the encryption key. Enter 1 for a common key; otherwise, enter 0 for a restricted key. If a key is common, any Backup Exec user can use the key to back up and restore data. If a key is restricted, any Backup Exec user can use the key to back up data, but only the key owner or a user who knows the pass phrase can use the key to restore the encrypted data.

27

Using command line switches Backup job commands (continued) Operation Additional Switches -dk: Function Description

Specifies the encryption key as the default key for new backup or duplicate backup set jobs. To clear the default key, specify the -dk: parameter with the key name None.

-d

Deletes an encryption key. If you do not specify the -d switch, an encryption key will be created.

-o220

Create selection Creates a list of resource selections to be used list when creating a backup job. -sselection name -ddescription -fscript file Required. Specifies the name of the selection list. A brief description of the selection list. Required. Specifies the selections to be contained in this selection list. Format for scripts is [MACHINE] MACHINE1=machine name|logon GUID Each path must be on a separate line. For example: PATH1=C:\test\*.*|{1950A99C-2423-451E-B9 77-225717870CEE} PATH2=C:\test2\*.* An example script is available in the selectionscript.txt file in the WINNT\UTILS\I386 directory on the Backup Exec DVD. -sn:media server name or -pn:media server pool name Specifies a preferred server name or media server pool name for the job.

28

Symantec Backup Exec Command Line Applet

Using command line switches Backup job commands (continued) Operation Additional Switches -pi:pool ID Function Description

Specifies a preferred server pool ID for the job. Displays Displays the live updates you have installed. installed hot fixes and service packs Error code lookup Displays an error message for an error code.

-o601

-o999

-eerror code

Specifies the error code for the error message you want to display.

Operations and switches for administrating jobs

Several command switches allow you to administer your jobs. These switches, which allow you to obtain information about the jobs, view job histories, and cancel a job, include:
Job monitoring switches Operation Additional Switches Function Description

-o15

Get job state

Displays one of many predefined job states if the command was successful. Also returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name or the job ID that contains the job statuses to display.

-jjob name or -ijob ID

29

Using command line switches Job monitoring switches (continued) Operation Additional Switches Function Description

-o16

Dump job status Copies to the console the job information and for scheduled descriptive headings for each item associated and active job with the job ID. Returns a 1 if the command succeeds or a -1 if the command fails. -jjob name or -ijob ID Required. Specifies the name or the job ID of the job to cancel. Cancel job Cancels a job. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name or the job ID of the job to cancel. Dump completed job status -j job name -ijob ID or -hi:job history ID -e Displays completed job status. Returns a 1 if the command succeeds or a -1 if the command fails. Specifies the job ID or job history ID that contains the job statuses to display.

-o20

-jjob name or -ijob ID -o21

Use this switch with -ijob ID to display details for the last instance of the job. Jobs on hold Displays all the jobs that have the on hold status. If you do not specify -j or -i only the number of jobs on hold appears. Use this switch to display job IDs. Use this switch to display job names. Query job Displays information about all job states and job types in the Job Monitor. Specifies the state of the job you want to query. Specifies the type of job you want to query. Use this switch to display job IDs.

-o22

-i -j -o23

-sjob state

-qjob type -i

30

Symantec Backup Exec Command Line Applet

Using command line switches Job monitoring switches (continued) Operation Additional Switches -j -js: Function Description

Use this switch to display job names. Use this switch to display a list of available job states that you can use with the -s switch. Use this switch to display a list of available job types that you can use with the -q switch. Use this switch to display a list of jobs that delete after the job completes. Dump job log name of completed job Copies to the console the job log name that is associated with the specified job ID or job name. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name or the job ID of the job. Dump job log contents Copies to the console the contents of the job log specified on the command line. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the job log name. Specify a 0 for text output or 1 for HTML output. Rename a job Renames a job. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Instructs Backup Exec to rename the job associated with the job IDs.

-jt:

-dj:

-o30

-jjob name or -ijob ID -o31

-ffile name -soutput style

-o35

-ijob id

Rename job associated with the job ID.

-jjob name

Current name of Required. Instructs Backup Exec to rename the job to the job. rename. Required.Provides the new name for the job.

-jn:new job name New name for the job.

31

Using command line switches Job monitoring switches (continued) Operation Additional Switches Function Description

-o200

Place job on hold Places the specified job on hold. Returns a 1 if the command succeeds or a -1 if the command fails. You must specify either the -j switch or the -f switch. -jjob name Required. Specifies the name of the job to be placed on hold. Required.Specifies a file that contains a list of jobs (one per line) to place on hold. Take job off hold Takes the specified job off hold. Returns a 1 if the command succeeds or a -1 if the command fails. You must specify either the -j switch or the -f switch. -jjob name Required. Specifies the name of the job to be taken off hold. Required. Specifies a file that contains a list of jobs (one per line) to place on hold. Delete scheduled job -jjob name or -ijob ID -ds: Delete the selection list if no other jobs are using it Deletes a scheduled job. You must specific the -j switch. Required. Specifies the name or the job ID of the job to cancel. If the scheduled job is not deleted, the selection list is not deleted, and a -1 is returned. If the scheduled job is deleted, the selection list will be deleted, and a 1 is returned. If the selection list is not deleted, a 0 is returned.

-ffilename

-o201

-ffilename

-o202

32

Symantec Backup Exec Command Line Applet

Using command line switches Job monitoring switches (continued) Operation Additional Switches Function Description

-o221

Delete a backup Deletes the specified backup selection list. selection list -sselection list name or -ffilename Required. Specifies the name of the selection list or filename to delete.

-o222

Exclude all selections in an existing selection list from backup. -e Use this switch to exclude every entry in the specified selection list from backup. List all backup selection lists. Displays all available backup selection lists. Returns a 1 if the command succeeds or a -1 if the command fails. Lists all existing preferred server configurations.

-o251

-o280

List preferred server group

-o281

Create preferred Lets you create a new preferred server server group configuration. Preferred server configurations give you more control over your backup jobs by letting you specify a preferred server from which Backup Exec backs up replicated data. Delete preferred Deletes the selected preferred server server group configuration. You can delete a preferred server configuration if you no longer need it. Set default Designates a default preferred server preferred server configuration for all of your backup jobs that group contain the appropriate replication data. When you designate a default preferred server configuration, it is not applied to existing selection lists. It is considered the default preferred server configuration for any subsequent selection lists you create.

-o282

-o283

33

Using command line switches Job monitoring switches (continued) Operation Additional Switches Function Description

-o290

List resources in Lets you view any servers and sites that make preferred server up the preferred server configuration. group Add resource to Lets you add a server or site to the preferred preferred server server group. You must specify the type of group resource that you want to add. -i:group id or -g:group name Specifies the ID or name of the preferred server configuration to which you want to add a resource. You can specify either the group ID or the group name. Specifies the resource you want to add to the preferred server group. Required. Specifies the type of resource you are adding to the preferred server configuration. Resource types include: 1 = Site 2 = Server 3 = Exchange 2010 forest 4 = Exchange 2010 DAG

-o291

-r:resource

-rt:resource type

-o292

Remove Lets you remove a server or site from the resources from preferred server configuration. preferred server group Disable error handling rule -irule ID Disables an error-handling rule.

-o312

Required.Specifies the ID of the rule being disabled.

34

Symantec Backup Exec Command Line Applet

Using command line switches Job monitoring switches (continued) Operation Additional Switches Function Description

-o506

Dump job information

Displays job, selection, and schedule information stored on this server. Also returns a 1 if the command succeeds or a -1 if the command fails. Specifies the name of the job that contains information that you want to be dumped.

-jjob name

-ddisplay type

Display type of Specifies the type of job information to job information display. Enter one of the following values: 1 = Display only the job information. Do not display the selection list or schedule information. 2 = Display only the selection list information. Do not display the job or schedule information. 3 = Display only the schedule information. Do not display the job or selection list information. If you do not use the -d switch, all job information is displayed.

-o507

Dump selection lists

Displays the contents of the specified selection list. If a selection list is not specified, all selection lists will be dumped. Specifies the name of the selection list.

-sselection list name -o509 Dump policy information

Displays the contents of the specified policy. If a policy is not specified, all policies will be dumped. Required. Specifies the GUID for the policy. To find the ID for a policy, use operation -o263 to display the policies on a computer. Instructs Backup Exec to display policy name.

-ipolicy ID

-j

35

Using command line switches

Restore job operations and switches

You can run a previously created restore job or launch a restore job script file through the following command line switches:
Restore job commands Operation Additional Switches Function Description

-o7

Run a restore job Runs a restore job that has been previously defined for a media server. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. -jjob name or -ijob ID Required. Specifies the name or the job ID of the previously defined job that Backup Exec should run. Specifies the priority for the job. Priority options include:

-pr:priority

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Creates and runs a restore job of a Microsoft SharePoint Portal Server 2003 through a server farm.

-o27

Restore Microsoft SharePoint Portal Server 2003 job -fm:farm name

Required. Specifies the SharePoint Portal Server farm to restore. Includes the Configuration database in the restore job.

-cf

36

Symantec Backup Exec Command Line Applet

Using command line switches Restore job commands (continued) Operation Additional Switches -ss: Function Description

Includes the Single sign-on database in the restore job. Includes the Document Library store in the restore job. Specifies a list of portal sites to restore. This list should be comma delimited. You can display a list of portal sites if you use the -o26 switch.

-ds:

-ps:portal site name

-ws:Windows SharePoint Services sites

Specifies a list of Windows SharePoint Services sites to restore. This list should be comma delimited. You can display a list of Windows SharePoint Services sites if you use the -o26 switch.

-dl:document library names

Specifies a list of backward compatible document libraries to restore. This list should be comma delimited. You can display a list of document libraries if you use the -o26 switch.

-ne:no earlier than date -nl:no later than date -jjob name

Specifies the earliest date range to perform a point-in-time restore. Specifies the latest date range to perform a point-in-time restore. Specifies the name that Backup Exec will assign to this job.

37

Using command line switches Restore job commands (continued) Operation Additional Switches -pr:priority Function Description

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning.

-o29

Use Oracle Use RMAN to create and run a restore for an Recovery Oracle database. Manager (RMAN) to restore an Oracle database -svr:server name Required. Specifies the name of a server

on which Oracle runs.

-sid:Oracle SID -act:logon account name

Required. Specifies the Oracle server ID. Specifies the logon account name to log on to connect to the server on which Oracle runs. You should specify this switch if the current logon account name is not valid to log on to the server. Specifies a list of tablespace names to restore. This list should be comma delimited. Specifies the earliest date range to perform a point-in-time restore. Specifies the latest date range to perform a point-in-time restore.

-tb:tablespace names -ne:no earlier than date -nl:no later than date

38

Symantec Backup Exec Command Line Applet

Using command line switches Restore job commands (continued) Operation Additional Switches -jjob name Function Description

Specifies the name that Backup Exec will assign to this job. Specifies the priority for the job. Priority options include:

-pr:priority

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -r Recover using redo logs Recovers up to the last committed transaction that is available from online and archived redo logs. Ensures that the database is opened as soon as the recovery is finished. Instructs the Command Line Applet to wait for the operation to complete before returning. Creates and runs a restore job of a SQL server.

-ro

Open database after recovery Wait for job completion

-w

-o36

Create a SQL server restore job -db:named instance and database name

Required. Specifies the named instance of SQL server the databases are in. Enter the named instance and database name in the server\instance+database format. You should separate the multiple names with a comma. You can specify *.* to restore all

databases in the instance.

Note Database names are case sensitive. -dt:backup date Restores the most recent backup job no later than the specified date.

39

Using command line switches Restore job commands (continued) Operation Additional Switches -jjob name Function Description

Specifies the name that Backup Exec will assign to this job. Specifies the priority for the job. Priority options include:

-pr:priority

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -o38 -vn:volume name Search catalog Searches the catalog for protected resources. Specifies the name of the volume that you want to search. Specifies the name of the media that you want to search. Specifies the earliest date range to perform a point-in-time search. Specifies the latest date range to perform a point-in-time search. Specifies the type of file by which you want to search. You can use a type of filename such as doc. Specifies the path by which you want to search. Specifies the server name by which you want to search. Search by directories only. Include subdirectories in the search.

-mn:media name

-ne:no earlier than date -nl:no later than date -fn:filename

-pa:path name

-sn:server name

-d -s

40

Symantec Backup Exec Command Line Applet

Using command line switches Restore job commands (continued) Operation Additional Switches Function Description

-o39

Create a restore job of NTFS volumes -pa:selection path

Runs a restore of NTFS volumes that include system state and shadow copy components.

Required. Specifies the selection to restore. You must enter the path name in the \\server\path\file format. You can enter multiple paths, however, the list should be comma delimited. For example, pa:"\\server1\path1\file1, \\server2\path2\file2" You can use a pipe to specify multiple selections under the same server. For example, -pa:"\\server1\path1\file1|\path2\file2|\path 3\file3" You can use a plus sign to specify multiple files under the same path. For example, -pa:"\\server1\path1\file1+file2+file3" You can specify *.type to restore the same type of file to be restored. For example, -pa:"\\server\path1\*.doc". To restore everything under a directory, use use *.* as the filename, or end the path with \. If the selection is a directory, but the selection text does not end with \, the folder name will be specified as the filename. The file will be restored instead of the directory.

-ne:no earlier than date -nl:no later than date

Specifies the earliest date range to perform a point-in-time restore. Specifies the latest date range to perform a point-in-time restore.

41

Using command line switches Restore job commands (continued) Operation Additional Switches -pr:priority Function Description

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Creates and runs a restore job of a Microsoft SharePoint Server 2007 through a server farm.

-o54

Restore Microsoft SharePoint Server 2007 job -fm:farm name

Required. Specifies the SharePoint server farm to restore. Includes the Configuration database in the restore job. Includes the Single sign-on database in the restore job. Restores the central administration site. Specifies the name of the Web application. You can list multiple names.

-cf

-ss:

-ca -wa:Web application name -sp: shared service provider name or -ssp shared service provider name

Specifies the name of the shared server provider. You can list multiple names.

42

Symantec Backup Exec Command Line Applet

Using command line switches Restore job commands (continued) Operation Additional Switches -gs -ne:no earlier than date -pw: Preserve existing Internet Information Services (IIS) web site and application pool Function Description

Restores the global settings. Specifies the earliest date range to perform a point-in-time restore. Enter 1 to preserve the existing IIS web site and application pool for the specified SharePoint web application. Enter 0 to create a new IIS web site and application pool with settings from the backup.

-nl:no later than date -j job name

Specifies the latest date range to perform a point-in-time restore. Specifies the name that Backup Exec will assign to this job. Specifies the priority for the job. Priority options include:

-pr:priority

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning.

43

Using command line switches Restore job commands (continued) Operation Additional Switches Function Description

-o90

Launch job using job script file

Executes a job based on the contents of a script file. Return values depend on the type of script. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. For more information about Backup Job Script Files, see Using job script files on page 127.

-fscript file

Required. Specifies the name of the Backup Exec script file. If the job is a scheduled job (not a run now job), the -w is ignored. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. If the job is a scheduled job (not a run now job), the -w is ignored.

-w

See also: Using job script files on page 127

Operations and switches for viewing and responding to alerts

Alerts are events that require administrator attention. Several command switches allow you to view and respond to alerts. These include:
Managing alerts switches Operation Additional Switches Function Description

-o40

Get number of alerts

Displays the number of alerts on the computer. Returns a 1 if the command succeeds or a -1 if the command fails. Displays all the alert IDs on the screen. Displays titles of alerts.

-i -tl:

Dump alert IDs Show titles

44

Symantec Backup Exec Command Line Applet

Using command line switches Managing alerts switches (continued) Operation Additional Switches -jserver name Function Description

Displays alerts generated from the specified server only. Displays history alerts. Displays the name of the server that generated the alert. Displays the date the alert was generated. Dump alert text Dumps the alert title and message to the console. Returns a 1 if the command succeeds or a -1 if the command fails.

-h -s

-d -o42

-ialert ID or -a

Required. Use -i to display a specific alert or -a to display active alerts. Wait for alert response Get number of information only alerts Instructs the Command Line Applet to prompt for a response to the alert. Displays the number of non-critical (information only alerts) on the computer. Also returns a 1 if the command succeeds or a -1 if the command fails. If -i is used with this command, all alert IDs will be displayed on the screen. Displays alert titles. Displays alerts generated from the specified server only. Displays the name of the server that generated the alert. Displays the date the alert was generated.

-w

-o43

-i

Dump all alert IDs Show titles

-tl: -jserver name

-s

-d

45

Using command line switches Managing alerts switches (continued) Operation Additional Switches Function Description

-o44

Get number of user intervention (critical) alerts -i Dump all alert IDs Show titles

Displays the number of user intervention alerts on the computer. Also returns a 1 if the command succeeds or a -1 if the command fails. If -i is used with this command, all alert IDs will be displayed on the screen. Displays alert titles. Displays alerts generated from the specified server only. Displays the name of the server that generated the alert. Displays the date the alert was generated.

-tl: -jserver name

-s

-d -o45 Clear all information only alerts

Clears all current information only alerts. Returns a 1 if the command succeeds or a -1 if the command fails.

-o46

Respond to alert Allows you to respond to an alert. Returns 1 if the command succeeds, 0 if the alert was already responded to, or -1 if the command fails. -ialert ID Required. Specifies the alert ID that you want to respond to. Required. Specifies a response. Responses are OK, YES, NO, CANCEL, RETRY,or IGNORE or instructs the Command Line Applet to prompt for a response. Specifies an OK response to informative alerts. If you specify the -a switch you cannot use the -w switch.

-rresponse or -w

-arespond to all informative alerts

46

Symantec Backup Exec Command Line Applet

Using command line switches Managing alerts switches (continued) Operation Additional Switches Function Description

-o47

Get all warning alerts

Displays the number of warning alerts on the computer. Also returns a 1 if the command succeeds or a -1 if the command fails. If -i is used with this command, all alert IDs display on the screen. Displays alert titles. Displays alerts generated from the specified server only. Displays the name of the server that generated the alert. Displays the date the alert was generated.

-i

Dump all alert IDs Show titles

-tl: -jserver name

-s

-d -o48 Get all error alerts

Displays the number of error alerts on the computer. Also returns a 1 if the command succeeds or a -1 if the command fails. If -i is used with this command, all alert IDs display on the screen. Displays alert titles. Displays alerts generated from the specified server only. Displays the name of the server that generated the alert. Displays the date the alert was generated.

-i

Dump all alert IDs Show titles

-tl: -jserver name

-s

-d -o49 List alert categories

Displays alert categories. Returns a 1 if the command succeeds or a -1 if the command fails. If -i is used with this command, all alert IDs will be displayed on the screen.

-i

Dump all alert IDs

47

Using command line switches Managing alerts switches (continued) Operation Additional Switches -j Function Description

Display alert category name Display event category Dump alert configuration

Displays alert names on screen.

-ac:

Displays the alert category on screen.

-o50

Displays the configuration for alerts on screen. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies an alert ID to display configuration information for.

-ialert category ID -o51 Set alert configuration -ialert category ID -e or -d Enable alert or disable alert

Modifies the alert configuration.

Required. Specifies an alert ID to display configuration information for. Enables or disables the specified alert for reporting by Backup Exec. Some alerts types, such as error and attention required, are always enabled. Enables or disables the sending of a notification when the alert occurs. Recipients must be configured to use this option.

-no: or -nn:

Enable notification or disable notification

-jl: or -nj:

Enable inclusion Sends the job log or disables the inclusion of of job log or the job log to the alert recipient that is disable inclusion configured for notification. of job log Enable sending of SNMP notifications or disable sending of SNMP notifications Enables or disables the sending of alert notifications through SNMP.

-s or -ns:

48

Symantec Backup Exec Command Line Applet

Using command line switches Managing alerts switches (continued) Operation Additional Switches -rl: or -nr: Function Description

Enable event logging or disable event logging Set time for automatic clearing of alert or disable automatic alert clearing

Enables or disables the logging of events in the Windows event log.

-ac:timeout or -na:

Sets the time in days, hours, or minutes for Backup Exec to automatically clear the alert or disables the automatic clearing of alerts. Set the time as D=days, H=hours, or M=minutes. The length of time entered cannot be more than seven days. Sets the automatic response for an alert. The possible responses are Yes, No, and Cancel.

-ar:response

Set the automatic response for an alert. Dump notification recipients

-o150

Displays the recipients that have defined notification methods. Returns a 1 if the command succeeds or a -1 if the command fails.

Operations and switches for error-handling rules

Backup Exec has system-defined error-handling rules that determine how job errors are handled. They apply to all backup jobs and are defined based on the cause of the failure. The rules can be configured to automatically perform operations such as retry, pause, or cancel a job after a failure occurs. Error-handling rules are disabled by default.
Error-Handling Rules switches Operation Additional Switches Function Description

-o310

Display error-handling rules

Displays the error-handling rules.

49

Using command line switches Error-Handling Rules switches (continued) Operation Additional Switches Function Description

-o311

Enable error handling rule -irule ID -mr:maximum retries Required. ID of the rule that is to be enabled. Indicates that the job should be retried and the number of times the job is to be retried. The range for maximum retries is 1 to 99. Indicates that the job should be retried and the number of minutes to wait before the job is retried. The range for the retry interval is 1 to 1,440. Pause job on error Indicates the job is to be paused until the user has taken action to clear the error. If this switch is absent, the job will be cancelled until its next scheduled run. Indicates the job is to be cancelled if an error occurs. Specifies miscellaneous information for the error-handling rule. Disable error handling rule -irule ID Disables the specified error-handling rule.

-ri:retry interval

-pj:

-cj:

Cancel job on error

-no:notes
-o312

Required. Specifies the error-handling rule that is to be disabled.

50

Symantec Backup Exec Command Line Applet

Using command line switches

Operations and switches for managing media and devices

Through the Command Line Applet, you can manage the storage devices attached to your media server, manage media in these devices, launch utility operations, and obtain the status of your media server. You can also use commands to stop and start Backup Exec system services and create logon accounts for accessing systems. The device and media management switches available include:
Device and media management switches Operation Additional Switches Function Description

-o62

Is drive paused

Returns a 1 if the drive is paused, a 0 if the drive is not paused, and a -1 if the command fails. Required. Specifies the name or the ID of the drive.

-ddrive name or -idrive ID -o63 Get number of drives

Displays the number of managed drives. Returns a 1 if the command succeeds or a -1 if the command fails. Displays drive IDs for all drives. Displays names for all drives.

-i -j -o64 Get number of drives available

Displays the number of managed drives that are online and not paused. Drives that are being used are considered online and are included in the number displayed. Returns a 1 if the command succeeds or a -1 if the command fails. Displays drive IDs for all drives. Displays names for all drives.

-i -j -o65 Get number of drives paused

Displays the number of managed drives that are paused. Returns a 1 if the command succeeds or a -1 if the command fails. Displays drive IDs for all drives. Displays names for all drives.

-i -j

51

Using command line switches Device and media management switches (continued) Operation Additional Switches Function Description

-o66

Get number of drives offline

Displays the number of managed drives that are offline. Returns a 1 if the command succeeds or a -1 if the command fails. Displays drive IDs for all drives. Displays names for all drives.

-i -j -o67 Dump drive properties

Displays general properties of a drive. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name or the ID of the drive.

-ddrive name or -idrive ID -o68 -o69 Query devices Get number of media sets

Displays the number of media sets. Returns a 1 if the command succeeds or a -1 if the command fails. Displays the media set IDs for all media sets. Displays the names of all media sets.

-i -j -o70

Dump media set Displays properties of the media set. Returns properties a 1 if the command succeeds or a -1 if the command fails. -imedia set ID or -jmedia set name Required. Specifies the media set ID or media set name.

-o71

Dump media Displays properties of the media label. label properties Returns a 1 if the command succeeds or a -1 if the command fails. -imedia set ID or -jmedia set name Required. Specifies the media set ID or media set name.

52

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches Function Description

-o78

Set robotic library properties -drobotic library -nd:new robotic library name -ps:pause or resume drive -e:enable or disable robotic library -es:enable or disable startup initialization -er:enable or disable startup initialization -eb:enable or disable bar code rules -sb:slot base

Sets properties for a robotic library.

Required. Specifies the robotic library to target for this operation. Specifies the name for the robotic library.

Enter 1 to pause the robotic library; otherwise, enter 0 to resume. Enter 1 to enable the robotic library; otherwise, enter 0 to disable the robotic library.

Enter 1 to enable the startup initilization; otherwise, enter 0 to disable the startup initilization.

Enter 1 to enable the removable storage; otherwise, enter 0 to disable the removable storage.

Enter 1 to enable bar code rules; otherwise, enter 0 to disable bar code rules.

Specifies the starting slot. Some robotic libraries have slots starting at "0"; others start at "1". Set device properties Sets properties for a device.

-o79

-ddevice name

Required. Specifies the device to target for this operation.

53

Using command line switches Device and media management switches (continued) Operation Additional Switches -ndnew device name -ps:pause or resume device -e:enable or disable device -m:enable or disable compression -bkblock size Function Description

Specifies the name for the device.

Enter 1 to pause the device; otherwise, enter 0 to resume. Enter 1 to enable the device; otherwise, enter 0 to disable the device. Enter 1 to enable compression; otherwise, enter 0 to disable compression.

Specifies the size of the blocks of data written to the device. Specifies the amount of data sent to the device on each read or write request. The buffer size must be an even multiple of the block size. Specifies the number of buffers allocated for this device. Specifies the number of buffers to be filled before data is first sent to the device, and any time after that if the device underruns. Specifies that this device read only one block of data at a time. Specifies that this device write only one block of data at a time. Specifies that this device read data without going through a Microsoft tape device API. Selecting this check box allows the data to pass directly through the device and allows more detailed information if device errors occur.

-bfbuffer size

-bcbuffer count

-hwhigh water count

-rsRead single block mode -wsWrite single block mode -rpRead SCSI pass-through mode

54

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -wpWrite SCSI pass-through mode Function Description

Specifies that his device write data without going through the Microsoft tape device API. Selecting this check box allows data to pass directly through the device driver and allows more detailed information if device errors occur. Resets the preferred configuration settings to the default. Resets the cleaning statistics. Import drive slots Imports a list of backup tapes. Returns job ID and 1 if the command succeeds, or a -1 if the command fails. Required. Specifies the robotic library to target for this operation. Instructs Backup Exec to auto inventory all slots. Specifies the slots in the robotic library to target. This list should be comma delimited. If no slots are specified, then all will be targeted by default. Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. See Using a schedule script with device and media operations on page 256.

-r

-s -o80

-arobotic library -ai:

-sslot numbers

-fschedule file

55

Using command line switches Device and media management switches (continued) Operation Additional Switches -pr:priority Function Description

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Exports a list of backup tapes. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. Required. Specifies the robotic library to target for this operation. Specifies the slots in the robotic library to target. This list should be comma delimited. If no slots are specified, then all will be targeted by default. Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. See Using a schedule script with device and media operations on page 256.

-o81

Export drive slots

-arobotic library -sslot numbers

-fschedule file

56

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -pr:priority Function Description

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Specifies the export of expired media only. Includes cleaning media in the export of expired media. Imports new media to the slot after the export expired media operation completes. Designate cleaning slot Designates a slot to be a cleaning slot. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the robotic library and the slot in the robotic library to target for this operation. Reset slot to be non-cleaning slot -arobotic library and -sslot number -o84 Get number of robots Designates a slot to be a non-cleaning slot. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the robotic library and the slots in the robotic library to target for this operation. Displays the number of managed robots. Returns a 1 if the command succeeds or a -1 if the command fails. 57

-x -xc

-xi

-o82

-arobotic library and -sslot number -o83

Using command line switches Device and media management switches (continued) Operation Additional Switches -i -o85 Dump robot properties Function Description

Displays the robot IDs. Displays property information for the specified robotic library. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID or the name of the robotic library to display properties for. If both -i and -d are provided, the -d parameter is used.

-irobot ID or -drobot name

-o86

Dump slot content -irobot ID or -drobot name

Displays the slot information with header descriptions. Required. Specifies the ID or the name of the robotic library to display properties for. If both -i and -d are provided, the -d parameter is used.

-sslot numbers

List the slot number to display information for. The list should be comma delimited. If the slot number is not specified, the contents of all slots for the robotic library are displayed. Dump robot partitions Displays partition information for the specified robotic library. Required. Specifies the name of the robotic library for which to display partition information. Create cleaning job Creates and runs a cleaning job on the specified drive. Returns the job ID and a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name of the robotic library drive you want to target.

-o87

-jrobot name

-o100

-ddrive name

58

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -fschedule file Function Description

Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. See Using a schedule script with device and media operations on page 256.

-pr:priority

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning.

-o101

Create media set Creates a media set with the specified name. Returns a 1 if the command succeeds or a -1 if the command fails. -mmedia set name -op:overwrite protection period Required. Specifies the name of the new media set. Specifies the overwrite protection period for the new media set. Enter the length of time in hours. Enter the value -1 to set the overwrite protection level to infinite. -ap:append Specifies the append period for the new media set. Enter the length of time in hours.

59

Using command line switches Device and media management switches (continued) Operation Additional Switches Function Description

-o102

Create drive pool Creates a drive pool with the specified name and assigns the given drives to it. Returns a 1 if the command succeeds, a 0 if one or more specified drives cannot be found, or a -1 if the command fails. -dp:drive pool Required. Specifies the name of the new drive pool. Specifies a list of drives to add to the drive pool. The list should be comma delimited. Create inventory Creates an inventory job on a specified job for robotic robotic library. library Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. When using this command, you must also use the -arobotic library switch, which inventories all slots and drives on a specified robotic library. -arobotic library -jjob name -fschedule file Required. Specifies the robotic library to target for this operation. Specifies a name for the job. Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. See Using a schedule script with device and media operations on page 256. -sslot numbers Specifies the slots in the robotic library to target. This list should be comma delimited. If no slots are specified, then all will be targeted by default.

-ddrives

-o103

60

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -pr:priority Function Description

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Locks the specified robotic library door. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. When using this command, you must also use the -arobotic library switch. Required. Specifies the robotic library to target for this operation. Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. See Using a schedule script with device and media operations on page 256. -pr:priority Specifies the priority for the job. Priority options include:

-o104

Lock library door

-arobotic library -fschedule file

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium.

61

Using command line switches Device and media management switches (continued) Operation Additional Switches -w Function Description

Wait for job completion

Instructs the Command Line Applet to wait for the operation to complete before returning. Unlocks the specified robotic library door. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. When using this command, you must also use the -arobotic library switch. Required. Specifies the robotic library to target for this operation. Schedule the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. See Using a schedule script with device and media operations on page 256.

-o105

Unlock library door

-arobotic library -fschedule file

-pr:priority

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning.

62

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches Function Description

-o106

Set media overwrite protection period

Specifies the media overwrite level and overwrite options. Returns a 1 if the command succeeds or a -1 if the command fails. When using this command, you must also use the -o1 and -o0 switches. If no switches are specified, the default overwrite level is 1=None.

-ol:overwrite level

Required. Specifies the overwrite level; for example, -o1:4. Overwrite Levels include: 1 = None 2 = None with prompt 3 = Partial 4 = Partial with prompt 5 = Full

-oo:recyclable

Required. Specifies the overwrite options; for example, -o0:0. Overwrite options include: 0 = Use scratch media first 1 = Use recyclable media first

63

Using command line switches Device and media management switches (continued) Operation Additional Switches Function Description

-o111

Erase media

Erases the tape in the specified drive according to the specified erase type (-e). Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. Note If you use -m, you can only erase backup-to-disk media. If you use -s, you can only erase robotic libraries. You cannot use both switches.

-ddevice name <loader or drive> -eerase type

Required. Specifies the drive name you want to target. If -s is used, -ddrive name will be the name of the robotic library. Required. Specifies the erase type. Erase types are: 1 = quick erase 3 = long erase

-jjob name -fschedule file

Specifies a name for the job. Schedule the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. See Using a schedule script with device and media operations on page 256.

-sslot numbers

Specifies the slot numbers containing the media to be erased. If this switch is used, -d will represent the robotic library name. Specifies the new name of the media. Required. Specifies the backup-to-disk folder to erase. You must specify the media in the backup-to-disk folder to erase.

-mn:media name -mmedia name

64

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -pr:priority Function Description

Specifies the priority for the job. Priority options include:

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning.

-o112

Retension media Retensions the tape in the specified drive. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. -ddrive name Required. Specifies the drive name. If -s is used, -ddrive name will be the name of the robotic library. Specifies the slot numbers containing the media to be retensioned. Specifies the priority for the job. Priority options include:

-sslot numbers

-pr:priority

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning.

65

Using command line switches Device and media management switches (continued) Operation Additional Switches Function Description

-o113

Label media

Labels the tape in the specified drive. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails.

-dlibrary name

Required. Specifies the name of the robotic library. Required. Specifies the media name. Specifies the slot numbers containing the media to be labeled. Specifies the priority for the job. Priority options include:

-mmedia name -sslot numbers

-pr:priority

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Formats the tape in the specified drive. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. -ddrive name Required. Specifies the drive name. If -s is used, -ddrive name will be the name of the robotic library. Specifies the slot numbers containing the media to be formatted.

-o114

Format media

-sslot numbers

66

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -pr:priority Function Description

Specifies the priority for the job. Priority options include:

Low Lowest Medium High Highest

If this switch is absent, the priority is set to medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Ejects the tape in the specified drive. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. Required. Specifies the drive name. Specifies the priority for the job. Priority options include:

-o115

Eject media from drive

-ddrive name -pr:priority

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -w Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning.

67

Using command line switches Device and media management switches (continued) Operation Additional Switches Function Description

-o116

Create a backup Creates a Backup Folder. Backup Exec allows folder you to create virtual devices called Backup Folders on the hard disk. These Backup Folders are used as destination devices for backup jobs. When you direct a backup job to a Backup Folder, the data is saved on disk as backup files. Returns a 1 if the command succeeds or a -1 if the command fails. -r Makes the backup folder being created into a removable backup-to-disk folder. Otherwise, the folder will be a fixed (non-removable) folder. Specifies the folder name. When you create a Backup Folder, Backup Exec initially assigns a name and path to it. You can rename a Backup Folder as long as you use a unique name. Renaming a Backup Folder changes the way it appears in Backup Exec, but does not change the location of the Backup Folder on the disk. -sfile size Specifies the maximum size for each backup-to-disk file contained in this folder. The file size can be from 1 MB to 4096 GB. The default is 1 GB. Specifies the maximum number of backup sets to be written to each backup-to-disk file in this folder. The maximum number can range from 1 to 8192. The default is 100. Specifies the amount of disk space to reserve on the disk. When this threshold is reached, Backup Exec cannot submit jobs for processing that are targeted to this backup-to-disk folder, but jobs that are running will finish.

-ffolder name

-nbackup sets

-pdisk space reserve

68

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -edevice setting Function Description

Specifies the device setting for the backup-to-disk folder. Devices settings include: 0 = Auto detect settings. Backup Exec automatically detect the preferred settings for this device. 1 = Buffered reads. The device allows buffered reads, which is the reading of large blocks of data. 2 = Buffered writes. The device allows buffered writes, which is the writing of large blocks of data.

-mconcurrent jobs

Specifies the number of concurrent operations that you want to allow to this folder. This number can range from 1 to 16. Specifies the location for the folder. If you use the -r switch in the command, the device that you specify must be a drive letter followed by a colon, such as "C:". Backup jobs submitted to a Backup Folder cannot span disks. If the size of a backup job exceeds the amount of free space on the disk where the Backup Folder is located, the job will fail. Make sure that there is sufficient free space on a disk for a backup job before submitting it. Use the software data compression option to maximize the amount of data that can be stored on a disk. If the backup job fails because of insufficient disk space, the data backed up before the job fails can still be restored.

-ddirectory

-o117

Inventory a stand-alone drive

Creates an inventory job on a specified stand-alone drive. Displays the job instance ID. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the drive name.

-ddrive name

69

Using command line switches Device and media management switches (continued) Operation Additional Switches -jjob name -fschedule file Function Description

Specifies a name for the job. Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w switch is ignored. Specifies the priority for the job. Priority options include:

-pr:priority

Highest High Medium Low Lowest

If this switch is absent, the priority will be set as Medium. -x Uses media auxiliary memory for inventory, which allows the media to be identified without having to be mounted. Wait for job completion Delete backup-to-disk folders -ffolder name Instructs the Command Line Applet to prompt for a response. Deletes a list of backup-to-disk folders.

-w

-0118

Required. Specifies the name of the backup-to-disk folders to delete. Set backup-to-disk properties Sets properties for a backup-to-disk folder.

-o119

-ffolder name

Required. Specifies the name of the backup-to-disk folder to target for this operation.

70

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -smaximum backup-to-disk file size Function Description

Specifies the maximum size for each backup-to-disk file contained in this folder, and then select either MB or GB as the unit of size. The file size can be from 1 MB to 4096 GB. The default is 1 GB. Specifies the maximum number of backup sets to be written to each backup-to-disk file in this folder. The maximum number can range from 1 to 8192. The default is 100. Specifies the amount of disk space to reserve on the disk. When this threshold is reached, Backup Exec cannot submit jobs for processing that are targeted to this backup-to-disk folder, but jobs that are running will finish. The backup-to-disk status displays Low Disk Space. Specifies the device setting for the backup-to-disk folder. Devices settings include: 0 = Auto detect settings. Backup Exec automatically detect the preferred settings for this device. 1 = Buffered reads. The device allows buffered reads, which is the reading of large blocks of data. 2 = Buffered writes. The device allows buffered writes, which is the writing of large blocks of data.

-qmaximum number of backup sets

-kreserve disk size

-edevice setting

-mnumber of concurrent ops

Specifies the number of concurrent operations that you want to allow to this folder. This number can range from 1 to 16. Delete media set Deletes the specified media set. Returns 1 if the command is successful or -1 if it failed.

-o120

-mmedia set

Required. Specifies the name of the media set.

71

Using command line switches Device and media management switches (continued) Operation Additional Switches Function Description

-o121

Delete drive pool Deletes the specified drive pool. Returns a 1 if the command succeeds or a -1 if the command fails. -dp:drive pool Required. Specifies the name of the drive pool. Create media server pool This operation is only available if the Central Admin Server Option (CASO) is installed. Creates a media server pool with the specified name. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name of the media server pool. Specifies a description for the media server pool. Specifies the media server IDs or names to add to the media server pool. Delete media server pool This operation is only available if the Central Admin Server Option (CASO) is installed. Deletes the media server pool with the specified name. Returns a 1 if the command succeeds or a -1 if the command fails. Note Use only one of the required switches for this command. -ipool IDs or -nm:pool names Required. Specifies the IDs or the names of the media server pool to be deleted. Rename a media server pool or set a new media pool description This operation is only available if the Central Admin Server Option (CASO) is installed. Renames the specified media server pool or specifies a new media pool description. Returns a 1 if the command succeeds or a -1 if the command fails. Note Use only one of the required switches for this command.

-o122

-nm:pool name

-pd:pool description -si:server IDs or -sn:server names -o123

-o124

72

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -ipool ID or -onm:old pool name -nm:new pool name -pd:pool description -o125 Get media server pools Function Description

Required. Specifies the ID of the media server pool or the name of the media server pool to be renamed. Specifies the new name of the media server pool. Specifies a description of the media server pool. This operation is only available if the Central Admin Server Option (CASO) is installed. Displays the media server pools. Returns a 1 if the command succeeds or a -1 if the command fails. Instructs Backup Exec to display the media server pool ID. Instructs Backup Exec to display the media server pool name. Instructs Backup Exec to only display the media server pools associated with the media server ID or media server name specified. Add a media server to a media server pool This operation is only available if the Central Admin Server Option (CASO) is installed. Adds a media server to the specified media server pool. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID of the media server pool or the name of the media server pool. Specifies the media server IDs or names to add to the media server pool.

-i

-j

-si:server ID or -sn:server name

-o126

-pi:pool ID or -pn:pool name

-si:server IDs or -sn:server names

73

Using command line switches Device and media management switches (continued) Operation Additional Switches Function Description

-o127

Remove a media server from a media server pool

This operation is only available if the Central Admin Server Option (CASO) is installed. Removes a media server from the specified media server pool. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID of the media server pool or the name of the media server pool. Specifies the media server IDs or names to remove from the media server pool.

-pi:pool ID or -pn:pool name

-si:server IDs or -sn:server names -o128 Get media servers in a media server pool

This operation is only available if the Central Admin Server Option (CASO) is installed. Displays the media servers in the media server pools. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID of the media server pool or the name of the media server pool. Instructs Backup Exec to display the media server ID. Instructs Backup Exec to display the media server name.

-pipool ID or -pn:pool name

-i

-j

-o129 -m: media label name

Delete media Specifies the label name of the media that you want to delete. The media must be in the Retired Media set before you can delete it. Move media Moves the specified media. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID of the media or the media server name to be moved.

-o130

-i or -jmedia name

74

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -ms:media set ID -o131 Rename media Function Description

Required. Specifies the media set ID to which you want to move the media. Renames the specified media. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name of the media to be renamed. Required. Specifies the new name of the media. List media label Lists the media labels contained in a specified media set. Returns a 1 if the command succeeds or a -1 if the command fails.

-imedia ID

-mn:media name

-o132

-imedia set ID or -jmedia set name -o133 Create media vault

Required. Specifies the ID of the media or the media set name to be moved.

Creates a media vault with the specified name to track media stored in specific sites. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name of the media vault. Specifies a description for the media vault.

-vn:vault name

-vd:vault description -o134 Delete media vault

Deletes the specified media vault. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID of the media vault or the name of the media vault to be deleted.

-ivault ID or -vn: vault name

75

Using command line switches Device and media management switches (continued) Operation Additional Switches Function Description

-o135

Create robotic library partitions

Creates a partition consisting of one or more slots on the specified robotic library. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID or the name of the robotic library on which the partitions will be created. Specifies the slots in the robotic library to include in the partition. This list should be comma delimited. If no slots are specified, then all will be targeted by default.

-irobot ID or -drobot name

-sslot numbers

-o136

Get list of media Displays the managed media vaults. Returns vaults a 1 if the command succeeds or a -1 if the command fails. -i -j Displays the IDs for all media vaults. Displays the names of all managed media vaults. Add media to a media vault Adds media to the specified media vault. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID of the media or the media set name to be moved.

-o137

-imedia set ID or -jmedia set name -mv:media vault ID or -vnmedia vauilt name -o140 Get number of media servers

Required. Specifies the ID of the media vault or the name of the media vault that the media will be added to. Displays the managed media servers. Returns a 1 if the command succeeds or a -1 if the command fails. Displays the media server IDs for all media servers.

-i

76

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -j Function Description

Displays the names of all managed media servers. Dump physical disk properties Outputs the properties for a specified physical disk on a storage array. Returns a 1 if the command succeeds or a -1 if the command fails. Specifies the ID or the name of the storage array. You must separate multiple entries with a comma.

-o531

-si:storage array ID or -sn:storage array name -pi:physical disk ID or -pn:physical disk name -pl:enclosure\sl ot

Specifies the ID or the name of the physical disk on the storage array. You must separate multiple entries with a comma.

Specifies the enclosure that the physical disk is in and the slot that the physical disk occupies. Enter the name of the enclosure and slot in the enclosure1\slot1 format. You must separate multiple names with a comma. Enter 1 to view the properties of a hot spare; otherwise, enter a 0. Enter 1 to view the properties of a physical disk that is configured for use with a storage array; otherwise, enter a 0. Enter 1 to view the properties of a physical disk that is unconfigurable; otherwise, enter a 0. Dump storage Outputs the properties for a specified storage array properties array. Returns a 1 if the command succeeds or a -1 if the command fails.

-hot:

-cf:

-ucf:

-o532

-sa:

Lists all the storage arrays.

77

Using command line switches Device and media management switches (continued) Operation Additional Switches -si:storage array ID or -sn:storage array name -vd: -vi:virtual disk ID or -vn:virtual disk name -o533 Configure a storage array -si:storage array ID or -sn:storage array name -pl:enclosure\sl ot or -hl:enclosure\s lot or -uhl:enclosure\s lot Function Description

Required. Specifies the ID or the name of the storage array. You must separate multiple entries with a comma.

Lists all the virtual disks. Specifies the ID or the name of the virtual disk on the storage array. You must separate multiple entries with a comma.

Configures a storage array for use with the Backup Exec Storage Provisioning Option. Required. Specifies the ID or the name of the storage array.

Required. Enter the enclosure number and the slot number of the physical disks that you want to configure. You can specify the enclosure number and the slot number to do the following:

Use -pl: to add a physical disk to create a disk group. You must specify at least three physical disks to create a disk group. Use -hl: to add a hot spare. Use -uhl: to remove a hot spare. The physical disk becomes available.

Enter the name in the enclosure1\slot1 format. You must separate the multiple names with a comma. You must use at least one switch. You can use all of the switches in the same operation. -vn:number of virtual disks Specifies the number of virtual disks that you want to create for this disk group.

78

Symantec Backup Exec Command Line Applet

Using command line switches Device and media management switches (continued) Operation Additional Switches -ms:media server name -o534 Function Description

Specifies the name of the media server.

Configure a Configures a virtual disk on a storage array to virtual disk on a use with Backup Exec. Returns a 1 if the storage array command succeeds or a -1 if the command fails. -vi:virtual disk ID or -vn:virtual disk name Required. Specifies the ID or the name of the virtual disk on the storage array.

-o535

Rename a Renames a virtual disk or a storage array. virtual disk or a Returns a 1 if the command succeeds or a -1 if storage array the command fails. You must specify either a storage array or a virtual disk to rename; you cannot specify both. -si:storage array ID or -sn:storage array name -vi:virtual disk ID or -vn:virtual disk name -nn:new device name Required. Specifies the ID or the name of the storage array.

Required. Specifies the ID or the name of the virtual disk on the storage array.

Required.Provides the new name for the device. Detect a new storage array Runs a scan operation to find new storage arrays, virtual disks, or physical disks.

-o536

79

Using command line switches

Backup Exec services commands

Several command line switches allow you to monitor and manage the Backup Exec services. These commands include:
Backup Exec service switches Operation Additional Switches Function Description

-o107

Set wizards as run

Sets the registry so that the startup wizards do not run. Returns a 1 if the command succeeds or a -1 if the command fails. Enter a 0 to specify that the startup wizards have not been run and should display. Enter a 1 to specify that the startup wizards have been run and should not display.

-dv:<0-1>

-o500

Is Backup Exec Checks if the Backup Exec server is available. server available Returns 1 if the Backup Exec Server is available on the network, 0 if the server is not available, or -1 if the command fails. -cserver_name Required. Specifies the name of the media server. Are Backup Exec Checks if the Backup Exec system services are system services running. Returns 1 if the Backup Exec running services are running on the computer. If the system services are not running, a 0 is displayed. If the command fails, a -1 is displayed. Start Backup Exec system services Starts all Backup Exec services on the specified computer. Returns a 1 if all services start, a 0 if any services fail, or a -1 if the command fails. Stops all Backup Exec services on the specified computer. Returns 1 if all services stop, a 0 if any services fail, or a -1 if the command fails.

-o501

-o502

-o503

Stop Backup Exec system services

80

Symantec Backup Exec Command Line Applet

Using command line switches Backup Exec service switches (continued) Operation Additional Switches Function Description

-o504

Dump Backup Exec system services status

Copies to the console each Backup Exec system service name and status. Returns a 1 if the command succeeds or a -1 if the command fails. Outputs properties for a specified Backup Exec server. Returns a 1 if the command succeeds or a -1 if the command fails. Outputs the Backup Exec server type. Server types are: 0 = stand-alone media server 1 = central administration server 2 = managed media server 3 = unknown server type

-o505

Dump Backup Exec server properties Dump server type

-o530

Logon account operations and switches

The following switch and subswitches enable you to create and modify logon accounts used for accessing specific systems:
Logon Account switches Operation Additional Switches Function Description

-o210

Create logon account

Creates a logon account for accessing specific systems being backed up or restored. This operation returns a logon account ID and a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the user name for this logon account. Specifies the password for this logon account. Required. Provides a name for this logon account.

-nl:user name

-pl:password -daccount name

81

Using command line switches Logon Account switches (continued) Operation Additional Switches -pa:account type -dl: Function Description

Specifies if the logon account is restricted or common. Specifies the logon account as the default account to use to browse, make sections, or restore data on your local and remote resources. When you use this switch to set a logon account as the default, the default only applies to the specified user. Use -o211 to display the default logon account or log in to Backup Exec when you are logged in as the specified user.

-o211

Dump logon accounts

Displays the logon account information on the console. Returns a 1 if the command succeeds or a -1 if the command fails. Deletes the specified logon account. Returns 1 if the command is successful or -1 if it failed. Required. Specifies the GUID, the user name, or the account name of the logon account to be deleted.

-o212

Delete logon account

-ilogon account GUID or -nl:user name or -d account name -o213 Modify logon account

Modifies properties for a specific logon account. The changes apply immediately and all resources that use the Backup Exec logon account are automatically updated. Changes made to a Backup Exec logon account are applied immediately. Returns 1 if the command is successful or -1 if it failed. Required. Specifies the GUID, the user name, or the account name of the logon account to be modified.

-ilogon account GUID or -nl:user name or -d account name -pw:password

Specifies the current password for this logon account.

82

Symantec Backup Exec Command Line Applet

Using command line switches Logon Account switches (continued) Operation Additional Switches -pl:password Function Description

Specifies the new password for this logon account. Required. Provides a name for this logon account. Specifies if the logon account is restricted or common. Enter 1 for a common key; otherwise, enter 0 for a restricted key. Specifies the logon account as the default account to use to browse, make sections, or restore data on your local and remote resources. When you use this switch to set a logon account as the default, the default only applies to the specified user. Use -o211 to display the default logon account or log in to Backup Exec when you are logged in as the specified user.

-daccount name

-pa:account type

-dl:

83

Using command line switches

Report operations and switches

The following switch and subswitches allow you to view and manage Backup Exec reports from the command line:
Report switches Operation Additional Switches Function Description

-o400 -i -rreport ID -j -ps:paramstr

Display report

Displays the report on the screen. Lists all available report IDs. Specifies the report ID to view. Lists available parameter names. Specifies parameters and values to use in the form @param1name=value, =value..., @param2name=value, =value....

-o401 -i -rreport ID -j -ps:paramstr

Print report

Prints the report on the default printer. Lists all available report IDs. Specifies the report ID to view. Lists available parameter names. Specifies parameters and values to use in the form @param1name=value, =value..., @param2name=value, =value....

-o402

Copy report to selected file format -i -rreport ID -j

Copies the report to a selected file format.

Lists all available report IDs. Specifies the report ID to view. Lists available parameter names.

84

Symantec Backup Exec Command Line Applet

Using command line switches Report switches (continued) Operation Additional Switches -ps:paramstr Function Description

Specifies parameters and values to use in the form @param1name=value, =value..., @param2name=value, =value.... Fully qualified filename for the storage location of the output file. Not valid for -ft:1 (HTML) file types. Fully qualified directory name for storage location of output files. Only valid for -ft:1 (HTML) file types. Use:

-ffilename

-ddirectory

-ft:format

-ft:1 for HTML file type. -ft:2 for XML file type. -ft:3 for Microsoft Excel file type. -ft:4 for Comma Separated Variables (CSV) type. -ft:5 for Adobe Portable Document Format (PDF)

-o403 -i or -ffilename

Insert report

Adds a report to the available file list. Required. Lists all available report IDs or the fully qualified filename for storage location of report file.

Operations for displaying network interface information

The command line operation -o510 lets you view information about the available network interface cards that you can specify as the default for every Backup Exec job. You can use this command line operation when you create a backup job script file, a restore job script file, and a backup job template script file.

85

Using command line switches

Backup Exec supports versions 4 and 6 of the Internet Protocol (IP), which are commonly referred to as IPv4 and IPv6. You can use IPv4 and IPv6 in backup and restore networks. Support for IPv6 is dependent upon operating system support for the protocol, as well as proper network configuration. You can use Backup Exec in a mixed IPv4/IPv6 environment or an IPv4-only environment. Enter an IPv4 or IPv6 address for a computer anywhere that you can enter a computer name in Backup Exec, except in the following locations:

User-defined selections Clusters Microsoft Windows does not support an IPv6 address as a clustered resource.

A Remote Agent that supports IPv6 can be backed up or restored using IPv6 only from a media server that is IPv6-compliant. The command line operation -o510 provides the following information:
Network interface information Item Friendly Name Description The name of a network interface card that can connect the media server to the network you want to use for the backup network. The Media Access Control (MAC) address The adapter description The adapter type Indicates if the network interface card is available. If the value is 1, then the network interface card is available and usable. If the value is 0, then the network interface card is not available and not usable. The subnet prefix of the network interface card. The IP address of the network interface card. The number of network interface cards that were found. The command returns a 1 if the command succeeds, or a -1 if the command fails.

MAC Address Description Type Available

Subnet Prefix 1 IP Address 1 Number of Objects Return Value

86

Symantec Backup Exec Command Line Applet

Using command line switches

Database management operations and switches

The following switch and subswitches allow you to manage databases that use Backup Exec:
Database management switches Operation Additional Switches Function Description

-o25

Manage a Microsoft SharePoint Server Farm -wb:web server name -fm:farm name

Attach, delete, and rename a Microsoft SharePoint server farms.

Required. Specifies the name of a Web server that belongs to the farm. Specifies the SharePoint server farm to manage. If you attempt to attach to a new farm and you do not specify a farm name, Backup Exec defaults to Server Farm x.

-a -d -nf:new farm name -e

Attaches to a new server farm Deletes a server farm. Renames an existing farm.

Enter 1 to enable the specified Web server in the farm; otherwise, enter 0 to disable the specified Web server. Replaces a previously defined Microsoft SharePoint server farm with a new server farm. Lists Microsoft Displays a the components of the specified SharePoint 2003 Microsoft SharePoint 2003 server farm. server farms When you specify additional switches, displays only the applicable components of the specified server.

-r

-o26

-wb:web server name

Type the name of a Web server that belongs to the farm. 87

Using command line switches Database management switches (continued) Operation Additional Switches -i: logon account or -act: account name Function Description

Specifies the logon account ID to use to display remote SharePoint servers, or specifies the logon account name to logon to connect to the remote server on which SharePoint runs. You should specify this switch if the current logon account name is not valid to log on to the server. Displays components of a specified server farm. Displays configuration database component names. Displays Single-sign on database component names. Displays Document Library store component names. Displays the portal sites and the components in the server farms. When you specify the name of a portal site, which also requires the -fm switch, displays only the components of the specified portal site.

-fm:farm name

-cf:

-ss:

-ds:

-ps:portal site name

-ws:Windows SharePoint Services site

Displays the Windows SharePoint Services sites and the components in the server farms. When you specify the name of a Windows SharePoint Services site, which also requires the -fm switch, displays only the components of the specified Windows SharePoint Services site. Displays the full name of the backward compatible document library names.

-dl:document library names

88

Symantec Backup Exec Command Line Applet

Using command line switches Database management switches (continued) Operation Additional Switches Function Description

Specifies a list of backward compatible document libraries to back up. This list should be comma delimited. If you do not specify a list of backward compatible document libraries, then all backward compatible document libraries in the farm are backed up. You can display a list of document library names if you use the -o26 switch. -o32 List Oracle instance information -svr:server name Displays a list of Oracle instance information.

Required. Specifies the name of a server

on which Oracle runs.

-sid:Oracle SID -act:logon account name

Required. Specifies the Oracle server ID. Specifies the logon account name to log on to connect to the server on which Oracle runs. You should specify this switch if the current logon account name is not valid to log on to the server. Displays tablespace names.

-tb:tablespace names -a -o53

Displays all archived logs. Lists Microsoft Displays a the components of the specified SharePoint 2007 Microsoft SharePoint 2007 server farm. When you specify additional switches, server farms displays only the applicable components of the specified server.

-wb:web server name

Type the name of a Web server that belongs to the farm.

89

Using command line switches Database management switches (continued) Operation Additional Switches -i: logon account ID or -act: account name Function Description

Specifies the logon account ID to use to display remote SharePoint servers, or specifies the logon account name to logon to connect to the remote server on which SharePoint runs. You should specify this switch if the current logon account name is not valid to log on to the server. Displays components of a specified server farm. Displays configuration database component names. Displays Single-sign on database component names. Displays the central administration site name. Displays information about the Web application. You can list multiple names.

-fm:farm name

-cf:

-ss:

-ca

-wa:Web application name -sp: shared service provider name or -ssp shared service provider name -si -gs -o32 List Oracle instance information -svr:server name

Displays information about the shared server provider. You can list multiple names.

Displays the search instance. Displays the global settings. Displays a list of Oracle instance information.

Required. Specifies the name of a server

on which Oracle runs.

90

Symantec Backup Exec Command Line Applet

Using command line switches Database management switches (continued) Operation Additional Switches -sid:Oracle SID -act:logon account name Function Description

Required. Specifies the Oracle server ID. Specifies the logon account name to log on to connect to the server on which Oracle runs. You should specify this switch if the current logon account name is not valid to log on to the server. Displays tablespace names.

-tb:tablespace names -a

Displays all archived logs.

91

Using command line switches

Setting default options

The command line switch -o300 allows you to set default options to be used for Backup Exec operations. After setting the default options, you can use the -o301 switch to retrieve the value of the default options set. To retrieve the value using the -o301 operation, specify the option name or file name after the command. If you do not specify an option name or file name, all the default options set will be retrieved. To retrieve a list of available default options and the values, use the -o301 operation with the -f switch. The default options can be set through a series of -do parameters and the use of a -dv parameter followed by the default value. For example, to set the job priority default to high using the -do parameter, enter: -o300 -do:DO_JOB_PRIORITY -dv:3 You can also set the default options through the use of the -f parameter followed by the name of a file. Use a text editor, such as Notepad, to create a file that contains all the default options. Each entry must be typed on separate line and include the name of the parameter typed in capital letters and then followed by an equal (=) or a colon (:) sign. The value for the entry must follow the equal sign and contain no quotes unless they are part of the value itself. For example, to set the job priority default to high and set the default backup to full using the -f parameter, create a text file that contains the following parameters: DO_JOB_PRIORITY=3 DO_BACKUP_TYPE=0 After you complete the file, enter: -o300 -f:filename

92

Symantec Backup Exec Command Line Applet

Using command line switches

The default parameters set through the -o300 switch can be overridden when creating an individual job. The following default options can be set using the -o300 switch:
Default option parameters Option Name General Default Options DO_GENERAL_ ENABLESTATS Display progress Enter 1 to display the percent indicators for backup jobs complete number and gauge while a backup job is processing; otherwise, enter 0. These indicators allow you to monitor the progress of the job. Backup jobs may take a little longer to complete when this option is set because the target device must be scanned to determine the amount of data to be backed up. Note Due to the time required to scan the target device, selecting this option when backing up remote devices is not recommended. DO_GENERAL_ STARTUPINVENTORY Inventory all drives on Backup Exec services startup Enter 1 to inventory all of the media in the storage devices when Backup Exec services are starting; otherwise, enter 0. Depending on the number of storage devices attached to the system, this process may take a few minutes. If you are using a robotic library, all of the robotic librarys slots are inventoried. Function Description

93

Using command line switches Default option parameters (continued) Option Name Job Default Options DO_JOB_PRIORITY Set job priority Specifies the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Priority options include:

Function

Description

0 = Low 1 = Lowest 2 = Medium 3 = High 4 = Highest

DO_JOB_LIMITAVAIL

Limit availability to a daily time window

Enter 1 to enable the availability window, which specifies when the selection list is available for backup each day; otherwise, enter 0. Enter the first date when the selection list should be available to be backed up. Enter the date in MM/DD/YYYY format. Enter the earliest time when the selection list is available for backup. Enter the time in 24-hour format. For example, enter 21:30:00 to specify 9:30 PM. Enter the latest time when the selection list is available for backup. Enter the time in 24-hour format. For example, enter 23:00:00 to specify 11:00 PM. Enter 1 to run the job only if the pre-job command is successful; otherwise, enter 0. If the pre-job command is not successful, the job does not run, and is marked as failed.

DO_JOB_LIMITAVAIL_DATE

First available date for availability window

DO_JOB_LIMITAVAIL_ BEGINTIME

Begin time for availability window

DO_JOB_LIMITAVAIL_ ENDTIME

End time for availability window

DO_JOB_ RUNJOBIFPRESUCCESS

Run job only if the pre-job command is successful.

94

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_JOB_ RUNPOSTIFJOBFAILS DO_JOB_RUNPOST Function Run post-job command even if the job fails. Description Enter 1 to run the post-job command even if the job fails; otherwise, enter 0.

Run post-job command if Enter 1 to run the post-job command pre-job command is only if the pre-job command is successful successful; otherwise, enter 0. Specify time interval for command Specifies the amount of time before or after the job in which the pre- or post-command should run. Enter 1 to have the job marked as failed if either the pre-job or post-job command fails; otherwise, enter 0.

DO_JOB_CMDTIMEOUT

DO_JOB_FAILIFCMDFAILS

Mark job as failed if either command fails

DO_JOB_RUNPOSTAFTER

Run post-command after Enter 1 to run the post-command after job verification completes the job verification completes; otherwise, enter 0. Specifies where the command is to be run Enter one of the following options:

DO_JOB_RUNON

0 = On this media server 1 = On each server backed up or restored to

DO_JOB_ CANCELTHRESHOLD

Cancel the job if not completed within the specified time.

Specifies the amount of time Backup Exec should wait for the job to complete before cancelling the job. This value should be provided in minutes.

DO_JOB_ DEVICEGUID

Set default device for job Specifies the drive pool or stand-alone drive to be used for processing the backup. Set the default media set Specifies the media set for the job.

DO_JOB_ MEDIASETGUID

95

Using command line switches Default option parameters (continued) Option Name Backup Default Options DO_BACKUP_TYPE Select default backup method Specifies the backup method to be used. Methods are:

Function

Description

0 = Full 1 = Copy 2 = Differential changed files 3 = Incremental changed files 4 = Daily 5 = Working set 6 = Incremental modified time 7 = Differential modified time 8 = Full modified time

If 5 is entered as the value, a value must also be entered for DO_BACKUP_ LASTACCCESSEDDAYS DO_BACKUP_ SINGLEBACKUPNTFS Enable single instance Enter 1 to ensure that only one backup for NTFS volumes instance of the backing file for NTFS volumes will be backed up regardless of the number of single instance store (SIS) links that point to it; otherwise, enter 0. Set last access date Note If 5 was entered as the value for DO_BACKUPT_TYPE, the DO_BACKUP_ LASTACCESSEDDAYS entry must be completed. Enter the number of days during which files that you want to include in the backup were last accessed. For example, to specify a working set backup to include all files last accessed within 30 days, type: -do:DO_BACKUP_ LASTACCESSEDDAYS -dv:30

DO_BACKUP_ LASTACCESSEDDAYS

96

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_BACKUP_ MEDIAOVERWRITE Function Set media overwrite protection Description Specify one of the following values:

0 = Overwrite 1 = Append, overwrite if no media available 2 = Append, no overwrite

DO_BACKUP_ COMPRESSIONTYPE

Set compression method Enter a number from 0 to 3 that corresponds with the type of compression to use. Options include:

0 = Hardware compression 1 = Software compression 2 = Hardware if available, otherwise software 3 = None

DO_BACKUP_COLLECTINFO

Collect additional information for synthetic backup and for true image restore

Enter 1 to collect information about files and directories that have been moved, renamed, or newly installed since the last backup job. These files and directories are included in the backup. Otherwise, enter 0. Enter 1 to have Backup Exec automatically perform a verify operation to make sure the media can be read after the backup has been completed; otherwise, enter 0. Verifying all backups is recommended. Enter 1 if the checksums are to be calculated for each data stream written to tape, and then written in a separate stream immediately following the data stream. If 0 is entered, backup performance may be improved, but there will be no way to verify the integrity of the data on the tape.

DO_BACKUP_AUTOVERIFY

Verify after backup

DO_BACKUP_ INSERTCHECKSUMS

Calculate checksums

97

Using command line switches Default option parameters (continued) Option Name DO_BACKUP_ TRAVERSEPOINTS Function Back up local mount points Description Enter 1 to back up mount points that direct a file or directory to a local disk or directory path; otherwise, enter 0. Using this option allows you to back up data that is linked to local files, but stored on another device without having to actually select the data. Enter 1 to back up data that has been migrated from primary storage to secondary storage; otherwise, enter 0. When using this option, the data will not be recalled to its original location; it will be backed up directly to the backup media. This option should not be used if:

DO_BACKUP_HSM

Back up data in remote storage

A single device containing one drive is used for secondary storage and backups because Remote Storage and Backup Exec will compete for use of the drive. You want to run a backup of the entire system because Backup Exec attempts to access all data that has been migrated to secondary storage and this may take a considerable amount of time.

DO_BACKUP_ USECHANGEJOURNAL

Use change journal

Enter 1 to use Windows NTFS Change Journal to determine which files have been modified since the last full backup; otherwise, enter 0. This option can only be used with NTFS volumes and only when the backup method selected is either DIFFERENTIAL Using modified time or INCREMENTAL - Using modified time.

98

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_BACKUP_ OPENFILEMETHOD Function Description

Back up open files if Open Enter a number from 0 to 3 to specify File Option is not how to back up open files if the Open available File Option is not available. Values include:

0 = Never 1 = With a lock 2 = Without a lock 3 = If closed within x seconds

DO_BACKUP_ OPENFILESKIPSECS

Back up open file if closed If 3 was entered for the value for within x seconds DO_BACKUP_OPENFILEMETHOD, enter a number from 1 to 999 to specify the number of seconds Backup Exec is to wait for an open file to close before continuing the backup. If the files do not close during the specified interval, they are skipped. If Backup Exec Granular Recovery Technology (GRT) is enabled for backup, enter a path on the NFTS volume of the local media server where Backup Exec can stage temporary data Enter the path to an NTFS volume on the local media server where Backup Exec can stage temporary data. Backup Exec deletes the data when the backup completes. At least 1 GB of disk space is required.

DO_BACKUP_GRTPATH

Restore Default Options DO_RESTORE_ EXISTINGMETHOD Restore over existing files Enter 1 to overwrite files on the target device that have the same name as files that are being restored; otherwise, enter 0. Restore corrupt files Enter 1 to allow Backup Exec to restore corrupted files during the restore process; otherwise, enter 0 to allow Backup Exec to automatically exclude corrupt files from the restore process.

DO_RESTORE_CORRUPT

99

Using command line switches Default option parameters (continued) Option Name DO_RESTORE_ JUNCMETHOD Function Restore junction points method Description Enter 0 if you want to restore the information for the junction points and the files and directories to which they are linked, overwriting existing junction points on your system. Enter 1 if you want to restore files and directories backed up from junction point links while retaining the systems current junction points. DO_RESTORE_TEMPPATH Path on media server for Type the path on the media server staging temporary where you want to stage temporary restore data restore data when using Backup Exec Granular Recovery Technology (GRT) to restore individual items from tape.

Network and Security Default Options DO_NIC_ ENABLEDSHARESELECTION DO_NIC_AGENTPORTRANGE Enter 1 to enable selection of Windows user shares; otherwise, enter 0. Enter a port range to allow remote agents to use a range of ports for communications. Enter 1 display the 32-bit number that determines the subnet to which the network interface card belongs; otherwise, enter 0. Enter 1 to select the name of the network interface card that connects the media server to the network you want to use for the backup network; otherwise, enter 0. Enter one of the following values to select the protocol you want to use:

DO_NIC_ AUTOOBTAINSUBNET

DO_NIC_ ANYAVAILABLE

DO_NIC_PROTOCOL

0 = any available protocol 1 = Use IPv4 2 = Use IPv6

100

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_NIC_MACADDRESS Function Description Enter 1 to display the Media Access Control (MAC) address, Adapter type, Description, IP addresses, and subnet prefixes of the network interface you selected for the backup network; otherwise, enter 0. Enter a subnet address to ensure that the data from a remote system you select for backup is backed up or restored over any available network. Specify the encryption method to use Enter a number from 0 through 3 to specify the encryption type. Selections are as follows:

DO_NIC_SUBNETADDRESS

DO_ENCRYPTION_TYPE

0 = None 1 = Software 2 = Hardware 3 = Hardware if available. Otherwise, use software.

To set an encryption type, you must first set a default encryption key by using -o99. If you set the encryption type to 2 or 3, the default key must be 256-bit encryption. DO_SAV_ THREATLEVELTRIGGER Set Symantec ThreatCon Enter a number from 0 through 4 to Level specify the Symantec ThreatCon Level at which backup jobs should run immediately. Selections are as follows:

0 = Disabled 2 = Level 2: Elevated 3 = Level 3: High 4 = Level 4: Extreme

Trial Job Default Options DO_TRIAL_ CHECKCREDENTIALS Check logon credentials for trial run job Enter 1 to verify that the logon account is correct for the volumes being backed up; otherwise, enter 0. 101

Using command line switches Default option parameters (continued) Option Name DO_TRIAL_ CHECKCAPACITY Function Description

Check media capacity for Enter 1 to test whether enough tape is trial run job available to complete the job; otherwise, enter 0. Note During the test run job, the number of scheduled jobs in the queue is not checked; therefore, jobs that are scheduled before the test run job may use the media that was available when the test run job was performed.

DO_TRIAL_CHECKMEDIA

Check media for trial run Enter 1 to test whether the media is job online and overwritable for a trial run job; otherwise, enter 0. Select method for Enter 0 if you want to determine job determining trial run job size from a previous job history, or size enter a 1 if you want to perform a pre-scan. Place job on hold if trial job fails Enter 1 to have the scheduled job placed on hold if any failures are detected during the test run; otherwise, enter 0.

DO_TRIAL_ DETERMINESIZEMETHOD

DO_TRIAL_ HOLDONFAILURE

Advanced Open File Options DO_OPENFILE_METHOD Enter one of the following values:

0 = None 1 = Use the Advanced Open File Option

102

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_OPENFILE_ CONFIGURATION=0-4 Function Specify the open file technology to back up open files Description Enter a number from 0 through 4 to specify the open file technology to back up open files. Selections include:

0 = Do not use the open file technology 1 = Automatically select open file technology 2 = Use Microsoft Volume Shadow Copy Service 3 = Use VERITAS Volume Snapshot Provider 4= Use VERITAS Storage Foundation for Windows FlashSnap Option

DO_SNAPSHOT_PROVIDER= 0-3

Specify the snapshot provider for the selected volume

Enter a number from 0 through 3 to specify the snapshot provider for the selected volume. Selections include:

0 = Automatic - Allows VSS to select the snapshot provider 1 = System - Use Microsoft software shadow copy provider 2 = Software - Use VERITAS Storage Foundation for Windows 3 = Use technology provided by hardware manufacturer

DO_USE_SINGLE_VOLUME_ SNAPSHOT=0 or 1

Process logical volumes for backup one at a time

Enter 1 to process logical volumes for backup one at a time; otherwise, enter 0.

DO_SELECTIONLIST_CREATE Specify separate selection lists for resources or computers

Enter a number from 0 through 2 to specify separate selection lists for resources or computers. Selections include: 0 = Single backup selection list for all selections 1 = Separate backup selection list for each computer 2 = Separate backup selection list for each resource 103

Using command line switches Default option parameters (continued) Option Name Function Description

Advanced Disk-based Backup Default Options DO_DISKBACKUP_OFFHOST Use offhost backup to move backup processing from the remote computer to the media server Specify snapshot provider Enter 1 if you want to enable offhost backup; otherwise, enter 0. If you enter 1, an offhost backup of all volumes is performed if all requirements are met.

DO_DISKBACKUP_ SNAPSHOT

Enter one of the following values:

Automatic - Use hardware if available; otherwise use software. Select this option to enable VSS to select the best provider for the selected volume. Software - Use Veritas Storage Foundation for Windows. Hardware - Use technology provided by hardware manufacturer:

If you select Software or Hardware as the snapshot provider, then the following information applies:

The provider must support transportable snaps. If multiple volumes are selected, then all volumes must be snappable by the same type of provider.

Software and hardware providers cannot both be used to snap different volumes in the same job. You must either create another job, or make sure that the following option is selected: Process logical volumes for offhost backup one at a time.

104

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name Function Description

DO_DISKBACKUP_OFFHOST_ Specify the job Enter one of the following values: NOTSUPPORTED disposition, if any, of the 0 = Continue the backup job selected resources do not (offhost backup is not used) support offhost backup 1 = Fail the backup job (further selections are not backed up after failure occurs) DO_DISKBACKUP_PROCESS Process logical volumes Enter 1 if you want to enable the for offhost backup one at backup of multiple volumes in one job. a time This method creates a snapshot of only one logical volume at a time. Otherwise, enter 0. To ensure database integrity, or if a volume contains mount points, multiple volumes may need to be snapped at one time. After the logical volume is snapped and backed up, the snapshot is deleted before the next logical volume is snapped. This option increases the ability to meet the minimum quiet time that is needed to complete a snapshot. A logical volume can comprise multiple physical volumes. A single logical volume can encompass all of the volumes on which databases reside. Job Log Default Options DO_LOG_SUMMARYLEVEL Select summary level for Enter one of the following values for job log the job log summary level:

0 = Summary only 1 = Summary and directories 2 = Summary, directories, and files 3 = Summary, directories, files, and details.

105

Using command line switches Default option parameters (continued) Option Name DO_LOG_FILEBASE Function Specify job log name Description Specify a job log name FILENAME#.txt. The # starts at 00. The default is BEX#.txt. Enter 1 to attach the job logs in an html format when an email notification is sent; otherwise, enter 0.

DO_LOG_ATTACH

Attach job log as html

SQL Default Options DO_SQL_BACKUPMETHOD Select the SQL backup method Select the backup method to be used for SQL databases by entering one of the following values:

0 = full 1 = log 2 = log no truncate 3 = differential

DO_SQL_ CHECKBEFOREBACKUP

Consistency check before Select a consistency check to run backup before a backup. Values are as follows:

0 = none 1 = full 2 = full with indexes 3 = physical

DO_SQL_ CONTINUEIFCHECKFAILS

Continue with backup if consistency check fails

Enter 1 if you want the backup job to continue if the consistency check fails; otherwise, enter 0. Select a consistency check to run after a backup. Values are:

DO_SQL_ CHECKAFTERBACKUP

Consistency check after backup

0 = none 1 = full 2 = full with indexes 3 = physical

106

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_SQL_ CHECKSUM Function Use checksums on backup (SQL 2005 only) Description Enter 1 if you want to have SQL 2005 add checksums to the SQL 2005 database data that is backed up by Backup Exec; otherwise, enter 0. Enter the number of database snapshots to keep on disk. As the threshold is met, older database snapshots are deleted, which are then replaced with new shapshots. Database snapshots continue to grow as the SQL 2005 database is updated. If you limit the number of snapshots, you minimize both the disk space and SQL Server processing time that is required when the snapshots are updated. Enter 1 if you want to create an on-disk copy of the SQL database that is backed up; otherwise, enter 0. If you enter 1, you can simultaneously back up a SQL database to storage media and write a copy of the database to a disk path you specify with the DO_SQL_SAVEPATH option.

DO_SQL_KEEPSNAPSHOTS

Specifies the number of database snapshots to keep

DO_SQL_CREATECOPIES

Create on-disk copies of SQL backups to be placed on the SQL server where the database is located

DO_SQL_SAVEPATH

Specify the path in which Enter the path for the on-disk copy of to save on-disk copies of the SQL backup. To use this option, you must enter 1 for SQL backups DO_SQL_CREATECOPIES. SQL restore method Select the default restore method for SQL databases. Values include:

DO_SQL_RESTOREMETHOD

0 = no recover 1 = recover 2 = standby

107

Using command line switches Default option parameters (continued) Option Name DO_SQL_REPLACE Function Replace database or filegroups Description Enter 1 if you want to replace a Microsoft SQL Server database or filegroup, even if another database or filegroup with the same name already exists on the server. Otherwise, enter 0. Select a consistency check to run after a restore. Values include:

DO_SQL_ CHECKAFTERRESTORE

Consistency check after restore

0 = none 1 = full 2 = full with indexes 3 = physical

DO_SQL_ ENABLEFGSUPPORT Exchange Default Options DO_XCH_ENABLE

Enable filegroup support Enter 1 if you want to enable filegroup support; otherwise, enter 0.

Enable Exchange support Enter 1 if you want to enable Exchange support; otherwise, enter 0. Exchange backup method Select the default backup method to use for Exchange databases. Values include:

DO_XCH_BACKUPMETHOD

0 = full 1 = copy 2 = differential 3 = incremental

DO_XCH_ MBOXBACKUPMETHOD

Exchange mailbox backup method

Select the default method for backing up Exchange mailboxes. Values are:

0 = full 1 = copy 2 = differential 3 = incremental

DO_XCH_ SINGLEINSTANCEBACKUP

Enable single instance backup for message attachments

Enter 1 if you want to enable single instance backup for message attachments; otherwise, enter 0.

108

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_XCH_NOLOSS Function No loss restore Description Enter 1 to restore without deleting existing job logs; otherwise, enter 0. Enter 1 to restore a public folder; otherwise, enter 0. Enter 1 to restore private mailboxes; otherwise, enter 0.

DO_XCH_PUBLIC

Restore public folder

DO_XCH_PRIVATE

Restore private mailboxes

DO_XCH_LOGPATH

Select temporary location Enter the temporary location for log for log and patch files and patch files. Automatically recreate user accounts and mailboxes Enter 1 to have Backup Exec automatically recreate user accounts and mailboxes if they do not already exist on the server; otherwise, enter 0. Enter 1 to enable the restore of individual mailboxes, mail messages, and folders from Information Store backups; otherwise, enter 0. Incremental backups are supported with policy-based jobs only. Enter 1 to restore over existing messages and folders when you restore individual mail messages and folders. Otherwise, enter 0.

DO_XCH_ AUTOCREATEMAILBOX

DO_XCH_ENABLE_ GRANULAR_RESTORE

Use Granual Recovery Technology to enable the restore of individual mailboxes, mail messages, and public folders Restore over existing messages and folders

DO_XCH_OVERWRITE

Microsoft SharePoint Default Options DO_SPPS2_BACKUPMETHOD Select the default method for backing up SharePoint databases. Values include:

0 = Full - Back up entire database 1 = Differential - Backup up database changes only

DO_SPPS2_ENABLE_ GRANULAR_RESTORE

Enter 1 to enable the restore of individual documents from database backups; otherwise, enter 0.

109

Using command line switches Default option parameters (continued) Option Name DO_SPPS2_PRE_DBCC Function Description Enter 1 to perform a consistency check before the backup of Microsoft SQL databases Microsoft SharePoint uses; otherwise, enter 0.

DO_SPPS2_CONT_ON_DBCC_ Continue with backup job Enter 1 to continue with the backup ERROR even if consistency check operation even if the consistency fails check fails; otherwise, enter 0. DO_SPPS2_RECNT_DB_ON_ RESTORE DO_SPPS2_RECONNECT Bring restore databases online Reconnect previous database links Enter 1 to bring the databases online after a restore job; otherwise, enter 0. Enter 1 to re-establish the link between the restored databases and their corresponding sites when you restore portal sites or Windows SharePoint Services sites; otherwise, enter 0. You must set the DO_SPPS2_RECNT_DB_ON_RESTORE value to 1 in order to use this option. Enter 1 if you want to replace existing documents with documents of the same name in the restore job; otherwise, enter 0.

DO_SPPS2_OVERWRITE

Restore over existing documents

Microsoft Active Directory Default Options DO_AD_RECREATE Recreate deleted options that cannot be restored from the Active Directory Deleted Objects container Enter 1 if you want to recreate deleted objects; otherwise, enter 0. You should enter 1 if both of the following have occurred:

The objects tombstone lifetimes have passed. The objects were purged from the Active Directory Deleted Objects container.

110

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_AD_RESTORE Function Use Backup Exec Granular Recovery Technology (GRT) to enable the restore of individual objects from the Active Directory backups Description Enter 1 to enable the restore of individual objects from Active Directory backups. With this option, you can restore of individual items from full backups of the Active Directory or ADAM/ AD LDS. Otherwise, enter 0. Symantec recommends that if you select this option, you should select a backup-to-disk folder on a local NTFS volume as the destination device. If data must be restored from a tape, then the media server must stage the restore of the entire database to a temporary path to extract individual items. DO_AD_CONSISTENCY_ CHECK Checks snapshots for data corruption Enter 1 to enable the consistency check. This option applies only to snapshots that are performed by the Microsoft Volume Shadow Copy Services (VSS). You must have Windows 2008 to use this option. Otherwise, enter 0.

DO_AD_CONSISTENCY_ CHECK_FAILS

Enables the backup job to Enter 1 to enable the backup job to continue even if the continue even if the consistency check consistency check fails fails. Otherwise, enter 0. You may want the job to continue if a backup of the database in its current state is better than no backup at all. Or you may want the job to continue if you back up a large database that may have only a small problem.

111

Using command line switches Default option parameters (continued) Option Name Lotus Domino Default Options DO_DOMINO_ BACKUPMETHOD Lotus Domino backup method Select the default method for backing up Lotus Domino databases. Values include:

Function

Description

0 = full 1 = differential 2 = incremental

DO_DOMINO_ RECYCLELOGS DO_DOMINO_ SECONDSTOWAIT

Mark archive logs for recycling Seconds to wait for database

Enter 1 to mark archive logs for recycling; otherwise, enter 0. Specify the number of seconds for the restore process to wait for a database that is in use by entering a value from 0 to 999. Select the default option for handling database IDs during a restore. Values include:

DO_DOMINO_ RECOVEROPTION

Database identification

0 = retain original IDs 1 = assign new database ID 2 = assign new database ID and replica ID

Oracle Default Options

112

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_ORACLE_ BACKUPMETHOD Function Select backup method Description Select the default method to back up Oracle databases. Values are as follows:

0 = Full - Back up selections. This method is the equivalent of the Oracle RMAN Incremental: Level 0 backup. Select this method to perform a full backup of Oracle selections. 1 = Differential - Back up changes since last full. This method is the equivalent of the Oracle RMAN Cumulative Incremental: Level 1 backup. Select this method to back up all database changes since the last full backup. A full backup is performed of all archived redo logs since log files are never partially backed up. 2 = Incremental - Back up changes since last full or incremental. This method is the equivalent of the Oracle RMAN Incremental: Level 1 backup. Select this method to back up all database changes since the last full or incremental backup. A full backup is performed of all archived redo logs since log files are never partially backed up.

DO_ORACLE_DELETELOGS

Delete backed up archive Enter 1 to have Backup Exec delete the log files archived log files automatically after the backup job. Otherwise, enter 0. Do not back up archive Enter 1 to have Backup Exec skip any log files that have already archived log files that were backed up been backed up previously; otherwise, enter 0. Perform the backup offline Enter 1 to have Backup Exec take the database offline before you start the backup job; otherwise, enter 0.

DO_ORACLE_DONT_ REBACKUP_LOGS

DO_ORACLE_ BACKUPOFFLINE

113

Using command line switches Default option parameters (continued) Option Name NetWare SMS Default Options DO_SMS_ BACKUPASEXPANDED Back up compressed files Enter 1 to have Backup Exec in decompressed form decompress, or expand, compressed files as they are backed up; otherwise, enter 0. Restore volume restrictions Enter 1 to restore NetWare volume restrictions; otherwise, enter 0. Function Description

DO_SMS_ RESTOREVOLRESTRICT

Linux, Unix, and Macintosh Default Options DO)UNIXMAC_ PRESERVETIME Preserve change time Enter 1 to prevent the Remote Agent from changing an objects (files and directories) attributes when a backup occurs; otherwise, enter 0.

DO_UNIXMAC_FOLLOW_ LOCALMOUNT

Follow local mount points Enter 1 to have Backup Exec follow local mount points during backup jobs; otherwise, enter 0. Follow remote mount points Enter 1 to have Backup Exec follow remote mount points during backup jobs; otherwise, enter 0. Enter 1 to back up the contents of directories that are linked with soft links. You must also select the directory that contains the soft link. Otherwise, enter 0. Enter 1 if the Remote Agent requires exclusive access to the files on remote systems that are connected through the Network File System; otherwise, enter 0.

DO_UNIXMAC_FOLLOW_ REMOTEMOUNT

DO_UNIXMAC_SOFTLINKED

Back up contents of soft-linked directories

DO_UNIXMAC_LOCK_ REMOTEFILES

Lock remote files

114

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name NDMP Default Options DO_NDMP_NETAPP_ BACKUPMETHOD Backup method for NDMP resources Enter a number 0 through 9 to specify the backup level. Level 0 provides a full backup. Levels 1 through 9 provide various levels of incremental backups. Level 1 backup method backs up new or modified files since the level 0 backup, level 2 backup method backs up new or modified files since the level 1 backup, and so on. Enter 1 to back up NetApp Access Control Lists; otherwise, enter 0. This option applies to NetApp filers only. Enter 1 to prevent the generation of file history data; otherwise, enter 0. File history is used to optimize recovery of selected subsets of data from the backup image. File history generation and processing increase the backup time. To improve backup time, enter 0 for this option. If file history is made unavailable and you must later restore data, restore the entire backup image. Enter 1 to restore NetApp Access Control Lists; otherwise, enter 0. Enter 1 to have Backup Exec use Direct Access Recovery (DAR) during the restore job; otherwise, enter 0. With DAR-enabled recovery, Backup Exec can specify the exact location of a file in a backup data stream. The NDMP server can then read the data applicable to the single file being restored. DAR reduces the amount of information that is processed and significantly reduces recovery time. If DAR is not available, the restore may take significantly longer. 115 Function Description

DO_NDMP_NETAPP_ BACKUP_CONTROLLISTS

Back up Access Control Lists

DO_NDMP_NETAPP_ DISABLEHISTORY

Disable file history

DO_NDMP_RESTORE_ CONTROLLISTS DO_NDMP_NETAPP_ DIRECTRECOVERY

Restore Access Control Lists Enable Direct Access Recovery

Using command line switches Default option parameters (continued) Option Name DO_NDMP_NETAPP_ RESTORE_WITHOUT_ WRITING Function Restore without writing data to disk (Verify data without doing a restore) Description Enter 1 to test the validity of the data that you selected for the restore job; otherwise, enter 0. Backup Exec does not restore the data. For NetApp/IBM filers, you should use this option to verify data instead of Backup Exec's verify backup job option. Enter a number 0 through 9 to specify the backup level. Level 0 provides a full backup. Levels 1 through 9 provide various levels of incremental backups. Level 1 backup method backs up new or modified files since the level 0 backup. Level 2 backup method backs up new or modified files since the level 1 backup, and so on. Enter one of the following values:

DO_NDMP_EMC_BACKUP_ METHOD

Backup method (EMC)

DO_NDMP_EMC_BACKUP_ TYPE

Backup Type

0 = VBB (EMC only) 1 = Dump

DO_NDMP_EMC_SNAPSURE

Back up with integrated checkpoints (SnapSure)

Enter 1 to enable Backup Exec to create a backup set that uses the EMC SnapSure feature; otherwise, enter 0. This feature applies only to EMC. For more information about SnapSure, see your EMC documentation.

DO_NDMP_EMC_ DISABLEHISTORY

Disable file history (EMC) Enter 1 to prevent the generation of file history data otherwise; enter 0. File history allows for the recovery of selected subsets of data from the backup history. File history is used to optimize recovery of selected subsets of data from the backup image. File history generation and processing increase the backup time. To improve backup time, enter 0 for this option. If file history is made unavailable and you must later restore data, restore the entire backup image.

116

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_NDMP_EMC_ TAPESILVERING Function Enable tape silvering Description Enter 1 to enable Backup Exec to create a backup set that you can use to replicate data by using tape silvering; otherwise, enter 0. This feature applies only to EMC. For more information about tape silvering, see your EMC documentation.

DO_NDMP_EMC_ DIRECTRECOVERY

Enable Direct Access Recovery

Enter 1 to have Backup Exec use Direct Access Recovery (DAR) during the restore job; otherwise, enter 0. With DAR-enabled recovery, Backup Exec can specify the exact location of a file in a backup data stream. The NDMP server can then read the data applicable to the single file being restored. DAR reduces the amount of information that is processed and significantly reduces recovery time. If DAR is not available, the restore may take significantly longer. Enter 1 to restore the data with its original directory structure intact. Enter 0 to restore all data in the directories and subdirectories to the path you specify in the File Redirection dialog box. This option affects restore jobs for NetApp/IBM data only.

DO_NDMP_NETAPP_ PRESERVETREE

Restores data with original directory structure intact

DO_NDMP_EMC_ PRESERVETREE

Restores data with original directory structure intact

Enter 1 to restore the data with its original directory structure intact. Enter 0 to restore all data in the directories and subdirectories to the path you specify in the File Redirection dialog box. This option affects restore jobs for EMC data only.

117

Using command line switches Default option parameters (continued) Option Name Function Description

Storage Provisioning Default Options DO_SPO_MAXBACKUPSETS Maximum number of backup sets per file Enter the maximum number of backup sets to write to a file on a virtual disk. The value can be between one and 8192. The default value is 100. If you specify fewer rather than more backup sets in a file, Backup Exec may be able to reclaim disk space faster. For example, you specify 100 backup sets per file. Backup Exec cannot reclaim any disk space until the overwrite protection period expires for all of the backup sets. If you specify one backup set per file, Backup Exec can reclaim disk space as soon as the overwrite protection period expires for that set. DO_SPO_MAXFILESIZE Maximum size for files Type the maximum size for each file that this virtual disk contains. The file size can be from 1 MB to 4194304 MB. The default is 4 GB. Note 1024 MB is equal to 1 GB. DO_SPO_MAXCONCURRENT Allow x concurrent jobs Enter the number of concurrent operations that you want to allow to this virtual disk. The value can be between one and 16. DO_SPO_THRESHOLD1 Threshold 1 Enter the low disk space threshold at which you want Backup Exec to send the first of three alerts. The default threshold is 75%, which is a percentage of the total available disk space on this virtual disk. The value can be between one and 100. The amount you enter must be equal to or less than threshold 2.

118

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_SPO_THRESHOLD2 Function Threshold 2 Description Enter the low disk space threshold at which you want Backup Exec to send the second of three alerts. The default threshold is 85%, which is a percentage of the total available disk space on this virtual disk. The value can be between 1 and 100. The amount you enter must be equal to or less than threshold three, but greater than or equal to threshold 1. DO_SPO_THRESHOLD3 Threshold 3 Enter the low disk space threshold at which you want Backup Exec to send the last of three alerts. The default threshold is 95%, which is a percentage of the total available disk space on this virtual disk. The value can be between 1 and 100. The amount you enter must be greater than or equal to threshold 2. Schedule Default Option DO_SCHEDULE_DELETION Job deletion for run once Enter one of the following values: jobs 0 = Delete the job if the job successfully completes

1 = Delete the job after the job completes 2 = Do not delete the job

Job Status and Recovery Default Options DO_STATUSRECOVERY_ STALLED Time before job status becomes stalled Enter the number of seconds before the statuses of active jobs are changed to Stalled when the Backup Exec engine service fails to respond.

119

Using command line switches Default option parameters (continued) Option Name DO_STATUSRECOVERY_ RECOVERED Function Time before job status becomes recovered Description Enter the number of seconds before jobs are failed and then recovered by Backup Exec. A custom error-handling rule named Recovered Jobs is applied to recovered jobs. If this rule is disabled, then any other errorhandling rules that are enabled will apply to the recovered jobs. If there are no error-handling rules that apply to the job, then the job fails.

Catalog Default Options DO_CAT_MEDIA_ INSEQUENCE Request all media in the sequence for catalog operations Enter 1 to catalog media starting with the lowest known tape number in the tape family. For example, if you dont have tape one, the catalog begins with tape two. Otherwise, enter 0.

DO_CAT_USECATALOGS

Use storage media-based Enter 1 to use the catalog information catalogs from the media; otherwise, enter 0. Truncate catalogs Enter 1 to retain only the header information and to remove all file and directory details after the specified number of days; otherwise, enter 0. If you select this option, you must enter a value for DO_CAT_TRUNCATEDAYS. Enter the amount of days before file and directory details are removed from the catalogs. The value can be between 1 and 999.

DO_CAT_TRUNCATEFLAG

DO_CAT_TRUNCATEDDAYS

Amount of days before truncating catalogs

DO_CAT_REMOVEFLAG

Remove unused catalogs Enter 1 to remove unused catalogs after a specified number of days; otherwise, enter 0. If you select this option, you must enter a value for DO_CAT_REMOVEDAYS. Amount of days before removing unused catalogs Enter the amount of days before unused catalogs are removed. The value can be between 1 and 999.

DO_CAT_REMOVEDAYS

120

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DO_CAT_PATH Function Set catalog path Description Specify a path on the volume for the catalog files.

Media Default Options DO_MEDIA_B2DLOCATION Backup-to-Disk default folder location Set media overwrite protection level Specify a path on the volume for the Backup-to-Disk folder. Enter one of the following values:

DO_MEDIA_ OVERWRITELEVEL

1 = None 2 = None with prompt 3 = Partial 4 = Partial with prompt 5 = Full

DO_MEDIA_ OVERWRITEOPTIONS

Set the media overwrite options

Enter one of the following values:

0 = Overwrite scratch media before overwriting recyclable media contained in the targeted media set 1 = Overwrite recyclable media contained in the targeted media set before overwriting scratch media

DO_MEDIA_DEFAULTVAULT Specify the default media Enter the default vault that you want vault media moved to when a job is run to move media to a vault or to export media. Intelligent Disaster Recovery Default Options DO_DISASTER_DATAPATH Disaster recovery data path Specify a path where a copy of the DR files for the protected computers will be stored. Specify an alternate data path where a second copy of the DR files can be stored.

DO_DISASTER_ ALTERNATEPATH

Alternate disaster recovery data path

121

Using command line switches Default option parameters (continued) Option Name Function Description

Backup-to-Disk Default Options DO_B2D_MAXBACKUPSETS Maximum number of backup sets per backup-to-disk file Type the maximum number of backup sets to be written to each backup-to-disk file. The maximum number can range from 1 to 8192. The default is 100. Fewer backup sets in a backup-to-disk file may allow the overwrite protection period to expire sooner, and the disk space to be reclaimed faster. Type the maximum size for each backup-to-disk file. The file size can be from 1 MB to 4194304 MB. The default is 4 GB. Note 1024 MB is equal to 1 GB. DO_B2D_ALLOCATEMAXSIZE Allocate the maximum size when creating the backup-to-disk file Enter 1 to create the backup-to-disk file at the maximum size to reduce disk fragmentation; otherwise, enter 0. This default does not apply to removable backup-to-disk folders.

DO_B2D_MAXFILESIZE

Maximum size for backup-to-disk files

DO_B2D_CONCURRENTJOBS Allow concurrent jobs for Type the number of concurrent this backup-to-disk folder operations that you want to allow to this folder. This number can range from 1 to 16. DO_B2D_RESERVESIZE Disk space reserve Enter an amount of disk space to reserve on a backup-to-disk folder. When this threshold is reached, Backup Exec cannot submit jobs for processing that are targeted to this backup-to-disk folder, but jobs that are running will finish. Type the default path for new backup-to-disk folders.

DO_B2D_FOLDERLOCATION

Specify backup-to-disk folder location

122

Symantec Backup Exec Command Line Applet

Using command line switches Default option parameters (continued) Option Name DB2 Default Options DO_DB2_BACKUPMETHOD Select backup method Specifies the backup method to be used for DB2 backup jobs. Methods are as follows:

Function

Description

0 = Full - Back up selections. Select this method to perform a full backup of DB2 selections. 1 = Differential - Back up changes since last full backup. 2 = Incremental - Back up changes since last full or incremental backup.

DO_DB2_BACKUPOFFLINE

Perform backups offline

Enter 1 if you want Backup Exec to take the database offline before you start the backup job; otherwise, enter 0. If you enter 1, Backup Exec brings the database online after the backup job is complete. Enter 1 if you want Backup Exec to force users off the database before it brings the database offline for the backup job. Otherwise, enter 0.

DO_DB2_QUIESCE

Quiesce the database before offline backup

Database Maintenance Default Options DO_DB_GROOM Remove old data from the Enter 1 if you want Backup Exec to Backup Exec database automatically delete old data from its database, using specified criteria. Otherwise, enter 0. Time to perform database Enter the time you want to perform maintenance database maintenance. All the maintenance occurs once a day at the time you specify.

DO_DB_TIME

123

Using command line switches Default option parameters (continued) Option Name DO_DB_ENABLE_ JOBHISTORYDAYS Function Keep job history Description Select one of the following options for keeping job history data:

0 = Keep job history for data on media that have current overwrite protection periods. 1 = Keep job history for a specified number of days. This option is used with the DO_DB_JOBHISTORYDAYS option.

DO_DB_JOBHISTORYDAYS

Number of days to keep job history data

Enter the number of days for job history data to remain on the Backup Exec database. Enter the number of days for alert history data to remain on the Backup Exec database. Enter the number of days for job logs to remain on the Backup Exec database. Enter the number of days for report data to remain on the Backup Exec database. Enter the number of days for audit logs to remain on the Backup Exec database. Enter 1 if you want to perform a database consistency check; otherwise, enter 0.

DO_DB_ ALERTHISTORYDAYS

Number of days to keep alert history data

DO_DB_JOBLOGDAYS

Number of days to keep job logs

DO_DB_REPORTDAYS

Number of days to keep report data

DO_DB_AUDITLOGDAYS

Number of days to keep audit logs

DO_DB_CONSISTENCY

Perform database consistency check

DO_DB_COMPACT

Compact the Backup Exec Enter 1 if you want to compact the database Backup Exec database; otherwise, enter 0. Dump contents of Backup Enter 1 if you want to dump the Exec database contents of the Backup Exec database to the Backup Exec data directory so that it can be backed up; otherwise, enter 0. Symantec Backup Exec Command Line Applet

DO_DB_DUMP

124

Using command line switches Default option parameters (continued) Option Name Reports DO_REPORTS_ COMPANYLOGO Use company logo image Enter 1 if you want to use a company file logo in the report header; otherwise, enter 0. Specify image file path Type the path to the logo that you want to use in all custom reports. Type the numbers that correspond to the values for red, green, and blue that you want to use for the banner color. Use the following format: <value for red>. <value for green>, <value for blue> Values can range from 0 through 255 DO_REPORTS_FOOTERTEXT Specify text to appear in the report footer DO_REPORTS_FOOTERTIME Include time in footer Type the text you want to appear in the report footer. Enter 1 if you want to include the time the report ran in the report footer; otherwise, enter 0. Function Description

DO_REPORTS_IMAGEFILE

DO_REPORTS_ BANNERCOLOR

Specify the color to use for the report banner

LiveUpdate DO_LU_ENABLED Lets you schedule automatic updates, and then choose the frequency of the updates Enter 1 to have Backup Exec download and install all updates that are available without prompting you first. Enter 2 to have Backup Exec alert you when updates are available. Updates are not downloaded or installed. Enter O to disable automatic updates.

125

Using command line switches Default option parameters (continued) Option Name DO_LU_FREQUENCY Function Lets you select the frequency with which Backup Exec checks for updates Description Enter O to have Backup Exec check for new updates only on the date and time that you specify. Enter 1 to have Backup Exec check for new updates every day at the time you specify. Enter 2 to have Backup Exec check for new updates once a week on the day and time that you specify. Enter 3 to have Backup Exec check for new updates once a month at the time you specify. DO_LU_DAY Lets you select the day on Enter one of the following: which you want Backup 0 = Sunday Exec to check for updates 1 = Monday

2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday

DO_LU_DATE

Lets you enter the specific date on which you want Backup Exec to check for updates

Enter the date in MM/DD/YYYY format. For example, enter 12/13/2010 to run the job on December 13, 2010.

DO_LU_TIME

Lets you enter the time at Enter the time in 24 hour format. For which you want Backup example, enter 21:30:00 to run the Exec to check for updates. job at 9:30 PM.

126

Symantec Backup Exec Command Line Applet

Using job script files

Using job script files

A job script file is a text (.txt) file that the Command Line applet can use with command line switch -o90 to create and launch jobs. The job script file can contain all of the switches you would normally specify on the command line when using the Command Line Applet as well as additional switches that you set when creating the job script file. The job script file can also be used in conjunction with some of the switches. Sample script files are included in the UTILS directory on the installation DVD. To activate an entry in this sample file, delete the forward slashes (//) at the beginning of the line. The following are the sample script files included:

Backup jobs - bjscript.txt Restore jobs - rjscript.txt Catalog jobs - catalogscript.txt Discovery resource jobs - discoveryscript.txt Duplicate backup jobs - djscript.txt Test run jobs - testrunscript.txt Copy job - cjscript.txt

Creating a backup job script file

Use a text editor, such as Notepad, to create a backup job script file that contains the following sections, and entries for each section:

[General] [Backup_Options] [Media_Options] [Miscellaneous] [Schedule] [Machine] [Selections] [Media_Server]

Each entry included for the various sections must be typed in capital letters and be immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. For example, to specify in the script that the job name is Workstation Backups and the job type is backup, the script file for the [General] section would appear as:
127

Using job script files

[General] JOB_TYPE=Backup JOB_NAME=Workstation Backups All possible entries for a Backup Job Script File are described in the following table. In creating a script file, you would not want to include all entries.
Possible backup job script file entries Section [General] JOB_TYPE=job type This entry must be completed with a value of Backup. Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Options are:

Entry

Description

JOB_PRIORITY=priority

Lowest Low Medium High Highest

JOB_NAME=job name SERVER=server name

Type the name of the backup job. Type the name of the Backup Exec server where the operation is to be performed. If a server is not specified, the local server is used by default. Type the user name for logging into a remote Backup Exec server. If a user name is not specified, the current user name is used. Enter the password for logging into a remote Backup Exec server. If a password is not specified, the current password is used.

USERNAME=username

PASSWORD=password

128

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry Description

[Backup_Options] BK_SET_NAME=backup set name Type the name of the backup set to be used by the job. Enter a number from 0 through 9 or 11 that corresponds to the backup method you want. Methods are:

BK_METHOD=0 - 9, 11

0 = Full 1 = Copy 2 = Differential changed files 3 = Incremental changed files 4 = Daily 5 = Working set 6 = Incremental modified time 7 = Differential modified time 8 = Full modified time 9 = Archive - Delete files after successful copy backup 11 = Synthetic full backup

If 5 is entered as the value, a value must also be entered for WORKING_SET_DAYS. DEVICE_NAME=device name Type the name of the device to be used for the backup. Type the GUID of the device to use for the backup.

DEVICE_ID=device GUID

129

Using job script files Possible backup job script file entries (continued) Section Entry OPEN_FILES_METHOD=0 - 3 Description Enter a number from 0 through 3 to specify how to back up open files. Selections include:

0 = Never 1 = If closed within a specified number of seconds. If this method is selected, use the flag OPEN_FILE_WAIT_TIME to set the number of seconds for Backup Exec to wait; otherwise, the value set for default options will be used. 2 = With a lock 3 = Without a lock

Note If 1 is entered as the value, Backup Exec will wait the number of seconds specified in OPEN_FILE_WAIT_TIME for the file to close before continuing the backup. If the files do not close during the specified interval, they are skipped. OPEN_FILE_WAIT_TIME=# Specifies the number of seconds Backup Exec is to wait for a file to close before continuing with the backup. Enter 1 to retension the media before backup; otherwise, enter 0. Enter 1 to retain the directory structure of the files that were backed up in an archive job on the hard drive; otherwise, enter 0. Enter 1 if single instance store is being used, and you want to ensure that only one instance of a file for NTFS volumes will be backed up regardless of the number of single instance store (SIS) links that point to it. Otherwise, enter 0.

RETENSION_MEDIA=0 or 1

PRESERVE_TREE_ON_ARCHIVE= 0 or 1

SINGLE_INSTANCE_FOR_NTFS=0 or 1

130

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry REMOTE_AGENT_PRIORITY=# Description Select the number of CPU cycles the media server will use to maintain optimal server performance while Remote Agent backups are running. The higher the priority, the more the protected servers CPU processing power is used during backup operations. Note Allocating fewer CPU cycles to a backup job results in slower backup performance. This entry contains the following options:

MEDIUM. Select this option to allocate the default number of CPU cycles the protected server will use during a Remote Agent backup. LOW. Select this option to allocate fewer server CPU cycles to the backup job. LOWEST. Select this option to allocate the fewest number of CPU cycles to the backup job.

SAV_THREATLEVELTRIGGER=0, 2 - 4

Select the ThreatCon level at which you want automatic backups to run. You can select from the following:

0 = Disabled 2 = Elevated 3 = High 4 = Extreme

131

Using job script files Possible backup job script file entries (continued) Section Entry WORKING_SET_DAYS=# Description Note If 5 was entered as the value for the BK_METHOD=# entry, the WORKING_SET_DAYS entry must be completed and included in the Backup Job Script File. Enter the number of days during which files that you want to include in the backup were last accessed. For example, if you want to specify for a working set backup to include all files last accessed within 30 days, type WORKING_SET_DAYS=30. BACKUP_LOCAL_MOUNT_POINTS= 0 or 1 Enter a value of 1 to back up mount points, which direct a file or directory to a local disk or directory path. Using this command allows you to back up data that is linked to local files, but is stored on another device without having to actually select the device. Enter a value of 1 to back up data that has been migrated from primary storage to secondary storage. The data will not be recalled to its original location; it will be backed up directly to the backup media. This command should not be used if:

BACKUP_REMOTE_STORAGE_HSM= 0 or 1

A single device is used for secondary storage and backups and it contains one drive because Remote Storage and Backup Exec will compete for use of the drive. You want to run a backup of your entire system because Backup Exec attempts to access all data that has been migrated to secondary storage and this may take a considerable amount of time.

[AOFO]

132

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry USE_OPEN_FILE_OPTION=0 or 1 Description Enter 1 to enable the Advanced Open File Option (AOFO) for the backup job. Enter 0 to disable AOFO. If you do not enable this option, jobs saved before you installed the Advanced Open File Option continue to use the previous settings for backing up files. Lets you select the open file configuration you want to use for the Advanced Open File Option. You have the following options:

OPEN_FILE_CONFIGURATION=1-4

1 = Automatically select open file technology 2 = Symantec Volume Snapshot Provider (Windows 2000 only) You can only use VSP on computers that have Windows 2000/XP 32-bit.

3 = Veritas Storage Foundation for Windows FlashSnap Option (Windows 2000 and 2003 only) You can only use Veritas Storage Foundation on computers that have Windows 2000/2003.

4 = Microsoft Volume Shadow Copy Service (Windows 2003 and later) Allows third-party hardware and software vendors to create snapshot add-ins for use with Microsofts technology. See your software documentation for information about VSS Writers that may be provided by the application software vendor. If you turn off Active Directory, Microsoft Volume Shadow Copy Service (VSS) is not available. Jobs that require VSS fail.

133

Using job script files Possible backup job script file entries (continued) Section Entry SNAPSHOT_PROVIDER=0-3 Description Indicates the snapshot provider to use for jobs. You have the following options:

0 = Automatic - Allow VSS to select the snapshot provider The order in which a snapshot provider is selected is hardware provider, software provider, and then the system provider.

1 = System - Use Microsoft Software Shadow Copy Provider 2 = Software - Use Veritas Storage Foundation for Windows 3 = Hardware - Use technology provided by hardware manufacturer

If you select Software or Hardware, then the following information applies:

If multiple volumes are selected, then all volumes must be snappable by the same type of provider. Software and hardware providers cannot both be used to snap different volumes in the same job. You must either create another job, or select the option Process logical volumes for backup one at a time.

134

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry Description

USE_SINGLE_VOLUME_SNAPSHOT=0 or Enables the backup of multiple 1 volumes in one job, while creating a snapshot of only one logical volume at a time. To ensure database integrity, or if a volume contains mount points, multiple volumes may need to be snapped at one time. A volume with mount points to other volumes is considered a logical volume for snapshot purposes. Therefore, that volume and the mount point volumes will be snapped together simultaneously. If this option is not selected, then a snapshot for all volumes in the backup job is created simultaneously. All volumes must meet the minimum quiet time. This option is only available for Symantec Volume Snapshot Provider (VSP) and Microsoft Volume Shadow Copy Service (VSS) jobs for logical volumes. [Exchange] EXCHANGE_METHOD=0 - 3 If you are backing up an Exchange server, use this entry. Enter a number from 0 through 3 that corresponds to the backup method you want for the Exchange database. Methods are:

0 = Backup All 1 = Backup Copy 2 = Backup Log Differential 3 = Backup Log Incremental

EXCHANGE_ENABLE_GRANULAR_ RESTORE=0 or 1

Enter 1 to enable the restore of individual documents from database backups. This option is only available when performing full backups; otherwise enter 0.

135

Using job script files Possible backup job script file entries (continued) Section Entry EXCHANGE_CONTINUOUS_ PROTECTION=0 or 1 Description Enter 1 to enable continuous backup of Exchange transaction logs with Backup Exec Continuous Protection Server; otherwise, enter 0. If you are backing up an Exchange server, use this entry. Enter a number from 0 through 3 that corresponds to the backup method you want for the Exchange database. Methods are:

EXCHANGE_MBOX_METHOD=0 - 3

0 = Full - Back up messages. Reset archive bit. 1 = Copy - Back up messages. 2 = Differential - Back up changed messages. 3 = Incremental - Back up changed messages. Reset archive bit.

EXCHANGE_SINGLE_INSTANCE=0 or 1

Enter 1 to back up only a single copy of all identical message attachments; otherwise, enter 0. Enter 1 to perform a consistency check and determine if possible data corruption exists when using the Backup Exec - Advanced Disk-based Backup Option (ADBO) or the Advanced Open File Option (AOFO); otherwise, enter 0. Enter 1 to continue the backup job even if the consistency check fails; otherwise, enter 0. Enter the interval in days, hours, or minutes for making recovery points when continuously backing up Exchange transaction logs with Backup Exec Continuous Protection Server.

EXCHANGE_CONSISTENCY_ CHECK=0 or 1

EXCHANGE_CONTINUE=0 or 1

EXCHANGE_RECOVERY_POINTS_ INTERVAL=xD (days) or xH (hours) or xM (minutes)

136

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry Description

[SharePoint Portal Server] SPPS2_METHOD=0 or 3 If you are backing up a SharePoint Portal Server. Enter a number 0 or 3 that corresponds to the backup method you want for the SharePoint Portal Server.

0 = Full - Back up entire database. 3 = Differential - Back up database changes only. Select this to back up only the changes made to the database since the last full backup.

Note The differential backup method cannot be used to back up Index databases or Document Libraries. The Full backup method will be used to back up these resources. SPPS2_ENABLE_GRANULAR_RESTORE=0 Enter 1 to enable the restore of or 1 individual documents from database backups. This option is only available when performing full backups; otherwise, enter 0. SPPS2_PRE_DBCC=0 or 1 Enter 1 to run a full consistency check (including indexes) of the Microsoft SQL databases used by Microsoft SharePoint before backing up the databases; otherwise, enter 0. Enter 1 to continue with the backup operation even if the consistency check fails; otherwise, enter 0. Enter 1 to release the lock on the SharePoint farm topology before backing up data; otherwise, enter 0.

SPPS2_CONT_ON_CC_FAILURE=0 or 1

SPPS2_RELEASE_LOCK= 0 or 1

137

Using job script files Possible backup job script file entries (continued) Section Entry SPPS3_FARMx=Farm name Description Change x to the lowest number that is not already used, and specify the name of the Microsoft SharePoint 2007 Portal 2 server farm that you want to back up. You should start with the number 1 and continue sequentially.

SPPS3_WEBSERVERx=Web server name Required. Specifies the Web server name that belongs to the server farm. SPPS3_CONFIGDBx=0 or 1 Enter 1 to include the Configuration database in the backup; otherwise, enter 0. Enter 1 to include the Single Sign-on database in the backup; otherwise, enter 0. Enter 1 to include the central administration site in the backup; otherwise, enter 0. Specify the name of the Web application. You can list multiple names. Specify the name of the shared server provider. You can list multiple names. Enter 1 to include the shared instance in the backup; otherwise, enter 0. Enter 1 to include the global settings in the backup; otherwise enter 0.

SPPS3_SSOx=0 or 1

SPPS3_CAx=0 or 1

SPPS3_WAxNAMEy=Web application name

SPPS3_SSPxNAMEy=Shared service provider name SPPS3_SIx=0 or 1

SPPS3_GSx=0 or 1

138

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section [SQL Server] SQL_METHOD=0 - 3 If you are backing up a SQL server, use this entry. Enter a number from 0 through 2 that corresponds to the backup method you want for the SQL database. Methods are:

Entry

Description

0 = Backup All 1 = Backup Log 2 = Backup Log No Truncate 3 = Differential

[Lotus Domino Server] LOTUS_DOMINO_METHOD=0 - 3 If you are backing up a Lotus Domino server, use this entry. Enter a number from 0 through 2 that corresponds to the backup method you want for the Lotus Domino database. Methods are:

0 = Full 1 = Differential 2 = Incremental

LOTUS_DOMINO_RECYCLE_LOGS= 0 or 1

If you are backing up a Lotus Domino server, use this entry to indicate that the Lotus Domino server will reuse the transaction log after it has been backed up.

1 = Recycle logs 0 = Do not recycle logs

NW_BK_MIGRATED=0 or 1

Enter 1 to back up migrated NetWare SMS files; otherwise, enter 0. This switch can only be used with versions prior to Backup Exec 10.x.

139

Using job script files Possible backup job script file entries (continued) Section Entry NW_BK_DECOMPRESS_FILES= 0 or 1 Description If you are backing up NetWare shares or volumes, include this entry in the Backup Job Script File. If you want to back up compressed files in decompressed form, enter 1 as the value; otherwise, enter 0. Enter 1 as the value if you want Backup Exec to overwrite a duplicate job if one exists; otherwise, enter 0. Enter 1 if you are backing up a SQL server, have specified that a database consistency check is to be performed before the backup, and want the job to continue if the pre-backup database consistency check failed. If you are backing up a SQL server, include this entry. Enter a value from 0 to 3 that corresponds to an option for performing a pre-backup database consistency check. Options are:

OVERWRITE_JOB=0 or 1

CONTINUE_ON_DBCC=0 or 1

PRE_BK_DBCC=0 - 3

0 = None 1 = No Index 2 = Full 3 = Physical only

POST_BK_DBCC=0 or 3

If you are backing up a SQL server include this entry. Enter a value from 0 to 3 that corresponds to an option for performing a post-backup database consistency check. Options are:

0 = None 1 = No Index 2 = Full 3 = Physical only

140

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section [SQL log] SQL_STANDBY_OPTION=0 or 1 Select the Standby value to put the database in standby mode when the job log backup completes. Select the No Recover value to put the database in a loading state when the job log backup completes. Users cannot connect to or query the database while it is in a loading state. Values are:

Entry

Description

0 = Standby 1 = No Recover

[Offhost provider] OFFHOST_PROVIDER=0 or 3 Enter a value from 0 to 3 that corresponds to the snapshot provider options for an offhost backup jobs. Options are:

0 = Disable offhost backup 1 = Automatic Use hardware if available 2 = Software Use VERITAS Storage Foundation for Windows 3 = Hardware Use technology provided by hardware manufacturer

OFFHOST_DISPOSITION=0 or 1

Enter 1 to allow the backup job to complete even if any of the volumes selected do not support offhost backup; otherwise, to fail the backup job, enter 0. Enter 1 to process logical volumes for offhost backup one at a time; otherwise, enter 0.

OFFHOST_SINGLESNAP=0 or 1

141

Using job script files Possible backup job script file entries (continued) Section Entry USE_OPEN_FILE_OPTION=0 or 1 Description Enter 1 as the value if you want to use the Advanced Open File Option if available; otherwise, enter 0. If Advanced OFO is unavailable, the OPEN_FILES_METHOD specified will be used. Enter a number from 1 through 4 to specify the open file technology to back up open files. Selections include:

OPEN_FILE_CONFIGURATION=1-4

1 = Automatically select open file technology 2 = Use Microsoft Volume Shadow Copy Service 3 = Use VERITAS Volume Snapshot Provider 4 = Use VERITAS Storage Foundation for Windows FlashSnap Option

SNAPSHOT_PROVIDER=0-3

Enter a number from 0 through 3 to specify the best provider for the selected volume. Selections include:

0 = Automatic - Allows VSS to select the snapshot provider 1 = System - Use Microsoft software shadow copy provider 2 = Software - Use VERITAS Storage Foundation for Windows 3 = Use technology provided by hardware manufacturer

USE_SINGLE_VOLUME_SNAPSHOT=0 or Enter 1 if you want to process logical 1 volumes for backup one at a time; otherwise, enter 0. [Data Encryption Setting] ENCRYPTION_KEY_NAME=key name Specify a name for the encryption key.

142

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry ENCRYPTION_TYPE=0 - 3 Description Enter a number from 0 to 3 that corresponds with the type of encryption to use. The following options are available:

0 = None 1 = Software 2 = Hardware 3 = Hardware if available, otherwise software

If 2 or 3 are entered, the default encryption key must be 256-bit encryption. [Media Options] MEDIA_SET=Media Set Name Enter the name of the media set to be used for the backup. If the media has a password, specify the password. To append the job to the media set specified in the MEDIA_SET entry or overwrite if no appendable media is available, enter 1 as the value. If you want the job to overwrite the media set specified in the MEDIA_SET entry, enter 0 as the value. If you do not enter a value, by default the job will be an overwrite job. APPEND_NO_OVERWRITE=0 or 1 If you want the job to either append to the media set specified in the MEDIA_SET entry, or if no appendable media is available then to terminate, enter 1. To have the job append to the media set, or overwrite if no appendable media is available, enter 0.

MEDIA_PASSWORD=Media Password

APPEND=0 or 1

143

Using job script files Possible backup job script file entries (continued) Section Entry VERIFY=0 or 1 Description Enter 1 as the value to have Backup Exec automatically perform a verify operation to make sure the media can be read once the backup has been completed; otherwise, enter 0. Verifying all backups is recommended. Enter a number from 0 to 3 that corresponds with the type of compression to use. Options include:

COMPRESSION_TYPE=0 - 3

0 = Hardware compression 1 = Software compression 2 = Hardware if available, otherwise software 3 = None

Note To use the default Backup Exec compression type, do not include this entry in the script. CHECKSUM=0 or 1 Enter 1 as the value if checksums are to be calculated for each data stream written to tape, and then written in a separate stream immediately following the data stream. If 0 is entered as the value, backup performance may be improved, but there will be no way to verify the integrity of the data on the tape. Enter 1 to eject the media when the job completes; otherwise, enter 0. Enter 1 to use write once, read many (WORM) media for this backup job; otherwise, enter 0.

EJECT_MEDIA=0 or 1

WORM_MEDIA=0 or 1

[Miscellaneous] PRE_JOB_COMMAND=command Specify a .exe or batch file command that is to run on the media server before the backup operation starts.

144

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry POST_JOB_COMMAND=command Description Specify a .exe or batch file command that is to run after the backup operation completes. Enter 1 to execute the post-job command only if the pre-job command is successful; otherwise, enter 0. Enter 1 to execute the job only if the pre-job command is successful; otherwise, enter 0. Enter 1 to execute the post-job command even if the job fails; otherwise, enter 0. Enter 1 to allow the pre- and post-job commands to be successful only if completed with a return code of zero. Otherwise, enter 0. An return code of zero returned to the operating system by the pre- or post-job command is interpreted by Backup Exec to mean the job completed successfully. A non-zero return code is interpreted by Backup Exec to mean the job ended with an error. After checking the return codes, Backup Exec continues processing according to selections you made for running the pre- and post-job commands. If you enter 0, the success of the preand post-job commands is not determined based on the return code. COMMAND_AUTO_CANCEL_TIME=# Enter the number of minutes Backup Exec should wait before cancelling a command that did not complete.

COMMAND_RUN_POST_IF_ PRE_SUCCESS=0 or 1

COMMAND_RUN_JOB_IF_PRE_SUCCESS= 0 or 1

COMMAND_RUN_POST_ IF_JOB_FAILS=0 or 1

COMMAND_FAIL_JOB_IF_FAILS= 0 or 1

145

Using job script files Possible backup job script file entries (continued) Section Entry COMMAND_RUN_OPTION=0 or 1 Description Enter 0 to run the command on this media server or 1 to run the command on each server being backed up. Enter 1 to use the job defaults from the Backup Exec Administration Console for this job. All other options will be overwritten. Enter 0 if you do not want to use the job defaults. Enter 1 to include the job log with a notification to an email or printer recipient; otherwise, enter 0. Enter 1 to use the MAC address specified with the NIC_ADDRESS entry, or the name specified with the NIC_NAME entry. Enter 0 to clear previous settings for the network interface, and to use any available network adapter. Operations for displaying network interface information on page 85 NIC_ADDRESS=00-00-00-00-00-00 Enter the Media Access Control (MAC) address for the network interface you selected. To use this setting, NIC_ENABLED must be set to 1. NIC_NAME=name Type the name of a network interface card when NIC_ENABLED=1. Enter 0 to use any available Internet Protocol. Enter 1 to use IPv4. Enter 2 to use IPv6. Operations for displaying network interface information on page 85 NIC_SUBNET_ENABLED=0 or 1 Enter 0 to use any available subnet prefix. Enter 1 to use a specific subnet prefix.

USE_JOB_DEFAULTS=0 or 1

PRINT_LOG_FILE=0 or 1

NIC_ENABLED=0 or 1

NIC_PROTOCOL=0 - 2

146

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry NIC_SUBNET=00.000.00.000 Description Specify a subnet prefix when NIC_ENABLED=1 and NIC_SUBNET_ENABLED=1. Enter 1 to use any available network interface card. Enter 0 to use only the network interface card that you specify.

NIC_ANY_AVAILABLE=0 or 1

[Schedule] Note You must enter values when you select to use either SCHED_REPEAT_INTERVAL, SCHED_DAYSOF MNTH, SCHED_DAYSOF WEEK, or DATE before the job is created. SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in MM/DD/YYYY format, that the schedule becomes effective. Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format. Enter the interval in HH:MM:SS format for the job to restart on each run day. For example, if you have set up the job to run every seven days, you can also set it up to run every four hours on its run day by entering SCHED_RESTART_INTERVAL=04:00:0 0. Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date, in MM/DD/YYYY format, from which the interval is calculated.

SCHED_STARTTIME=HH:MM:SS

SCHED_ENDTIME=HH:MM:SS

SCHED_RESTART_INTERVAL=HH:MM:SS

SCHED_REPEAT_INTERVAL=X

SCHED_ANCHOR=MM/DD/YYYY

147

Using job script files Possible backup job script file entries (continued) Section Entry SCHED_DAYSOFMONTH=x Description Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002

148

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry DATE=MM/DD/YYYY Description Enter the start date for the job in MM/DD/YYYY format. Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter a value of 1 if the job is to run immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set, the default value is 1. AUTO_CANCEL_TIME=# Enter the number of minutes after which the job is cancelled if it is not completed. Backup Exec starts timing the job when the job is queued, not when the job begins. Enter 1 as the value if you want to schedule the job on hold; otherwise, enter 0. Enter a number from 0 to 2 that corresponds to job deletion. Options include:

TIME=hh:mm:ss

HOLD=0 or 1

DELETE_JOB_AFTER=0 - 3

0 = Do not delete the job 1 = Delete the job after the job completes 2 = Delete the job if the job successfully completes

[Machine] MACHINEx=machine name|logon GUID Specify the logon account used to log on to remote machines and back up remote data and databases.

149

Using job script files Possible backup job script file entries (continued) Section [Selections] PATHx=string Specify which files or directories get backed up. For example, PATH1=\\Myserver1\Myshare1\Mydir 1\*.* or PATH2=\\Myserver2\Myshare2\Mydir 2\*.* Selections that end with a backslash indicate the selection is a directory. Selections that do no end with a backslash indicate the selection is a file. For example, PATH1=c:\example (indicates that example is the name of a file on drive C. PATH2=c:\example\ (indicates that example is a directory on drive C. The order in which resource selections are specified is the order in which the resources will be backed up. To back up System State, use the string \\server name\System?State\*.* Note To back up Shadow Copy Components on a Windows 2003 computer, type "\\server name\Shadow?Copy ?Components\*.*" after -s. To use a separate logon account for backup selections, type a comma after PATHx=string. Then, type the logon account that you want to use for that selection. INCLUDEx=0 or 1 Enter 1 to include this item in the backup job; otherwise, enter 0. Enter 1 to include all subdirectories; otherwise, enter 0. Entry Description

SUBDIRSx=0 or 1

150

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry UNIXx=x Description Change x to the number that corresponds to the path that contains the Unix files or directories to be backed up. Enter a 1 if it is a Unix selection. Change x to a unique number and specify the name of the Enterprise Vault Server to back up. Change x to the unique number that corresponds to the Enterprise Vault Server that you want to back up. Then specify the Enterprise Vault selection prefix. Change x to the unique number that corresponds to the Enterprise Vault Server that you want to back up. Then specify the directory that contains the file that you want to back up. Change x to the unique number that corresponds to the Enterprise Vault server that you want to back up. Then specify the file that you want to back up. You can back up the following:

EV_SERVERx=Enterprise Vault server name

EV_PREFIXx=Enterprise Vault selection prefix

EV_DIRECTORYx=Enterprise Vault directory

EV_FILEx=Enterprise Vault file

Enterprise Vault sites Audit databases FSA Reporting databases Directory databases Monitoring databases

EXCHANGEx=Exchange Server name

Change x to a unique number and specify the name of the Exchange Server to back up.

151

Using job script files Possible backup job script file entries (continued) Section Entry EXCH2ROOT?=Exchange Server name Description Specifies the name of the Exchange server that contains this selection. Change ? to a number that corresponds to the number of the selection. The selections must be in a sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. Each selection must specify at least the server name and the storage group. See the example in EXCH2DB?=Exchange Server database name. EXCH2SG?=Exchange Server storage Specifies the name of the Exchange group name Server storage group that you want to back up, or that contains the database you want to back up. Change ? to the same number used to identify the selection for the Exchange Server. See the example in EXCH2DB?=Exchange Server database name.

152

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry EXCH2DB?=Exchange Server database name Description Specifies the name of the Exchange Server database you want to back up. Change ? to the same number used to identify the selection for the Exchange Server and storage group. In the following example, SERVER_NAME is an Exchange server name, and it is the same server in all of the selections. The first selection backs up the First Storage Group, the second selection backs up the Mailbox database in the Second Storage Group, and the third selection backs up the Users database in the Second Storage Group. EXCH2ROOT1=SERVER_NAME EXCH2SG1=First Storage Group EXCH2ROOT3=SERVER_NAME EXCH2SG2=Second Storage Group EXCH2DB2=Mailboxes EXCH2ROOT3=SERVER_NAME EXCH2SG3=Second Storage Group EXCHDB3=Users EXCH2010_SERVERx=Exchange 2010 Server name Specifies the name of the Exchange 2010 server you want to back up. Change x to a unique number to identify the Exchange 2010 server. To back up an Exchange 2010 server, you should use either EXCH2010_SERVER or EXCH2010_DAG, but not both.

153

Using job script files Possible backup job script file entries (continued) Section Entry Description

EXCH2010_DAGx=Exchange 2010 Specifies the name of the Exchange Database Availability Group name 2010 Database Availability Group (DAG) you want to back up. Change x to a unique number to identify the DAG. To back up an Exchange 2010 Server, you should use either EXCH2010_SERVER or EXCH2010_DAG, but not both. EXCH2010_DBx=Exchange 2010 database name Specifies the name of the Exchange 2010 database that you want to back up. It refers to the Exchange 2010 server or Database Availability Group (DAG) that you want to back up. Change x to the unique number that corresponds to the Exchange 2010 server or DAG that you want to back up. EXCH2010_DB is required for Exchange 2010 backups. SQL2S? =SERVER_NAME Specifies the name of the SQL server that contains this selection. Change ? to a number that corresponds to the number of the selection. The selections must be in a sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. See the example in SQL2NI?=SQL server named instance name. SQL2DB?=SQL server database name Specifies the name of the SQL server database to back up. Type *.* to back up all the databases. Change ? to a number that corresponds to the number of the selection.

154

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry Description

SQL2NI?=SQL server named instance Specifies the named instance on the name SQL server to back up. Change ? to the same number used to identify the selection for the SQL server. For example, to back up the named instance ONE, the named instance TWO, and the SQL server itself, the entries would be: SQL2S1=SERVER_NAME SQL2NI1=ONE SQL2S2=SERVER_NAME SQL2NI2=TWO SQL2S3=SERVER_NAME LNSERVER?=SERVER_NAME Specifies the name of the Lotus Notes server that contains this selection. Change ? to a number that corresponds to the number of the selection. The selections must be in a sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. See the example in LNDRIVE?=Drive letter.

155

Using job script files Possible backup job script file entries (continued) Section Entry LNDRIVE?=Drive letter Description Change ? to the same number used to identify the selection for the Lotus Notes server. In the following example, SERVER_NAME is a Lotus Notes server name, and it is the same server in all of the selections. To back up the D drive and the E drive on the Lotus Notes server SERVER_NAME, the entries would be: LNSERVER1=SERVER_NAME LNDRIVE1=D LNSERVER2=SERVER_NAME LNDRIVE2=E ORCLSRV?=SERVER_NAME Specifies the name of the Oracle server that contains this selection. Change ? to a number that corresponds to the number of the selection. The selections must be in a sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. See the example name in ORCLSID?=System identifier for database.

156

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry ORCLSID?=System identifier for database Description Specifies the SID (System Identifier) for the Oracle database to back up. Change ? to the same number used to identify the selection for the Oracle server. In the following example, SERVER_NAME is an Oracle server name, and it is the same server in all of the selections. To back up the databases SID1 and SID2 on the Oracle server, the entries would be: ORCLSRV1=SERVER_NAME ORCLSID1=SID1 ORCLSRV2=SERVER_NAME ORCLSID2=SID2 SPPS2_FARMx=farm name Change x to the lowest number that is not already used, and specify the name of the Microsoft SharePoint 2003 Portal server farm that you want to back up. For example, SPPS2_FARM1=farm name. You should start with number 1 and continue sequentially. The order in which the farm names are specified is the order in which the farms will be backed up. SPPS2_WEBSERVERx=Web server name Specify the name of a Web server that belongs to the farm. Note This item is not required if the farm name is specified. SPPS2_CONFIGDBx=0 or 1 Enter 1 to include the Configuration database in the backup job; otherwise, enter 0 or leave it blank. Enter 1 to include the Single sign-on database in the backup job; otherwise, enter 0 or leave it blank.

SPPS2_SSOx=0 or 1

157

Using job script files Possible backup job script file entries (continued) Section Entry SPPS2_DLSx=0 or 1 Description Enter 1 to include the Document Library store in the backup job; otherwise, enter 0 or leave it blank. Specify the name of the portal site belongs to the farm. Since each farm may have more than one portal, you must use the same format that you specify for SPPS2_FARMx. For example: SPPS2_FARM1=farm name SPP2_PORTAL1NAME1=portal1 SPP2_PORTAL1NAME2=portal2 SPPS2_TEAM_SITExNAMEy=Windows SharePoint services site name Specify the name of the Windows SharePoint services site that belongs to the farm. Since each farm may have more than one Windows SharePoint services site, you must use the same format that you specify for SPPS2_FARMx. For example: SPPS2_FARM1=farm name SPP2_TEAM_SITE1NAME1=team site1 SPP2_TEAM_SITE1NAME2=team site2 SPPS2_DOC_SITExNAMEy=document libary Specify the name of the backward compatible document library that belongs to the farm. Since each farm may have more than one document library, you must use the same format that you specify for SPPS2_FARMx. For example: SPPS2_FARM1=farm name SPP2_DOC_SITE1NAME1=document libary1 SPP2_DOC_SITE1NAME2=document library2

SPPS2_PORTALxNAMEy=portal site name

158

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry APATHx=String Description Specify which files or directories are backed up and aliased when running an alias backup. The order in which resource selections are specified is the order in which the resources will be backed up. Change x to a unique number for each device aliasing backup selection. An alias backup allows you to specify a share to back up, and then specify another share from which the backup will appear to have originated. This type of backup is useful when the location of the data to be backed up is temporary. For example, a share may be cloned and placed on another device while it is backed up in order to off-load traffic from a busy device. If a temporary share is backed up, the restore path for the share may not exist if a restore becomes necessary. Instead, you can specify an alias to a location where you want the share to appear to have been backed up from. For example: APATH1=\\MachineA\C$\*.* AINCLUDE1=1 ASUBDIRS1=1 AALIAS1=\\MachineB\D$ indicates that \\MachineA\C$\*.* and all its subdirectories should be backed up and aliased as \\MachineB\D$. Alias jobs support both UNC and local devices. However, both the target and the source must be the same, either both UNC or both local devices. You cannot mix them. Note The schedule option RUN_IMMEDIATE=1 must be included or the alias selection will be ignored.

159

Using job script files Possible backup job script file entries (continued) Section Entry AINCLUDEx=0 or 1 Description Enter 1 to include this item in the backup job when running an alias backup; otherwise, enter 0. Change x to a unique number for each alias backup selection. ASUBDIRSx=0 or 1 Enter 1 to include all subdirectories when running an alias backup; otherwise, enter 0. Change x to a unique number for each device aliasing backup selection. AALIASx=String Specify the share from which the backup will appear to have originated, when running an alias backup. Change x to a unique number for each device aliasing backup selection. For example: AALIAS1=\\MachineB\D$ See also the example for APATHx=String [Media_server] PREFERRED_SERVER_NAME=Media server name This operation is only available if the Central Admin Server Option (CASO) is installed. Specify the preferred media server on which backup jobs run. PREFERRED_SERVER=Media server GUID This operation is only available if the Central Admin Server Option (CASO) is installed. Specify the GUID for the preferred media server on which backup jobs run.

160

Symantec Backup Exec Command Line Applet

Using job script files Possible backup job script file entries (continued) Section Entry MEDIA_SERVER_POOL_NAME=Media server pool name Description This operation is only available if the Central Admin Server Option (CASO) is installed. Specify the media server pool to use for the backup job. MEDIA_SERVER_POOL=Media server pool GUID This operation is only available if the Central Admin Server Option (CASO) is installed. Specify the media server pool to use for the backup job.

161

Using job script files

Creating a restore job script file

Use a text editor, such as Notepad, to create a restore job script file that contains entries for the restore job options. The restore job script file has similar entries, or values, as those used in the backup job script file. Sections of a Restore Job Script include:

[General] [Restore_Options] [Selections] [Schedule]

Each entry included in the restore job script file must be typed in capital letters and immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. For example, to specify in the script that the job name is Workstation Restore and the job type is restore, the script file would appear as: [General] JOB_TYPE=Restore JOB_NAME=Workstation Restore All possible entries for a restore job script file are described in the following table. When creating a script file, do not include all entries Note The Job History GUID is required for bemcmd -o90 restores. To obtain the Job History GUID, first use -o23 and /or -o506 to obtain the Job Instance GUID. Then use the Job Instance GUID with -o21 to obtain the Job History GUID.
Possible restore job script file entries Section [General] JOB_TYPE=Job type This field must be completed with a value of Restore. Type the name of the restore job. Type the name of the media server where the operation is to be performed. If a server is not specified, the local server is used by default. Entry Description

JOB_NAME=Job name SERVER=Server name

162

Symantec Backup Exec Command Line Applet

Using job script files Possible restore job script file entries (continued) Section Entry USERNAME=User name Description Type the user name for logging into the system being restored. If a user name is not specified, the current user name is used. Type the password for logging into the system being restored. If a password is not specified, the current password is used. Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority set determines which job runs first. If a priority is not entered, the priority will be Medium. Options are:

PASSWORD=Password

JOB_PRIORITY=Priority

Lowest Low Medium High Highest

[Restore Options] RESTORE_CORRUPT_FILES=0 or 1 Enter 1 if you do not want Backup Exec to automatically exclude corrupt files from the restore process; otherwise, enter 0. Enter a number to specify how Backup Exec should treat existing files: 0 = Skip if file exists 1 = Restore over existing 3 = Skip if existing file is more recent

RESTORE_EXISTING=0, 1, or 3

163

Using job script files Possible restore job script file entries (continued) Section Entry RESTORE_SECURITY=0 - 2 Description Enter a number from 0 through 2 to specify the security information:

0 = Restore all information for files and directories 1 = Restore file level security 2 = Restore all information except security for files and directories

RESTORE_PRESERVE=0 or 1

Enter 1 to restore the data with its original directory structure intact. Enter 0 to restore all data (including the data in subdirectories) to the path specified in SHARE_REDIRECT_PATH. Type the name of the device, such as a drive or backup-to-disk folder, containing the data to be restored. Type a destination drive, other than where the data was originally backed up, to which the data is to be restored. Type the target path on the drive specified in SHARE_REDIRECT_DRIVE. To retain the original directory structure, make sure that the value for RESTORE_PRESERVE=1.

DEVICE_NAME=Device name

SHARE_REDIRECT_DRIVE=Drive letter

SHARE_REDIRECT_PATH=Path name

SHARE_REDIRECT_SERVER_ ACCOUNT=GUID

Type the GUID of the Backup Exec logon account to use to access the SharePoint data. To obtain the GUID, use operation -o211 to display the logon account information. Type the GUID of the Backup Exec logon account to use to access the path to which you want to redirect the restore. To obtain the GUID, use operation -o211 to display the logon account information.

SHARE_REDIRECT_PATH_ ACCOUNT=GUID

164

Symantec Backup Exec Command Line Applet

Using job script files Possible restore job script file entries (continued) Section Entry SQL_REDIRECT_SERVER= SQL Server name Description If you are redirecting SQL data, type the name of the SQL server where the data is to be restored. If you are redirecting SQL data to a named instance, specify the instance name. Otherwise, the data is restored to the default instance. If you are redirecting this restore to a different database on the target server, specify the target database name. If you are restoring a differential or log backup, and the associated database backup was restored to a renamed database, the new database name must be entered. Type the GUID of the Backup Exec logon account that stores the credentials of a Windows user account. The Windows user account must have been granted the System Administrator role on the SQL instance. To obtain the GUID, use operation -o211 to display the logon account information. Type the GUID of the Backup Exec logon account that stores the credentials of the SQL user account if you are using SQL Server Authentication. To obtain the GUID, use operation -o211 to display the logon account information. If you are redirecting Exchange data, specify the Exchange server where the data is to be restored.

SQL_REDIRECT_INSTANCE= Instance name

SQL_REDIRECT_DATABASE= Database name

SQL_REDIRECT_SERVER_ ACCOUNT=GUID

SQL_REDIRECT_ ACCOUNT=GUID

XCH_REDIRECT_SERVER=Exchange Server name

165

Using job script files Possible restore job script file entries (continued) Section Entry XCH_REDIRECT_SERVER_ ACCOUNT=GUID Description Type the GUID of the Backup Exec logon account that stores the credentials of a Windows user account. To obtain the GUID, use operation -o211 to display the logon account information. If you are redirecting an Exchange mailbox, specify the name of the target mailbox. The mailbox must already exist before you can restore to it. Type the GUID of the logon account that has rights to the target mailbox. To obtain the GUID, use operation -o211 to display the logon account information. Specify whether server sets or document sets are being restored. Enter the name of the local drive or the UNC path to which you want to redirect the restore. If you type a UNC path, use the format server name\share name. Type the folder location on the drive to which you want to redirect the restore. Type the name of the computer to which you want to redirect the restore. Use the format \\server name. Type the name of the workspace to which you want to redirect the restore. Note You must type an entry in this field, even if you are restoring the data to the original workspace. You cannot redirect the restore to a different folder in the workspace.

XCH_REDIRECT_MAILBOX=Exchange mailbox name

XCH_REDIRECT_MAILBOX_ ACCOUNT=GUID

SP_REDIRECT_SETS_SERVER= Server/Documents SP_REDIRECT_DRIVE=Drive name

SP_REDIRECT_PATH=Path

SP_REDIRECT_SERVER=\\server name

SP_REDIRECT_WORKGROUP= Workspace name

166

Symantec Backup Exec Command Line Applet

Using job script files Possible restore job script file entries (continued) Section Entry SP_REDIRECT_SERVER_ ACCOUNT=GUID Description Type the GUID of the Backup Exec logon account to use it to access the SharePoint data. To obtain the GUID, use operation -o211 to display the logon account information. Enter 1 to restore the Removable Storage database; otherwise, enter 0. Enter 1 to restore disk quota data; otherwise, enter 0. Disk quotas track and control disk usage on a per user, per volume basis; the values can be restored to the limits that were set before the backup. Enter 1 to restore the Terminal Services database, which contains licensing data for client licenses; otherwise, enter 0. Enter 1 to restore the Windows Management Instrumentation (WMI) respository, which provides support for monitoring and controlling system resources and provides a consistent view of your managed environment; otherwise, enter 0. Enter 1 to restore the cluster configuration; otherwise, enter 0. Enter 1 to force the recovery of the cluster quorum even if other nodes are online the and/or disk signatures do not match option; otherwise, enter 0.

RESTORE_RSM_DATA=0 or 1

RESTORE_DISK_QUOTA=0 or 1

RESTORE_TERMINAL_SERVICES= 0 or 1

RESTORE_WMI=0 or 1

RESTORE_CLUSTER_DB=0 or 1

RESTORE_FORCE_RECOVERY= 0 or 1

167

Using job script files Possible restore job script file entries (continued) Section Entry RESTORE_PRIMARY_REPLICA=0 or 1 Description Enter 1 if all the domain controllers in the domain are being restored and you want to designate this server as the primary arbitrator. If you enter 0, replication may not function. Use this option when you perform a restore of a domain controller in a domain that does not have any other domain controllers. RESTORE_REGISTRY=0 or 1 Enter 1 to restore registry information if it exists in the selected data; otherwise, enter 0. Enter 1 to merge existing hardware configuration and registry services with the data to be restored when restoring registry information; otherwise, enter 0. Enter 1 to preserve existing junction points and restore files and directories from backup media. Enter 0 to restore junction points, files and directories from backup media. Specify a .exe or batch file command to run on the media server before the restore operation starts. Specify a .exe or batch file command to run after the restore operation completes. Enter 1 to execute the post-job command only if the pre-job command is successful; otherwise, enter 0. Enter 1 to execute the job only if the pre-job command is successful; otherwise, enter 0.

RESTORE_PNP_MERGE=0 or 1

RESTORE_JUNCSASDIRS=0 or 1

PRE_JOB_COMMAND=Command

POST_JOB_COMMAND=Command

COMMAND_RUN_POST_IF_ PRE_SUCCESS=0 or 1

COMMAND_RUN_JOB_IF_PRE_SUCCESS= 0 or 1

168

Symantec Backup Exec Command Line Applet

Using job script files Possible restore job script file entries (continued) Section Entry COMMAND_RUN_POST_ IF_JOB_FAILS=0 or 1 Description Enter 1 to execute the post-job command even if the job fails; otherwise, enter 0. Enter 1 to allow the pre- and post-job commands to be successful only if completed with a return code of zero. Otherwise, enter 0. An return code of zero returned to the operating system by the pre- or post-job command is interpreted by Backup Exec to mean the job completed successfully. A non-zero return code is interpreted by Backup Exec to mean the job ended with an error. After checking the return codes, Backup Exec continues processing according to selections you made for running the pre- and post-job commands. If you enter 0, the success of the preand post-job commands is not determined based on the return code. COMMAND_AUTO_CANCEL_ TIME=# Enter the number of minutes Backup Exec should wait before cancelling a command that did not complete. Enter 0 to run the command on this media server or 1 to run the command on each server being restored to. Enter one of the following values for recovering the database:

COMMAND_FAIL_JOB_IF_FAILS= 0 or 1

COMMAND_RUN_OPTION=0 or 1

SQL_DATABASE_RECOVER=0 - 3

0 = Create a standby database 1 = Recover the database 2 = Do not recover the database

169

Using job script files Possible restore job script file entries (continued) Section Entry SQL_REPLACE_DATABASE=0 or 1 Description Enter 1 to replace a database or file group, even if another database or filegroup with the same name already exists on the server; otherwise, enter 0. Enter 1 to enable Backup Exec to stop SQL so that the master can be restored; otherwise, enter NO. If you enter 1, all existing users are logged off, and the master is put into single-user mode. SQL_POSTRESTORE_DBCC=0 - 3 Enter one of the following values for performing a consistency check after restore:

SQL_AUTOMASTER=0 or 1

0 = None 1 = Full check, excluding indexes 2 = Full check, including indexes 3 = Physical check only

SQL_DEFAULT_DRIVE=Drive letter

Enter the drive letter for an alternate drive to which SQL database files will be restored. Enter 1 to restore all SQL Server database files to the alternate drive specified in SQL_DEFAULT_DRIVE even if the drive where they originally resided exists. Enter 0 to restore SQL database files to the alternate drive specified in SQL_DEFAULT_DRIVE only when the drive where they originally resided does not exist.

SQL_USE_ALLDEFAULT=0 or 1

SQL_USE_DEFAULT_INSTDIR=0 or 1

Enter 1 to restore all database files to the target instances data location; otherwise, enter 0.

170

Symantec Backup Exec Command Line Applet

Using job script files Possible restore job script file entries (continued) Section Entry SQL_POINTINTIME=MM/DD/YYYY, HH:MM:SS Description Enter the date and time to restore transactions for a transaction log up to and including a point in time in the transaction log. After the point in time, recovery from the transaction log is stopped. Enter the named transaction to include in the recovery of the transaction log. Recovery will be stopped after this named transaction is restored. Enter 1 to restore transactions from a transaction log up to a named transaction in the transaction log. After the named transaction, recovery from the transaction log is stopped. Otherwise, enter 0.

SQL_LOGMARK_NAME=Named transaction

SQL_LOGMARK_INCLUDE=0 or 1

SQL_LOGMARK_TIME=MM/DD/YYYY,HH: Enter the date and time after which MM:SS the restore operation is to search for the named transaction. SPPS2_RECNT_DB_ON_ RESTORE=0 or 1 SPPS2_RECONNECT=0 or 1 Enter 1 to bring the databases online after a restore job; otherwise, enter 0. Enter 1 to re-establish the link between the restored databases and their corresponding sites; otherwise, enter 0. Enter 1 to release the lock on the SharePoint farm topology before restoring data; otherwise, enter 0. Enter 1 if you are restoring Exchange data and want Backup Exec to automatically recreate user accounts and mailboxes; otherwise, enter 0.

SPPS2_RELEASE_LOCK=0 or 1

XCH_AUTOCREATE_MAILBOX=0 or 1

171

Using job script files Possible restore job script file entries (continued) Section Entry XCH_OVERWRITE=0 or 1 Description Enter 1 if you are restoring Exchange data and you want Backup Exec to overwrite an existing item with the message or folder. A new object ID is not created for the message or folder; only the contents and properties are replaced. Otherwise, enter 0. Enter 1 to preserve the existing transaction logs on the Exchange 2000 or later server. Enter 0 to purge some or all of the existing transaction logs, depending on the value of ESE_RECOVERY_POINTINTIME. If you enter 1, transaction logs from the storage media are then restored and added to the existing set of transaction logs on the Exchange server. When the restore operation finishes, Exchange automatically updates its databases with the uncommitted transactions found in the existing and newly-restored transaction logs. This option is selected by default.

ESE_NOLOSS_RESTORE=0 or 1

172

Symantec Backup Exec Command Line Applet

Using job script files Possible restore job script file entries (continued) Section Entry Description

ESE_RECOVERY_POINTINTIME=MM/DD/Y Enter a date and time to restore YYY,HH:MM:SS Exchange 2000 and later transactions from the transaction log. Transaction logs after this time are skipped. Transactions up to and including this date and time are restored provided all of the following conditions are met:

The ESE_NOLOSS_RESTORE value is set to 0. The backup set that is being restored is from a continuous protection backup. The value is a valid date and time.

Note If the ESE_NO_LOSS_RESTORE value is set to 0 but the other conditions are not met, the value of ESE_RECOVERY_POINTINTIME is ignored and a loss restore job runs.

173

Using job script files Possible restore job script file entries (continued) Section Entry ESE_TEMPLOG_PATH=Path Description Enter a location where the associated log and patch files are to be kept until the database is restored. The default location is \temp. If storage groups are being restored, a subdirectory in \temp is created for each storage group. The log and patch files for each storage group are kept in the corresponding subdirectory. After the Exchange 2000 or later database is restored, the log and patch files in the temporary location are applied to the database, and then the current log files are applied. After the restore is complete, the log and patch files are automatically deleted from the temporary location (including any subdirectories). Make sure the temporary location for log and patch files is empty before you start a restore job. If a restore job fails, check the temporary location (including subdirectories) to make sure any previous log and patch files from a previous restore job were deleted. ESE_COMMIT_AFTER=0 or 1 Enter 1 to enable the Exchange 2000 or later restore operation to replay log files and roll back any uncompleted transactions if your selection contains the last backup set to be restored. If you enter 0, the database is left in an intermediate state and is not yet usable. If this option is selected when an intermediate backup is being applied, you cannot continue to restore backups. You must restart the restore operation from the beginning.

174

Symantec Backup Exec Command Line Applet

Using job script files Possible restore job script file entries (continued) Section Entry ESE_MOUNT_AFTER=0 or 1 Description Enter 1 to mount the Exchange 2000 or later database so that it is available to users; otherwise, enter 0. This checkbox is only available if EXE_LASTSET is set to 1. Enter 1 to automatically take the Exchange 2000 or later database offline before the restore job runs; otherwise, enter 0. Specify the number of seconds for the restore process to wait for a database that is in use. When a Lotus database is restored it must first be taken offline. This will ensure that the database is not being accessed, closed, or deleted while the restore operation is being processed. If the database is still in use and cannot be taken offline after the specified wait time, the restore will fail. Enter one of the following options for recovering a Lotus Domino database:

ESE_DISMOUNT_BEFORE=0 or 1

LOTUS_WAIT_MSECS=x

LOTUS_DBRECOVER_OPTION=0 - 3

0 = Retain original IDs 1 = Assign new database IDs 2 = Assign new database IDs and replica IDs

LOTUS_POINTINTIME=MM/DD/YYYY,HH: Enter a date and time from which to MM:SS restore the Lotus Domino database. RESTORE_VOL_RESTRICT=0 or 1 Enter 1 if you are restoring NetWare data and want to restore volume restrictions; otherwise, enter 0.

175

Using job script files Possible restore job script file entries (continued) Section Entry NIC_ENABLED=0 or 1 Description Enter 1 to use the MAC address specified with the NIC_ADDRESS entry, or the name specified with the NIC_NAME entry. Enter 0 to clear previous settings for the network interface, and to use any available network adapter. Operations for displaying network interface information on page 85 NIC_ADDRESS=00-00-00-00-00-00 Enter the Media Access Control (MAC) address for the network interface you selected. To use this setting, NIC_ENABLED must be set to 1. NIC_NAME=name Type the name of a network interface card when NIC_ENABLED=1. Enter 0 to use any available Internet Protocol. Enter 1 to use IPv4. Enter 2 to use IPv6. Operations for displaying network interface information on page 85 NIC_SUBNET_ENABLED=0 or 1 Enter 0 to use any available subnet prefix. Enter 1 to use a specific subnet prefix. Specify a subnet prefix when NIC_ENABLED=1 and NIC_SUBNET_ENABLED=1. Enter 1 to use any available network interface card. Enter 0 to use only the network interface card that you specify.

NIC_PROTOCOL=0 - 2

NIC_SUBNET=00.000.00.000

NIC_ANY_AVAILABLE=0 or 1

176

Symantec Backup Exec Command Line Applet

Using job script files Possible restore job script file entries (continued) Section [Selections] JOBHISTORY_GUID=Job History GUID Required or SELECTIONx is required. Specifies the GUID of the backup job that has already run. To obtain the Job History GUID, first use -o23 and /or -o506 to obtain the Job Instance GUID. Then use the Job Instance GUID with -o21 to obtain the Job History GUID. SELECTIONx=file selection to restore Required or JOBHISTORY_GUID is required. Specifies the file selection to restore. If you specify the file selection, use the following format: \\machinename\path1\file1+file2+ file3|path2\filex+filey+filez Note You must use the SELECTIONx to restore encrypted backup jobs. START_DATE=MM/DD/YYYY Specifies the earliest date range to perform a point-in-time restore. Enter the start date in MM/DD/YYYY format for this job. END_DATE=MM/DD/YYYY Specifies the latest date range to perform a point-in-time restore. Enter the end date in MM/DD/YYYY format for this job. [Schedule] SCHED_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format. Entry Description

SCHED_ENDTIME=HH:MM:SS

177

Using job script files Possible restore job script file entries (continued) Section Entry SCHED_RESTART_INTERVAL=HH:MM:SS Description Enter the interval in HH:MM:SS format for the job to restart on each run day. For example, if you have set the job up to run every seven days, you can also set it up to run every four hours on its run day by entering SCHED_RESTART_INTERVAL=04:00:0 0. Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date in MM/DD/YYYY format the interval is calculated from. Enter the date in MM/DD/YYYY format that the schedule becomes effective. Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x In a comma delimited string, enter the day of the week, a forward slash, and the week of the month you want the job to run. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3

SCHED_REPEAT_INTERVAL=X

SCHED_ANCHOR=MM/DD/YYYY

SCHED_EFFECTIVE=MM/DD/YYYY

SCHED_DAYSOFMONTH=x

178

Symantec Backup Exec Command Line Applet

Using job script files Possible restore job script file entries (continued) Section Entry SCHED_INCLUDEDATEx=MM/DD/YYYY Description Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, if you want the job to run the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, if you do not want the job to run on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in MM/DD/YYYY format. Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter a value of 1 if the job is to run immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set, the default value is 1. HOLD=0 or 1 Enter 1 as the value if you want to schedule the job on hold; otherwise, enter 0.

TIME=hh:mm:ss

179

Using job script files Possible restore job script file entries (continued) Section Entry AUTO_CANCEL_TIME=# Description Enter the number of minutes after which the job is canceled if it is not completed. Backup Exec starts timing the job when the job is queued, not when the job begins. Enter a number from 0 to 2 that corresponds to job deletion. Options include:

DELETE_JOB_AFTER=0 - 3

0 = Do not delete the job 1 = Delete the job after the job completes 2 = Delete the job if the job successfully completes

180

Symantec Backup Exec Command Line Applet

Using job script files

Creating a catalog job script file

Use a text editor, such as Notepad, to create a catalog job script file that contains entries for the catalog job options. The catalog job script file has similar entries, or values, as those used in the other job script file. Sections of a Catalog Job Script include:

[General] [Catalog_Options] [Schedule]

Each entry included in the catalog job script file must be typed in capital letters and immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. For example, to specify in the script that the job name is Workstation Catalog and the job type is catalog, the script file would appear as: [General] JOB_TYPE=Catalog JOB_NAME=Workstation Catalog All possible entries for a catalog job script file are described in the following table. When creating a script file, do not include all entries.
Possible catalog job script file entries Section [General] JOB_TYPE=Job type This entry must be completed with a value of Catalog. Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Options are:

Entry

Description

JOB_PRIORITY=Priority

Lowest Low Medium High Highest

181

Using job script files Possible catalog job script file entries (continued) Section Entry JOB_NAME=Job name Description Type the name of the catalog job. If a name is not provided, one will automatically be generated. Type the name of the Backup Exec server where the operation is to be performed. If a server is not specified, the local server is used by default. Type the user name for logging into a remote Backup Exec server. If a user name is not specified, the current user name is used. Enter the password for logging into a remote Backup Exec server. If a password is not specified, the current password is used.

SERVER=Server name

USERNAME=Username

PASSWORD=Password

[Catalog_Options] MEDIA_ID=Media ID Specifies the ID of the media to be cataloged. The format of the media ID should be in the following format: MEDIA_ID={GUID} MEDIA_PASSWORD=Media password If the media has a password, specify the password.

[Schedule] SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in MM/DD/YYYY format, that the schedule becomes effective. Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format.

SCHED_STARTTIME=HH:MM:SS

SCHED_ENDTIME=HH:MM:SS

182

Symantec Backup Exec Command Line Applet

Using job script files Possible catalog job script file entries (continued) Section Entry SCHED_RESTART_INTERVAL=HH:MM:SS Description Enter the interval in HH:MM:SS format for the job to restart on each run day. For example, if you have set up the job to run every seven days, you can also set it up to run every four hours on its run day by entering SCHED_RESTART_INTERVAL=04:00:0 0. Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date, in MM/DD/YYYY format, from which the interval is calculated. Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3

SCHED_REPEAT_INTERVAL=x

SCHED_ANCHOR=MM/DD/YYYY

SCHED_DAYSOFMONTH=x

183

Using job script files Possible catalog job script file entries (continued) Section Entry SCHED_INCLUDEDATEx=MM/DD/YYYY Description Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in MM/DD/YYYY format. If schedule values are not entered, then the DATE==MM/DD/YYYY and TIME=hh:mm:ss entries will be used to set the Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter 1 to run the catalog job immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section.If no other scheduling options have been selected and this entry is not set, the default value is 1.

TIME=hh:mm:ss

184

Symantec Backup Exec Command Line Applet

Using job script files Possible catalog job script file entries (continued) Section Entry AUTO_CANCEL_TIME=# Description Enter the number of minutes after which the job is canceled if it is not completed. Backup Exec starts timing the job when the job is queued, not when the job begins. To specify hours, enter a value divisible by 60. Enter 1 if you want the job to be submitted on hold; otherwise, enter 0. Enter a number from 0 to 2 that corresponds to job deletion. Options include:

HOLD=0 or 1

DELETE_JOB_AFTER=0 - 2

0 = Do not delete the job 1 = Delete the job after the job completes 2 = Delete the job if the job successfully completes

185

Using job script files

Creating a discovery job script file

Use a text editor, such as Notepad, to create a discovery job script file that contains entries for the discovery job options. The discovery job script file has similar entries, or values, as those used in the other job script file. Sections of a Discovery Job Script include:

[General] [Discovery_Options] [Selections] [Schedule]

Each entry included in the discovery job script file must be typed in capital letters and immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. For example, to specify in the script that the job name is Workstation Resource Discovery and the job type is discovery, the script file would appear as: [General] JOB_TYPE=Discovery JOB_NAME=Workstation Resource Discovery All possible entries for a discovery job script file are described in the following table. When creating a script file, do not include all entries.
Possible discovery job script file entries Section [General] JOB_TYPE=Job type This entry must be completed with a value of Discovery. Entry Description

186

Symantec Backup Exec Command Line Applet

Using job script files Possible discovery job script file entries (continued) Section Entry JOB_PRIORITY=Priority Description Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Options are:

Lowest Low Medium High Highest

JOB_NAME=Job name

Type the name of the discovery job. If a name is not provided, one will automatically be generated. Type the name of the Backup Exec server where the operation is to be performed. If a server is not specified, the local server is used by default. Type the user name for logging into a remote Backup Exec server. If a user name is not specified, the current user name is used. Enter the password for logging into a remote Backup Exec server. If a password is not specified, the current password is used.

SERVER=Server name

USERNAME=Username

PASSWORD=Password

[Discovery_Options] DISCOVER_ADMINISTRATIVE_SHARES=0 Enter 1 to have Backup Exec search for or 1 new administrative network shares or volumes; otherwise, enter 0. DISCOVER_USER_SHARES=0 or 1 Enter 1 to have Backup Exec search for new user-defined shares; otherwise, enter 0.

187

Using job script files Possible discovery job script file entries (continued) Section Entry DISCOVER_SQL_DATABASES=0 or 1 Description Enter 1 to have Backup Exec search for new SQL databases; otherwise, enter 0. Enter 1 to have Backup Exec search for new Exchange databases; otherwise, enter 0. Backup Exec searches for Information Store, Exchange Directory, or Storage Groups; it does not discover individual databases under storage groups. DISCOVER_DOMINO_DATABASES=0 or 1 Enter 1 to have Backup Exec search for new Lotus Domino databases; otherwise, enter 0. DISCOVER_SYSTEMSTATE=0 or 1 Enter 1 to have Backup Exec search for new System State resources; otherwise, enter 0. Enter 1 to have Backup Exec search for new SharePoint servers; otherwise, enter 0. Enter 1 to have Backup Exec send separate notifications when each new resource is found; otherwise, enter 0. Enter 1 to have Backup Exec send a notification that includes all resources previously found during resource discovery jobs; otherwise, enter 0.

DISCOVER_EXCHANGE_DATABASES=0 or 1

DISCOVER_SHAREPOINT=0 or 1

NOTIFY_SEPARATE=0 or 1

NOTIFY_INCLUDE_PREVIOUS=0 or 1

188

Symantec Backup Exec Command Line Applet

Using job script files Possible discovery job script file entries (continued) Section [Selections] DOMAINx Specifies the domains you want Backup Exec to search for new resources. You can also specify the logon account GUID for the domain. If logon account credentials are not entered, the current logged on users default logon account is used. Each entry must be comma delimited string. For example, DOMAIN1, DOMAIN2 or DOMAIN1=domain1, {10011001-1001-1001-0101-01010101 01} EXCLUDEx Specifies the domains you want to exclude from the discovery job. If you specify multiple domains, the list must be in a comma delimited string. Entry Description

[Schedule] SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in MM/DD/YYYY format, that the schedule becomes effective. Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format. Enter the interval in HH:MM:SS format for the job to restart on each run day. For example, if you have set up the job to run every seven days, you can also set it up to run every four hours on its run day by entering SCHED_RESTART_INTERVAL=04:00:0 0.

SCHED_STARTTIME=HH:MM:SS

SCHED_ENDTIME=HH:MM:SS

SCHED_RESTART_INTERVAL=HH:MM:SS

189

Using job script files Possible discovery job script file entries (continued) Section Entry SCHED_REPEAT_INTERVAL=x Description Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date, in MM/DD/YYYY format, from which the interval is calculated. Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002

SCHED_ANCHOR=MM/DD/YYYY

SCHED_DAYSOFMONTH=x

190

Symantec Backup Exec Command Line Applet

Using job script files Possible discovery job script file entries (continued) Section Entry SCHED_EXCLUDEDATEx=MM/DD/YYYY Description Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in MM/DD/YYYY format. If schedule values are not entered, then the DATE==MM/DD/YYYY and TIME=hh:mm:ss entries will be used to set the Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter 1 to run the discovery job immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set, the default value is 1. AUTO_CANCEL_TIME=# Enter the number of minutes after which the job is canceled if it is not completed. Backup Exec starts timing the job when the job is queued, not when the job begins. To specify hours, enter a value divisible by 60. Enter 1 if you want the job to be submitted on hold; otherwise, enter 0.

TIME=hh:mm:ss

HOLD=0 or 1

191

Using job script files

Creating a duplicate backup job script file

Use a text editor, such as Notepad, to create a duplicate backup job script file that contains entries for the duplicate backup job options. The duplicate backup job script file has similar entries, or values, as those used in the other job script file. Sections of a Duplicate Backup Job Script include:

[General] [Setcopy_Options] [Selections] [Schedule]

Each entry included in the duplicate backup job script file must be typed in capital letters and immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. For example, to specify in the script that the job name is Workstation Duplicate Backup and the job type is setcopy, the script file would appear as: [General] JOB_TYPE=SetCopy JOB_NAME=Workstation Duplicate Backup All possible entries for a duplicate backup job script file are described in the following table. When creating a script file, do not include all entries.
Possible duplicate job script file entries Section [General] JOB_TYPE=Job type This entry must be completed with a value of Setcopy. Entry Description

192

Symantec Backup Exec Command Line Applet

Using job script files Possible duplicate job script file entries (continued) Section Entry JOB_PRIORITY=Priority Description Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Options are:

Lowest Low Medium High Highest

JOB_NAME=Job name

Type the name of the duplicate job. If a name is not provided, one will automatically be generated. Type a description of the information you are backing up. Enter the GUID of the device used as the destination device for the original backup job. Use operation -o63 to display managed drives. Type the name of the Backup Exec server where the operation is to be performed. If a server is not specified, the local server is used by default. Type the user name for logging into a remote Backup Exec server. If a user name is not specified, the current user name is used. Enter the password for logging into a remote Backup Exec server. If a password is not specified, the current password is used.

JOB_DESCRIPTION=Description

PREFERRED_SOURCE_DEVICE_GUID= Source device guid

SERVER=Server name

USERNAME=Username

PASSWORD=Password

193

Using job script files Possible duplicate job script file entries (continued) Section Entry Description

[Setcopy_Options] DEVICE_NAME=Device name Type the name of the device to be used for the duplicate job. Enter the GUID of the media set to be used for the duplicate job. Use operation -o69 to display media sets. Enter 1 as the value if you want Backup Exec to overwrite the media; otherwise, enter 0. Enter 1 to append this backup to the media set. If there is no appendable media available, the job is appended to overwritable media that will then be added to the media set; otherwise enter 0. Enter 1 to append to this backup to the media set. If there is no appendable media available, the job is terminated; otherwise, enter 0.

MEDIA_SET_GUID=Media set GUID

OVERWRITE_MEDIA=0 or 1

APPEND_OVERWRITE=0 or 1

APPEND_TERMINATE=0 or 1

EJECT _MEDIA_AFTER_COMPLETES=0 or Enter 1 to have Backup Exec 1 automatically eject the media in the drive when the operation completes. CHECKSUM=0 or 1 Enter 1 as the value if checksums are to be calculated for each data stream written to tape, and then written in a separate stream immediately following the data stream. If 0 is entered as the value, backup performance may be improved, but there will be no way to verify the integrity of the data on the tape. Enter 1 to retension the media before backup; otherwise, enter 0.

RETENSION_MEDIA=0 or 1

194

Symantec Backup Exec Command Line Applet

Using job script files Possible duplicate job script file entries (continued) Section Entry MEDIA_PASSWORD=Media password Description If the media has a password, specify the password. Enter 1 to have Backup Exec automatically perform a verify operation to make sure the media can be read after the backup has been completed; otherwise, enter 0. Enter 1 to select hardware compression; otherwise, enter 0. Specify a name for the encryption key. Enter a number from 0 to 3 that corresponds with the type of encryption to use. Options are as follows:

AUTO_VERIFY=0 or 1

COMPRESSION_TYPE=0 or 1

ENCRYPTION_KEY_NAME=key name ENCRYPTION_TYPE=0 - 3

0 = None 1 = Software 2 = Hardware 3 = Hardware if available, otherwise software

If 2 or 3 are entered, the default encryption key must be 256-bit encryption. [Selections] JOBHISTORY_GUID=Job History GUID Specifies the backup job that has already run to obtain the Job History GUID, first use -o23 and /or -o506 to obtain the Job Instance GUID. Then use the Job Instance GUID with -o21 to obtain the Job History GUID. [Schedule] SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in MM/DD/YYYY format, that the schedule becomes effective.

195

Using job script files Possible duplicate job script file entries (continued) Section Entry SCHED_STARTTIME=HH:MM:SS Description Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format. Enter the interval in HH:MM:SS format for the job to restart on each run day. For example, if you have set up the job to run every seven days, you can also set it up to run every four hours on its run day by entering SCHED_RESTART_INTERVAL=04:00:0 0. Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date, in MM/DD/YYYY format, from which the interval is calculated. Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15

SCHED_ENDTIME=HH:MM:SS

SCHED_RESTART_INTERVAL=HH:MM:SS

SCHED_REPEAT_INTERVAL=x

SCHED_ANCHOR=MM/DD/YYYY

SCHED_DAYSOFMONTH=x

196

Symantec Backup Exec Command Line Applet

Using job script files Possible duplicate job script file entries (continued) Section Entry SCHED_DAYSOFWEEK=x Description Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in MM/DD/YYYY format. If schedule values are not entered, then the DATE==MM/DD/YYYY and TIME=hh:mm:ss entries will be used to set the

197

Using job script files Possible duplicate job script file entries (continued) Section Entry TIME=hh:mm:ss Description Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter 1 to run the duplicate backup job immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set, the default value is 1. AUTO_CANCEL_TIME=# Enter the number of minutes after which the job is canceled if it is not completed. Backup Exec starts timing the job when the job is queued, not when the job begins. To specify hours, enter a value divisible by 60. Enter 1 if you want the job to be submitted on hold; otherwise, enter 0. Enter a number from 0 to 2 that corresponds to job deletion. Options include:

HOLD=0 or 1

DELETE_JOB_AFTER=0 - 3

0 = Do not delete the job 1 = Delete the job after the job completes 2 = Delete the job if the job successfully completes

198

Symantec Backup Exec Command Line Applet

Using job script files

Creating a test run job script file

Use a text editor, such as Notepad, to create a test run backup job script file that contains entries for the test run job options. The test run backup job script file has similar entries, or values, as those used in the other job script file. Sections of a Test Run Job Script include:

[General] [TestRun_Options] [Schedule]

Each entry included in the test run job script file must be typed in capital letters and immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. For example, to specify in the script that the job name is Workstation Test Run and the job type is TestRun, the script file would appear as: [General] JOB_TYPE=TestRun JOB_NAME=Workstation Test Run All possible entries for a test run job script file are described in the following table. When creating a script file, do not include all entries..
Possible test run job script file entries Section [General] JOB_TYPE=Job type This entry must be completed with a value of TestRun. Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Options are:

Entry

Description

JOB_PRIORITY=Priority

Lowest Low Medium High Highest

199

Using job script files Possible test run job script file entries (continued) Section Entry JOB_NAME=Job name Description Type the name of the test run job. If a name is not provided, one will automatically be generated. Type the name of the Backup Exec server where the operation is to be performed. If a server is not specified, the local server is used by default. Type the user name for logging into a remote Backup Exec server. If a user name is not specified, the current user name is used. Enter the password for logging into a remote Backup Exec server. If a password is not specified, the current password is used.

SERVER-Server name

USERNAME=Username

PASSWORD=Password

[TestRun_Options] JOBINSTANCE_GUID=Job GUID Specifies the job ID of the existing job to use for the test run job. Enter 1 to verify that the logon account is correct for the resources being backed up; otherwise, enter 0. Enter 1 to test whether enough tape is available to complete the job; otherwise, enter 0. Note During the test run job, the number of scheduled jobs in the queue is not checked; therefore, jobs that are scheduled before the test run job may use the media that was available when the test run job was performed. MEDIA_CHECK=0 or 1 Enter 1 to test whether the media is online and overwritable for a trial run job; otherwise, enter 0.

CREDENTIALS_CHECK=0 or 1

MEDIA_CAPACITY_CHECK=0 or 1

200

Symantec Backup Exec Command Line Applet

Using job script files Possible test run job script file entries (continued) Section Entry JOBSIZE_METHOD=0 or 1 Description Enter 0 if you want to determine job size from a previous job history, or enter a 1 if you want to perform a pre-scan. Enter 1 to have the scheduled job placed on hold if any failures are detected during the test run; otherwise, enter 0.

HOLD_ON_FAILURE=0 or 1

[Schedule] SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in MM/DD/YYYY format, that the schedule becomes effective. Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format. Enter the interval in HH:MM:SS format for the job to restart on each run day. For example, if you have set up the job to run every seven days, you can also set it up to run every four hours on its run day by entering SCHED_RESTART_INTERVAL=04:00:0 0. Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date, in MM/DD/YYYY format, from which the interval is calculated.

SCHED_STARTTIME=HH:MM:SS

SCHED_ENDTIME=HH:MM:SS

SCHED_RESTART_INTERVAL=HH:MM:SS

SCHED_REPEAT_INTERVAL=x

SCHED_ANCHOR=MM/DD/YYYY

201

Using job script files Possible test run job script file entries (continued) Section Entry SCHED_DAYSOFMONTH=x Description Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002

202

Symantec Backup Exec Command Line Applet

Using job script files Possible test run job script file entries (continued) Section Entry DATE=MM/DD/YYYY Description Enter the start date for the job in MM/DD/YYYY format. If schedule values are not entered, then the DATE==MM/DD/YYYY and TIME=hh:mm:ss entries will be used to set the Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter 1 to run the test run job immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set, the default value is 1. AUTO_CANCEL_TIME=# Enter the number of minutes after which the job is canceled if it is not completed. Backup Exec starts timing the job when the job is queued, not when the job begins. To specify hours, enter a value divisible by 60. Enter 1 if you want the job to be submitted on hold; otherwise, enter 0. Enter a number from 0 to 2 that corresponds to job deletion. Options include:

TIME=hh:mm:ss

HOLD=0 or 1

DELETE_JOB_AFTER=0 - 3

0 = Do not delete the job 1 = Delete the job after the job completes 2 = Delete the job if the job successfully completes

203

Using job script files

Creating a copy job script file

Use a text editor, such as Notepad, to create a copy job backup job script file that contains entries for the copy job options. The copy job backup job script file has similar entries, or values, as those used in the other job script file. Sections of a Copy Job Script include:

[General] [Job] [Selection List] [Policy] [Login Account] [Configuration]

Each entry included in the copy job script file must be typed in capital letters and immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. For example, to specify in the script that the job name is Workstation Copy and the job type is Copy, the script file would appear as: [General] JOB_TYPE=Copy JOB_NAME=Workstation Copy All possible entries for a copy job script file are described in the following table. When creating a script file, do not include all entries..
Possible copy job script file entries Section [General] JOB_TYPE=Job type This entry must be completed with a value of Copy. Entry Description

[Job] JOB_NAME=Job name Type the name of the copy job. If a name is not provided, one will automatically be generated.

204

Symantec Backup Exec Command Line Applet

Using job script files Possible copy job script file entries (continued) Section Entry SERVERx=Server name Description Type the destination server where you want to copy the job. If a server is not specified, the local server is used by default. Type the login account name for logging into the destination server. If a user name is not specified, the current user name is used. Enter 1 as the value if you want Backup Exec to overwrite the job that has the same name; otherwise, enter 0. Enter 1 as the value if you want to overwrite a logon account that has the same account name; otherwise, enter 0.

LOGINACCOUNT_NAMEx=login account name

OVERWRITE_JOB=0 or 1

OVERWRITE_LOGIN_ACCOUNT=0 or 1

[Selection List] SELECTION_LIST_NAMEx=selection list name to be copied SERVERx=Server name Type the name of the selection list to be copied. Type the destination server where you want to copy the selection list. If a server is not specified, the local server is used by default. Type the login account name for logging into the destination server. If a user name is not specified, the current user name is used. Enter 1 as the value if you want to overwrite a selection list that has the same name; otherwise, enter 0.

LOGINACCOUNT_NAMEx=login account name

OVERWRITE_SELECTION=0 or 1

[Policy] POLICY_NAMEx=policy name to be copied Type the name of the policy to be copied.

205

Using job script files Possible copy job script file entries (continued) Section Entry SERVERx=Server name Description Type the destination server where you want to copy the policy. If a server is not specified, the local server is used by default. Type the login account name for logging into the destination server. If a user name is not specified, the current user name is used. Enter 1 as the value if you want to overwrite a policy that has the same name; otherwise, enter 0.

LOGINACCOUNT_NAMEx=login account name

OVERWRITE_POLICY=0 or 1

[Login Account ACCOUNT_NAMEx=login account name SERVERx=Server name Type the name of the logon account to be copied. Type the destination server where you want to copy the logon account. If a server is not specified, the local server is used by default. Enter 1 as the value if you want to overwrite a logon account that has the same name; otherwise, enter 0.

OVERWRITE_ACCOUNT=0 or 1

[Configuration] DEFAULT_JOB_OPTIONS=0 or 1 Enter 1 as the value if you want to overwrite the default job options; otherwise, enter 0. Enter 1 as the value if you want to overwrite the default schedule options; otherwise, enter 0. Enter 1 as the value if you want to overwrite the default error handling rules; otherwise, enter 0.

DEFAULT_SCHEDULE=0 or 1

ERROR_HANDLING _RULES=0 or 1

206

Symantec Backup Exec Command Line Applet

Using job script files Possible copy job script file entries (continued) Section Entry ALERT_CONFIGURATION=0 or 1 Description Enter 1 as the value if you want to overwrite the default alert options; otherwise, enter 0. Type the destination server where you want to copy the configuration information. If a server is not specified, the local server is used by default. Type the login account name for logging into the destination server. If a user name is not specified, the current user name is used.

SERVERx=Server name

LOGINACCOUNT_NAMEx=login account name

Saving and launching the job script file

After creating the job script file, save it as a plain text file. When launching the job script file, specify the directory where the file resides along with the filename. To launch a script file, type the following at the command prompt: bemcmd -o90 -f"drive letter\directory\script name" For example, suppose you created a directory for your scripts called Scripts and named a script for differential backups of workstations DIFFBKWORK. To launch this script with the verbose command, type: bemcmd -o90 -v -fc:\scripts\diffbkwork.txt

207

Using scripts and selection lists

Using scripts and selection lists

Selection lists provide a quick and easy way of selecting files that you back up often. After you choose devices, directories and files, you can save the selections as a selection list script that you can use in regularly scheduled operations or once-only operations. A sample selection script file (selectionscript.txt) is included in the UTILS directory on the installation DVD. To activate an entry in this sample file, delete the forward slashes (//) in the line. The selection list script is used with command -o220 to create a selection list.

Creating a selection list script file

Use a text editor, such as Notepad, to create a selection list script file that contains all data selections for the backup job. Each entry included in the selection list script file must be typed in capital letters and must be immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. All possible entries for a selection list script file are described in the following table. Do not include all entries in a script file.
Values for selection list script Section [Machine] MACHINEx=machine name,logon GUID Specify the logon account used to log on to remote machines and back up remote data and databases. [Selections] SCRIPT_PRIORITY=priority Enter the priority for the script. If a priority is not entered, the priority will be Medium. Options are:

Entry

Description

Lowest Low Medium High Highest

208

Symantec Backup Exec Command Line Applet

Using scripts and selection lists Values for selection list script (continued) Section Entry PATHx=String Description Specify which files or directories get backed up. For example, PATH1=\\Myserver\Myshare\Mydir\*. * The order in which resource selections are specified is the order in which the resources will be backed up. Please note the following about the order in which selections can be backed up:

You can order resources within a server, but you cannot alternate selections across servers. For example, you can select C: and D: from Server A followed by selections from Server B. However, you cannot order selections as C: from Server A and then C: from Server B and then D: from both servers. For any given server, system state or shadow copy components must be last.

To use a separate logon account for backup selections, type a comma after PATHx=string. Then, type the logon account that you want to use for that selection. INCLUDEx=0 or 1 Enter a value of 1 if you want to include this item in the backup job; otherwise, enter 0. Enter a value of 1 if you want to include all subdirectories; otherwise, enter 0. Change x to a unique number and specify the name of the Enterprise Vault Server to back up.

SUBDIRSx-0 or 1

EV_SERVERx=Enterprise Vault server name

209

Using scripts and selection lists Values for selection list script (continued) Section Entry EV_PREFIXx=Enterprise Vault selection prefix Description Change x to the unique number that corresponds to the Enterprise Vault Server that you want to back up. Then specify the Enterprise Vault selection prefix. Change x to the unique number that corresponds to the Enterprise Vault Server that you want to back up. Then specify the directory that contains the file that you want to back up. Change x to the unique number that corresponds to the Enterprise Vault server that you want to back up. Then specify the file that you want to back up. You can back up the following:

EV_DIRECTORYx=Enterprise Vault directory

EV_FILEx=Enterprise Vault file

Enterprise Vault sites Audit databases FSA Reporting databases Directory databases Monitoring databases

EXCHANGEx=Exchange Server name

Change x to a unique number and specify the name of the Exchange Server you want to back up.

210

Symantec Backup Exec Command Line Applet

Using scripts and selection lists Values for selection list script (continued) Section Entry EXCH2ROOTx=Exchange Server name Description Specifies the name of the Exchange server that contains this selection. Change x to a number that corresponds to the number of the selection. The selections must be in a sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. Each selection must specify at least the server name and the storage group. See the example in EXCH2DBx=Exchange Server database name. EXCH2SGx=Exchange Server storage Specifies the name of the Exchange group name Server storage group that you want to back up, or that contains the database you want to back up. Change x to the same number used to identify the selection for the Exchange Server. See the example in EXCH2DBx=Exchange Server database name.

211

Using scripts and selection lists Values for selection list script (continued) Section Entry EXCH2DBx=Exchange Server database name Description Specifies the name of the Exchange Server database you want to back up. Change x to the same number used to identify the selection for the Exchange Server and storage group. In the following example, SERVER_NAME is an Exchange server name, and it is the same server in all of the selections. The first selection backs up the First Storage Group, the second selection backs up the Mailbox database in the Second Storage Group, and the third selection backs up the Users database in the Second Storage Group. EXCH2ROOT1=SERVER_NAME EXCH2SG1=First Storage Group EXCH2ROOT3=SERVER_NAME EXCH2SG2=Second Storage Group EXCH2DB2=Mailboxes EXCH2ROOT3=SERVER_NAME EXCH2SG3=Second Storage Group EXCHDB3=Users EXCH2010_SERVERx=Exchange 2010 Server name Specifies the name of the Exchange 2010 server you want to back up. Change x to a unique number to identify the Exchange 2010 server. To back up an Exchange 2010 server, you should use either EXCH2010_SERVER or EXCH2010_DAG, but not both.

212

Symantec Backup Exec Command Line Applet

Using scripts and selection lists Values for selection list script (continued) Section Entry Description

EXCH2010_DAGx=Exchange 2010 Specifies the name of the Exchange Database Availability Group name 2010 Database Availability Group (DAG) you want to back up. Change x to a unique number to identify the DAG. To back up an Exchange 2010 Server, you should use either EXCH2010_SERVER or EXCH2010_DAG, but not both. EXCH2010_DBx=Exchange 2010 database name Specifies the name of the Exchange 2010 database that you want to back up. It refers to the Exchange 2010 server or Database Availability Group (DAG) that you want to back up. Change x to the unique number that corresponds to the Exchange 2010 server or DAG that you want to back up. EXCH2010_DB is required for Exchange 2010 backups. SQL2S?=SERVER_NAME Specifies the name of the SQL server that contains this selection. Change ? to a number that corresponds to the number of the selection. The selections must be in sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. See the example in SQL2NI?=SQL server named instance name.

213

Using scripts and selection lists Values for selection list script (continued) Section Entry Description

SQL2NI?=SQL server named instance Specifies the named instance on the name SQL server to back up. Change ? to the same number used to identify the selection for the SQL server. For example, to back up the named instance ONE, the named instance TWO, and the SQL server itself, the entries would be: SQL2S1=SERVER_NAME SQL2NI1=ONE SQL2S2=SERVER_NAME SQL2NI2=TWO SQL2S3=SERVER_NAME SQL2DB?=SQL server database name Specifies the name of the SQL server database to back up. Type *.* to back up all the databases. Change ? to a number that corresponds to the number of the selection. LNSERVER?=SERVER_NAME Specifies the name of the Lotus Notes server that contains this selection. Change ? to a number that corresponds to the number of the selection. The selections must be in sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. See the example in LNDRIVE?=Drive letter.

214

Symantec Backup Exec Command Line Applet

Using scripts and selection lists Values for selection list script (continued) Section Entry LNDRIVE?=DRIVE_LETTER Description Change ? to the same number used to identify the selection for the Lotus Notes server. In the following example, SERVER_NAME is a Lotus Notes server name, and it is the same server in all of the selections. To back up the D drive and the E drive on the Lotus Notes server SERVER_NAME, the entries would be: LNSERVER1=SERVER_NAME LNDRIVE1=D LNSERVER2=SERVER_NAME LNDRIVE2=E ORCLSRV?=SERVER_NAME Specifies the name of the Oracle server that contains this selection. Change ? to a number that corresponds to the number of the selection. The selections must be in sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. See the example name in ORCLSID?=System identifier for database.

215

Using scripts and selection lists Values for selection list script (continued) Section Entry ORCLSID?=System identifier for database Description Specifies the SID (System Identifier) for the Oracle database you want to back up. Change ? to the same number used to identify the selection for the Oracle server. In the following example, SERVER_NAME is an Oracle server name, and it is the same server in all of the selections. To back up the databases SID1 and SID2 on the Oracle server, the entries would be ORCLSRV1=SERVER_NAME ORCLSID1=SID1 ORCLSRV2=SERVER_NAME ORCLSID2=SID2 SPPS2_FARMx=Farm name Change x to the lowest number that is not already used, and specify the name of the Microsoft SharePoint 2003 Portal server farm that you want to back up. For example, SPPS2_FARM1=farm name. You should start with number 1 and continue sequentially. The order in which the farm names are specified is the order in which the farms will be backed up. SPPS2_WEBSERVERx=Web server name Required. Specifies the Web server name that belongs to the server farm. SPPS2_CONFIGDBx=0 or 1 Enter 1 to include the Configuration database in the backup; otherwise, enter 0. Enter 1 to include the Single Sign-on database in the backup; otherwise, enter 0.

SPPS2_SSOx=0 or 1

216

Symantec Backup Exec Command Line Applet

Using scripts and selection lists Values for selection list script (continued) Section Entry SPPS2_DLSx=0 or 1 Description Enter 1 to include the Document Library store in the backup; otherwise, enter 0. Specify the name of the Portal Site that belongs to the farm. Since each farm may have more than one portal, you must use the same format that you specify for SPPS2_FARMx. For example: SPPS2_FARM1=farm name SPP2_PORTAL1NAME2=portal1 SPP2_PORTAL1NAME2=portal SPPS2_TEAM_SITExNAMEy=Windows SharePoint services site name Specify the name of the Windows SharePoint services site that belongs to the farm. Since each farm may have more than one Windows SharePoint services site, you must use the same format that you specify for SPPS2_FARMx. For example: SPPS2_FARM1=farm name SPP2_PORTAL1NAME2=portal1 SPP2_PORTAL1NAME2=portal SPPS2_DOC_SITExNAMEy=document library Specify the name of the backward compatible document library that belongs to the farm. Since each farm may have more than one document library, you must use the same format that you specify for SPPS2_FARMx. For example: SPPS2_FARM1=farm name SPP2_PORTAL1NAME2=portal1 SPP2_PORTAL1NAME2=portal

SPPS2_PORTALxNAMEy=Portal name

217

Using scripts and selection lists Values for selection list script (continued) Section Entry SPPS3_FARMx=Farm name Description Change x to the lowest number that is not already used, and specify the name of the Microsoft SharePoint 2007 Portal 2 server farm that you want to back up. You should start with the number 1 and continue sequentially.

SPPS3_WEBSERVERx=Web server name Required. Specifies the Web server name that belongs to the server farm. SPPS3_CONFIGDBx=0 or 1 Enter 1 to include the Configuration database in the backup; otherwise, enter 0. Enter 1 to include the Single Sign-on database in the backup; otherwise, enter 0. Enter 1 to include the central administration site in the backup; otherwise, enter 0. Specify the name of the Web application. You can list multiple names. Specify the name of the shared server provider. You can list multiple names. Enter 1 to include the shared instance in the backup; otherwise, enter 0. Enter 1 to include the global settings in the backup; otherwise, enter 0.

SPPS3_SSOx=0 or 1

SPPS3_CAx=0 or 1

SPPS3_WAxNAMEy=Web application name

SPPS3_SSPxNAMEy=Shared service provider name SPPS3_SIx=0 or 1

SPPS3_GSx=0 or 1

Note Alias selections will be ignored unless RUN_IMMEDIATE=1 in the [Schedule] section of backup job or backup job template. [Availability]

218

Symantec Backup Exec Command Line Applet

Using scripts and selection lists Values for selection list script (continued) Section Entry USEWINDOW=0 or 1 Description Enter 1 to specify when the selection list will be available for backup each day; otherwise, enter 0. Enter the beginning date when the selection list should be available to be backed up in MM/DD/YYYY format. The list will be available every day from this date onward. Enter the earliest time when the selection list will be available for backup in HH:MM:SS format. Enter the latest time when the selection list will be available for backup in HH:MM:SS format.

EFFECTIVEDATE=MM/DD/YYYY

STARTTIME=HH:MM:SS

ENDTIME=HH:MM:SS

[Media_server] PREFERRED_SERVER_NAME=Media server name This operation is only available if the Central Admin Server Option (CASO) is installed. Specify the preferred media server on which backup jobs run. PREFERRED_SERVER=Media server GUID This operation is only available if the Central Admin Server Option (CASO) is installed. Specify the preferred media server on which backup jobs run. MEDIA_SERVER_POOL_NAME==Media server pool name This operation is only available if the Central Admin Server Option (CASO) is installed. Specify the media server pool to use for the backup job.

219

Using scripts and selection lists Values for selection list script (continued) Section Entry MEDIA_SERVER_POOL=Media server pool GUID Description This operation is only available if the Central Admin Server Option (CASO) is installed. Specify the media server pool to use for the backup job.

220

Symantec Backup Exec Command Line Applet

Using Policy Commands

Using Policy Commands

You can create policies that enable you to manage backup jobs and strategies. Policies contain job templates, which are job attributes that define how and when Backup Exec processes a job. Templates specify the devices, settings, and schedule for a job, but do not include the selections to be backed up. The policy switches available include:
Policy Commands Operation Additional Switches Function Description

-o260

Create new policy

Executes a policy based on the contents of a file. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name of the policy script file to be executed.

-fpolicy file

-o261

Delete a policy

Deletes the specified policy. Returns 1 if the command is successful or -1 if it failed. Required. Specifies the ID or the name of the policy to be deleted.

-ipolicy ID or -j:policy name

-o262 -jpolicy name

Update a policy

Update an existing policy. Required. Specifies the name of the policy to apply to the selection list. Required. Specifies the name of the policy script file to be executed.

-fpolicy file

-o263

Get number of policies

Displays the number of policies created on a computer. Returns a 1 if the command succeeds or a -1 if the command fails. If -tl: or -r is specified, -i or -j is required Instructs Backup Exec to display policy IDs. Instructs Backup Exec to display policy name. Instructs Backup Exec to display templates for the specified policy ID or policy name.

-i -j -tl:

221

Using Policy Commands Policy Commands (continued) Operation Additional Switches -r Function Description

Instructs Backup Exec to display templates rules for the specified policy ID or policy name. Apply policy to selection lists Applies the specified policy to selection lists. The selection list IDs or names must be separated by a comma. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID or name of the policy to apply to the selection list. Required. Specifies the selection list IDs or names to apply to the policy.

-o264

-ipolicy ID or -j:policy name -si:selection list IDs or -sj:selection list names -ffilename

Specifies a file that contains a lists of selection lists (one per line). Remove policy from script Removes the specified policy from a script. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID or name of the policy to remove from the script. Required. Specifies the selection list IDs or names to remove from the script.

-o265

-ipolicy ID or -j:policy name -si:selection list IDs or -sj:selection list names -ffilename

Specifies a file that contains a lists of selection lists (one per line).

222

Symantec Backup Exec Command Line Applet

Using Policy Commands

Creating a policy
Command line switch -o260 creates a policy by reading a policy script file, such as the example script file policy.txt. The policy contains a set of required and optional entries for creating a policy. The FILEx entries specify the names of separate template script files and the TYPEx entries specify the type of template. A sample policy script file (policy.txt) is included in the UTILS directory on the installation DVD. To activate an entry in this sample file, delete the forward slashes (//) at the beginning of the line. Use a text editor, such as Notepad, to create a policy that contains three sections, and entries for each section. The sections of a policy file are:

[General] [Templates] [Rules]

Policy file values Section [General] NAME Required. Specifies the name of the policy being created. Specifies a description of the policy being created. Entry Description

DESCRIPTION

[Template] NAMEx=Name of template Required. Specifies the name of the template. Multiple entries can be entered. For example, NAME1=, NAME2=ID, and so on. Required. Specifies the name of a file that contains a job template. Note The FILEx entry is not required for Export media templates.

FILEx=Name of job template file

223

Using Policy Commands Policy file values (continued) Section Entry TYPEx=Template type Description Required. Specifies the type of template specified by the FILEx entry. Values for TYPEx are:

0 = Backup template 1 = Duplicate backup sets template 2 = Export media template 3 = Synthetic full template

[Rules] RULE_FIRST_TEMPLATEx=Name of first template Specifies the name of the template in the [Template} section with the highest precedence. Specifies the name of the template in the [Template} section with the lowest precedence.

RULE_SECOND_TEMPLATEx=Name of second template

224

Symantec Backup Exec Command Line Applet

Using Policy Commands Policy file values (continued) Section Entry RULE_TYPEx=0 - 8, 10, or 11 Description Specifies rules for handling the template job start times. Rules to handle conflicting job start times include:

0 - If start times conflict, <First Template> supersedes <Second Template>. 7 - If start times conflict, <First Template> will start and upon completion, starts <Second Template> 1 - After <First Template> starts, also start <Second Template> 2 - After <First Template> completes, start <Second Template>. 3 - If <First Template> successfully completes, start <Second Template>. 4 - If <First Template> fails, start <Second Template>. 5 - After <First Template> completes, start <Second Template> to duplicate the backup sets. 6 - After <First Template> completes, start <Second Template> to duplicate the backup sets.

Rules to link jobs together:

Rules to duplicate backup sets:

225

Using Policy Commands Policy file values (continued) Section Entry Description Rules to limit when jobs run:

8 - <First Template> must complete at least once before any other templates will be allowed to start. 11 - Run <First Template> only once. 10 - After <First Template> completes, start <Second Template> to export media.

Rules to export media:

226

Symantec Backup Exec Command Line Applet

Using Policy Commands

Using job template script files within a policy

When creating a policy, you can define or create a job template script files to use with the policy. A job template script file includes the destination, settings, and schedule options. After the policy is created, you can use -o264 with a selection script to quickly create jobs based on the job templates. When using -o264, a policy and selection lists can only be associated with each other once. To use the same policy and selection lists to create another job, run -o265 before using -o264. Sample script files are included in the UTILS directory on the installation DVD. To activate an entry in this sample file, delete the forward slashes (//) at the beginning of the line. Examples of the template script files are given in the following files:

Backup template - bjtemplatescript.txt Duplicate backup sets template - djtemplatescript.txt Synthetic full backup job template - sftemplatescript.txt

Note The duplicate backup sets template cannot be set to run now. Use a text editor, such as Notepad, to create a job template script file that contains all settings and options for a job, except for the data selections. Each entry included in the job template script file must be typed in capital letters and must be immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces unless they are part of the value itself. For example, to specify in the script that the backup method is working set and that the device name is Backup-to-Disk Folder 1, the script should appear as: BK_METHOD=1 DEVICE_NAME="Backup-to-Disk Folder 1"

227

Creating a backup job template script file

Creating a backup job template script file

Use a text editor, such as Notepad, to create a backup job template script file that contains the following sections, and entries for each section:

[Backup_Options] [Miscellaneous] [Schedule]

Each entry included for the various sections must be typed in capital letters and be immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. All possible entries for a duplicate backup template job script file are described in the following table. In creating a script file, you would not want to include all entries.
Possible backup job template script file entries Section Entry Description

[Backup_Options] BK_SET_NAME=backup set name Type the name of the backup set to be used by the job. Enter a number from 0 through 9 and 11 that corresponds to the backup method you want. Methods are:

BK_METHOD=0 - 9, 11

0 = Full 1 = Copy 2 = Differential changed files 3 = Incremental changed files 4 = Daily 5 = Working set 6 = Incremental modified time 7 = Differential modified time 8 = Full modified time 9 = Archive - Delete files after successful copy backup 11 = Synthetic full backup

If 5 is entered as the value, a value must also be entered for WORKING_SET_DAYS.

228

Symantec Backup Exec Command Line Applet

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry BACKUP_LOCAL_MOUNT_POINTS= 0 or 1 Description Enter a value of 1 to back up mount points, which direct a file or directory to a local disk or directory path. Using this command allows you to back up data that is linked to local files, but is stored on another device without having to actually select the device. Enter a value of 1 to back up data that has been migrated from primary storage to secondary storage. The data will not be recalled to its original location; it will be backed up directly to the backup media. This command should not be used if:

BACKUP_REMOTE_STORAGE_HSM= 0 or 1

A single device is used for secondary storage and backups and it contains one drive because Remote Storage and Backup Exec will compete for use of the drive. You want to run a backup of your entire system because Backup Exec attempts to access all data that has been migrated to secondary storage and this may take a considerable amount of time.

229

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry COLLECT_INFO_FOR_SYNTHETIC_BK=0 or 1 Description When you select this option, Backup Exec compares path names, file names, modified times, and other attributes with those from the previous full and incremental backups. If any of these attributes are new or changed, then the file or directory is backed up. Note This option displays only for templates. Enter 1 to have Backup Exec do the following:

Collect the information that is required to detect files and directories that have been moved, renamed, or newly installed since the last backup. Include those files and directories in the backup jobs.

Enter 0 to have Backup Exec skip the files and directories that have unchanged archive bits. Backup jobs that have this option selected require more disk space, and take more time to run, than backups that do not. You must select this option for the baseline and incremental backup template in the synthetic backup policy. DEVICE_NAME=device name Type the name of the device to be used for the backup.

230

Symantec Backup Exec Command Line Applet

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry OPEN_FILES_METHOD=0 - 3 Description Enter a number from 0 through 3 to specify how to back up open files. Selections include:

0 = Never 1 = If closed within a specified number of seconds. If this method is selected, use the flag OPEN_FILE_WAIT_TIME to set the number of seconds for Backup Exec to wait; otherwise, the value set for default options will be used. 2 = With a lock 3 = Without a lock

Note If 1 is entered as the value, Backup Exec will wait the number of seconds specified in OPEN_FILE_WAIT_TIME for the file to close before continuing the backup. If the files do not close during the specified interval, they are skipped. OPEN_FILE_WAIT_TIME=# Specifies the number of seconds Backup Exec is to wait for a file to close before continuing with the backup. Enter 1 to retension the media before backup; otherwise, enter 0. Enter 1 to retain the directory structure of the files that were backed up in an archive job on the hard drive; otherwise, enter 0. Enter 1 if single instance store is being used, and you want to ensure that only one instance of a file for NTFS volumes will be backed up regardless of the number of single instance store (SIS) links that point to it. Otherwise, enter 0.

RETENSION_MEDIA=0 or 1

PRESERVE_TREE_ON_ARCHIVE= 0 or 1

SINGLE_INSTANCE_FOR_NTFS=0 or 1

231

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry REMOTE_AGENT_PRIORITY=# Description Select the number of CPU cycles the media server will use to maintain optimal server performance while Remote Agent backups are running. The higher the priority, the more the protected servers CPU processing power is used during backup operations. Note Allocating fewer CPU cycles to a backup job results in slower backup performance. This entry contains the following options:

MEDIUM. Select this option to allocate the default number of CPU cycles the protected server will use during a Remote Agent backup. LOW. Select this option to allocate fewer server CPU cycles to the backup job. LOWEST. Select this option to allocate the fewest number of CPU cycles to the backup job.

WORKING_SET_DAYS=#

Note If 5 was entered as the value for the BK_METHOD=# entry, the WORKING_SET_DAYS entry must be completed and included in the Backup Job Script File. Enter the number of days during which files that you want to include in the backup were last accessed. For example, if you want to specify for a working set backup to include all files last accessed within 30 days, type WORKING_SET_DAYS=30.

232

Symantec Backup Exec Command Line Applet

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry EXCHANGE_METHOD=0 - 3 Description If you are backing up an Exchange server, use this entry. Enter a number from 0 through 3 that corresponds to the backup method you want for the Exchange database. Methods are:

0 = Backup All 1 = Backup Copy 2 = Backup Log Differential 3 = Backup Log Incremental

EXCHANGE_ENABLE_GRANULAR_ RESTORE=0 or 1

Enter 1 to enable the restore of individual documents from database backups. This option is only available when performing full backups; otherwise enter 0. If you are backing up an Exchange server, use this entry. Enter a number from 0 through 3 that corresponds to the backup method you want for the Exchange database. Methods are:

EXCHANGE_MBOX_METHOD=0 - 3

0 = Full - Back up messages. Reset archive bit. 1 = Copy - Back up messages. 2 = Differential - Back up changed messages. 3 = Incremental - Back up changed messages. Reset archive bit.

EXCHANGE_SINGLE_INSTANCE=0 or 1

Enter 1 to back up only a single copy of all identical message attachments; otherwise, enter 0.

EXCHANGE_CONSISTENCY_CHECK=0 or Enter 1 to perform a consistency check 1 and determine if possible data corruption exists when using the Backup Exec - Advanced Disk-based Backup Option (ADBO) or the Advanced Open File Option (AOFO); otherwise, enter 0.

233

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry EXCHANGE_CONTINUE=0 or 1 Description Enter 1 to continue the backup job even if the consistency check fails; otherwise, enter 0. Enter 1 to enable continuous backup of Exchange transaction logs with Backup Exec Continuous Protection Server; otherwise, enter 0. Enter the interval in days, hours, or minutes for making recovery points when continuously backing up Exchange transaction logs with Backup Exec Continuous Protection Server. If you are backing up a SharePoint Portal Server. Enter a number 0 or 3that corresponds to the backup method you want for the SharePoint Portal Server.

EXCHANGE_CONTINUOUS_ PROTECTION=0 or 1

EXCHANGE_RECOVERY_POINTS_ INTERVAL=xD (days) or xH (hours) or xM (minutes)

SPPS2_METHOD=0 or 3

0 = Full - Back up entire database. 3 = Differential - Back up database changes only. Select this to back up only the changes made to the database since the last full backup.

Note The differential backup method cannot be used to back up Index databases or Document Libraries. The Full backup method will be used to back up these resources. SPPS2_ENABLE_GRANULAR_RESTORE=0 Enter 1 to enable the restore of or 1 individual documents from database backups. This option is only available when performing full backups; otherwise, enter 0.

234

Symantec Backup Exec Command Line Applet

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry SPPS2_PRE_DBCC=0 or 1 Description Enter 1 to run a full consistency check (including indexes) of the Microsoft SQL databases used by Microsoft SharePoint before backing up the databases; otherwise, enter 0. Enter 1 to continue with the backup operation even if the consistency check fails; otherwise, enter 0. Enter 1 to release the lock on the SharePoint farm topology before backing up data; otherwise, enter 0. If you are backing up a SQL server, use this entry. Enter a number from 0 through 2 that corresponds to the backup method you want for the SQL database. Methods are:

SPPS2_CONT_ON_CC_FAILURE=0 or 1

SPPS2_RELEASE_LOCK=0 or 1

SQL_METHOD=0 - 3

0 = Backup All 1 = Backup Log 2 = Backup Log No Truncate 3 = Differential

LOTUS_DOMINO_METHOD=0 - 2

If you are backing up a Lotus Domino server, use this entry. Enter a number from 0 through 2 that corresponds to the backup method you want for the Lotus Domino database. Methods are:

0 = Full 1 = Differential 2 = Incremental

LOTUS_DOMINO_RECYCLE_LOGS= 0 or 1

If you are backing up a Lotus Domino server, use this entry to indicate that the Lotus Domino server will reuse the transaction log after it has been backed up.

1 = Recycle logs 0 = Do not recycle logs

235

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry NW_BK_MIGRATED=0 or 1 Description Enter 1 to back up migrated NetWare SMS files; otherwise, enter 0. This switch can only be used with versions prior to Backup Exec 10.x. NW_BK_DECOMPRESS_FILES= 0 or 1 If you are backing up NetWare shares or volumes, include this entry in the Backup Job Script File. If you want to back up compressed files in decompressed form, enter 1 as the value; otherwise, enter 0. Enter 1 as the value if you want Backup Exec to overwrite a duplicate job if one exists; otherwise, enter 0. Enter 1 if you are backing up a SQL server, have specified that a database consistency check is to be performed before the backup, and want the job to continue if the pre-backup database consistency check failed. If you are backing up a SQL server, include this entry. Enter a value from 0 to 3 that corresponds to an option for performing a pre-backup database consistency check. Options are:

OVERWRITE_JOB=0 or 1

CONTINUE_ON_DBCC=0 or 1

PRE_BK_DBCC=0 - 3

0 = None 1 = No Index 2 = Full 3 = Physical only

236

Symantec Backup Exec Command Line Applet

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry POST_BK_DBCC=0- 3 Description If you are backing up a SQL server include this entry. Enter a value from 0 to 3 that corresponds to an option for performing a post-backup database consistency check. Options are:

0 = None 1 = No Index 2 = Full 3 = Physical only

SQL_STANDBY_OPTION=0 or 1

Select the Standby value to put the database in standby mode when the job log backup completes. Select the No Recover value to put the database in a loading state when the job log backup completes. Users cannot connect to or query the database while it is in a loading state. Values are:

0 = Standby 1=No Recover

USE_OPEN_FILE_OPTION=0 or 1

Enter 1 as the value if you want to use the Advanced Open File Option if available; otherwise, enter 0. If Advanced OFO is unavailable, the OPEN_FILES_METHOD specified will be used. Enter a number from 1 through 4 to specify the open file technology to back up open files. Selections include:

OPEN_FILE_CONFIGURATION=1-4

1 = Automatically select open file technology 2 = Use Microsoft Volume Shadow Copy Service 3 = Use VERITAS Volume Snapshot Provider 4 = Use VERITAS Storage Foundation for Windows FlashSnap Option

237

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry SNAPSHOT_PROVIDER=0-3 Description Enter a number from 0 through 3 to specify the best provider for the selected volume. Selections include:

0 = Automatic - Allows VSS to select the snapshot provider 1 = System - Use Microsoft software shadow copy provider 2 = Software - Use VERITAS Storage Foundation for Windows 3 = Use technology provided by hardware manufacturer

USE_SINGLE_VOLUME_SNAPSHOT=0 or Enter 1 if you want to process logical 1 volumes for backup one at a time; otherwise, enter 0. OFFHOST_PROVIDER=0 - 3 Enter a value from 0 to 3 that corresponds to the snapshot provider options for an offhost backup jobs. Options are:

0 = Disable offhost backup 1 = Automatic Use hardware if available 2 = Software Use VERITAS Storage Foundation for Windows 3 = Hardware Use technology provided by hardware manufacturer

OFFHOST_DISPOSITION=0 or 1

Enter 1 to allow the backup job to complete even if any of the volumes selected do not support offhost backup; otherwise, to fail the backup job, enter 0. Enter 1 to process logical volumes for offhost backup one at a time; otherwise, enter 0. Specify a name for the encryption key.

OFFHOST_SINGLESNAP=0 or 1

ENCRYPTION_KEY_NAME=key name

238

Symantec Backup Exec Command Line Applet

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry ENCRYPTION_TYPE=0 - 3 Description Enter a number from 0 to 3 that corresponds with the type of encryption to use. Options are as follows:

0 = None 1 = Software 2 = Hardware 3 = Hardware if available, otherwise software

If 2 or 3 are entered, the default encryption key must be 256-bit encryption. SAV_THREATLEVELTRIGGER=0, 2 - 4 Select the ThreatCon level at which you want automatic backups to run. You can select from the following:

0 = Disabled 2 = Elevated 3 = High 4 = Extreme

[Media Options] MEDIA_SET=Media Set Name Enter the name of the media set to be used for the backup. If the media has a password, specify the password. To append the job to the media set specified in the MEDIA_SET entry or overwrite if no appendable media is available, enter 1 as the value. If you want the job to overwrite the media set specified in the MEDIA_SET entry, enter 0 as the value. If you do not enter a value, by default the job will be an overwrite job.

MEDIA_PASSWORD=Media Password

APPEND=0 or 1

239

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry APPEND_NO_OVERWRITE=0 or 1 Description If you want the job to either append to the media set specified in the MEDIA_SET entry, or if no appendable media is available then to terminate, enter 1. To have the job append to the media set, or overwrite if no appendable media is available, enter 0. Enter 1 as the value to have Backup Exec automatically perform a verify operation to make sure the media can be read once the backup has been completed; otherwise, enter 0. Verifying all backups is recommended. Enter a number from 0 to 3 that corresponds with the type of compression to use. Options include:

VERIFY=0 or 1

COMPRESSION_TYPE=0 - 3

0 = Hardware compression 1 = Software compression 2 = Hardware if available, otherwise software 3 = None

Note To use the default Backup Exec compression type, do not include this entry in the script. CHECKSUM=0 or 1 Enter 1 as the value if checksums are to be calculated for each data stream written to tape, and then written in a separate stream immediately following the data stream. If 0 is entered as the value, backup performance may be improved, but there will be no way to verify the integrity of the data on the tape. Enter 1 to eject the media when the job completes; otherwise, enter 0.

EJECT_MEDIA=0 or 1

240

Symantec Backup Exec Command Line Applet

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry Description

[Miscellaneous] PRE_JOB_COMMAND=command Specify a .exe or batch file command that is to run on the media server before the backup operation starts. Specify a .exe or batch file command that is to run after the backup operation completes. Enter 1 to execute the post-job command only if the pre-job command is successful; otherwise, enter 0. Enter 1 to execute the job only if the pre-job command is successful; otherwise, enter 0. Enter 1 to execute the post-job command even if the job fails; otherwise, enter 0. Enter 1 to allow the pre- and post-job commands to be successful only if completed with a return code of zero. Otherwise, enter 0. An return code of zero returned to the operating system by the pre- or post-job command is interpreted by Backup Exec to mean the job completed successfully. A non-zero return code is interpreted by Backup Exec to mean the job ended with an error. After checking the return codes, Backup Exec continues processing according to selections you made for running the pre- and post-job commands. If you enter 0, the success of the preand post-job commands is not determined based on the return code.

POST_JOB_COMMAND=command

COMMAND_RUN_POST_IF_ PRE_SUCCESS=0 or 1

COMMAND_RUN_JOB_IF_PRE_SUCCESS= 0 or 1

COMMAND_RUN_POST_ IF_JOB_FAILS=0 or 1

COMMAND_FAIL_JOB_IF_FAILS= 0 or 1

241

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry COMMAND_AUTO_CANCEL_TIME=# Description Enter the number of minutes Backup Exec should wait before cancelling a command that did not complete. Enter 0 to run the command on this media server or 1 to run the command on each server being backed up. Enter 1 to use the MAC address specified with the NIC_ADDRESS entry, or the name specified with the NIC_NAME entry. Enter 0 to clear previous settings for the network interface, and to use any available network adapter. Operations for displaying network interface information on page 85 NIC_ADDRESS=00-00-00-00-00-00 Enter the Media Access Control (MAC) address for the network interface you selected. To use this setting, NIC_ENABLED must be set to 1. NIC_NAME=name Type the name of a network interface card when NIC_ENABLED=1. Enter 0 to use any available Internet Protocol. Enter 1 to use IPv4. Enter 2 to use IPv6. Operations for displaying network interface information on page 85 NIC_SUBNET_ENABLED=0 or 1 Enter 0 to use any available subnet prefix. Enter 1 to use a specific subnet prefix. Specify a subnet prefix when NIC_ENABLED=1 and NIC_SUBNET_ENABLED=1.

COMMAND_RUN_OPTION=0 or 1

NIC_ENABLED=0 or 1

NIC_PROTOCOL=0 - 2

NIC_SUBNET=00.000.00.000

242

Symantec Backup Exec Command Line Applet

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry NIC_ANY_AVAILABLE=0 or 1 Description Enter 1 to use any available network interface card. Enter 0 to use only the network interface card that you specify.

[Schedule] Note You must enter values when you select to use either SCHED_REPEAT_INTERVAL, SCHED_DAYSOF MNTH, SCHED_DAYSOF WEEK, or DATE before the job is created. SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in MM/DD/YYYY format, that the schedule becomes effective. Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format. Enter the interval in HH:MM:SS format for the job to restart on each run day. For example, if you have set up the job to run every seven days, you can also set it up to run every four hours on its run day by entering SCHED_RESTART_INTERVAL=04:00:0 0. Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date, in MM/DD/YYYY format, from which the interval is calculated.

SCHED_STARTTIME=HH:MM:SS

SCHED_ENDTIME=HH:MM:SS

SCHED_RESTART_INTERVAL=HH:MM:SS

SCHED_REPEAT_INTERVAL=X

SCHED_ANCHOR=MM/DD/YYYY

243

Creating a backup job template script file Possible backup job template script file entries (continued) Section Entry SCHED_DAYSOFMONTH=x Description Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002

244

Symantec Backup Exec Command Line Applet

Creating a duplicate backup job template script file Possible backup job template script file entries (continued) Section Entry DATE=MM/DD/YYYY Description Enter the start date for the job in MM/DD/YYYY format. Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter a value of 1 if the job is to run immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set, the default value is 1. AUTO_CANCEL_TIME=# Enter the number of minutes after which the job is canceled if it is not completed. Backup Exec starts timing the job when the job is queued, not when the job begins. Enter 1 as the value if you want to schedule the job on hold; otherwise, enter 0.

TIME=hh:mm:ss

HOLD=0 or 1

Creating a duplicate backup job template script file

Use a text editor, such as Notepad, to create a duplicate backup job template script file that contains entries for the duplicate backup template job options. The duplicate backup job template script file has similar entries, or values, as those used in the other job script file. Sections of a Duplicate Backup Job Script include:

[General] [Setcopy_Options] [Schedule]

245

Creating a duplicate backup job template script file

Each entry included in the duplicate backup job script file must be typed in capital letters and immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. All possible entries for a duplicate backup template job script file are described in the following table. When creating a script file, do not include all entries.
Possible duplicate job template script file entries Section [General] BACKUP_SET_DESCRIPTION= Description PREFERRED_SOURCE_DEVICE_GUID= Source device guid Type a description of the information you are duplicating. Enter the GUID of the device used as the destination device for the original backup job. Use operation -o63 to display managed drives. Entry Description

[Setcopy_Options] DEVICE_NAME=Device name Type the name of the device to be used for the duplicate job. Enter the GUID of the media set to be used for the duplicate job. Use operation -o69 to display media sets. Enter 1 as the value if you want Backup Exec to overwrite the media; otherwise, enter 0. Enter 1 to append this backup to the media set. If there is no appendable media available, the job is appended to overwritable media that will then be added to the media set; otherwise enter 0. Enter 1 to append to this backup to the media set. If there is no appendable media available, the job is terminated; otherwise, enter 0.

MEDIA_SET_GUID=Media set GUID

OVERWRITE_MEDIA=0 or 1

APPEND_OVERWRITE=0 or 1

APPEND_TERMINATE=0 or 1

246

Symantec Backup Exec Command Line Applet

Creating a duplicate backup job template script file Possible duplicate job template script file entries (continued) Section Entry Description

EJECT _MEDIA_AFTER_COMPLETES=0 or Enter 1 to have Backup Exec 1 automatically eject the media in the drive when the operation completes. WRITE_CHECKSUMS=0 or 1 Enter 1 as the value if checksums are to be calculated for each data stream written to tape, and then written in a separate stream immediately following the data stream. If 0 is entered as the value, backup performance may be improved, but there will be no way to verify the integrity of the data on the tape. Enter 1 to retension the media before backup; otherwise, enter 0. If the media has a password, specify the password. Enter 1 to have Backup Exec automatically perform a verify operation to make sure the media can be read after the backup has been completed; otherwise, enter 0. Enter 1 to select hardware compression; otherwise, enter 0. Specify a name for the encryption key.

RETENSION_MEDIA=0 or 1

MEDIA_PASSWORD=Media password

AUTO_VERIFY=0 or 1

COMPRESSION_TYPE=0 or 1

ENCRYPTION_KEY_NAME=key name

247

Creating a duplicate backup job template script file Possible duplicate job template script file entries (continued) Section Entry ENCRYPTION_TYPE=0 - 3 Description Enter a number from 0 to 3 that corresponds with the type of encryption to use. Options are as follows:

0 = None 1 = Software 2 = Hardware 3 = Hardware if available, otherwise software

If 2 or 3 are entered, the default encryption key must be 256-bit encryption. [Schedule] SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in MM/DD/YYYY format, that the schedule becomes effective. Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format. Enter the interval in HH:MM:SS format for the job to restart on each run day. For example, if you have set up the job to run every seven days, you can also set it up to run every four hours on its run day by entering SCHED_RESTART_INTERVAL=04:00:0 0. Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date, in MM/DD/YYYY format, from which the interval is calculated.

SCHED_STARTTIME=HH:MM:SS

SCHED_ENDTIME=HH:MM:SS

SCHED_RESTART_INTERVAL=HH:MM:SS

SCHED_REPEAT_INTERVAL=x

SCHED_ANCHOR=MM/DD/YYYY

248

Symantec Backup Exec Command Line Applet

Creating a duplicate backup job template script file Possible duplicate job template script file entries (continued) Section Entry SCHED_DAYSOFMONTH=x Description Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002

249

Creating a duplicate backup job template script file Possible duplicate job template script file entries (continued) Section Entry DATE=MM/DD/YYYY Description Enter the start date for the job in MM/DD/YYYY format. If schedule values are not entered, then the DATE==MM/DD/YYYY and TIME=hh:mm:ss entries will be used to set the Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter 1 to run the duplicate backup job immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set, the default value is 1. AUTO_CANCEL_TIME=# Enter the number of minutes after which the job is canceled if it is not completed. Backup Exec starts timing the job when the job is queued, not when the job begins. To specify hours, enter a value divisible by 60. Enter 1 to run the job based on a template rule. For example, with the After <Template A> completes, start <Template B> rule, <Temaplate B> will run whenever <Template A> completes. Otherwise, enter 0. Enter 1 if you want the job to be submitted on hold; otherwise, enter 0.

TIME=hh:mm:ss

RUN_ACCORDING_RULE=0 or 1

HOLD=0 or 1

250

Symantec Backup Exec Command Line Applet

Creating a synthetic full job template script file

Creating a synthetic full job template script file

Use a text editor, such as Notepad, to create a backup job script file that contains the following sections, and entries for each section:

[General] [Synthetic_Options] [Schedule]

Each entry included for the various sections must be typed in capital letters and be immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. All possible entries for a Backup Job Script File are described in the following table. In creating a script file, you would not want to include all entries.
Possible synthetic full template script file entries Section [General] BACKUP_SET_DESCRIPTION= Description PREFERRED_SOURCE_DEVICE_GUID= Source device guid Type a description of the information you are duplicating. Enter the GUID of the device used as the destination device for the original backup job. Use operation -o63 to display managed drives. Entry Description

[Synthetic_Options] DEVICE_NAME=device name Type the name of the device to be used for the backup. Enter the name of the media set to be used for the backup. Enter 1 as the value if you want Backup Exec to overwrite the media; otherwise, enter 0.

MEDIA_SET=Media Set Name

OVERWRITE_MEDIA=0 or 1

251

Creating a synthetic full job template script file Possible synthetic full template script file entries (continued) Section Entry APPEND_OVERWRITE=0 or 1 Description Enter 1 to append this backup to the media set. If there is no appendable media available, the job is appended to overwritable media that will then be added to the media set; otherwise enter 0. Enter 1 to append to this backup to the media set. If there is no appendable media available, the job is terminated; otherwise, enter 0.

APPEND_TERMINATE=0 or 1

EJECT _MEDIA_AFTER_COMPLETES=0 or Enter 1 to have Backup Exec 1 automatically eject the media in the drive when the operation completes. WRITE_CHECKSUM=0 or 1 Enter 1 as the value if checksums are to be calculated for each data stream written to tape, and then written in a separate stream immediately following the data stream. If 0 is entered as the value, backup performance may be improved, but there will be no way to verify the integrity of the data on the tape. Enter 1 to retension the media before backup; otherwise, enter 0. Enter 1 to use write once, read many (WORM) media for this backup job; otherwise, enter 0. If the media has a password, specify the password. Enter 1 to have Backup Exec automatically perform a verify operation to make sure the media can be read after the backup has been completed; otherwise, enter 0.

RETENSION_MEDIA=0 or 1

WORM_MEDIA=0 or 1

MEDIA_PASSWORD=Media Password

AUTO_VERIFY=0 or 1

252

Symantec Backup Exec Command Line Applet

Creating a synthetic full job template script file Possible synthetic full template script file entries (continued) Section Entry COMPRESSION_TYPE=0 - 3 Description Enter a number from 0 to 3 that corresponds with the type of compression to use. Options include:

0 = Hardware compression 1 = Software compression 2 = Hardware if available, otherwise software 3 = None

Note To use the default Backup Exec compression type, do not include this entry in the script. [Schedule] Note You must enter values when you select to use either SCHED_REPEAT_INTERVAL, SCHED_DAYSOF MNTH, SCHED_DAYSOF WEEK, or DATE before the job is created. SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in MM/DD/YYYY format, that the schedule becomes effective. Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format. Enter the interval in HH:MM:SS format for the job to restart on each run day. For example, if you have set up the job to run every seven days, you can also set it up to run every four hours on its run day by entering SCHED_RESTART_INTERVAL=04:00:0 0. Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7.

SCHED_STARTTIME=HH:MM:SS

SCHED_ENDTIME=HH:MM:SS

SCHED_RESTART_INTERVAL=HH:MM:SS

SCHED_REPEAT_INTERVAL=X

253

Creating a synthetic full job template script file Possible synthetic full template script file entries (continued) Section Entry SCHED_ANCHOR=MM/DD/YYYY Description Enter the date, in MM/DD/YYYY format, from which the interval is calculated. Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, enter a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002

SCHED_DAYSOFMONTH=x

254

Symantec Backup Exec Command Line Applet

Creating a synthetic full job template script file Possible synthetic full template script file entries (continued) Section Entry SCHED_EXCLUDEDATEx=MM/DD/YYYY Description Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in MM/DD/YYYY format. Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter a value of 1 if the job is to run immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set, the default value is 1. AUTO_CANCEL_TIME=# Enter the number of minutes after which the job is canceled if it is not completed. Backup Exec starts timing the job when the job is queued, not when the job begins. Enter 1 as the value if you want to schedule the job on hold; otherwise, enter 0.

TIME=hh:mm:ss

HOLD=0 or 1

255

Using a schedule script with device and media operations

Using a schedule script with device and media operations

Use a text editor, such as Notepad, to create a schedule script file that contains all settings and options for a device and media operation, such as cleaning a robotic library drive, that can be scheduled as a recurring job. Each entry included in the schedule script file must be typed in capital letters and must be immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself. All possible entries for a schedule script file are described in the following table. Do not include all entries in the script file. The following values are in the schedule script file:
Values for schedule script file Section [Schedule] SCHED_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format. Enter the interval in HH:MM:SS format for the job to restart on each run day. For example, if you have set up the job to run every seven days, you can also set it up to run every four hours on its run day by entering SCHED_RESTART_INTERVAL=04:00:0 0. Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date, in MM/DD/YYYY format, from which the interval is calculated. Entry Description

SCHED_ENDTIME=HH:MM:SS

SCHED_RESTART_INTERVAL=HH:MM:SS

SCHED_REPEAT_INTERVAL=X

SCHED_ANCHOR=MM/DD/YYYY

256

Symantec Backup Exec Command Line Applet

Using a schedule script with device and media operations Values for schedule script file (continued) Section Entry SCHED_EFFECTIVE=MM/DD/YYYY Description Enter the date, in MM/DD/YYYY format, that the schedule becomes effective. Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1 /3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, if you want the job to run on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002

SCHED_DAYSOFMONTH=x

257

Using a schedule script with device and media operations Values for schedule script file (continued) Section Entry SCHED_EXCLUDEDATEx=MM/DD/YYYY Description Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, if you want to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in MM/DD/YYYY format. Note The start date month, day, and year must be separated by forward slashes. TIME=hh:mm:ss Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter a value of 1 if the job is to run immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set, the default value is 1. AUTO_CANCEL_TIME=XMINUTES/HOURS Enter a number and select either MINUTES or HOURS to specify to cancel a job if not completed with the selected time. Enter 1 if you want the job to be submitted on hold; otherwise, enter 0.

HOLD=0 or 1

258

Symantec Backup Exec Command Line Applet

Understanding job status messages

Understanding job status messages

The Command Line Applet displays job statuses as numeric values. Descriptions of possible job status return values are:
Possible job statuses Job Status Code JOB_STATE_CANCELED = 1 Description The job has been terminated because it was canceled. The job has completed and is waiting for final disposition. The job has completed successfully with some exceptions. The job has been dispatched. The job is on hold. The job has completed with an error. The schedule for the task is invalid. The job will never run. The jobs scheduled time window closed before the job could be dispatched. There may not have been an available device during the time window. The job is ready, but the media server is paused. The job is in a transitional state. During startup, Backup Exec detected that a job was active when the server was shut down, and that the Checkpoint restart option was not enabled for this job. The job history log has been marked JOB_STATE_RECOVERED, and the job has been scheduled to restart immediately.

JOB_STATE_COMPLETED = 2

JOB_STATE_SUCCESS_WITH_ EXCEPTIONS = 3 JOB_STATE_DISPATCHED = 4 JOB_STATE_HOLD = 5 JOB_STATE_ERROR = 6 JOB_STATE_INVALID SCHEDULE = 7

JOB_STATE_NOT_IN_WINDOW = 10

JOB_STATE_READY_BUT_PAUSED = 11 JOB_STATE_PENDING = 12 JOB_STATE_RECOVERED = 13

259

Understanding job status messages Possible job statuses (continued) Job Status Code JOB_STATE_RESUMED = 15 Description During startup, Backup Exec detected that a job was active when the server was shut down, and that the Checkpoint restart option was enabled for this job. The job history log has been marked JOB_STATE_RESUMED, the job has been scheduled to restart immediately, and the job flag has been set to indicate checkpoint restart. The job is currently running on the server. The job is eligible for dispatch. The job has a due date in the future. The job has been completed successfully. The job is ready, but another higher precedence task is eligible to run. The job was canceled because it was not completed within the number of hours or minutes that were set for the Enable automatic cancellation option on the job schedule. The job needs to have the due date calculated. The job is linked to another job, and will not start until that job is finished.

JOB_STATE_ACTIVE = 16 JOB_STATE_READY = 17 JOB_STATE_SCHEDULED = 18 JOB_STATE_SUCCESS = 19 JOB_STATE_SUPERCEDED = 20

JOB_STATE_THRESHOLD_AUTO_ ABORT = 21

JOB_STATE_TO_BE_SCHEDULED = 22 JOB_STATE_LINKED_JOB = 23

260

Symantec Backup Exec Command Line Applet

Index
A ADBO, offhost backup, 105 agent switches, 87 alert configuration, setting, 48 alert switches, 44 alerts display, 44 respond to, 46 view text, 45 alias backup, in backup job script file, 159 AOFO, setting default options, 102 B Backup Exec Command Line Applet, about, 5 Backup Exec services commands, 80 managing, 80 backup job alias backup in script file, 159 creating, 11 creating using script file, 127, 251 running previously created job, 10 script file, creating and using, 127 switches, 10 backup job script file creating, 127, 251 using for alias backup, 159 backup job switches, 10 backup job template script batch file commands, 241 Exchange server settings, 233 Lotus Domino server settings, 235 media options, 239 NetWare server settings, 236 open file settings, 231 SharePoint Portal Server settings, 234 SQL server settings, 235 backup selection list, deleting, 33 backup template script contents, 228 creating, 228 for Exchange server, 233 for Lotus Domino server, 235 for NetWare, 236 for SharePoint Portal Server, 234 for SQL server, 235 backup-to-disk folders creating, 68 deleting, 70 viewing properties, 70 bemcmd command, 7 bjscript.txt, 127 bjtemplatescript.txt, 227 C catalog job creating using script file, 181 script file, creating and using, 181 catalog job script file, creating, 181 catalogscript.txt, 127 cleaning job, creating, 58 cleaning slot, designating, 57 command line applet, using, 6 command line switches administrating jobs, 29 backup job, 10 restore job, 36 used with all operations, 9 D default options Active Directory, 110 ADBO, 104 AOFO, 102 backup-to-disk, 122 catalog, 120 database maintenance, 123 DB2, 123 display progress indicators for job, 93 Exchange server, 108 for backup jobs, 96 for restore jobs, 99 IDR, 121 job default options, 94 job log, 105 job status and recovery, 119 Linux, UNIX, and Macintosh, 114 Lotus Domino, 112 media, 121 Microsoft SharePoint, 109 NDMP, 115 261

NetWare SMS, 114 network and security, 100 Oracle server, 112 reports, 125 schedule, 119 setting, 92 setting general options, 93 setting job priority, 94 setting startup inventory option, 93 SQL server, 106 storage provisioning, 118 trial job, 101 device management switches, 51 devices, managing, 51 discovery job creating using script file, 186 script file, creating and using, 186 discovery job script file creating, 186 setting discovery options, 187 setting general options, 186 setting schedule options, 189 specifying domains, 189 discoveryscript.txt, 127 djscript.txt, 127 djtemplatescript.txt, 227 drive pool creating, 60 deleting, 72 duplicate backup job, creating using script file, 192 duplicate backup template script creating, 245 setting device and media options, 194 setting general options, 192 duplicate job script file, creating, 192 E eject media job, 67 encryption keys, creating and maintaining, 26 error-handling rules switches, 49 Exchange server restore job script file entries, 165 Exchange Server, backing up, 16 G global command line switches, 9

I inventory job robotic library, 60 stand-alone drive, 69 J job administrating, 29 canceling, 29 job log, copying to console, 31 job monitor switches, 29 job priority, specifying, 10, 25 job status messages, 259 L label media, 66, 75 logon account switches, 81 Lotus Domino Agent backup job script method, using, 139, 235 setting default options, 112 using for backup, 18 M media erasing, 64 formatting, 66 label, 75 labeling, 66 moving, 74 renaming, 75 retension tape, 65 media management switches, 51 media options backup job template script, 239 default, 121 media overwrite protection period, setting, 63 media protection level, setting for backup job, 14 media server pool adding server to, 73 creating, 72 deleting, 72 displaying ID, 73 removing server from, 74 renaming, 72 media sets creating, 59 deleting, 71

262

Symantec Backup Exec Command Line Applet

media vault adding media to, 76 creating, 75 deleting, 75 displaying, 76 media, managing, 51 move media, 74 O offhost backup, choosing single volume snap, 105 online help, 9 Oracle Agent, backing up, 19 P policy job creating using script file, 221 template script files, 227 policy values, 223 pre/post commands restore job script file, 168 using backup job template script file, 241 priority, specifying for backup job, 12 properties physical disk on storage array, 77 storage array, 77 R rename media, 75 report switches, 84 requirements, 6 restore job creating using script file, 162 running previously created, 36 script file, creating and using, 162 restore job script file creating, 162 running, 36 rjscript.txt, 127 RMAN restoring Oracle database, 38 using for backup job, 23 robotic library partitions, creating, 76 S schedule script file using with device and media operations, 256 values, 256 V

script file about, 127 backup, 228 duplicate backup job, 245 restore job, 44 saving and launching, 207 synthetic full, 251 updating for this release, 5 selection lists creating, 28 creating using script file, 208 script file using in command line applet, 208 values for, 208 server drive, backing up, 15 sftemplatescript.txt, 227 SQL 7.0 backing up, 18 placing in standby mode or load state, 18 SQL Server backing up, 17 restoring, 39 storage array configure, 78 configure virtual disk, 79 detect, 79 rename, 79 Storage Provisioning Option default options, 118 synthetic full job template script, creating, 251 T templates backup script, 228 duplicate backup job script, 245 synthetic full job script, 251 using script files, 227 test run job creating using script file, 199, 204 script file, creating and using, 199, 204 test run script file, 199, 204 testrunscript.txt, 127 virtual disk configure, 79 rename, 79

Index

263

264

Symantec Backup Exec Command Line Applet