Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

SymantecTM Backup Exec For Windows Servers

Download as pdf or txt
Download as pdf or txt
You are on page 1of 254

SymantecTM Backup Exec for

Windows Servers

Command Line Applet


Symantec Legal Notice
Copyright © 2007 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

2 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Backup job operations and switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Operations and switches for administrating jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Restore job operations and switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Operations and switches for viewing and responding to alerts . . . . . . . . . . . . . . . 49
Operations and switches for error-handling rules . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Operations and switches for managing media and devices . . . . . . . . . . . . . . . . . . . 55
Backup Exec services commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Logon account operations and switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Report operations and switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Database management operations and switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Setting default options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Using job script files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Creating a backup job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Creating a restore job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Creating a catalog job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Creating a discovery job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Creating a duplicate backup job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Creating a test run job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Creating a copy job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Saving and launching the job script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Using scripts and selection lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Creating a selection list script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Using Policy Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

3
Creating a policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Using job template script files within a policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Creating a backup job template script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Creating a duplicate backup job template script file . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Creating a synthetic full job template script file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Using a schedule script with device and media operations . . . . . . . . . . . . . . . . . . . . . 241
Understanding job status messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

4 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.

5
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 Pentium system

Memory Required 16 MB RAM

Disk Space A minimum of 1 MB of hard disk space after Microsoft Windows is


installed

Other Hardware CD-ROM

Using the Command Line Applet


The Backup Exec Command Line Applet is installed with Backup Exec for Windows
Servers. 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 files beclass.dll, libvxsigcomp2.dll,
vxcrypto.dll, besocket.dll, bestdutl.dll, msvcr71.dll, and msvcp71.dll must exist on
that computer. If they do not already exist, copy them 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.

6 Symantec Backup Exec Command Line Applet


Using command line switches

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:
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.

7
Using command line switches

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.

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.

-?operation number Displays help about a command line operation.


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

-llogfile Directs all output to a specified logfile and to the console. You
must specify the logfile name where the output is to be written.

-la:logfile Appends all output to the specified logfile and to the console. You
must specify the logfile name where the output is to be written.

8 Symantec Backup Exec Command Line Applet


Using command line switches

Command line switches for all operations (continued)

Item Description

-nuser name 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.

-ppassword 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.

-tBackup Exec server Specifies the type of OS the server is running. The default is
type Windows.
To specify a NetWare server, type -tNW.
To specify a Windows server, type -tNT.

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

-w Waits for the job to complete before exiting the program. The
commands with switch -w returns a 1 if successful or -1 on-0
failure.

--deprecation 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.

--category Displays category numbers that you append to the -? switch.

9
Using command line switches

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 Function Description


Switches

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

-jjob name or Required. Specifies the name or the job ID of


-ijob ID 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.

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o2 Create backup Creates and runs a backup job for a specified
job 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.

10 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-jjob name Specifies the name Backup Exec will assign to


this job. If you do not specify a name, a
default name is generated.

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

-sd:device name 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.

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-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.

11
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-sfile list or Required. Specifies a path to a group of files,


-sf:file name the name of a file that contains a list (one per
or line) of files, or an existing selection list name
-sl:selection to be backed up.
list name 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:

12 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

◆ 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.

-mp:media Specifies the media protection level:


protection ◆ 0 = Overwrite
level
◆ 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.

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-e or -ef:file Specifies a list of items or the name of a file


name that contains a list of items to exclude from
the backup job.

-rl: List of server Specifies the server name and logon account
and logon GUIDs. The list should be comma delimited.
accounts

13
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-rf: 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.

-o3 Back up server Creates and runs a backup job to back up the
drive 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.

-jjob name Specifies the name that Backup Exec will


assign to this job.

-ddrive name 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.

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-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.

14 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

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

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o4 Back up This operation is not for Exchange 2000. If


Exchange server you are running Exchange 2000, use
operation -o6.
Creates and runs a backup job to back up the
Microsoft Exchange Server on the media
server. Returns a job instance ID. Also returns
a 1 if the command succeeds or a -1 if the
command fails.
Note While individual mailboxes cannot be
selected for backup, all mailboxes are
included in a server backup.

The Agent for Microsoft Exchange


Server must be enabled on the Backup
Exec server in order to back up the
Exchange Server.

-jjob name Specifies the name that Backup Exec will


assign to this job.

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-pn:media
server pool
name

15
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-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 Applet or the Backup Exec
Administration Console, as long as that job
has already been created and saved.

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o5 Back up SQL This option is not for SQL 2000. If you are
server running SQL 2000, use operation -o8.
Creates and runs a backup job to back up the
Microsoft SQL Server on the media server.
Returns a job instance ID. Also returns a 1 if
the command succeeds or a -1 if the
command fails.
Note Although individual tables and file
groups cannot be selected for backup,
all subcontainers except for the master
filegroup are included in a server
backup.

The Agent for Microsoft SQL Server


must be enabled on the Backup Exec
server in order to back up a SQL Server.

-jjob name Specifies the name that Backup Exec will


assign to this job.

16 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-lo:database Specifies the log backup option.


mode

-db:database Specifies the name of a database to back up.


name

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-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.

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

17
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-o6 Back up Creates and runs a backup job for Exchange


Exchange 2000 2000 Server. Returns a job instance ID. Also
server 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.

-sg:storage Required. Specifies the storage group to back


group up.

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-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 Applet or the Backup Exec
Administration Console, as long as that job
has already been created and saved.

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

18 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-o8 Back up SQL Creates and runs a backup job for SQL Server
Server 2000 2000. 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.

-jjob name Specifies the name that Backup Exec will


assign to this job.

-db:database Specifies the name of the database to back


name up.

-ni:named Specifies the named instance to back up.


instance

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-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.

19
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-lo:database Places a Microsoft SQL Server database in


mode 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.

-o9 Back up Creates and runs a backup job for the


MicroSoft Microsoft SharePoint Portal Server 2001.
SharePoint Returns a job instance ID. Also returns a 1 if
Portal Server the command succeeds or a -1 if the
2001 command fails.
The Agent for Microsoft SharePoint must be
enabled on the media server in order for this
command to work.

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-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.

20 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

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

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-jjob name Specifies the name that Backup Exec will


assign to this job.

-o17 Back up Lotus Creates and runs a backup job of the Lotus
Notes server Notes server. Returns a 1 if the command
succeeds or a -1 if the command fails.

-jjob name Specifies the name that Backup Exec will


assign to this job.

-ddrive name Required. Specifies the drive letter where


Lotus Notes is installed.

-tl:path Specifies the complete path to the


transaction log file.

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-pn:media
server pool
name

21
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

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

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o18 Back up Oracle Creates and runs a backup job of the Oracle
server 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.

-si:SID name Required. Specifies the SID name to back up.

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-pn:media
server pool
name

22 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-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 Applet or the Backup Exec
Administration Console, as long as that job
has already been created and saved.

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

23
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-o19 Create alias Creates and runs an alias backup. Files to be


backup job backed up are specified as a comma delimited
list (for example, “c:\dir\file” or
“\\server\share name\...”) with a matching
comma delimited list of aliases.
Returns a job instance ID. Also returns a 1 if
the command succeeds or a -1 if the
command fails.
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 temporary share
may be created when a mirror is split. Or 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.
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.

-jjob name Specifies the name that Backup Exec will


assign to this job.

-mmedia set Specifies the name of the media set that


Backup Exec should target.

-mp:media Specifies the media protection level:


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

24 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-ddevice name Specifies the name of the device that Backup


Exec should use for the alias backup.

-sd:device name 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.

25
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-sfile list or Required. Specifies the host path of files or


-sf:file name specifies the name of a file that contains a list
(one per line) of files to be backed up and
aliased. The list should be comma delimited.
By default, subdirectories will be recursed. To
skip subdirectories during backup, /n should
be placed before the last quotation mark.
Specifies the list of files to back up or
specifies the name of a file that contains a list
(one per line) of files to be backed up.
Specifies the host path of files to be backed
up and aliased. The list should be comma
delimited. By default, subdirectories will be
recursed. To skip subdirectories during
backup, /n should be placed before the last
quotation mark.
For example:
“c:\dir\file” or “\\server\ share name\.../n"
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
ordered last.

26 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-aalias list Required. Specifies a second host drive (the


device alias) for all the selections listed in the
-s switch list. The device that you specify
must be a drive letter followed by a colon,
such as "G:". You must include a matching
comma delimited list of aliases for the
selections specified in the -s switch list.
Note This switch cannot be used with the -sf
switch.

-sf:filename Use this switch instead of -s and -a to specify


the name of a file that contains a list (one per
line) of files to be backed up.
Note This switch cannot be used with the -s
and -a switches.

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-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.

-w Wait for job Specifies that the Command Line Applet


completion should wait for the operation to complete
before returning.

-g Specifies that the a frozen image is to be


backed up.

27
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-o24 Back up a Creates and runs a backup job for the


Microsoft Microsoft SharePoint Portal Server 2003.
SharePoint Returns a job instance ID. Also returns a 1 if
Portal Server the command succeeds or a -1 if the
2003 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 Required. Specifies the name of a Web


name server that belongs to the farm.

-fm:farm name Required. Specifies the SharePoint Portal


Server farm to back up.

-cf Includes the Configuration database in the


backup job.

-ss Includes the Single sign-on database in the


backup job.

-ds Includes the Document Library store in the


backup job.

-ps:portal site Specifies a list portal sites to back up. This


name 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.

28 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-ws:Windows Specifies a list of Windows SharePoint


SharePoint Services site name to back up. This list should
Services sites 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 Specifies a list of backward compatible


library names 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.

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

29
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

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

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning. If the job is a scheduled job (not a
run now job), the -w is ignored.

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-pn:media
server pool
name

-o28 Use Oracle Use RMAN to create and run a backup job for
Recovery an Oracle database. Returns a job instance ID.
Manager Also returns a 1 if the command succeeds or a
(RMAN) to back -1 if the command fails.
up an Oracle
database

-svr:server name Required. Specifies the name of a server


on which Oracle runs.

-sid:Oracle SID Required. Specifies the Oracle server ID.

-a Backup up all archived logs.

-jjob name Specifies the name that Backup Exec will


assign to this job.

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

30 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning. If the job is a scheduled job (not a
run now job), the -w is ignored.

-o52 Back up a Creates and runs a backup job for the


Microsoft Microsoft SharePoint Portal Server 2007.
SharePoint Returns a job instance ID. Also returns a 1 if
Portal Server the command succeeds or a -1 if the
2007 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 Required. Specifies the name of a Web


name server that belongs to the farm.

-fm:farm name Required. Specifies the SharePoint Portal


Server farm to back up.

-cf: Includes the Configuration database in the


backup job.

-ss: Includes the Single sign-on database in the


backup job.

-ca Backs up the central administration site.

-wa:Web Specifies the name of the Web application.


application You can list multiple names.
name

-sp: shared Specifies the name of the shared server


service provider. You can list multiple names.
provider name
or -ssp shared
service
provider name

31
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-si Backs up the shared instance.

-gs Backs up the global settings.

-jjob name or Required. Specifies the name or the job ID of


-ijob ID 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.

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

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning. If the job is a scheduled job (not a
run now job), the -w is ignored.

32 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-e Enables Backup Exec Granular Recovery


Technology (GRT), which lets you restore
individual items from tape.

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-pn:media
server pool
name

-o90 Launch job Executes a job based on the contents of a


using job script script file. Return values depend on the type
file 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 119.

-fscript file Required. Specifies the name of the Backup


Exec job script file.

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning. If the job is a scheduled job (not a
run now job), the -w is ignored.

-o99 Manage an Creates and maintains encryption keys.


encryption key

-kkey name Required. Specifies the name of the


encryption key.

-pp:pass phrase 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.

33
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-em:encryption Specifies the encryption method to use.


method 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 Specifies the encryption type to use for this


type (128 or key. Your choices are 128-bit AES or 256-bit
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.

34 Symantec Backup Exec Command Line Applet


Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-dk: 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 Required. Specifies the name of the selection


name list.

-ddescription A brief description of the selection list.

-fscript file 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 CD.

-sn:media Specifies a preferred server name or media


server name or server pool name for the job.
-pn:media
server pool
name

-pi:pool ID Specifies a preferred server pool ID for the


job.

35
Using command line switches

Backup job commands (continued)

Operation Additional Function Description


Switches

-o999 Error code Displays an error message for an error code.


lookup

-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 Function Description


Switches

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

-jjob name or Required. Specifies the name or the job ID


-ijob ID that contains the job statuses to display.

-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 Required. Specifies the name or the job ID of


-ijob ID the job to cancel.

-o20 Cancel job Cancels a job. Returns a 1 if the command


succeeds or a -1 if the command fails.

-jjob name or Required. Specifies the name or the job ID of


-ijob ID the job to cancel.

36 Symantec Backup Exec Command Line Applet


Using command line switches

Job monitoring switches (continued)

Operation Additional Function Description


Switches

-o21 Dump Displays completed job status. Returns a 1 if


completed job the command succeeds or a -1 if the
status command fails.

-ijob ID or Specifies the job ID or job history ID that


-hi:job history contains the job statuses to display.
ID

-e Use this switch with -ijob ID to display


details for the last instance of the job.

-li:job ID Use this switch to display a list of all job


history IDs for the specified job ID.

-o22 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.

-i Use this switch to display job IDs.

-j Use this switch to display job names.

-o23 Query job Displays information about all job states and
job types in the Job Monitor.

-sjob state Specifies the state of the job you want to


query.

-qjob type Specifies the type of job you want to query.

-i Use this switch to display job IDs.

-j Use this switch to display job names.

-js: Use this switch to display a list of available


job states that you can use with the -s switch.

-jt: Use this switch to display a list of available


job types that you can use with the -q switch.

37
Using command line switches

Job monitoring switches (continued)

Operation Additional Function Description


Switches

-o30 Dump job log Copies to the console the job log name that is
name of associated with the specified job ID or job
completed job name. Returns a 1 if the command succeeds
or a -1 if the command fails.

-jjob name or Required. Specifies the name or the job ID of


-ijob ID the job.

-o31 Dump job log Copies to the console the contents of the job
contents log specified on the command line. Returns a
1 if the command succeeds or a -1 if the
command fails.

-ffile name Required. Specifies the job log name.

-soutput style Specify a 0 for text output or 1 for HTML


output.

-o35 Rename a job Renames a job. Returns a 1 if the command


succeeds or a -1 if the command fails.

-ijob id Rename job Required. Instructs Backup Exec to rename


associated with the job associated with the job IDs.
the job ID.

-jjob name Current name of Required. Instructs Backup Exec to rename


the job to the job.
rename.

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

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

38 Symantec Backup Exec Command Line Applet


Using command line switches

Job monitoring switches (continued)

Operation Additional Function Description


Switches

-ffilename Required.Specifies a file that contains a list


of jobs (one per line) to place on hold.

-o201 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.

-ffilename Required. Specifies a file that contains a list


of jobs (one per line) to place on hold.

-o202 Delete Deletes a scheduled job.


scheduled job You must specific the -j switch.

-jjob name or Required. Specifies the name or the job ID of


-ijob ID the job to cancel.

-ds: Delete the If the scheduled job is not deleted, the


selection list if selection list is not deleted, and a -1 is
no other jobs are returned.
using it 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.

-o221 Delete a backup Deletes the specified backup selection list.


selection list

-sselection Required. Specifies the name of the selection


list name or list or filename to delete.
-ffilename

-o251 List all backup Displays all available backup selection lists.
selection lists. Returns a 1 if the command succeeds or a -1 if
the command fails.

39
Using command line switches

Job monitoring switches (continued)

Operation Additional Function Description


Switches

-o312 Disable error Disables an error-handling rule.


handling rule

-irule ID Required.Specifies the ID of the rule being


disabled.

-o506 Dump job Displays job, selection, and schedule


information information stored on this server. Also
returns a 1 if the command succeeds or a -1 if
the command fails.

-jjob name Specifies the name of the job that contains


information that you want to be dumped.

-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 Displays the contents of the specified


lists selection list. If a selection list is not
specified, all selection lists will be dumped.

-sselection Specifies the name of the selection list.


list name

-o509 Dump policy Displays the contents of the specified policy.


information If a policy is not specified, all policies will be
dumped.

40 Symantec Backup Exec Command Line Applet


Using command line switches

Job monitoring switches (continued)

Operation Additional Function Description


Switches

-ipolicy ID Required. Specifies the GUID for the policy.


To find the ID for a policy, use operation
-o263 to display the policies on a computer.

-j Instructs Backup Exec to display policy name.

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 Function Description


Switches

-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 Required. Specifies the name or the job ID of


-ijob ID the previously defined job that Backup Exec
should 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.

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

41
Using command line switches

Restore job commands (continued)

Operation Additional Function Description


Switches

-o27 Restore Creates and runs a restore job of a Microsoft


Microsoft SharePoint Portal Server 2003 through a
SharePoint server farm.
Portal Server
2003 job

-fm:farm name Required. Specifies the SharePoint Portal


Server farm to restore.

-cf Includes the Configuration database in the


restore job.

-ss: Includes the Single sign-on database in the


restore job.

-ds: Includes the Document Library store in the


restore job.

-ps:portal site Specifies a list of portal sites to restore. This


name list should be comma delimited.
You can display a list of portal sites if you use
the -o26 switch.

-ws:Windows Specifies a list of Windows SharePoint


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

-dl:document Specifies a list of backward compatible


library names 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 Specifies the earliest date range to perform a


than date point-in-time restore.

-nl:no later Specifies the latest date range to perform a


than date point-in-time restore.

42 Symantec Backup Exec Command Line Applet


Using command line switches

Restore job commands (continued)

Operation Additional Function Description


Switches

-jjob name Specifies the name that Backup Exec will


assign to this job.

-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 Instructs the Command Line Applet to wait


completion 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 Required. Specifies the Oracle server ID.

-act:logon Specifies the logon account name to log on to


account name 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.

-tb:tablespace Specifies a list of tablespace names to restore.


names This list should be comma delimited.

-ne:no earlier Specifies the earliest date range to perform a


than date point-in-time restore.

43
Using command line switches

Restore job commands (continued)

Operation Additional Function Description


Switches

-nl:no later Specifies the latest date range to perform a


than date point-in-time restore.

-jjob name Specifies the name that Backup Exec will


assign to this job.

-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 Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o36 Create a SQL Creates and runs a restore job of a SQL 2000
2000 server server.
restore job

-db:named Required. Specifies the named instance of


instance and SQL 2000 the databases are in.
database name

-dt:backup date Restores the most recent backup job no later


than the specified date.

-jjob name Specifies the name that Backup Exec will


assign to this job.

44 Symantec Backup Exec Command Line Applet


Using command line switches

Restore job commands (continued)

Operation Additional Function Description


Switches

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

-o38 Search catalog Searches the catalog for protected resources.

-vn:volume name Specifies the name of the volume that you


want to search.

-mn:media name Specifies the name of the media that you


want to search.

-ne:no earlier Specifies the earliest date range to perform a


than date point-in-time search.

-nl:no later Specifies the latest date range to perform a


than date point-in-time search.

-fn:filename Specifies the type of file by which you want to


search. You can use a type of filename such as
.doc.

-pa:path name Specifies the path by which you want to


search.

-sn:server name Specifies the server name by which you want


to search.

-d Search by directories only.

-s Include subdirectories in the search.

-o39 Create a restore Runs a restore of NTFS volumes that include


job of NTFS system state and shadow copy components.
volumes

45
Using command line switches

Restore job commands (continued)

Operation Additional Function Description


Switches

-pa:selection Required. Specifies the selection to restore.


path 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 Specifies the earliest date range to perform a


than date point-in-time restore.

-nl:no later Specifies the latest date range to perform a


than date point-in-time restore.

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

46 Symantec Backup Exec Command Line Applet


Using command line switches

Restore job commands (continued)

Operation Additional Function Description


Switches

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o54 Restore Creates and runs a restore job of a Microsoft


Microsoft SharePoint Portal Server 2007 through a
SharePoint server farm.
Portal Server
2007 job

-fm:farm name Required. Specifies the SharePoint Portal


Server farm to restore.

-cf Includes the Configuration database in the


restore job.

-ss: Includes the Single sign-on database in the


restore job.

-ca Restores the central administration site.

-wa:Web Specifies the name of the Web application.


application You can list multiple names.
name

-sp: shared Specifies the name of the shared server


service provider. You can list multiple names.
provider name
or -ssp shared
service
provider name

-gs Restores the global settings.

-ne:no earlier Specifies the earliest date range to perform a


than date point-in-time restore.

-nl:no later Specifies the latest date range to perform a


than date point-in-time restore.

-j job name Specifies the name that Backup Exec will


assign to this job.

47
Using command line switches

Restore job commands (continued)

Operation Additional Function Description


Switches

-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 Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o90 Launch job Executes a job based on the contents of a


using job script script file. Return values depend on the type
file 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 119.

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

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning. If the job is a scheduled job (not a
run now job), the -w is ignored.

See also:
“Using job script files” on page 119

48 Symantec Backup Exec Command Line Applet


Using command line switches

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 Function Description


Switches

-o40 Get number of Displays the number of alerts on the


alerts computer. Returns a 1 if the command
succeeds or a -1 if the command fails.

-i Dump alert IDs Displays all the alert IDs on the screen.

-tl: Show titles Displays titles of alerts.

-jserver name Displays alerts generated from the specified


server only.

-h Displays history alerts.

-s Displays the name of the server that


generated the alert.

-d Displays the date the alert was generated.

-o42 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.

-ialert ID or -a Required. Use -i to display a specific alert or


-a to display active alerts.

-w Wait for alert Instructs the Command Line Applet to


response prompt for a response to the alert.

-o43 Get number of Displays the number of non-critical


information (information only alerts) on the computer.
only alerts Also returns a 1 if the command succeeds or a
-1 if the command fails.

-i Dump all alert If -i is used with this command, all alert IDs
IDs will be displayed on the screen.

-tl: Show titles Displays alert titles.

49
Using command line switches

Managing alerts switches (continued)

Operation Additional Function Description


Switches

-jserver name Displays alerts generated from the specified


server only.

-s Displays the name of the server that


generated the alert.

-d Displays the date the alert was generated.

-o44 Get number of Displays the number of user intervention


user alerts on the computer. Also returns a 1 if the
intervention command succeeds or a -1 if the command
(critical) alerts fails.

-i Dump all alert If -i is used with this command, all alert IDs
IDs will be displayed on the screen.

-tl: Show titles Displays alert titles.

-jserver name Displays alerts generated from the specified


server only.

-s Displays the name of the server that


generated the alert.

-d Displays the date the alert was generated.

-o45 Clear all Clears all current information only alerts.


information Returns a 1 if the command succeeds or a -1 if
only alerts 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.

-rresponse or -w Required. Specifies a response. Responses


are OK, YES, NO, CANCEL, RETRY,or IGNORE
or instructs the Command Line Applet to
prompt for a response.

50 Symantec Backup Exec Command Line Applet


Using command line switches

Managing alerts switches (continued)

Operation Additional Function Description


Switches

-arespond to Specifies an OK response to informative


all alerts. If you specify the -a switch you cannot
informative use the -w switch.
alerts

-o47 Get all warning Displays the number of warning alerts on the
alerts computer. Also returns a 1 if the command
succeeds or a -1 if the command fails.

-i Dump all alert If -i is used with this command, all alert IDs
IDs display on the screen.

-tl: Show titles Displays alert titles.

-jserver name Displays alerts generated from the specified


server only.

-s Displays the name of the server that


generated the alert.

-d Displays the date the alert was generated.

-o48 Get all error Displays the number of error alerts on the
alerts computer. Also returns a 1 if the command
succeeds or a -1 if the command fails.

-i Dump all alert If -i is used with this command, all alert IDs
IDs display on the screen.

-tl: Show titles Displays alert titles.

-jserver name Displays alerts generated from the specified


server only.

-s Displays the name of the server that


generated the alert.

-d Displays the date the alert was generated.

-o49 List alert Displays alert categories. Returns a 1 if the


categories command succeeds or a -1 if the command
fails.

51
Using command line switches

Managing alerts switches (continued)

Operation Additional Function Description


Switches

-i Dump all alert If -i is used with this command, all alert IDs
IDs will be displayed on the screen.

-j Display alert Displays alert names on screen.


category name

-ac: Display event Displays the alert category on screen.


category

-o50 Dump alert Displays the configuration for alerts on


configuration screen. Returns a 1 if the command succeeds
or a -1 if the command fails.

-ialert Required. Specifies an alert ID to display


category ID configuration information for.

-o51 Set alert Modifies the alert configuration.


configuration

-ialert Required. Specifies an alert ID to display


category ID configuration information for.

-e or -d Enable alert or Enables or disables the specified alert for


disable alert reporting by Backup Exec. Some alerts types,
such as error and attention required, are
always enabled.

-no: or -nn: Enable Enables or disables the sending of a


notification or notification when the alert occurs. Recipients
disable must be configured to use this option.
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

52 Symantec Backup Exec Command Line Applet


Using command line switches

Managing alerts switches (continued)

Operation Additional Function Description


Switches

-s or -ns: Enable sending Enables or disables the sending of alert


of SNMP notifications through SNMP.
notifications or
disable sending
of SNMP
notifications

-rl: or -nr: Enable event Enables or disables the logging of events in


logging or the Windows event log.
disable event
logging

-ac:timeout or Set time for Sets the time in days, hours, or minutes for
-na: automatic Backup Exec to automatically clear the alert
clearing of alert or disables the automatic clearing of alerts.
or disable Set the time as D=days, H=hours, or
automatic alert M=minutes.
clearing The length of time entered cannot be more
than seven days.

-ar:response Set the Sets the automatic response for an alert. The
automatic possible responses are Yes, No, and Cancel.
response for an
alert.

-o150 Dump Displays the recipients that have defined


notification notification methods. Returns a 1 if the
recipients command succeeds or a -1 if the command
fails.

53
Using command line switches

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 Function Description


Switches

-o310 Display Displays the error-handling rules.


error-handling
rules

-o311 Enable error


handling rule

-irule ID Required. ID of the rule that is to be enabled.

-mr:maximum Indicates that the job should be retried and


retries the number of times the job is to be retried.
The range for maximum retries is 1 to 99.

-ri:retry Indicates that the job should be retried and


interval the number of minutes to wait before the job
is retried. The range for the retry interval is 1
to 1,440.

-pj: Pause job on Indicates the job is to be paused until the user
error has taken action to clear the error. If this
switch is absent, the job will be cancelled
until its next scheduled run.

-cj: Cancel job on Indicates the job is to be cancelled if an error


error occurs.

-no:notes Specifies miscellaneous information for the


error-handling rule.

-o312 Disable error Disables the specified error-handling rule.


handling rule

-irule ID Required. Specifies the error-handling rule


that is to be disabled.

54 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 Function Description


Switches

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

-ddrive name or Required. Specifies the name or the ID of the


-idrive ID drive.

-o63 Get number of Displays the number of managed drives.


drives Returns a 1 if the command succeeds or a -1 if
the command fails.

-i Displays drive IDs for all drives.

-j Displays names for all drives.

-o64 Get number of Displays the number of managed drives that


drives available 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.

-i Displays drive IDs for all drives.

-j Displays names for all drives.

-o65 Get number of Displays the number of managed drives that


drives paused are paused. Returns a 1 if the command
succeeds or a -1 if the command fails.

-i Displays drive IDs for all drives.

-j Displays names for all drives.

55
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-o66 Get number of Displays the number of managed drives that


drives offline are offline. Returns a 1 if the command
succeeds or a -1 if the command fails.

-i Displays drive IDs for all drives.

-j Displays names for all drives.

-o67 Dump drive Displays general properties of a drive.


properties Returns a 1 if the command succeeds or a -1 if
the command fails.

-ddrive name or Required. Specifies the name or the ID of the


-idrive ID drive.

-o68 Query devices

-o69 Get number of Displays the number of media sets. Returns a


media sets 1 if the command succeeds or a -1 if the
command fails.

-i Displays the media set IDs for all media sets.

-j Displays the names of all media sets.

-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 Required. Specifies the media set ID or


or -jmedia set media set name.
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 Required. Specifies the media set ID or


or -jmedia set media set name.
name

56 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-o78 Set robotic Sets properties for a robotic library.


library
properties

-drobotic Required. Specifies the robotic library to


library target for this operation.

-nd:new robotic Specifies the name for the robotic library.


library name

-ps:pause or Enter 1 to pause the robotic library;


resume drive otherwise, enter 0 to resume.

-e:enable or Enter 1 to enable the robotic library;


disable otherwise, enter 0 to disable the robotic
robotic library.
library

-es:enable or Enter 1 to enable the startup initilization;


disable otherwise, enter 0 to disable the startup
startup initilization.
initialization

-er:enable or Enter 1 to enable the removable storage;


disable otherwise, enter 0 to disable the removable
startup storage.
initialization

-eb:enable or Enter 1 to enable bar code rules; otherwise,


disable bar enter 0 to disable bar code rules.
code rules

-sb:slot base Specifies the starting slot. Some robotic


libraries have slots starting at "0"; others
start at "1".

-o79 Set device Sets properties for a device.


properties

-ddevice name Required. Specifies the device to target for


this operation.

57
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-ndnew device Specifies the name for the device.


name

-ps:pause or Enter 1 to pause the device; otherwise, enter


resume device 0 to resume.

-e:enable or Enter 1 to enable the device; otherwise, enter


disable device 0 to disable the device.

-e:enable or Enter 1 to enable compression; otherwise,


disable enter 0 to disable compression.
compression

-bkblock size Specifies the size of the blocks of data written


to the device.

-bfbuffer size 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.

-bcbuffer count Specifies the number of buffers allocated for


this device.

-hwhigh water Specifies the number of buffers to be filled


count before data is first sent to the device, and any
time after that if the device underruns.

-rsRead single Specifies that this device read only one block
block mode of data at a time.

-wsWrite single Specifies that this device write only one block
block mode of data at a time.

-rpRead SCSI Specifies that this device read data without


pass-through going through a Microsoft tape device API.
mode Selecting this check box allows the data to
pass directly through the device and allows
more detailed information if device errors
occur.

58 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-wpWrite SCSI Specifies that his device write data without


pass-through going through the Microsoft tape device API.
mode Selecting this check box allows data to pass
directly through the device driver and allows
more detailed information if device errors
occur.

-r Resets the preferred configuration settings to


the default.

-s Resets the cleaning statistics.

-o80 Import drive Imports a list of backup tapes. Returns job ID


slots and 1 if the command succeeds, or a -1 if the
command fails.

-arobotic Required. Specifies the robotic library to


library target for this operation.

-ai: Instructs Backup Exec to auto inventory all


slots.

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

-fschedule file 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 241.

59
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-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 Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o81 Export drive Exports a list of backup tapes. Returns the job
slots ID and a 1 if the command succeeds, or a -1 if
the command fails.

-arobotic Required. Specifies the robotic library to


library target for this operation.

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

-fschedule file 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 241.

60 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-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 Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-x Specifies the export of expired media only.

-xc Includes cleaning media in the export of


expired media.

-xi Imports new media to the slot after the


export expired media operation completes.

-o82 Designate Designates a slot to be a cleaning slot.


cleaning slot Returns a 1 if the command succeeds or a -1 if
the command fails.

-arobotic Required. Specifies the robotic library or the


library or slots in the robotic library to target for this
-sslot number operation.
If you specify the slot number, the list should
be comma delimited. If no slots are specified,
then all will be targeted by default.

-o83 Reset slot to be Designates a slot to be a non-cleaning slot.


non-cleaning Returns a 1 if the command succeeds or a -1 if
slot the command fails.

61
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-arobotic Required. Specifies the robotic library or the


library or slots in the robotic library to target for this
-sslot number operation.
If you specify the slot number, the list should
be comma delimited. If no slots are specified,
then all will be targeted by default.

-o84 Get number of Displays the number of managed robots.


robots Returns a 1 if the command succeeds or a -1 if
the command fails.

-i Displays the robot IDs.

-o85 Dump robot Displays property information for the


properties specified robotic library. Returns a 1 if the
command succeeds or a -1 if the command
fails.

-irobot ID or Required. Specifies the ID or the name of the


-drobot name robotic library to display properties for.
If both -i and -d are provided, the -d
parameter is used.

-o86 Dump slot Displays the slot information with header


content descriptions.

-irobot ID or Required. Specifies the ID or the name of the


-drobot name 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.

62 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-o100 Create cleaning Creates and runs a cleaning job on the


job 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 name of the robotic


library drive you want to target.

-fschedule file 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 241.

-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 Instructs the Command Line Applet to wait


completion 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 Required. Specifies the name of the new


name media set.

-op:overwrite Specifies the overwrite protection period for


protection the new media set. Enter the length of time in
period hours.
Enter the value -1 to set the overwrite
protection level to infinite.

63
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-ap:append Specifies the append period for the new


media set. Enter the length of time in hours.

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

-ddrives Specifies a list of drives to add to the drive


pool. The list should be comma delimited.

-o103 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 Required. Specifies the robotic library to


library target for this operation.

-jjob name Specifies a name for the job.

-fschedule file 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 241.

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

64 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-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 Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o104 Lock library Locks the specified robotic library door.


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.

-arobotic Required. Specifies the robotic library to


library target for this operation.

-fschedule file 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 241.

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

65
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o105 Unlock library Unlocks the specified robotic library door.


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.

-arobotic Required. Specifies the robotic library to


library target for this operation.

-fschedule file 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 241.

-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 Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

66 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-o106 Set media Specifies the media overwrite level and


overwrite overwrite options.
protection Returns a 1 if the command succeeds or a -1 if
period 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 Required. Specifies the overwrite level; for


level 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

67
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-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 Required. Specifies the drive name you want


<loader or to target. If -s is used, -ddrive name will be
drive> the name of the robotic library.

-eerase type Required. Specifies the erase type. Erase


types are:
1 = quick erase
3 = long erase

-jjob name Specifies a name for the job.

-fschedule file 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 241.

-sslot numbers Specifies the slot numbers containing the


media to be erased. If this switch is used, -d
will represent the robotic library name.

-mn:media name Specifies the new name of the media.

-mmedia name Required. Specifies the backup-to-disk folder


to erase. You must specify the media in the
backup-to-disk folder to erase.

68 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-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 Instructs the Command Line Applet to wait


completion 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.

-sslot numbers Specifies the slot numbers containing the


media to be retensioned.

-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 Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

69
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

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

-ddrive name Required. Specifies the drive name. If -s is


used, -ddrive name will be the name of the
robotic library.

-mmedia name Required. Specifies the media name.

-sslot numbers Specifies the slot numbers containing the


media to be labeled.

-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 Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o114 Format media 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.

-sslot numbers Specifies the slot numbers containing the


media to be formatted.

70 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-pr:priority 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 Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

-o115 Eject media Ejects the tape in the specified drive. Returns
from drive the job ID and a 1 if the command succeeds,
or a -1 if the command fails.

-ddrive name Required. Specifies the drive 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.

-w Wait for job Instructs the Command Line Applet to wait


completion for the operation to complete before
returning.

71
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

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

-ffolder name 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.

-nbackup sets 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.

-pdisk space Specifies the amount of disk space to reserve


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.

72 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-edevice Specifies the device setting for the


setting 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 Specifies the number of concurrent


jobs operations that you want to allow to this
folder. This number can range from 1 to 16.

-ddirectory 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.

-o117 Inventory a Creates an inventory job on a specified


stand-alone stand-alone drive. Displays the job instance
drive ID. Returns a 1 if the command succeeds or a
-1 if the command fails.

-ddrive name Required. Specifies the drive name.

73
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-jjob name Specifies a name for the job.

-fschedule file Schedules the job. If -fschedule file


represents a scheduled job (not a run now
job), then the -w switch is ignored.

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

-x Uses media auxiliary memory for inventory,


which allows the media to be identified
without having to be mounted.

-w Wait for job Instructs the Command Line Applet to


completion prompt for a response.

-0118 Delete Deletes a list of backup-to-disk folders.


backup-to-disk
folders

-ffolder name Required. Specifies the name of the


backup-to-disk folders to delete.

-o119 Set Sets properties for a backup-to-disk folder.


backup-to-disk
properties

-ffolder name Required. Specifies the name of the


backup-to-disk folder to target for this
operation.

74 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-smaximum Specifies the maximum size for each


backup-to-disk backup-to-disk file contained in this folder,
file size 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.

-qmaximum Specifies the maximum number of backup


number of sets to be written to each backup-to-disk file
backup sets in this folder. The maximum number can
range from 1 to 8192. The default is 100.

-kreserve disk Specifies the amount of disk space to reserve


size 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.

-edevice Specifies the device setting for the


setting 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.

-mnumber of Specifies the number of concurrent


concurrent ops operations that you want to allow to this
folder. This number can range from 1 to 16.

-o120 Delete media set Deletes the specified media set. Returns 1 if
the command is successful or -1 if it failed.

-mmedia set Required. Specifies the name of the media


set.

75
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

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

-o122 Create media This operation is only available if the Central


server pool 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.

-nm:pool name Required. Specifies the name of the media


server pool.

-pd:pool Specifies a description for the media server


description pool.

-si:server IDs or Specifies the media server IDs or names to


-sn:server names add to the media server pool.

-o123 Delete media This operation is only available if the Central


server pool 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 Required. Specifies the IDs or the names of


-nm:pool names the media server pool to be deleted.

-o124 Rename a media This operation is only available if the Central


server pool or Admin Server Option (CASO) is installed.
set a new media Renames the specified media server pool or
pool description 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.

76 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-ipool ID or Required. Specifies the ID of the media


-onm:old pool server pool or the name of the media server
name pool to be renamed.

-nm:new pool Specifies the new name of the media server


name pool.

-pd:pool Specifies a description of the media server


description pool.

-o125 Get media This operation is only available if the Central


server pools 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.

-i Instructs Backup Exec to display the media


server pool ID.

-j Instructs Backup Exec to display the media


server pool name.

-si:server ID or Instructs Backup Exec to only display the


-sn:server name media server pools associated with the media
server ID or media server name specified.

-o126 Add a media This operation is only available if the Central


server to a Admin Server Option (CASO) is installed.
media server Adds a media server to the specified media
pool server pool. Returns a 1 if the command
succeeds or a -1 if the command fails.

-pi:pool ID or Required. Specifies the ID of the media


-pn:pool name server pool or the name of the media server
pool.

-si:server IDs or Specifies the media server IDs or names to


-sn:server names add to the media server pool.

77
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-o127 Remove a media This operation is only available if the Central


server from a Admin Server Option (CASO) is installed.
media server Removes a media server from the specified
pool media server pool. Returns a 1 if the
command succeeds or a -1 if the command
fails.

-pi:pool ID or Required. Specifies the ID of the media


-pn:pool name server pool or the name of the media server
pool.

-si:server IDs or Specifies the media server IDs or names to


-sn:server names remove from the media server pool.

-o128 Get media This operation is only available if the Central


servers in a Admin Server Option (CASO) is installed.
media server Displays the media servers in the media
pool server pools. Returns a 1 if the command
succeeds or a -1 if the command fails.

-pipool ID or Required. Specifies the ID of the media


-pn:pool name server pool or the name of the media server
pool.

-i Instructs Backup Exec to display the media


server ID.

-j Instructs Backup Exec to display the media


server name.

-o130 Move media Moves the specified media. Returns a 1 if the


command succeeds or a -1 if the command
fails.

-i or -jmedia Required. Specifies the ID of the media or the


name media server name to be moved.

-ms:media set Required. Specifies the media set ID to which


ID you want to move the media.

78 Symantec Backup Exec Command Line Applet


Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-o131 Rename media Renames the specified media. Returns a 1 if


the command succeeds or a -1 if the
command fails.

-imedia ID Required. Specifies the name of the media to


be renamed.

-mn:media name Required. Specifies the new name of the


media.

-o132 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 set ID Required. Specifies the ID of the media or the


or -jmedia set media set name to be moved.
name

-o133 Create media Creates a media vault with the specified


vault name to track media stored in specific sites.
Returns a 1 if the command succeeds or a -1 if
the command fails.

-vn:vault name Required. Specifies the name of the media


vault.

-vd:vault Specifies a description for the media vault.


description

-o134 Delete media Deletes the specified media vault. Returns a 1


vault if the command succeeds or a -1 if the
command fails.

-ivault ID or Required. Specifies the ID of the media vault


-vn: vault name or the name of the media vault to be deleted.

-o135 Create robotic Creates a partition consisting of one or more


library slots on the specified robotic library. Returns
partitions a 1 if the command succeeds or a -1 if the
command fails.

79
Using command line switches

Device and media management switches (continued)

Operation Additional Function Description


Switches

-irobot ID or Required. Specifies the ID or the name of the


-drobot name robotic library on which the partitions will be
created.

-sslot numbers 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.

-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 Displays the IDs for all media vaults.

-j Displays the names of all managed media


vaults.

-o137 Add media to a Adds media to the specified media vault.


media vault Returns a 1 if the command succeeds or a -1 if
the command fails.

-imedia set ID Required. Specifies the ID of the media or the


or -jmedia set media set name to be moved.
name

-mv:media vault Required. Specifies the ID of the media vault


ID or -vnmedia or the name of the media vault that the media
vauilt name will be added to.

-o140 Get number of Displays the managed media servers. Returns


media servers a 1 if the command succeeds or a -1 if the
command fails.

-i Displays the media server IDs for all media


servers.

-j Displays the names of all managed media


servers.

80 Symantec Backup Exec Command Line Applet


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 Function Description


Switches

-o107 Set wizards as Sets the registry so that the startup wizards
run do not run. Returns a 1 if the command
succeeds or a -1 if the command fails.

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

-o501 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.

-o502 Start Backup Starts all Backup Exec services on the


Exec system specified computer. Returns a 1 if all services
services start, a 0 if any services fail, or a -1 if the
command fails.

-o503 Stop Backup Stops all Backup Exec services on the


Exec system specified computer. Returns 1 if all services
services stop, a 0 if any services fail, or a -1 if the
command fails.

-o504 Dump Backup Copies to the console each Backup Exec


Exec system system service name and status. Returns a 1
services status if the command succeeds or a -1 if the
command fails.

-o505 Dump Backup Outputs properties for a specified Backup


Exec server Exec server. Returns a 1 if the command
properties succeeds or a -1 if the command fails.

81
Using command line switches

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 Function Description


Switches

-o210 Create logon Creates a logon account for accessing specific


account 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.

-nl:user name Required. Specifies the user name for this


logon account.

-pl:password Specifies the password for this logon account.

-daccount name Required. Provides a name for this logon


account.

-pa:account Specifies if the logon account is restricted or


type common.

-dl: 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 Displays the logon account information on


accounts the console. It will also display logon
accounts of non DJM proxy jobs. Returns a 1
if the command succeeds or a -1 if the
command fails.

-o212 Delete logon Deletes the specified logon account. Returns


account 1 if the command is successful or -1 if it
failed.

82 Symantec Backup Exec Command Line Applet


Using command line switches

Logon Account switches (continued)

Operation Additional Function Description


Switches

-ilogon account Required. Specifies the GUID or the logon


GUID or -jlogin account name of the logon account to be
account name deleted.

-o213 Modify logon Modifies properties for a specific logon


account 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.

-ilogon account Required. Specifies the GUID or the logon


GUID or -jlogin account name of the logon account to be
account name deleted.

-pw:password Specifies the current password for this logon


account.

-pl:password Specifies the new password for this logon


account.

-daccount name Required. Provides a name for this logon


account.

-pa:account Specifies if the logon account is restricted or


type common.

-dl: 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.

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 Function Description


Switches

-o400 Display report Displays the report on the screen.

-i Lists all available report IDs.

-rreport ID Specifies the report ID to view.

-j Lists available parameter names.

-ps:paramstr Specifies parameters and values to use in the


form ’@param1name=value, =value...,
@param2name=value, =value...’.

-o401 Print report Prints the report on the default printer.

-i Lists all available report IDs.

-rreport ID Specifies the report ID to view.

-j Lists available parameter names.

-ps:paramstr Specifies parameters and values to use in the


form ’@param1name=value, =value...,
@param2name=value, =value...’.

-o402 Copy report to Copies the report to a selected file format.


selected file
format

-i Lists all available report IDs.

-rreport ID Specifies the report ID to view.

-j Lists available parameter names.

84 Symantec Backup Exec Command Line Applet


Using command line switches

Report switches (continued)

Operation Additional Function Description


Switches

-ps:paramstr Specifies parameters and values to use in the


form ’@param1name=value, =value...,
@param2name=value, =value...’.

-ffilename Fully qualified filename for the storage


location of the output file. Not valid for -ft:1
(HTML) file types.

-ddirectory Fully qualified directory name for storage


location of output files. Only valid for -ft:1
(HTML) file types.

-ft:format Use:
◆ -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 Insert report Adds a report to the available file list.

-i or -ffilename Required. Lists all available report IDs or the


fully qualified filename for storage location
of report file.

85
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 Function Description


Switches

-o25 Manage a Attach, delete, and rename a Microsoft


Microsoft SharePoint server farms.
SharePoint
Server Farm

-wb:web server Required. Specifies the name of a Web


name server that belongs to the farm.

-fm:farm name 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 Attaches to a new server farm

-d Deletes a server farm.

-nf:new farm Renames an existing farm.


name

-e Enter 1 to enable the specified Web server in


the farm; otherwise, enter 0 to disable the
specified Web server.

-r Replaces a previously defined Microsoft


SharePoint server farm with a new server
farm.

-o26 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.

-wb:web server Displays Web server names.


name

86 Symantec Backup Exec Command Line Applet


Using command line switches

Database management switches (continued)

Operation Additional Function Description


Switches

-fm:farm name Displays components of a specified server


farm.

-cf: Displays configuration database component


names.

-ss: Displays Single-sign on database component


names.

-ds: Displays Document Library store component


names.

-ps:portal site Displays the portal sites and the components


name 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.

-ws:Windows Displays the Windows SharePoint Services


SharePoint sites and the components in the server farms.
Services site 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.

-dl:document Displays the full name of the backward


library names compatible 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.

87
Using command line switches

Database management switches (continued)

Operation Additional Function Description


Switches

-o32 List Oracle Displays a list of Oracle instance information.


instance
information

-svr:server name Required. Specifies the name of a server


on which Oracle runs.

-sid:Oracle SID Required. Specifies the Oracle server ID.

-act:logon Specifies the logon account name to log on to


account name 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.

-tb:tablespace Displays tablespace names.


names

-a Displays all archived logs.

-o53 Lists Microsoft Displays a the components of the specified


SharePoint 2007 Microsoft SharePoint 2007 server farm.
server farms When you specify additional switches,
displays only the applicable components of
the specified server.

-wb:web server Displays Web server names.


name

-fm:farm name Displays components of a specified server


farm.

-cf: Displays configuration database component


names.

-ss: Displays Single-sign on database component


names.

-ca Displays the central administration site


name.

88 Symantec Backup Exec Command Line Applet


Using command line switches

Database management switches (continued)

Operation Additional Function Description


Switches

-wa:Web Displays information about the Web


application application. You can list multiple names.
name

-sp: shared Displays information about the shared server


service provider. You can list multiple names.
provider name
or -ssp shared
service
provider name

-si Displays the search instance.

-gs Displays the global settings.

-o32 List Oracle Displays a list of Oracle instance information.


instance
information

-svr:server name Required. Specifies the name of a server


on which Oracle runs.

-sid:Oracle SID Required. Specifies the Oracle server ID.

-act:logon Specifies the logon account name to log on to


account name 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.

-tb:tablespace Displays tablespace names.


names

-a Displays all archived logs.

89
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

90 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 Function Description

General Default Options

DO_GENERAL_ Display progress Enter 1 to display the percent


ENABLESTATS 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_ Inventory all drives on Enter 1 to inventory all of the media


STARTUPINVENTORY Backup Exec services in the storage devices when Backup
startup 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 library’s slots are
inventoried.

91
Using command line switches

Default option parameters (continued)

Option Name Function Description

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:
◆ 0 = Low
◆ 1 = Lowest
◆ 2 = Medium
◆ 3 = High
◆ 4 = Highest

DO_JOB_LIMITAVAIL Limit availability to a Enter 1 to enable the availability


daily time window window, which specifies when the
selection list is available for backup
each day; otherwise, enter 0.

DO_JOB_LIMITAVAIL_DATE First available date for Enter the first date when the selection
availability window list should be available to be backed
up.

DO_JOB_LIMITAVAIL_BEGINT Begin time for Enter the earliest time when the
IME availability window selection list is available for backup.

DO_JOB_LIMITAVAIL_ENDTI End time for availability Enter the latest time when the
ME window selection list is available for backup.

DO_JOB_RUNJOBIFPRE Run job only if the Enter 1 to run the job only if the
SUCCESS pre-job command is pre-job command is successful;
successful. otherwise, enter 0. If the pre-job
command is not successful, the job
does not run, and is marked as failed.

DO_JOB_RUNPOSTIFJOB Run post-job command Enter 1 to run the post-job command


FAILS even if the job fails. even if the job fails; otherwise, enter 0.

DO_JOB_RUNPOST 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.

92 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_JOB_CMDTIMEOUT Specify time interval for Specifies the amount of time before or
command after the job in which the pre- or
post-command should run.

DO_JOB_FAILIFCMDFAILS Mark job as failed if Enter 1 to have the job marked as


either command fails failed if either the pre-job or post-job
command fails; otherwise, enter 0.

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.

DO_JOB_RUNON Specifies where the Enter one of the following options:


command is to be run ◆ 0 = On this media server
◆ 1 = On each server backed up or
restored to

DO_JOB_ Cancel the job if not Specifies the amount of time Backup
CANCELTHRESHOLD completed within the Exec should wait for the job to
specified time. complete before cancelling the job.
This value should be provided in
minutes.

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

DO_JOB_ Set the default media set Specifies the media set for the job.
MEDIASETGUID

93
Using command line switches

Default option parameters (continued)

Option Name Function Description

Backup Default Options

DO_BACKUP_TYPE Select default backup Specifies the backup method to be


method used. Methods are:
◆ 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_ Enable single instance Enter 1 to ensure that only one


SINGLEBACKUPNTFS 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.

DO_BACKUP_ Set last access date Note If 5 was entered as the value for
LASTACCESSEDDAYS 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

94 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_BACKUP_ Set media overwrite Specify one of the following values:


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

DO_BACKUP_ Set compression method Enter a number from 0 to 3 that


COMPRESSIONTYPE 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 Enter 1 to collect information about


information for synthetic files and directories that have been
backup and for true moved, renamed, or newly installed
image restore since the last backup job. These files
and directories are included in the
backup. Otherwise, enter 0.

DO_BACKUP_AUTOVERIFY Verify after backup 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.

DO_BACKUP_ Calculate checksums Enter 1 if the checksums are to be


INSERTCHECKSUMS 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.

95
Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_BACKUP_ Back up local mount Enter 1 to back up mount points that


TRAVERSEPOINTS points 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.

DO_BACKUP_HSM Back up data in remote Enter 1 to back up data that has been
storage 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:
◆ 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_ Use change journal Enter 1 to use Windows NTFS Change


USECHANGEJOURNAL 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.

96 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_BACKUP_ Back up open files if Open Enter a number from 0 to 3 to specify


OPENFILEMETHOD 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_ Back up open file if closed If 3 was entered for the value for
OPENFILESKIPSECS 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.

Restore Default Options

DO_RESTORE_ Restore over existing files Enter 1 to overwrite files on the target
EXISTINGMETHOD device that have the same name as
files that are being restored; otherwise,
enter 0.

DO_RESTORE_CORRUPT 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_ Restore junction points Enter 0 if you want to restore the


JUNCMETHOD method 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
system’s current junction points.

97
Using command line switches

Default option parameters (continued)

Option Name Function Description

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_ Enter 1 to enable selection of Windows


ENABLEDSHARESELECTION user shares; otherwise, enter 0.

DO_NIC_AGENTPORTRANGE Enter a port range to allow remote


agents to use a range of ports for
communications.

DO_NIC_ Enter 1 display the 32-bit number that


AUTOOBTAINSUBNET determines the subnet to which the
network interface card belongs;
otherwise, enter 0.

DO_NIC_ Enter 1 to select the name of the


ANYAVAILABLE network interface card that connects
the media server to the network you
want to use for the backup network;
otherwise, enter 0.

DO_NIC_PROTOCOL Enter one of the following values to


select the protocol you want to use:
◆ 0 = any available protocol
◆ 1 = Use IPv4
◆ 2 = Use IPv6

DO_NIC_MACADDRESS 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.

DO_NIC_SUBNETADDRESS 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.

98 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_ENCRYPTION_TYPE Specify the encryption Enter a number from 0 through 3 to


method to use specify the encryption type.
Selections are as follows:
◆ 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_THREATLEVELTRIG Set Symantec ThreatCon Enter a number from 0 through 4 to


GER 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_ Check logon credentials Enter 1 to verify that the logon


CHECKCREDENTIALS for trial run job account is correct for the volumes
being backed up; otherwise, enter 0.

DO_TRIAL_ Check media capacity for Enter 1 to test whether enough tape is
CHECKCAPACITY 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.

99
Using command line switches

Default option parameters (continued)

Option Name Function Description

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.

DO_TRIAL_ Select method for Enter 0 if you want to determine job


DETERMINESIZEMETHOD determining trial run job size from a previous job history, or
size enter a 1 if you want to perform a
pre-scan.

DO_TRIAL_ Place job on hold if trial Enter 1 to have the scheduled job
HOLDONFAILURE job fails placed on hold if any failures are
detected during the test run;
otherwise, enter 0.

Advanced Open File Options

DO_OPENFILE_METHOD Enter one of the following values:


◆ 0 = None
◆ 1 = Use the Advanced Open File
Option

DO_OPENFILE_CONFIGURAT Specify the open file Enter a number from 0 through 4 to


ION=0-4 technology to back up specify the open file technology to
open files 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

100 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_SNAPSHOT_PROVIDER= Specify the snapshot Enter a number from 0 through 3 to


0-3 provider for the selected specify the snapshot provider for the
volume 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_S Process logical volumes Enter 1 to process logical volumes for


NAPSHOT=0 or 1 for backup one at a time backup one at a time; otherwise, enter
0.

DO_SELECTIONLIST_CREATE Specify separate ◆ Enter a number from 0 through 2


selection lists for to specify separate selection lists
resources or computers 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

Advanced Disk-based Backup Default Options

DO_DISKBACKUP_OFFHOST Use offhost backup to Enter 1 if you want to enable offhost


move backup processing backup; otherwise, enter 0. If you enter
from the remote 1, an offhost backup of all volumes is
computer to the media performed if all requirements are met.
server

101
Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_DISKBACKUP_SNAPSHO Specify snapshot Enter one of the following values:


T provider ◆ 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.

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)

102 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

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.

DO_LOG_FILEBASE Specify job log name Specify a job log name FILENAME#.txt.
The # starts at 00. The default is
BEX#.txt.

DO_LOG_ATTACH Attach job log as html Enter 1 to attach the job logs in an
html format when an email
notification is sent; otherwise, enter 0.

103
Using command line switches

Default option parameters (continued)

Option Name Function Description

SQL Default Options

DO_SQL_BACKUPMETHOD Select the SQL backup Select the backup method to be used
method for SQL databases by entering one of
the following values:
◆ 0 = full
◆ 1 = log
◆ 2 = log no truncate
◆ 3 = differential

DO_SQL_ Consistency check before Select a consistency check to run


CHECKBEFOREBACKUP backup before a backup.
Values are as follows:
◆ 0 = none
◆ 1 = full
◆ 2 = full with indexes
◆ 3 = physical

DO_SQL_ Continue with backup if Enter 1 if you want the backup job to
CONTINUEIFCHECKFAILS consistency check fails continue if the consistency check fails;
otherwise, enter 0.

DO_SQL_ Consistency check after Select a consistency check to run after


CHECKAFTERBACKUP backup a backup. Values are:
◆ 0 = none
◆ 1 = full
◆ 2 = full with indexes
◆ 3 = physical

DO_SQL_ CHECKSUM Use checksums on Enter 1 if you want to have SQL 2005
backup (SQL 2005 only) add checksums to the SQL 2005
database data that is backed up by
Backup Exec; otherwise, enter 0.

104 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_SQL_KEEPSNAPSHOTS Specifies the number of Enter the number of database


database snapshots to snapshots to keep on disk. As the
keep 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.

DO_SQL_CREATECOPIES Create on-disk copies of Enter 1 if you want to create an


SQL backups to be placed on-disk copy of the SQL database that
on the SQL server where is backed up; otherwise, enter 0. If you
the database is located 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_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,
SQL backups you must enter 1 for
DO_SQL_CREATECOPIES.

DO_SQL_RESTOREMETHOD SQL restore method Select the default restore method for
SQL databases. Values include:
◆ 0 = no recover
◆ 1 = recover
◆ 2 = standby

DO_SQL_REPLACE Replace database or Enter 1 if you want to replace a


filegroups Microsoft SQL Server v7.0 or later
database or filegroup, even if another
database or filegroup with the same
name already exists on the server.
Otherwise, enter 0.

105
Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_SQL_ Consistency check after Select a consistency check to run after


CHECKAFTERRESTORE restore a restore. Values include:
◆ 0 = none
◆ 1 = full
◆ 2 = full with indexes
◆ 3 = physical

DO_SQL_ Enable filegroup support Enter 1 if you want to enable filegroup


ENABLEFGSUPPORT support; otherwise, enter 0.

Exchange Default Options

DO_XCH_ENABLE Enable Exchange support Enter 1 if you want to enable Exchange


support; otherwise, enter 0.

DO_XCH_BACKUPMETHOD Exchange backup method Select the default backup method to


use for Exchange databases. Values
include:
◆ 0 = full
◆ 1 = copy
◆ 2 = differential
◆ 3 = incremental

DO_XCH_ Exchange mailbox Select the default method for backing


MBOXBACKUPMETHOD backup method up Exchange mailboxes. Values are:
◆ 0 = full
◆ 1 = copy
◆ 2 = differential
◆ 3 = incremental

DO_XCH_ Enable single instance Enter 1 if you want to enable single


SINGLEINSTANCEBACKUP backup for message instance backup for message
attachments attachments; otherwise, enter 0.

DO_XCH_NOLOSS No loss restore Enter 1 to restore without deleting


existing job logs; otherwise, enter 0.

DO_XCH_PUBLIC Restore public folder Enter 1 to restore a public folder;


otherwise, enter 0.

106 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_XCH_PRIVATE Restore private Enter 1 to restore private mailboxes;


mailboxes otherwise, enter 0.

DO_XCH_LOGPATH Select temporary location Enter the temporary location for log
for log and patch files and patch files.

DO_XCH_ Automatically recreate Enter 1 to have Backup Exec


AUTOCREATEMAILBOX user accounts and automatically recreate user accounts
mailboxes and mailboxes if they do not already
exist on the server; otherwise, enter 0.

DO_XCH_ENABLE_ Use Granual Recovery Enter 1 to enable the restore of


GRANULAR_RESTORE Technology to enable the individual mailboxes, mail messages,
restore of individual and folders from Information Store
mailboxes, mail backups; otherwise, enter 0. This
messages, and public option applies to Exchange 2000 and
folders later only. Incremental backups are
supported with policy-based jobs only.

DO_XCH_OVERWRITE Restore over existing Enter 1 to restore over existing


messages and folders messages and folders when you restore
individual mail messages and folders.
Otherwise, enter 0.

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_ Enter 1 to enable the restore of


GRANULAR_RESTORE individual documents from database
backups; otherwise, enter 0.

DO_SPPS2_PRE_DBCC Enter 1 to perform a consistency check


before the backup of Microsoft SQL
databases Microsoft SharePoint uses;
otherwise, enter 0.

107
Using command line switches

Default option parameters (continued)

Option Name Function Description

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_ Bring restore databases Enter 1 to bring the databases online


RESTORE online after a restore job; otherwise, enter 0.

DO_SPPS2_RECONNECT Reconnect previous Enter 1 to re-establish the link


database links 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.

DO_SPPS2_OVERWRITE Restore over existing Enter 1 if you want to replace existing


documents documents with documents of the
same name in the restore job;
otherwise, enter 0.

Microsoft Active Directory Default Options

DO_AD_RECREATE Recreate deleted options Enter 1 if you want to recreate deleted


that cannot be restored objects; otherwise, enter 0.
from the Active Directory You should enter 1 if both of the
Deleted Objects container following have occurred:
◆ The object’s tombstone lifetimes
have passed.
◆ The objects were purged from the
Active Directory Deleted Objects
container.

108 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_AD_RESTORE Use Backup Exec Enter 1 to enable the restore of


Granular Recovery individual objects from Active
Technology (GRT) to Directory backups. With this option,
enable the restore of you can restore of individual items
individual objects from from full backups of the Active
the Active Directory Directory or ADAM/ AD LDS.
backups 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.

Lotus Domino Default Options

DO_DOMINO_ Lotus Domino backup Select the default method for backing
BACKUPMETHOD method up Lotus Domino databases. Values
include:
◆ 0 = full
◆ 1 = differential
◆ 2 = incremental

DO_DOMINO_ Mark archive logs for Enter 1 to mark archive logs for
RECYCLELOGS recycling recycling; otherwise, enter 0.

DO_DOMINO_ Seconds to wait for Specify the number of seconds for the
SECONDSTOWAIT database restore process to wait for a database
that is in use by entering a value from
0 to 999.

DO_DOMINO_ Database identification Select the default option for handling


RECOVEROPTION database IDs during a restore. Values
include:
◆ 0 = retain original IDs
◆ 1 = assign new database ID
◆ 2 = assign new database ID and
replica ID

109
Using command line switches

Default option parameters (continued)

Option Name Function Description

Oracle Default Options

DO_ORACLE_BACKUPMETHO Select backup method Select the default method to back up


D 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_ORACLE_DONT_REBACK Do not back up archive Enter 1 to have Backup Exec skip any
UP_LOGS log files that have already archived log files that were backed up
been backed up previously; otherwise, enter 0.

DO_ORACLE_BACKUPOFFLIN Perform the backup Enter 1 to have Backup Exec take the
E offline database offline before you start the
backup job; otherwise, enter 0.

110 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

NetWare SMS Default Options

DO_SMS_ Back up compressed files Enter 1 to have Backup Exec


BACKUPASEXPANDED in decompressed form decompress, or expand, compressed
files as they are backed up; otherwise,
enter 0.

DO_SMS_ Restore volume Enter 1 to restore NetWare volume


RESTOREVOL_RESTRICT restrictions restrictions; otherwise, enter 0.

Linux, Unix, and Macintosh Default Options

DO)UNIXMAC_PRESERVETIM Preserve change time Enter 1 to prevent the Remote Agent


E from changing an object’s (files and
directories) attributes when a backup
occurs; otherwise, enter 0.

DO_UNIXMAC_FOLLOW_LOC Follow local mount points Enter 1 to have Backup Exec follow
ALMOUNT local mount points during backup jobs;
otherwise, enter 0.

DO_UNIXMAC_FOLLOW_RE Follow remote mount Enter 1 to have Backup Exec follow


MOTEMOUNT points remote mount points during backup
jobs; otherwise, enter 0.

DO_UNIXMAC_SOFTLINK Back up contents of Enter 1 to back up the contents of


soft-linked directories directories that are linked with soft
links. You must also select the
directory that contains the soft link.
Otherwise, enter 0.

DO_UNIXMAC_LOCK_REMOT Lock remote files Enter 1 if the Remote Agent requires


EFILES exclusive access to the files on remote
systems that are connected through
the Network File System; otherwise,
enter 0.

111
Using command line switches

Default option parameters (continued)

Option Name Function Description

NDMP Default Options

DO_NDMP_BACKUPMETHOD Backup method for Enter a number 0 through 9 to specify


NDMP resources 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.

DO_NDMP_BACKUP_CONTRO Back up Access Control Enter 1 to back up NetApp Access


LLISTS Lists Control Lists; otherwise, enter 0. This
option applies to NetApp filers only.

DO_NDMP_DISABLEHISTORY Disable file history 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.

DO_NDMP_RESTORE_CONTR Restore Access Control Enter 1 to restore NetApp Access


OLISTS Lists Control Lists; otherwise, enter 0.

DO_NDMP_DIRECTRECOVER Enable Direct Access Enter 1 to have Backup Exec use Direct
Y Recovery 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.

112 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

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_STAL Time before job status Enter the number of seconds before
LED becomes stalled the statuses of active jobs are changed
to Stalled when the Backup Exec
engine service fails to respond.

DO_STATUSRECOVERY_REC Time before job status Enter the number of seconds before
OVERED becomes recovered 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 error-
handling 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_INSEQUENC Request all media in the Enter 1 to catalog media starting with
E sequence for catalog the lowest known tape number in the
operations tape family. For example, if you don’t
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.

113
Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_CAT_TRUNCATEFLAG 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.

DO_CAT_TRUNCATEDDAYS Amount of days before Enter the amount of days before file
truncating catalogs and directory details are removed from
the catalogs. The value can be between
1 and 999.

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.

DO_CAT_REMOVEDAYS Amount of days before Enter the amount of days before


removing unused unused catalogs are removed. The
catalogs value can be between 1 and 999.

DO_CAT_PATH Set catalog path Specify a path on the volume for the
catalog files.

Media Default Options

DO_MEDIA_B2DLOCATION Backup-to-Disk default Specify a path on the volume for the


folder location Backup-to-Disk folder.

DO_MEDIA_ Set media overwrite Enter one of the following values:


OVERWRITELEVEL protection level ◆ 1 = None
◆ 2 = None with prompt
◆ 3 = Partial
◆ 4 = Partial with prompt
◆ 5 = Full

114 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_MEDIA_ Set the media overwrite Enter one of the following values:
OVERWRITEOPTIONS options ◆ 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 Specify a path where a copy of the DR


path files for the protected computers will
be stored.

DO_DISASTER_ Alternate disaster Specify an alternate data path where a


ALTERNATEPATH recovery data path second copy of the DR files can be
stored.

Backup-to-Disk Default Options

DO_B2D_MAXBACKUPSETS Maximum number of Type the maximum number of backup


backup sets per sets to be written to each
backup-to-disk file 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.

DO_B2D_MAXFILESIZE Maximum size for Type the maximum size for each
backup-to-disk files backup-to-disk file, including either
MB or GB. The file size can be from 1
MB to 4096 GB. The default is 4 GB.

115
Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_B2D_ALLOCATEMAXSIZE Allocate the maximum Enter 1 to create the backup-to-disk


size when creating the file at the maximum size to reduce disk
backup-to-disk file fragmentation; otherwise, enter 0.
This default does not apply to
removable backup-to-disk folders.

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.

DO_B2D_FOLDERLOCATION Specify backup-to-disk Type the default path for new


folder location backup-to-disk folders.

DB2 Default Options

DO_DB2_BACKUPMETHOD Select backup method Specifies the backup method to be


used for DB2 backup jobs.
Methods are as follows:
◆ 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.

116 Symantec Backup Exec Command Line Applet


Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_DB2_QUIESCE Quiesce the database Enter 1 if you want Backup Exec to


before offline backup force users off the database before it
brings the database offline for the
backup job. Otherwise, enter 0.

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.

DO_DB_TIME 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_ENABLE_JOBHISTOR Keep job history Select one of the following options for
YDAYS 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 Enter the number of days for job
job history data history data to remain on the Backup
Exec database.

DO_DB_ Number of days to keep Enter the number of days for alert
ALERTHISTORYDAYS alert history data history data to remain on the Backup
Exec database.

DO_DB_JOBLOGDAYS Number of days to keep Enter the number of days for job logs
job logs to remain on the Backup Exec
database.

DO_DB_REPORTDAYS Number of days to keep Enter the number of days for report
report data data to remain on the Backup Exec
database.

117
Using command line switches

Default option parameters (continued)

Option Name Function Description

DO_DB_AUDITLOGDAYS Number of days to keep Enter the number of days for audit
audit logs logs to remain on the Backup Exec
database.

DO_DB_CONSISTENCY Perform database Enter 1 if you want to perform a


consistency check database consistency check; otherwise,
enter 0.

DO_DB_COMPACT Compact the Backup Exec Enter 1 if you want to compact the
database Backup Exec database; otherwise,
enter 0.

DO_DB_DUMP 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.

Reports

DO_REPORTS_COMPANYLOG Use company logo image Enter 1 if you want to use a company
O file logo in the report header; otherwise,
enter O.

DO_REPORTS_IMAGEFILE Specify image file path Type the path to the logo that you want
to use in all custom reports.

DO_REPORTS_BANNERCOLO Specify the color to use Type the numbers that correspond to
R for the report banner 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 Type the text you want to appear in the
the report footer report footer.

DO_REPORTS_FOOTERTIME Include time in footer Enter 1 if you want to include the time
the report ran in the report footer;
otherwise, enter O.

118 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 CD. 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]
■ [W2K]
■ [Schedule]
■ [Machine]
■ [Selections]
■ [Media_Server]

119
Using job script files

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:
[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. For example, either
INTERVAL_DAY or INTERVAL_WEEK, but not both entries, could be present in a script
file.

Possible backup job script file entries

Section Entry Description

[General]

JOB_TYPE=job type This entry must be completed with a


value of Backup.

JOB_PRIORITY=priority 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 backup job.

SERVER=server name 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.

120 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

USERNAME=username 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.

PASSWORD=password Enter the password for logging into a


remote Backup Exec server. If a
password is not specified, the current
password is used.

[Backup_Options]

BK_SET_NAME=backup set name Type the name of the backup set to be


used by the job.

BK_METHOD=# Enter a number from 0 through 9 or 11


that corresponds to the backup
method you want. Methods are:
◆ 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.

121
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

USE_OPEN_FILE_OPTION=0 or 1 Enter 1 as the value if you want to use


the Advanced Open File Option
(AOFO); otherwise, enter 0. If AOFO is
unavailable, the
OPEN_FILES_METHOD specified is
used.

OPEN_FILES_METHOD=# 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.

RETENSION_MEDIA=0 or 1 Enter 1 to retension the media before


backup; otherwise, enter 0.

PRESERVE_TREE_ON_ARCHIVE= Enter 1 to retain the directory


0 or 1 structure of the files that were backed
up in an archive job on the hard drive;
otherwise, enter 0.

122 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

SINGLE_INSTANCE_FOR_NTFS=0 or 1 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.

REMOTE_AGENT_PRIORITY=# 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 server’s 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.

123
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

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.

[Exchange]

EXCHANGE_METHOD=# 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_ Enter 1 to enable the restore of


RESTORE individual documents from database
backups. This option is only available
when performing full backups;
otherwise enter 0.

EXCHANGE_CONTINUOUS_ Enter 1 to enable continuous backup of


PROTECTION=# Exchange transaction logs with
Backup Exec Continuous Protection
Server; otherwise, enter 0.

124 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

EXCHANGE_MBOX_METHOD=# 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 = 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=# Enter 1 to back up only a single copy of


all identical message attachments;
otherwise, enter 0.

EXCHANGE_CONSISTENCY_ Enter 1 to perform a consistency check


CHECK=0 or 1 and determine if possible data
corruption exists when using the
VERITAS Backup Exec for Windows
Servers - Advanced Disk-based Backup
Option (ADBO) or the Advanced Open
File Option (AOFO); otherwise, enter
0.

EXCHANGE_CONTINUE=0 or 1 Enter 1 to continue the backup job


even if the consistency check fails;
otherwise, enter 0.

EXCHANGE_RECOVERY_POINTS_ Enter the interval in days, hours, or


INTERVAL=xD (days) or xH (hours) minutes for making recovery points
or xM (minutes) when continuously backing up
Exchange transaction logs with
Backup Exec Continuous Protection
Server.

125
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

[SharePoint Portal Server]

SPPS2_METHOD=# 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.
◆ 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 Enter 1 to enable the restore of


individual documents from database
backups. This option is only available
when performing full backups;
otherwise, enter 0.

SPPS2_PRE_DBCC=# 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.

SPPS2_CONT_ON_CC_FAILURE=# Enter 1 to continue with the backup


operation even if the consistency
check fails; otherwise, enter 0.

SPPS2_RELEASE_LOCK Enter 1 to release the lock on the


SharePoint farm topology before
backing up data; otherwise, enter 0.

126 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

[SQL Server]

SQL_METHOD=# 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:
◆ 0 = Backup All
◆ 1 = Backup Log
◆ 2 = Backup Log No Truncate
◆ 3 = Differential

[Lotus Domino Server]

LOTUS_DOMINO_METHOD=# 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= If you are backing up a Lotus Domino


0 or 1 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.

127
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

NW_BK_DECOMPRESS_FILES= If you are backing up NetWare shares


0 or 1 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.

OVERWRITE_JOB=0 or 1 Enter 1 as the value if you want


Backup Exec to overwrite a duplicate
job if one exists; otherwise, enter 0.

CONTINUE_ON_DBCC=0 or 1 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.

PRE_BK_DBCC=# 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:
◆ 0 = None
◆ 1 = No Index
◆ 2 = Full
◆ 3 = Physical only (SQL 2000 only)

POST_BK_DBCC=# 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 2000 only)

128 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

[SQL 2000 log]

SQL_STANDBY_OPTION=# This entry is for Microsoft SQL Server


2000 only. 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

[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.

OFFHOST_SINGLESNAP=0 or 1 Enter 1 to process logical volumes for


offhost backup one at a time;
otherwise, enter 0.

129
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

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.

OPEN_FILE_CONFIGURATION=1-4 Enter a number from 1 through 4 to


specify the open file technology to
back up open files. Selections include:
◆ 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.

IMAGE_BACKUP=0 or 1 Enter a number that corresponds to


the image backup method.
Methods are as follows:
◆ 0 = Do not use image backup
◆ 1 = Use the image backup method

130 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

[Data Encryption Setting]

ENCRYPTION_KEY_NAME=key name Specify a name for the encryption key.

ENCRYPTION_TYPE=# 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_NAME=Media Name Specify a label for the new or


overwritable media.

MEDIA_SET=Media Set Name Enter the name of the media set to be


used for the backup.

MEDIA_PASSWORD=Media Password If the media has a password, specify


the password.

APPEND=0 or 1 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.

131
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

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.

VERIFY=0 or 1 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.

COMPRESSION_TYPE=# 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.

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.

EJECT_MEDIA=0 or 1 Enter 1 to eject the media when the job


completes; otherwise, enter 0.

132 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job 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.

POST_JOB_COMMAND=command Specify a .exe or batch file command


that is to run after the backup
operation completes.

COMMAND_RUN_POST_IF_ Enter 1 to execute the post-job


PRE_SUCCESS=0 or 1 command only if the pre-job command
is successful; otherwise, enter 0.

COMMAND_RUN_JOB_IF_PRE_SUCCESS= Enter 1 to execute the job only if the


0 or 1 pre-job command is successful;
otherwise, enter 0.

COMMAND_RUN_POST_ Enter 1 to execute the post-job


IF_JOB_FAILS=0 or 1 command even if the job fails;
otherwise, enter 0.

COMMAND_FAIL_JOB_IF_FAILS= Enter 1 to allow the pre- and post-job


0 or 1 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 pre-
and post-job commands is not
determined based on the return code.

133
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

COMMAND_AUTO_CANCEL_TIME=# Enter the number of minutes Backup


Exec should wait before cancelling a
command that did not complete.

COMMAND_RUN_OPTION=# Enter 0 to run the command on this


media server or 1 to run the command
on each server being backed up.

USE_JOB_DEFAULTS=0 or 1 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.

PRINT_LOG_FILE=0 or 1 Enter 1 to include the job log with a


notification to an email or printer
recipient; otherwise, enter 0.

NIC_ENABLED=0 or 1 Enter 1 to use the MAC address or


service entry name specified with the
NIC_ADDRESS entry.
Enter 0 to clear previous settings for
the network interface, and to use any
available network adapter.

NIC_ADDRESS For Windows 2000 and later operating


systems, enter the Media Access
Control (MAC) address for the network
interface you selected.
To use this setting, NIC_ENABLED
must be set to 1.

134 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

NIC_SUBNET_ADDRESS If the setting used in NIC_ADDRESS is


connected to multiple subnets, then
enter the network ID based on the IP
address and the subnet mask of the
network interface card you selected.
To view this ID, on the Tools menu,
click Options, then under Properties,
click Network, and view the Network
ID field.
This setting corresponds to the
network interface used in
NIC_ADDRESS.
You must also enter the
NIC_SUBNET_MASK.

NIC_SUBNET_MASK If the setting used in NIC_ADDRESS is


connected to multiple subnets, then
enter the mask that determines the
subnet to which the network interface
belongs.
To view this ID, on the Tools menu,
click Options, then under Properties,
click Network, and view the Subnet
mask field.
This setting corresponds to the
network interface used in
NIC_ADDRESS.
You must also enter the
NIC_SUBNET_ADDRESS.

NIC_SUBNET_AUTOGET=0 or 1 Enter 1 to have Backup Exec use any


available network adapter.

[W2K]

BACKUP_LOCAL_MOUNT_POINTS= Enter a value of 1 to back up mount


0 or 1 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.

135
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

BACKUP_REMOTE_STORAGE_HSM= Enter a value of 1 to back up data that


0 or 1 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:
◆ 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.

[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.

SCHED_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS


format for this job.

SCHED_ENDTIME=HH:MM:SS Enter the latest time this job can start


in HH:MM:SS format.

SCHED_RESTART_INTERVAL=HH:MM:SS 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.

136 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

SCHED_REPEAT_INTERVAL=X 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_ANCHOR=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


from which the interval is calculated.

SCHED_DAYSOFMONTH=x 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 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

137
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

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.

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=# 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.

HOLD=0 or 1 Enter 1 as the value if you want to


schedule the job on hold; otherwise,
enter 0.

138 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

DELETE_JOB_AFTER=# Enter a number from 0 to 2 that


corresponds to job deletion. Options
include:
◆ 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.

139
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

[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.

INCLUDEx=0 or 1 Enter 1 to include this item in the


backup job; otherwise, enter 0.

SUBDIRSx=0 or 1 Enter 1 to include all subdirectories;


otherwise, enter 0.

UNIXx=x 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.

140 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

EXCHANGEx=Exchange Server name Change x to a unique number and


specify the name of the Exchange
Server to back up.

EXCH2ROOT?=Exchange 2000 Server Specifies the name of the Exchange


name 2000 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 2000
Server database name.”

EXCH2SG?=Exchange 2000 Server Specifies the name of the Exchange


storage group name 2000 Server storage group to back up,
or that contains the database to back
up.
Change ? to the same number used to
identify the selection for the Exchange
2000 Server. See the example in
“EXCH2DB?=Exchange 2000
Server database name.”

141
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

EXCH2DB?=Exchange 2000 Server Specifies the name of the Exchange


database name 2000 Server database to back up.
Change ? to the same number used to
identify the selection for the Exchange
2000 Server and storage group.
In the following example,
SERVER_NAME is an Exchange 2000
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

EXCH2ROOT2=SERVER_NAME
EXCH2SG2=Second Storage Group
EXHC2DB2=Mailboxes

EXCH2ROOT3=SERVER_NAME
EXCH2SG3=Second Storage Group
EXHC2DB3=Users

SQLx=SQL Server name Change x to a unique number and


specify the name of the SQL Server to
back up.

142 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

SQL2S? =SERVER_NAME Specifies the name of the SQL Server


2000 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
2000 named instance name.”

SQL2DB?=SQL Server 2000 database Specifies the name of the SQL Server
name 2000 database to back up. Type *.* to
back up all the databases. Change ? to
a number that corresponds to the
number of the selection.

SQL2NI?=SQL Server 2000 named Specifies the named instance on the


instance name SQL Server 2000 to back up.
Change ? to the same number used to
identify the selection for the SQL
Server 2000. For example, to back up
the named instance ONE, the named
instance TWO, and the SQL Server
2000 itself, the entries would be:
SQL2S1=SERVER_NAME
SQL2NI1=ONE

SQL2S2=SERVER_NAME
SQL2NI2=TWO

SQL2S3=SERVER_NAME

143
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

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.”

LNDRIVE?=Drive letter 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

144 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

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.”

ORCLSID?=System identifier for Specifies the SID (System Identifier)


database 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

SPPSx=SharePoint Portal Server Change x to a unique number and


2001 name specify the name of the Microsoft
SharePoint Portal Server 2001 server
to back up.

145
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

SPPS2_FARMx=farm name Specify which SharePoint server farm


you want to back up. For example,
SPPS2_FARM1=farm name
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=1 or 0 Enter 1 to include the Configuration


database in the backup job; otherwise,
enter 0 or leave it blank.

SPPS2_SSOx=1 or 0 Enter 1 to include the Single sign-on


database in the backup job; otherwise,
enter 0 or leave it blank.

SPPS2_DLSx=1 or 0 Enter 1 to include the Document


Library store in the backup job;
otherwise, enter 0 or leave it blank.

SPPS2_PORTALxNAMEy=portal site Specify the name of the portal site


name 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

146 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

SPPS2_TEAM_SITExNAMEy=Windows Specify the name of the Windows


SharePoint services site name 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 Specify the name of the backward


libary 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_RELEASE_LOCK Enter 1 to release the lock on the


SharePoint farm topology before
backing up data; otherwise, enter 0.

147
Using job script files

Possible backup job script file entries (continued)

Section Entry Description

APATHx=String 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 temporary
share may be created when a mirror is
split. Or 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.

148 Symantec Backup Exec Command Line Applet


Using job script files

Possible backup job script file entries (continued)

Section Entry Description

AINCLUDEx=0 or 1 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 This operation is only available if the


server name Central Admin Server Option (CASO) is
installed.
Specify the preferred media server on
which backup jobs run.

MEDIA_SERVER_POOL_NAME=Media This operation is only available if the


server pool name Central Admin Server Option (CASO) is
installed.
Specify the media server pool to use
for the backup job.

149
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 Entry Description

[General]

JOB_TYPE=Job type This field must be completed with a


value of Restore.

JOB_NAME=Job name Type the name of the restore job.

SERVER=Server name 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.

150 Symantec Backup Exec Command Line Applet


Using job script files

Possible restore job script file entries (continued)

Section Entry Description

USERNAME=User name Type the user name for logging into


the system being restored. If a user
name is not specified, the current user
name is used.

PASSWORD=Password Type the password for logging into the


system being restored. If a password is
not specified, the current password is
used.

JOB_PRIORITY=Priority 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:
◆ 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.

RESTORE_EXISTING=x Values for x are:


0 = Skip if file exists
1 = Restore over existing
3 = Skip if existing file is more recent

151
Using job script files

Possible restore job script file entries (continued)

Section Entry Description

RESTORE_SECURITY=x Enter a number from 0 through 2 to


specify the security information:
◆ 0 = Automatic - Allows VSS to
select the snapshot provider
◆ 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.

DEVICE_NAME=Device name Type the name of the device, such as a


drive or backup-to-disk folder,
containing the data to be restored.

SHARE_REDIRECT_DRIVE=Drive Type a destination drive, other than


letter where the data was originally backed
up, to which the data is to be restored.

SHARE_REDIRECT_PATH=Path name 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.

SQL_REDIRECT_SERVER= If you are redirecting SQL data, type


SQL Server name the name of the SQL server where the
data is to be restored.

SQL_REDIRECT_INSTANCE= If you are redirecting SQL data to a


Instance name named instance, specify the instance
name. Otherwise, the data is restored
to the default instance.

152 Symantec Backup Exec Command Line Applet


Using job script files

Possible restore job script file entries (continued)

Section Entry Description

SQL_REDIRECT_DATABASE= If you are redirecting this restore to a


Database name 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.

XCH_REDIRECT_SERVER=Exchange If you are redirecting Exchange data,


Server name specify the Exchange server where the
data is to be restored.

XCH_REDIRECT_MAILBOX=Exchange If you are redirecting an Exchange


mailbox name mailbox, specify the name of the target
mailbox. The mailbox must already
exist before you can restore to it.

SP_REDIRECT_SETS_SERVER= Specify whether server sets or


Server/Documents document sets are being restored.

SP_REDIRECT_DRIVE=Drive name 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.

SP_REDIRECT_PATH=Path Type the folder location on the drive to


which you want to redirect the restore.

SP_REDIRECT_SERVER=\\server name Type the name of the computer to


which you want to redirect the restore.
Use the format \\server name.

SP_REDIRECT_WORKGROUP= Type the name of the workspace to


Workspace name 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.

153
Using job script files

Possible restore job script file entries (continued)

Section Entry Description

RESTORE_RSM_DATA=0 or 1 Enter 1 to restore the Removable


Storage database; otherwise, enter 0.

RESTORE_DISK_QUOTA=0 or 1 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.

RESTORE_TERMINAL_SERVICES= Enter 1 to restore the Terminal


0 or 1 Services database, which contains
licensing data for client licenses;
otherwise, enter 0.

RESTORE_WMI=0 or 1 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.

RESTORE_CLUSTER_DB=0 or 1 Enter 1 to restore the cluster


configuration; otherwise, enter 0.

RESTORE_FORCE_RECOVERY= Enter 1 to force the recovery of the


0 or 1 cluster quorum even if other nodes are
online the and/or disk signatures do
not match option; otherwise, enter 0.

RESTORE_PRIMARY_REPLICA=0 or 1 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.

154 Symantec Backup Exec Command Line Applet


Using job script files

Possible restore job script file entries (continued)

Section Entry Description

RESTORE_REGISTRY=0 or 1 Enter 1 to restore registry information


if it exists in the selected data;
otherwise, enter 0.

RESTORE_PNP_MERGE=0 or 1 Enter 1 to merge existing hardware


configuration and registry services
with the data to be restored when
restoring registry information;
otherwise, enter 0.

RESTORE_JUNCSASDIRS=0 or 1 Enter 1 to restore junction points, files


and directories from backup media, or
enter 0 to preserve existing junction
points and restore files and directories
from backup media.

PRE_JOB_COMMAND=Command Specify a .exe or batch file command to


run on the media server before the
restore operation starts.

POST_JOB_COMMAND=Command Specify a .exe or batch file command to


run after the restore operation
completes.

COMMAND_RUN_POST_IF_ Enter 1 to execute the post-job


PRE_SUCCESS=0 or 1 command only if the pre-job command
is successful; otherwise, enter 0.

COMMAND_RUN_JOB_IF_PRE_SUCCESS= Enter 1 to execute the job only if the


0 or 1 pre-job command is successful;
otherwise, enter 0.

COMMAND_RUN_POST_ Enter 1 to execute the post-job


IF_JOB_FAILS=0 or 1 command even if the job fails;
otherwise, enter 0.

155
Using job script files

Possible restore job script file entries (continued)

Section Entry Description

COMMAND_FAIL_JOB_IF_FAILS= Enter 1 to allow the pre- and post-job


0 or 1 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 pre-
and post-job commands is not
determined based on the return code.

COMMAND_AUTO_CANCEL_ Enter the number of minutes Backup


TIME=# Exec should wait before cancelling a
command that did not complete.

COMMAND_RUN_OPTION=# Enter 0 to run the command on this


media server or 1 to run the command
on each server being restored to.

SQL_DATABASE_RECOVER=# Enter one of the following values for


recovering the database:
◆ 0 = No recover
◆ 1 = Recover database
◆ 2 = Standby database

SQL_REPLACE_DATABASE=0 or 1 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.

156 Symantec Backup Exec Command Line Applet


Using job script files

Possible restore job script file entries (continued)

Section Entry Description

SQL_AUTOMASTER=0 or 1 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=# Enter one of the following values for


performing a consistency check after
restore:
◆ 0 = None
◆ 1 = Full check, excluding indexes
◆ 2 = Full check, including indexes
◆ 3 = Physical check only (SQL 2000
only)

SQL_DEFAULT_DRIVE=Drive letter Enter the drive letter for an alternate


drive to which SQL database files will
be restored.

SQL_USE_ALLDEFAULT=0 or 1 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_DEFAULT_INSTDIR=0 or 1 Enter 1 to restore all database files to


the target instance’s data location;
otherwise, enter 0.

SQL_POINTINTIME=MM/DD/YYYY, Enter the date and time to restore


HH:MM:SS 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.

157
Using job script files

Possible restore job script file entries (continued)

Section Entry Description

SQL_LOGMARK_NAME=Named Enter the named transaction to


transaction include in the recovery of the
transaction log. Recovery will be
stopped after this named transaction
is restored.

SQL_LOGMARK_INCLUDE=0 or 1 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_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_ Enter 1 to bring the databases online


RESTORE after a restore job; otherwise, enter 0.

SPPS2_RECONNECT Enter 1 to re-establish the link


between the restored databases and
their corresponding sites; otherwise,
enter 0.

SPPS2_RELEASE_LOCK Enter 1 to release the lock on the


SharePoint farm topology before
restoring data; otherwise, enter 0.

XCH_AUTOCREATE_MAILBOX=0 or 1 Enter 1 if you are restoring Exchange


data and want Backup Exec to
automatically recreate user accounts
and mailboxes; otherwise, enter 0.

XCH_NOLOSS_RESTORE=0 or 1 Enter 1 if you are restoring Exchange


2000 data and do not want to delete
the existing job logs; otherwise, enter
0.

XCH_RESTORE_PUBLIC=0 or 1 Enter 1 if you are restoring Exchange


data and want to restore public folders;
otherwise, enter 0.

158 Symantec Backup Exec Command Line Applet


Using job script files

Possible restore job script file entries (continued)

Section Entry Description

XCH_RESTORE_PRIVATE=0 or 1 Enter 1 if you are restoring Exchange


data and want to restore private
mailboxes; otherwise, enter 0.

ESE_NOLOSS_RESTORE=0 or 1 Enter 1 to preserve the existing


transaction logs on the Exchange 2000
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 2000
server. When the restore operation
finishes, Exchange 2000 automatically
updates its databases with the
uncommitted transactions found in
the existing and newly-restored
transaction logs. This option is
selected by default.

ESE_RECOVERY_POINTINTIME=MM/DD/Y Enter a date and time to restore


YYY,HH:MM:SS 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.

159
Using job script files

Possible restore job script file entries (continued)

Section Entry Description

ESE_TEMPLOG_PATH=Path 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 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 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.

ESE_MOUNT_AFTER=0 or 1 Enter 1 to mount the database so that


it is available to users; otherwise, enter
0. This checkbox is only available if
EXE_LASTSET is set to 1.

160 Symantec Backup Exec Command Line Applet


Using job script files

Possible restore job script file entries (continued)

Section Entry Description

ESE_DISMOUNT_BEFORE=0 or 1 Enter 1 to automatically take the


database offline before the restore job
runs; otherwise, enter 0.

LOTUS_WAIT_MSECS=x 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.

LOTUS_DBRECOVER_OPTION=# Enter one of the following options for


recovering a Lotus Domino database:
◆ 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.

NIC_ENABLED=0 or 1 Enter 1 to use the MAC address or


service entry name specified with the
NIC_ADDRESS entry.
Enter 0 to clear previous settings for
the network interface, and to use any
available network adapter.

161
Using job script files

Possible restore job script file entries (continued)

Section Entry Description

NIC_ADDRESS For Windows 2000 and later operating


systems, enter the Media Access
Control (MAC) address for the network
card you selected.
To use this setting, NIC_ENABLED
must be set to 1.

NIC_SUBNET_ADDRESS If the setting used in NIC_ADDRESS is


connected to multiple subnets, then
enter the network ID based on the IP
address and the subnet mask of the
network interface card you selected,
for example, 10.212.10.113.
To view this ID, on the Tools menu,
click Options, then under Properties,
click Network, and view the Network
ID field.
This setting corresponds to the
network interface used in
NIC_ADDRESS.
You must also enter the
NIC_SUBNET_MASK.

NIC_SUBNET_MASK If the setting used in NIC_ADDRESS is


connected to multiple subnets, then
enter the mask that determines the
subnet to which the network interface
belongs, for example, 255.255.254.0.
To view this ID, on the Tools menu,
click Options, then under Properties,
click Network, and view the Subnet
mask field.
This setting corresponds to the
network interface used in
NIC_ADDRESS.
You must also enter the
NIC_SUBNET_ADDRESS.

NIC_SUBNET_AUTOGET=0 or 1 Enter 1 to have Backup Exec use any


available network adapter; otherwise,
enter 0.

162 Symantec Backup Exec Command Line Applet


Using job script files

Possible restore job script file entries (continued)

Section Entry Description

[Selections]

JOBHISTORY_GUID or SELECTIONx=file Required. Specifies the backup job


selection to restore 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 or
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.

SCHED_ENDTIME=HH:MM:SS Enter the latest time this job can start


in HH:MM:SS format.

163
Using job script files

Possible restore job script file entries (continued)

Section Entry Description

SCHED_RESTART_INTERVAL=HH:MM:SS 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.

SCHED_REPEAT_INTERVAL=X 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_ANCHOR=MM/DD/YYYY Enter the date in mm/dd/yyyy format


the interval is calculated from.

SCHED_EFFECTIVE=MM/DD/YYYY Enter the date in mm/dd/yyyy format


that the schedule becomes effective.

SCHED_DAYSOFMONTH=x 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 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

164 Symantec Backup Exec Command Line Applet


Using job script files

Possible restore job script file entries (continued)

Section Entry Description

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

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.

165
Using job script files

Possible restore job script file entries (continued)

Section Entry Description

INTERVAL_MINUTES=# If a number is specified, the job is


scheduled to run every specified
number of minutes.
Note Only one of the INTERVAL
values should be specified (i.e., if
you specify a value for
INTERVAL_MINUTES, do not
specify a value for
INTERVAL_HOURS,
INTERVAL_DAYS, or
INTERVAL_WEEKS. Also, use
either one of the INTERVAL
values, or the WEEKS and
WEEKDAYS, or the DAYS, or the
DAYS_OF_MONTH entries.
Unless specifically noted, these
scheduling options should not
be used in conjunction with each
other.

INTERVAL_HOURS=# If a number is specified, the job is


scheduled to run every specified
number of hours.
Note Only one of the INTERVAL
values should be specified (i.e., if
you specify a value for
INTERVAL_MINUTES, do not
specify a value for
INTERVAL_HOURS,
INTERVAL_DAYS, or
INTERVAL_WEEKS. Also, use
either one of the INTERVAL
values, or the WEEKS and
WEEKDAYS, or the DAYS, or the
DAYS_OF_MONTH entries.
Unless specifically noted, these
scheduling options should not
be used in conjunction with each
other.

166 Symantec Backup Exec Command Line Applet


Using job script files

Possible restore job script file entries (continued)

Section Entry Description

INTERVAL_DAYS=# If a number is specified, the job is


scheduled to run every specified
number of days.
Note Only one of the INTERVAL
values should be specified (i.e., if
you specify a value for
INTERVAL_MINUTES, do not
specify a value for
INTERVAL_HOURS,
INTERVAL_DAYS, or
INTERVAL_WEEKS. Also, use
either one of the INTERVAL
values, or the WEEKS and
WEEKDAYS, or the DAYS, or the
DAYS_OF_MONTH entries.
Unless specifically noted, these
scheduling options should not
be used in conjunction with each
other.

INTERVAL_WEEKS=# If a number is specified, the job is


scheduled to run every specified
number of weeks.
Note Only one of the INTERVAL
values should be specified (i.e., if
you specify a value for
INTERVAL_MINUTES, do not
specify a value for
INTERVAL_HOURS,
INTERVAL_DAYS, or
INTERVAL_WEEKS. Also, use
either one of the INTERVAL
values, or the WEEKS and
WEEKDAYS, or the DAYS, or the
DAYS_OF_MONTH entries.
Unless specifically noted, these
scheduling options should not
be used in conjunction with each
other.

167
Using job script files

Possible restore job script file entries (continued)

Section Entry Description

WEEKS=FIRST,SECOND,THIRD, The job will be scheduled for the


FOURTH,LAST specified week of the month. For
example, if the entry appears as
WEEKS=FIRST, the job will be
or
scheduled to run the first week of the
month.
WEEKS=1,2,3,4,5 Note If this entry is included in the
Restore Job Script File, a value
must also be provided for the
WEEKDAY entry. Do not use this
entry in conjunction with the
INTERVAL entries, the DAYS, or
the DAY_OF_MONTH entries.

WEEKDAY=SUN/MON/TUES/WED/ Note If the entry WEEKS is included


THU/FRI/SAT in the Restore Job Script File, a
value must also be provided for
this entry.
Enter the day of the week the job
should be completed. Only one day can
be entered in this entry, which works
in conjunction with the WEEKS entry.

DAYS=SUN/MON/TUES/WED/THU/FRI/SA If this entry is included in the Restore


T Job Script File, the restore job will be
scheduled for the indicated day or
days. Multiple days can be included,
but must be separated by commas. For
example:
DAYS=MON,WED,FRI
Note Do not use this entry in
conjunction with the INTERVAL
entries, the WEEKS, or the
DAY_OF_MONTH entries.

168 Symantec Backup Exec Command Line Applet


Using job script files

Possible restore job script file entries (continued)

Section Entry Description

DAY_OF_MONTH=# If this entry is included in the Restore


Job Script File, the backup job will be
scheduled for the indicated day of the
month. The value can range from 1 to
31. Only one number can be specified.
Note Do not use this entry in
conjunction with the INTERVAL
entries, the WEEKS, or the DAYS
entries.

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.

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.

DELETE_JOB_AFTER=# Enter a number from 0 to 2 that


corresponds to job deletion. Options
include:
◆ 0 = Do not delete the job
◆ 1 = Delete the job after the job
completes
◆ 2 = Delete the job if the job
successfully completes

169
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 Entry Description

[General]

JOB_TYPE=Job type This entry must be completed with a


value of Catalog.

JOB_PRIORITY=Priority 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

170 Symantec Backup Exec Command Line Applet


Using job script files

Possible catalog job script file entries (continued)

Section Entry Description

JOB_NAME=Job name Type the name of the catalog job. If a


name is not provided, one will
automatically be generated.

SERVER=Server name 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.

USERNAME=Username 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.

PASSWORD=Password Enter the password for logging into a


remote Backup Exec server. If a
password is not specified, the current
password is used.

[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.

SCHED_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS


format for this job.

SCHED_ENDTIME=HH:MM:SS Enter the latest time this job can start


in HH:MM:SS format.

171
Using job script files

Possible catalog job script file entries (continued)

Section Entry Description

SCHED_RESTART_INTERVAL=HH:MM:SS 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_REPEAT_INTERVAL=x 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_ANCHOR=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


from which the interval is calculated.

SCHED_DAYSOFMONTH=x 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

172 Symantec Backup Exec Command Line Applet


Using job script files

Possible catalog job script file entries (continued)

Section Entry Description

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

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

173
Using job script files

Possible catalog job script file entries (continued)

Section Entry Description

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.

HOLD=0 or 1 Enter 1 if you want the job to be


submitted on hold; otherwise, enter 0.

DELETE_JOB_AFTER=# Enter a number from 0 to 2 that


corresponds to job deletion. Options
include:
◆ 0 = Do not delete the job
◆ 1 = Delete the job after the job
completes
◆ 2 = Delete the job if the job
successfully completes

174 Symantec Backup Exec Command Line Applet


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 Entry Description

[General]

JOB_TYPE=Job type This entry must be completed with a


value of Discovery.

175
Using job script files

Possible discovery job script file entries (continued)

Section Entry Description

JOB_PRIORITY=Priority 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.

SERVER=Server name 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.

USERNAME=Username 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.

PASSWORD=Password Enter the password for logging into a


remote Backup Exec server. If a
password is not specified, the current
password is used.

[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.

176 Symantec Backup Exec Command Line Applet


Using job script files

Possible discovery job script file entries (continued)

Section Entry Description

DISCOVER_SQL_DATABASES=0 or 1 Enter 1 to have Backup Exec search for


new SQL databases; otherwise, enter 0.

DISCOVER_EXCHANGE_DATABASES=0 Enter 1 to have Backup Exec search for


or 1 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.

DISCOVER_SHAREPOINT=0 or 1 Enter 1 to have Backup Exec search for


new SharePoint servers; otherwise,
enter 0.

NOTIFY_SEPARATE=0 or 1 Enter 1 to have Backup Exec send


separate notifications when each new
resource is found; otherwise, enter 0.

NOTIFY_INCLUDE_PREVIOUS=0 or 1 Enter 1 to have Backup Exec send a


notification that includes all resources
previously found during resource
discovery jobs; otherwise, enter 0.

177
Using job script files

Possible discovery job script file entries (continued)

Section Entry Description

[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 user’s
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.

[Schedule]

SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


that the schedule becomes effective.

SCHED_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS


format for this job.

SCHED_ENDTIME=HH:MM:SS Enter the latest time this job can start


in HH:MM:SS format.

SCHED_RESTART_INTERVAL=HH:MM:SS 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.

178 Symantec Backup Exec Command Line Applet


Using job script files

Possible discovery job script file entries (continued)

Section Entry Description

SCHED_REPEAT_INTERVAL=x 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_ANCHOR=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


from which the interval is calculated.

SCHED_DAYSOFMONTH=x 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

179
Using job script files

Possible discovery job script file entries (continued)

Section Entry Description

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

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

HOLD=0 or 1 Enter 1 if you want the job to be


submitted on hold; otherwise, enter 0.

180 Symantec Backup Exec Command Line Applet


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 Entry Description

[General]

JOB_TYPE=Job type This entry must be completed with a


value of Setcopy.

181
Using job script files

Possible duplicate job script file entries (continued)

Section Entry Description

JOB_PRIORITY=Priority 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.

JOB_DESCRIPTION=Description Type a description of the information


you are backing up.

PREFERRED_SOURCE_DEVICE_GUID= Enter the GUID of the device used as


Source device guid the destination device for the original
backup job. Use operation -o63 to
display managed drives.

SERVER=Server name 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.

USERNAME=Username 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.

PASSWORD=Password Enter the password for logging into a


remote Backup Exec server. If a
password is not specified, the current
password is used.

182 Symantec Backup Exec Command Line Applet


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.

MEDIA_SET_GUID=Media set GUID Enter the name of the media set to be


used for the duplicate job. Use
operation -o69 to display media sets.

OVERWRITE_MEDIA=0 or 1 Enter 1 as the value if you want


Backup Exec to overwrite a duplicate
job if one exists; otherwise, enter 0.

APPEND_OVERWRITE=0 or 1 Enter 1 to append to the media set


specified in the MEDIA_SET_GUID
entry, or to have the job append to
overwritable media that will then be
added to the media set, enter 0.

APPEND_TERMINATE=0 or 1 Enter 1 to append to the media set


specified in the MEDIA_SET_GUID
entry, if appendable media is available.
To have the job terminate if no
appendable media is available, enter 0.

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.

RETENSION_MEDIA=0 or 1 Enter 1 to retension the media before


backup; otherwise, enter 0.

183
Using job script files

Possible duplicate job script file entries (continued)

Section Entry Description

MEDIA_PASSWORD=Media password If the media has a password, specify


the password.

AUTO_VERIFY=0 or 1 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.

COMPRESSION_TYPE=0 or 1 Enter 1 to select hardware


compression; otherwise, enter 0.

ENCRYPTION_KEY_NAME=key name Specify a name for the encryption key.

ENCRYPTION_TYPE=# 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.

[Selections]

JOBHISTORY_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.

184 Symantec Backup Exec Command Line Applet


Using job script files

Possible duplicate job script file entries (continued)

Section Entry Description

SCHED_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS


format for this job.

SCHED_ENDTIME=HH:MM:SS Enter the latest time this job can start


in HH:MM:SS format.

SCHED_RESTART_INTERVAL=HH:MM:SS 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_REPEAT_INTERVAL=x 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_ANCHOR=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


from which the interval is calculated.

SCHED_DAYSOFMONTH=x 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

185
Using job script files

Possible duplicate job script file entries (continued)

Section Entry Description

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

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

186 Symantec Backup Exec Command Line Applet


Using job script files

Possible duplicate job script file entries (continued)

Section Entry Description

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

HOLD=0 or 1 Enter 1 if you want the job to be


submitted on hold; otherwise, enter 0.

DELETE_JOB_AFTER=# Enter a number from 0 to 2 that


corresponds to job deletion. Options
include:
◆ 0 = Do not delete the job
◆ 1 = Delete the job after the job
completes
◆ 2 = Delete the job if the job
successfully completes

187
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 Entry Description

[General]

JOB_TYPE=Job type This entry must be completed with a


value of TestRun.

JOB_PRIORITY=Priority 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

188 Symantec Backup Exec Command Line Applet


Using job script files

Possible test run job script file entries (continued)

Section Entry Description

JOB_NAME=Job name Type the name of the test run job. If a


name is not provided, one will
automatically be generated.

SERVER-Server name 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.

USERNAME=Username 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.

PASSWORD=Password Enter the password for logging into a


remote Backup Exec server. If a
password is not specified, the current
password is used.

[TestRun_Options]

JOBINSTANCE_GUID=0 or 1 Enter 1 as the value if you want


Backup Exec to overwrite a test run job
if one exists; otherwise, enter 0.

APPEND_OVERWRITE=0 or 1 Enter 1 to append to the media set


specified in the MEDIA_SET_GUID
entry, or to have the job append to
overwritable media that will then be
added to the media set, enter 0.

APPEND_TERMINATE=0 or 1 Enter 1 to append to the media set


specified in the MEDIA_SET_GUID
entry, if appendable media is available.
To have the job terminate if no
appendable media is available, enter 0.

EJECT _MEDIA_AFTER_COMPLETES=0 or Enter 1 to have Backup Exec


1 automatically eject the media in the
drive when the operation completes.

189
Using job script files

Possible test run job script file entries (continued)

Section Entry Description

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.

RETENSION_MEDIA=0 or 1 Enter 1 to retension the media before


backup; otherwise, enter 0.

MEDIA_PASSWORD=Media password If the media has a password, specify


the password.

AUTO_VERIFY=0 or 1 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.

COMPRESSION_TYPE=0 or 1 Enter 1 to select hardware


compression; otherwise, enter 0.

[Selections]

JOBINSTANCE_GUID=Job GUID Specifies the job ID of the existing job


to use for the test run job.

CREDENTIALS_CHECK=0 or 1 Enter 1 to verify that the logon


account is correct for the resources
being backed up; otherwise, enter 0.

190 Symantec Backup Exec Command Line Applet


Using job script files

Possible test run job script file entries (continued)

Section Entry Description

MEDIA_CAPACITY_CHECK=0 or 1 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.

JOBSIZE_METHOD=0 or 1 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.

HOLD_ON_FAILURE=0 or 1 Enter 1 to have the scheduled job


placed on hold if any failures are
detected during the test run;
otherwise, enter 0.

[Schedule]

SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


that the schedule becomes effective.

SCHED_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS


format for this job.

SCHED_ENDTIME=HH:MM:SS Enter the latest time this job can start


in HH:MM:SS format.

191
Using job script files

Possible test run job script file entries (continued)

Section Entry Description

SCHED_RESTART_INTERVAL=HH:MM:SS 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_REPEAT_INTERVAL=x 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_ANCHOR=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


from which the interval is calculated.

SCHED_DAYSOFMONTH=x 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

192 Symantec Backup Exec Command Line Applet


Using job script files

Possible test run job script file entries (continued)

Section Entry Description

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

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

193
Using job script files

Possible test run job script file entries (continued)

Section Entry Description

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.

HOLD=0 or 1 Enter 1 if you want the job to be


submitted on hold; otherwise, enter 0.

DELETE_JOB_AFTER=# Enter a number from 0 to 2 that


corresponds to job deletion. Options
include:
◆ 0 = Do not delete the job
◆ 1 = Delete the job after the job
completes
◆ 2 = Delete the job if the job
successfully completes

194 Symantec Backup Exec Command Line Applet


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 Entry Description

[General]

JOB_TYPE=Job type This entry must be completed with a


value of Copy.

[Job]

JOB_NAME=Job name Type the name of the copy job. If a


name is not provided, one will
automatically be generated.

195
Using job script files

Possible copy job script file entries (continued)

Section Entry Description

SERVERx=Server name Type the destination server where you


want to copy the job. If a server is not
specified, the local server is used by
default.

LOGINACCOUNT_NAMEx=login Type the login account name for


account name logging into the destination server. If a
user name is not specified, the current
user name is used.

OVERWRITE_JOB=0 or 1 Enter 1 as the value if you want


Backup Exec to overwrite the job that
has the same name; otherwise, enter 0.

OVERWRITE_LOGIN_ACCOUNT=0 or 1 Enter 1 as the value if you want to


overwrite a logon account that has the
same account name; otherwise, enter
0.

[Selection List]

SELECTION_LIST_NAMEx=selection Type the name of the selection list to


list name to be copied be copied.

SERVERx=Server name 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.

LOGINACCOUNT_NAMEx=login Type the login account name for


account name logging into the destination server. If a
user name is not specified, the current
user name is used.

OVERWRITE_SELECTION=0 or 1 Enter 1 as the value if you want to


overwrite a selection list that has the
same name; otherwise, enter 0.

[Policy]

POLICY_NAMEx=policy name to be Type the name of the policy to be


copied copied.

196 Symantec Backup Exec Command Line Applet


Using job script files

Possible copy job script file entries (continued)

Section Entry Description

SERVERx=Server name Type the destination server where you


want to copy the policy. If a server is
not specified, the local server is used
by default.

LOGINACCOUNT_NAMEx=login Type the login account name for


account name logging into the destination server. If a
user name is not specified, the current
user name is used.

OVERWRITE_POLICY=0 or 1 Enter 1 as the value if you want to


overwrite a policy that has the same
name; otherwise, enter 0.

[Login Account

ACCOUNT_NAMEx=login account Type the name of the logon account to


name be copied.

SERVERx=Server name 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.

OVERWRITE_ACCOUNT=0 or 1 Enter 1 as the value if you want to


overwrite a logon account that has the
same name; otherwise, enter 0.

[Configuration]

DEFAULT_JOB_OPTIONS=0 or 1 Enter 1 as the value if you want to


overwrite the default job options;
otherwise, enter 0.

DEFAULT_SCHEDULE=0 or 1 Enter 1 as the value if you want to


overwrite the default schedule options;
otherwise, enter 0.

ERROR_HANDLING _RULES=0 or 1 Enter 1 as the value if you want to


overwrite the default error handling
rules; otherwise, enter 0.

197
Using job script files

Possible copy job script file entries (continued)

Section Entry Description

ALERT_CONFIGURATION=0 or 1 Enter 1 as the value if you want to


overwrite the default alert options;
otherwise, enter 0.

SERVERx=Server name 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.

LOGINACCOUNT_NAMEx=login Type the login account name for


account name logging into the destination server. If a
user name is not specified, the current
user name is used.

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 -f”c:\scripts\diffbkwork.txt”

198 Symantec Backup Exec Command Line Applet


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 CD. 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 Entry Description

[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:
◆ Lowest
◆ Low
◆ Medium
◆ High
◆ Highest

199
Using scripts and selection lists

Values for selection list script (continued)

Section Entry Description

PATHx=String 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.

INCLUDEx=0 or 1 Enter a value of 1 if you want to


include this item in the backup job;
otherwise, enter 0.

SUBDIRSx-0 or 1 Enter a value of 1 if you want to


include all subdirectories; otherwise,
enter 0.

EXCHANGEx=Exchange Server name Change x to a unique number and


specify the name of the Exchange
Server you want to back up.

SQLx=SQL Server name Change x to a unique number and


specify the name of the SQL Server
you want to back up.

200 Symantec Backup Exec Command Line Applet


Using scripts and selection lists

Values for selection list script (continued)

Section Entry Description

EXCH2ROOTx=Exchange 2000 Server Specifies the name of the Exchange


name 2000 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
“EXCH2DB?=Exchange 2000
Server database name” on
page 142.

EXCH2SGx=Exchange 2000 Server Specifies the name of the Exchange


storage group name 2000 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
2000 Server.

201
Using scripts and selection lists

Values for selection list script (continued)

Section Entry Description

EXCH2DBx=Exchange 2000 Server Specifies the name of the Exchange


database name 2000 Server database you want to back
up.
Change x to the same number used to
identify the selection for the Exchange
2000 Server and storage group.
In the following example,
SERVER_NAME is an Exchange 2000
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

EXCH2ROOT2=SERVER_NAME
EXCH2SG2=Second Storage Group
EXHC2DB2=Mailboxes

EXCH2ROOT3=SERVER_NAME
EXCH2SG3=Second Storage Group
EXHC2DB3=Users

SQL2S?=SERVER_NAME Specifies the name of the SQL Server


2000 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
2000 named instance name.”

202 Symantec Backup Exec Command Line Applet


Using scripts and selection lists

Values for selection list script (continued)

Section Entry Description

SQL2NI?=SQL Server 2000 named Specifies the named instance on the


instance name SQL Server 2000 to back up.
Change ? to the same number used to
identify the selection for the SQL
Server 2000. For example, to back up
the named instance ONE, the named
instance TWO, and the SQL Server
2000 itself, the entries would be:
SQL2S1=SERVER_NAME
SQL2NI1=ONE

SQL2S2=SERVER_NAME
SQL2NI2=TWO

SQL2S3=SERVER_NAME

SQL2DB?=SQL Server 2000 database Specifies the name of the SQL Server
name 2000 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.”

203
Using scripts and selection lists

Values for selection list script (continued)

Section Entry Description

LNDRIVE?=DRIVE_LETTER 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.”

204 Symantec Backup Exec Command Line Applet


Using scripts and selection lists

Values for selection list script (continued)

Section Entry Description

ORCLSID?=System identifier for Specifies the SID (System Identifier)


database 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

SPPSx=SharePoint Portal Server Change x to a unique number and


name specify the name of the Microsoft
SharePoint Portal Server you want to
back up.

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

[Availability]

USEWINDOW=0 or 1 Enter 1 to specify when the selection


list will be available for backup each
day; otherwise, enter 0.

EFFECTIVEDATE=MM/DD/YYYY 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.

STARTTIME=HH:MM:SS Enter the earliest time when the


selection list will be available for
backup in HH:MM:SS format.

205
Using scripts and selection lists

Values for selection list script (continued)

Section Entry Description

ENDTIME=HH:MM:SS Enter the latest time when the


selection list will be available for
backup in HH:MM:SS format.

[Media_server]

PREFERRED_SERVER=Media server This operation is only available if the


GUID Central Admin Server Option (CASO) is
installed.
Specify the preferred media server on
which backup jobs run.

MEDIA_SERVER_POOL=Media server This operation is only available if the


pool GUID Central Admin Server Option (CASO) is
installed.
Specify the media server pool to use
for the backup job.

206 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 Function Description


Switches

-o260 Create new Executes a policy based on the contents of a


policy file. Returns a 1 if the command succeeds or a
-1 if the command fails.

-fpolicy file Required. Specifies the name of the policy


script file to be executed.

-o261 Delete a policy Deletes the specified policy. Returns 1 if the


command is successful or -1 if it failed.

-ipolicy ID or Required. Specifies the ID or the name of the


-j:policy name policy to be deleted.

-o262 Update a policy Update an existing policy.

-jpolicy name Required. Specifies the name of the policy to


apply to the selection list.

-fpolicy file Required. Specifies the name of the policy


script file to be executed.

-o263 Get number of Displays the number of policies created on a


policies 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

-i Instructs Backup Exec to display policy IDs.

-j Instructs Backup Exec to display policy name.

-tl: Instructs Backup Exec to display templates


for the specified policy ID or policy name.

207
Using Policy Commands

Policy Commands (continued)

Operation Additional Function Description


Switches

-r Instructs Backup Exec to display templates


rules for the specified policy ID or policy
name.

-o264 Apply policy to Applies the specified policy to selection lists.


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.

-ipolicy ID or Required. Specifies the ID or name of the


-j:policy name policy to apply to the selection list.

-sj:selection Required. Specifies the selection list IDs or


list IDs or names to apply to the policy.
-j:selection
list names

-ffilename Specifies a file that contains a lists of


selection lists (one per line).

-o265 Remove policy Removes the specified policy from a script.


from script Returns a 1 if the command succeeds or a -1 if
the command fails.

-ipolicy ID or Required. Specifies the ID or name of the


-j:policy name policy to remove from the script.

-sj:selection Required. Specifies the selection list IDs or


list IDs or names to remove from the script.
-j:selection
list names

-ffilename Specifies a file that contains a lists of


selection lists (one per line).

208 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 CD. 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 Entry Description

[General]

NAME Required. Specifies the name of the


policy being created.

DESCRIPTION Specifies a description of the policy


being created.

[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.

FILEx=Name of job template file Required. Specifies the name of a file


that contains a job template.
Note The FILEx entry is not required
for Export media templates.

209
Using Policy Commands

Policy file values (continued)

Section Entry Description

TYPEx=Template type 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

[Rules]

RULE_FIRST_TEMPLATEx=Name of Specifies the name of the template in


first template the [Template} section with the
highest precedence.

RULE_SECOND_TEMPLATEx=Name of Specifies the name of the template in


second template the [Template} section with the lowest
precedence.

210 Symantec Backup Exec Command Line Applet


Using Policy Commands

Policy file values (continued)

Section Entry Description

RULE_TYPEx=0-8, or 10 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>
Rules to link jobs together:
◆ 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>.
Rules to duplicate backup sets:
◆ 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.

211
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.
Rules to export media:
◆ 10 - After <First Template>
completes, start <Second
Template> to export media.

212 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 CD. 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"

213
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]
■ [W2K]
■ [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.

214 Symantec Backup Exec Command Line Applet


Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

BK_METHOD=# Enter a number from 0 through 9 and


11 that corresponds to the backup
method you want. Methods are:
◆ 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.

215
Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

OPEN_FILES_METHOD=# 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.

RETENSION_MEDIA=0 or 1 Enter 1 to retension the media before


backup; otherwise, enter 0.

PRESERVE_TREE_ON_ARCHIVE= Enter 1 to retain the directory


0 or 1 structure of the files that were backed
up in an archive job on the hard drive;
otherwise, enter 0.

SINGLE_INSTANCE_FOR_NTFS=0 or 1 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.

216 Symantec Backup Exec Command Line Applet


Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

REMOTE_AGENT_PRIORITY=# 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 server’s 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.

217
Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

EXCHANGE_METHOD=# 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_ Enter 1 to enable the restore of


RESTORE individual documents from database
backups. This option is only available
when performing full backups;
otherwise enter 0.

EXCHANGE_MBOX_METHOD=# 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 = 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=# 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
VERITAS Backup Exec for Windows
Servers - Advanced Disk-based Backup
Option (ADBO) or the Advanced Open
File Option (AOFO); otherwise, enter
0.

218 Symantec Backup Exec Command Line Applet


Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

EXCHANGE_CONTINUE=0 or 1 Enter 1 to continue the backup job


even if the consistency check fails;
otherwise, enter 0.

EXCHANGE_CONTINUOUS_ Enter 1 to enable continuous backup of


PROTECTION=# Exchange transaction logs with
Backup Exec Continuous Protection
Server; otherwise, enter 0.

EXCHANGE_RECOVERY_POINTS_ Enter the interval in days, hours, or


INTERVAL=xD (days) or xH (hours) minutes for making recovery points
or xM (minutes) when continuously backing up
Exchange transaction logs with
Backup Exec Continuous Protection
Server.

SPPS2_METHOD=# 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.
◆ 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 Enter 1 to enable the restore of


individual documents from database
backups. This option is only available
when performing full backups;
otherwise, enter 0.

219
Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

SPPS2_PRE_DBCC=# 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.

SPPS2_CONT_ON_CC_FAILURE=# Enter 1 to continue with the backup


operation even if the consistency
check fails; otherwise, enter 0.

SPPS2_RELEASE_LOCK Enter 1 to release the lock on the


SharePoint farm topology before
backing up data; otherwise, enter 0.

SQL_METHOD=# 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:
◆ 0 = Backup All
◆ 1 = Backup Log
◆ 2 = Backup Log No Truncate
◆ 3 = Differential

LOTUS_DOMINO_METHOD=# 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= If you are backing up a Lotus Domino


0 or 1 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

220 Symantec Backup Exec Command Line Applet


Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

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.

NW_BK_DECOMPRESS_FILES= If you are backing up NetWare shares


0 or 1 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.

OVERWRITE_JOB=0 or 1 Enter 1 as the value if you want


Backup Exec to overwrite a duplicate
job if one exists; otherwise, enter 0.

CONTINUE_ON_DBCC=0 or 1 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.

PRE_BK_DBCC=# 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:
◆ 0 = None
◆ 1 = No Index
◆ 2 = Full
◆ 3 = Physical only (SQL 2000 only)

221
Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

POST_BK_DBCC=# 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 2000 only)

SQL_STANDBY_OPTION=# This entry is for Microsoft SQL Server


2000 only. 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.

222 Symantec Backup Exec Command Line Applet


Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

OPEN_FILE_CONFIGURATION=1-4 Enter a number from 1 through 4 to


specify the open file technology to
back up open files. Selections include:
◆ 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.

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

223
Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

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.

OFFHOST_SINGLESNAP=0 or 1 Enter 1 to process logical volumes for


offhost backup one at a time;
otherwise, enter 0.

ENCRYPTION_KEY_NAME=key name Specify a name for the encryption key.

ENCRYPTION_TYPE=# 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.

[Media Options]

MEDIA_NAME=Media Name Specify a label for the new or


overwritable media.

MEDIA_SET=Media Set Name Enter the name of the media set to be


used for the backup.

MEDIA_PASSWORD=Media Password If the media has a password, specify


the password.

224 Symantec Backup Exec Command Line Applet


Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

APPEND=0 or 1 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.

VERIFY=0 or 1 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.

COMPRESSION_TYPE=# 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.

225
Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

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.

EJECT_MEDIA=0 or 1 Enter 1 to eject the media when the job


completes; otherwise, enter 0.

[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.

POST_JOB_COMMAND=command Specify a .exe or batch file command


that is to run after the backup
operation completes.

COMMAND_RUN_POST_IF_ Enter 1 to execute the post-job


PRE_SUCCESS=0 or 1 command only if the pre-job command
is successful; otherwise, enter 0.

COMMAND_RUN_JOB_IF_PRE_SUCCESS= Enter 1 to execute the job only if the


0 or 1 pre-job command is successful;
otherwise, enter 0.

COMMAND_RUN_POST_ Enter 1 to execute the post-job


IF_JOB_FAILS=0 or 1 command even if the job fails;
otherwise, enter 0.

226 Symantec Backup Exec Command Line Applet


Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

COMMAND_FAIL_JOB_IF_FAILS= Enter 1 to allow the pre- and post-job


0 or 1 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 pre-
and 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_OPTION=# Enter 0 to run the command on this


media server or 1 to run the command
on each server being backed up.

NIC_ENABLED=0 or 1 Enter 1 to use the MAC address or


service entry name specified with the
NIC_ADDRESS entry.
Enter 0 to clear previous settings for
the network interface, and to use any
available network adapter.

NIC_ADDRESS For Windows 2000 and later operating


systems, enter the Media Access
Control (MAC) address for the network
interface you selected.
To use this setting, NIC_ENABLED
must be set to 1.

227
Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

NIC_SUBNET_ADDRESS If the setting used in NIC_ADDRESS is


connected to multiple subnets, then
enter the network ID based on the IP
address and the subnet mask of the
network interface card you selected.
To view this ID, on the Tools menu,
click Options, then under Properties,
click Network, and view the Network
ID field.
This setting corresponds to the
network interface used in
NIC_ADDRESS.
You must also enter the
NIC_SUBNET_MASK.

NIC_SUBNET_MASK If the setting used in NIC_ADDRESS is


connected to multiple subnets, then
enter the mask that determines the
subnet to which the network interface
belongs.
To view this ID, on the Tools menu,
click Options, then under Properties,
click Network, and view the Subnet
mask field.
This setting corresponds to the
network interface used in
NIC_ADDRESS.
You must also enter the
NIC_SUBNET_ADDRESS.

NIC_SUBNET_AUTOGET=0 or 1 Enter 1 to have Backup Exec use any


available network adapter.

[W2K]

BACKUP_LOCAL_MOUNT_POINTS= Enter a value of 1 to back up mount


0 or 1 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.

228 Symantec Backup Exec Command Line Applet


Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

BACKUP_REMOTE_STORAGE_HSM= Enter a value of 1 to back up data that


0 or 1 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:
◆ 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.

[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.

SCHED_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS


format for this job.

SCHED_ENDTIME=HH:MM:SS Enter the latest time this job can start


in HH:MM:SS format.

SCHED_RESTART_INTERVAL=HH:MM:SS 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.

229
Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

SCHED_REPEAT_INTERVAL=X 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_ANCHOR=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


from which the interval is calculated.

SCHED_DAYSOFMONTH=x 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 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

230 Symantec Backup Exec Command Line Applet


Creating a backup job template script file

Possible backup job template script file entries (continued)

Section Entry Description

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.

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=# 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.

HOLD=0 or 1 Enter 1 as the value if you want to


schedule the job on hold; otherwise,
enter 0.

231
Creating a duplicate backup job template script file

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]
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 Entry Description

[General]

BACKUP_SET_DESCRIPTION=Descripti Type a description of the information


on you are duplicating.

PREFERRED_SOURCE_DEVICE_GUID= Enter the GUID of the device used as


Source device guid the destination device for the original
backup job. Use operation -o63 to
display managed drives.

[Setcopy_Options]

DEVICE_NAME=Device name Type the name of the device to be used


for the duplicate job.

MEDIA_SET_GUID=Media set GUID Enter the name of the media set to be


used for the duplicate job. Use
operation -o69 to display media sets.

OVERWRITE_MEDIA=0 or 1 Enter 1 as the value if you want


Backup Exec to overwrite a duplicate
job if one exists; otherwise, enter 0.

232 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

APPEND_OVERWRITE=0 or 1 Enter 1 to append to the media set


specified in the MEDIA_SET_GUID
entry, or to have the job append to
overwritable media that will then be
added to the media set, enter 0.

APPEND_TERMINATE=0 or 1 Enter 1 to append to the media set


specified in the MEDIA_SET_GUID
entry, if appendable media is available.
To have the job terminate if no
appendable media is available, enter 0.

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.

RETENSION_MEDIA=0 or 1 Enter 1 to retension the media before


backup; otherwise, enter 0.

MEDIA_PASSWORD=Media password If the media has a password, specify


the password.

AUTO_VERIFY=0 or 1 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.

COMPRESSION_TYPE=0 or 1 Enter 1 to select hardware


compression; otherwise, enter 0.

ENCRYPTION_KEY_NAME=key name Specify a name for the encryption key.

233
Creating a duplicate backup job template script file

Possible duplicate job template script file entries (continued)

Section Entry Description

ENCRYPTION_TYPE=# 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.

SCHED_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS


format for this job.

SCHED_ENDTIME=HH:MM:SS Enter the latest time this job can start


in HH:MM:SS format.

SCHED_RESTART_INTERVAL=HH:MM:SS 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_REPEAT_INTERVAL=x 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_ANCHOR=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


from which the interval is calculated.

234 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

SCHED_DAYSOFMONTH=x 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

235
Creating a duplicate backup job template script file

Possible duplicate job template script file entries (continued)

Section Entry Description

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

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

HOLD=0 or 1 Enter 1 if you want the job to be


submitted on hold; otherwise, enter 0.

236 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 Entry Description

[General]

BACKUP_SET_DESCRIPTION=Descripti Type a description of the information


on you are duplicating.

PREFERRED_SOURCE_DEVICE_GUID= Enter the GUID of the device used as


Source device guid the destination device for the original
backup job. Use operation -o63 to
display managed drives.

[Synthetic_Options]

DEVICE_NAME=device name Type the name of the device to be used


for the backup.

MEDIA_SET=Media Set Name Enter the name of the media set to be


used for the backup.

OVERWRITE_MEDIA=0 or 1 Enter 1 as the value if you want


Backup Exec to overwrite a duplicate
job if one exists; otherwise, enter 0.

APPEND_OVERWRITE=0 or 1 Enter 1 to append to the media set


specified in the MEDIA_SET_GUID
entry, or to have the job append to
overwritable media that will then be
added to the media set, enter 0.

237
Creating a synthetic full job template script file

Possible synthetic full template script file entries (continued)

Section Entry Description

APPEND_TERMINATE=0 or 1 Enter 1 to append to the media set


specified in the MEDIA_SET_GUID
entry, if appendable media is available.
To have the job terminate if no
appendable media is available, enter 0.

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.

RETENSION_MEDIA=0 or 1 Enter 1 to retension the media before


backup; otherwise, enter 0.

MEDIA_PASSWORD=Media Password If the media has a password, specify


the password.

AUTO_VERIFY=0 or 1 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.

238 Symantec Backup Exec Command Line Applet


Creating a synthetic full job template script file

Possible synthetic full template script file entries (continued)

Section Entry Description

COMPRESSION_TYPE=# 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.

SCHED_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS


format for this job.

SCHED_ENDTIME=HH:MM:SS Enter the latest time this job can start


in HH:MM:SS format.

SCHED_RESTART_INTERVAL=HH:MM:SS 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_REPEAT_INTERVAL=X 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_ANCHOR=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


from which the interval is calculated.

239
Creating a synthetic full job template script file

Possible synthetic full template script file entries (continued)

Section Entry Description

SCHED_DAYSOFMONTH=x 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 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

240 Symantec Backup Exec Command Line Applet


Using a schedule script with device and media operations

Possible synthetic full template script file entries (continued)

Section Entry Description

DATE=MM/DD/YYYY Enter the start date for the job in


mm/dd/yyyy format.

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=# 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.

HOLD=0 or 1 Enter 1 as the value if you want to


schedule the job on hold; otherwise,
enter 0.

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.

241
Using a schedule script with device and media operations

The following values are in the schedule script file:

Values for schedule script file

Section Entry Description

[Schedule]

SCHED_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS


format for this job.

SCHED_ENDTIME=HH:MM:SS Enter the latest time this job can start


in HH:MM:SS format.

SCHED_RESTART_INTERVAL=HH:MM:SS 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_REPEAT_INTERVAL=X 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_ANCHOR=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


from which the interval is calculated.

SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in mm/dd/yyyy format,


that the schedule becomes effective.

SCHED_DAYSOFMONTH 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

242 Symantec Backup Exec Command Line Applet


Using a schedule script with device and media operations

Values for schedule script file (continued)

Section Entry Description

SCHED_DAYSOFWEEK 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_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 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.

243
Using a schedule script with device and media operations

Values for schedule script file (continued)

Section Entry Description

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.

INTERVAL_MINUTES=# If a number is specified, the job is


scheduled to run every specified
number of minutes.
Note Only one of the INTERVAL
values should be specified. For
example, if you specify a value
for INTERVAL_MINUTES, do
not specify a value for
INTERVAL_HOURS,
INTERVAL_DAYS, or
INTERVAL_WEEKS. Also, use
either one of the INTERVAL
values, or the WEEKS and
WEEKDAYS, or the DAYS, or the
DAYS_OF_MONTH entries.
Unless specifically noted, these
scheduling options should not
be used in conjunction with each
other.

244 Symantec Backup Exec Command Line Applet


Using a schedule script with device and media operations

Values for schedule script file (continued)

Section Entry Description

INTERVAL_HOURS=# If a number is specified, the job is


scheduled to run every specified
number of hours.
Note Only one of the INTERVAL
values should be specified. For
example, if you specify a value
for INTERVAL_MINUTES, do
not specify a value for
INTERVAL_HOURS,
INTERVAL_DAYS, or
INTERVAL_WEEKS. Also, use
either one of the INTERVAL
values, or the WEEKS and
WEEKDAYS, or the DAYS, or the
DAYS_OF_MONTH entries.
Unless specifically noted, these
scheduling options should not
be used in conjunction with each
other.

INTERVAL_DAYS=# If a number is specified, the job is


scheduled to run every specified
number of days.
Note Only one of the INTERVAL
values should be specified. For
example, if you specify a value
for INTERVAL_MINUTES, do
not specify a value for
INTERVAL_HOURS,
INTERVAL_DAYS, or
INTERVAL_WEEKS. Also, use
either one of the INTERVAL
values, or the WEEKS and
WEEKDAYS, or the DAYS, or the
DAYS_OF_MONTH entries.
Unless specifically noted, these
scheduling options should not
be used in conjunction with each
other.

245
Using a schedule script with device and media operations

Values for schedule script file (continued)

Section Entry Description

INTERVAL_WEEKS=# If a number is specified, the job is


scheduled to run every specified
number of weeks.
Note Only one of the INTERVAL
values should be specified. For
example, if you specify a value
for INTERVAL_MINUTES, do
not specify a value for
INTERVAL_HOURS,
INTERVAL_DAYS, or
INTERVAL_WEEKS. Also, use
either one of the INTERVAL
values, or the WEEKS and
WEEKDAYS, or the DAYS, or the
DAYS_OF_MONTH entries.
Unless specifically noted, these
scheduling options should not
be used in conjunction with each
other.

WEEKS=FIRST,SECOND,THIRD, The job will be scheduled for the


FOURTH,LAST specified week of the month. For
example, if the entry appears as
WEEKS=FIRST, the job will be
or
scheduled to run the first week of the
month.
WEEKS=1,2,3,4,5 Note If this entry is included in the
Backup Job Script File, a value
must also be provided for the
WEEKDAY entry. Do not use this
entry in conjunction with the
INTERVAL, DAYS, or
DAY_OF_MONTH entries.

WEEKDAY=SUN/MON/TUES/WED/ Note If the entry WEEKS is included


THU/FRI/SAT in the Backup Job Script File, a
value must also be provided for
this entry.
Enter the day of the week the job
should be completed. Only one day can
be entered in this entry, which works
in conjunction with the WEEKS entry.

246 Symantec Backup Exec Command Line Applet


Using a schedule script with device and media operations

Values for schedule script file (continued)

Section Entry Description

DAYS=SUN/MON/TUES/WED/THU/ If this entry is included in the Backup


FRI/SAT Job Script File, the backup job will be
scheduled for the indicated day or
days. Multiple days can be included,
but must be separated by commas. For
example:
DAYS=MON,WED,FRI
Note Do not use this entry in
conjunction with the INTERVAL,
WEEKS, or DAY_OF_MONTH
entries.

DAY_OF_MONTH=# If this entry is included in the Backup


Job Script File, the backup job will be
scheduled for the indicated day of the
month. The value can range from 1 to
31. Only one number can be specified.
Note Do not use this entry in
conjunction with the INTERVAL
entries, the WEEKS, or the DAYS
entries.

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.

HOLD=0 or 1 Enter 1 if you want the job to be


submitted on hold; otherwise, enter 0.

247
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 Description

JOB_STATE_CANCELED = 1 The job has been terminated because it was


canceled.

JOB_STATE_COMPLETED = 2 The job has completed and is waiting for final


disposition.

JOB_STATE_SUCCESS_WITH_EXCEPTION The job has completed successfully with some


S=3 exceptions.

JOB_STATE_DISPATCHED = 4 The job has been dispatched.

JOB_STATE_HOLD = 5 The job is on hold.

JOB_STATE_ERROR = 6 The job has completed with an error.

JOB_STATE_INVALID SCHEDULE = 7 The schedule for the task is invalid. The job will
never run.

JOB_STATE_NOT_IN_WINDOW = 10 The job’s scheduled time window closed before the


job could be dispatched. There may not have been
an available device during the time window.

JOB_STATE_READY_BUT_PAUSED = 11 The job is ready, but the media server is paused.

JOB_STATE_PENDING = 12 The job is in a transitional state.

JOB_STATE_RECOVERED = 13 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.

248 Symantec Backup Exec Command Line Applet


Understanding job status messages

Possible job statuses (continued)

Job Status Code Description

JOB_STATE_RESUMED = 15 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.

JOB_STATE_ACTIVE = 16 The job is currently running on the server.

JOB_STATE_READY = 17 The job is eligible for dispatch.

JOB_STATE_SCHEDULED = 18 The job has a due date in the future.

JOB_STATE_SUCCESS = 19 The job has been completed successfully.

JOB_STATE_SUPERCEDED = 20 The job is ready, but another higher precedence task


is eligible to run.

JOB_STATE_THRESHOLD_AUTO_ABORT = The job was canceled because it was not completed


21 within the number of hours or minutes that were set
for the Enable automatic cancellation option on the
job schedule.

JOB_STATE_TO_BE_SCHEDULED = 22 The job needs to have the due date calculated.

JOB_STATE_LINKED_JOB = 23 The job is linked to another job, and will not start
until that job is finished.

249
Understanding job status messages

250 Symantec Backup Exec Command Line Applet


Index
A for SharePoint Portal Server, 219
ADBO, offhost backup, 103 for SQL server, 220
agent switches, 86 backup-to-disk folders
alert configuration, setting, 52 creating, 72
alert switches, 49 deleting, 74
alerts viewing properties, 74
display, 49 bemcmd command, 6
respond to, 50 bjscript.txt, 119
view text, 49 bjtemplatescript.txt, 213
alias backup, in backup job script file, 24,
C
148
catalog job
AOFO, setting default options, 100
creating using script file, 170
B script file, creating and using, 170
Backup Exec Command Line Applet, catalog job script file, creating, 170
about, 5 catalogscript.txt, 119
Backup Exec services cleaning job, creating, 63
commands, 81 cleaning slot, designating, 61
managing, 81 clone, using alias backup for, 24
backup job command line applet, using, 6
alias backup in script file, 24, 148 command line switches
creating, 10 administrating jobs, 36
creating using script file, 119, 237 backup job, 10
running previously created job, 10 restore job, 41
script file, creating and using, 119 used with all operations, 8
switches, 10
D
backup job script file
default options
creating, 119, 237
Active Directory, 108
using for alias backup, 148
ADBO, 101
backup job switches, 10
AOFO, 100
backup job template script
backup-to-disk, 115
batch file commands, 226
catalog, 113
Exchange server settings, 218
database maintenance, 117
Lotus Domino server settings, 220
DB2, 116
media options, 224
display progress indicators for job, 91
NetWare server settings, 221
Exchange server, 106
open file settings, 216
for backup jobs, 94
SharePoint Portal Server settings, 219
for restore jobs, 97
SQL server settings, 220
IDR, 115
backup selection list, deleting, 39
job default options, 92
backup template script
job log, 103
contents, 214
job status and recovery, 113
creating, 214
Linux, UNIX, and Macintosh, 111
for Exchange server, 218
Lotus Domino, 109
for Lotus Domino server, 220
media, 114
for NetWare, 221

251
Microsoft SharePoint, 107 I
NDMP, 112 inventory job
NetWare SMS, 111 robotic library, 64
network and security, 98 stand-alone drive, 73
Oracle server, 110
J
reports, 118
job
schedule, 113
administrating, 36
setting, 90
canceling, 36
setting general options, 91
job log, copying to console, 38
setting job priority, 92
job monitor switches, 36
setting startup inventory option, 91
job priority, specifying, 10, 32
SQL server, 104
job status messages, 248
trial job, 99
device management switches, 55 L
devices, managing, 55 label media, 70, 79
discovery job logon account switches, 82
creating using script file, 175 Lotus Domino Agent
script file, creating and using, 175 backup job script method, using, 127,
discovery job script file 220
creating, 175 setting default options, 109
setting discovery options, 176 using for backup, 21
setting general options, 175 M
setting schedule options, 178 media
specifying domains, 178 ejecting from drive, 71
discoveryscript.txt, 119 erasing, 68
djscript.txt, 119 formatting, 70
djtemplatescript.txt, 213 label, 79
drive pool labeling, 70
creating, 64 moving, 78
deleting, 76 renaming, 79
duplicate backup job, creating using script retension tape, 69
file, 181 media management switches, 55
duplicate backup template script media options
creating, 232 backup job template script, 224
setting device and media options, 183 default, 114
setting general options, 181 media overwrite protection period,
duplicate job script file, creating, 181 setting, 67
E media protection level, setting for backup
eject media job, 71 job, 13
encryption keys, creating and media server pool
maintaining, 33 adding server to, 77
error-handling rules switches, 54 creating, 76
Exchange 2000 server, backing up, 18 deleting, 76
Exchange server displaying ID, 77
backing up, 15 removing server from, 78
restore job script file entries, 153 renaming, 76
media sets
G
creating, 63
global command line switches, 8

252 Symantec Backup Exec Command Line Applet


deleting, 75 S
media vault schedule script file
adding media to, 80 using with device and media
creating, 79 operations, 241
deleting, 79 values, 242
displaying, 80 script file
media, managing, 55 about, 119
mirror, using alias backup for split backup, 214
mirror, 24, 148 duplicate backup job, 232
move media, 78 restore job, 48
saving and launching, 198
O
synthetic full, 237
offhost backup, choosing single volume
updating for this release, 5
snap, 103
selection lists
online help, 8
creating, 35
Oracle Agent, backing up, 22
creating using script file, 199
P script file
policy job using in command line applet, 199
creating using script file, 207 values for, 199
template script files, 213 server drive, backing up, 14
policy values, 209 sftemplatescript.txt, 213
pre/post commands SharePoint Portal Server, backing up
restore job script file, 155 from, 20
using backup job template script SQL 7.0
file, 226 backing up, 16, 20
priority, specifying for backup job, 11 placing in standby mode or load
R state, 20
rename media, 79 SQL Server 2000
report switches, 84 backing up, 19
requirements, 6 restoring, 44
restore job synthetic full job template script,
creating using script file, 150 creating, 237
running previously created, 41 T
script file, creating and using, 150 templates
restore job script file backup script, 214
creating, 150 duplicate backup job script, 232
running, 41 synthetic full job script, 237
rjscript.txt, 119 using script files, 213
RMAN test run job
restoring Oracle database, 43 creating using script file, 188, 195
using for backup job, 30 script file, creating and using, 188, 195
robotic library partitions, creating, 79 test run script file, 188, 195
testrunscript.txt, 119

Index 253
254 Symantec Backup Exec Command Line Applet

You might also like