backupe xec_command line

September 2004

VERITASTM Backup Exec for Windows Servers

Command Line Applet

Disclaimer

The information contained in this publication is subject to change without notice. VERITAS Software Corporation makes no warranty of any kind with regard to this manual, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. VERITAS Software Corporation shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this manual.

VERITAS Legal Notice

Copyright © 2004 VERITAS Software Corporation. All rights reserved. VERITAS, the VERITAS logo, and all other VERITAS product names and slogans are trademarks or registered trademarks of VERITAS Software Corporation. VERITAS, VERITAS Backup Exec for Windows Servers, the VERITAS logo, Reg. U.S. Pat. & Tm. Off. Other product names and/or slogans mentioned herein may be trademarks or registered trademarks of their respective companies.

VERITAS Software Corporation350 Ellis StreetMountain View, CA 94043 USAPhone 650–527–8000 Fax 650–527–2908www.veritas.com

Third-Party Copyrights

Douglas C. Schmidt and his research group at Washington University and University of California, Irvine

ACE (TM) is copyrighted by Douglas C. Schmidt and his research group at Washington University and University of California, Irvine,

Copyright (c) 1993-2002, all rights reserved.

Apache Software Foundation

Apache Tomcat 4.0, Apache Xerces C++ 1.2.0 and 1.3.0

Apache Software License

Version 1.1

Copyright (c) 2000 The Apache Software Foundation. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. The end-user documentation included with the redistribution, if any, must include the following acknowledgment:

“This product includes software developed by the Apache Software Foundation (http://www.apache.org/)."Alternately, this acknowledgment may appear in the software itself, if and wherever such third-party acknowledgments normally appears.

4. The names "Apache" and "Apache Software Foundation" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact [email protected].

5. Products derived from this software may not be called "Apache", nor may "Apache" appear in their name, without prior written permission of the Apache Software Foundation.

THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals on behalf of the Apache Software Foundation. For more information on the Apache Software Foundation, please see <http://www.apache.org/>. Portions of this software are based upon public domain software originally written at the National Center for Supercomputing Applications, University of Illinois, Urbana-Champaign.

Crystal Decisions, Inc. (formerly Seagate Software Information Management Group, Holdings, Inc.

Crystal Reports 8.5

Use, duplication, reproduction, or transfer of this commercial software and accompanying documentation is restricted in accordance with FAR 12.212 and DFARS 227.7202 and by a license agreement. Contact: Crystal Decisions, Inc., Attn: Contrcts Department, 895 Emerson Street, Palo Alto, CA 94301.

Nebiru Software Inc. (dba DomAPI)

DomAPI LIbrary 5.0 Copyright 2001-2003

Boris Fornitchev

STLPort 3.2.1

Copyright 1999,2000 Boris Fomitchev

This material is provided "as is", with absolutely no warranty expressed or implied. Any use is at your own risk. Permission to use or copy this software for any purpose is hereby granted without fee, provided the above notices are retained on all copies. Permission to modify the code and to distribute modified code is granted, provided the above notices are retained, and a notice that the code was modified is included with the above copyright notice. The Licensee may distribute binaries compiled with STLport (whether original or modified) without any royalties or restrictions. The Licensee may distribute original or modified STLport sources, provided that: (i) The conditions indicated in the above permission notice are met; (ii) The following copyright notices are retained when present, and conditions provided in accompanying permission notices are met: Copyright 1994 Hewlett-Packard Company

Copyright 1996,97 Silicon Graphics

Computer Systems, Inc.

Copyright 1997 Moscow Center for SPARC Technology.

Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. Hewlett- Packard Company makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. Silicon Graphics makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. Moscow Center for SPARC Technology makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Carnegie Mellon University and The Regents of the University of California

ucd-snmp 4.1.1 Copyright 1989, 1991, 1992 by Carnegie Mellon University

Derivative Work -Copyright 1996, 1998-2000 The Regents of the University of California All Rights Reserved Permission to use, copy, modify and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appears in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of CMU and The Regents of the University of California not be used in advertising or publicity pertaining to distribution of the software without specific written permission.

CMU AND THE REGENTS OF THE UNIVERSITY OF CALIFORNIA DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL CMU OR THE REGENTS OF THE UNIVERSITY OF CALIFORNIA BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM THE LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Ronald L. Rivest

Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All rights reserved.

License to copy and use this software is granted provided that it is identified as the "RSA Data Security, Inc. MD5 Message-Digest Algorithm" in all material mentioning or referencing this software or this function.

License is also granted to make and use derivative works provided that such works are identified as "derived from the RSA Data Security, Inc. MD5 Message-Digest Algorithm" in all material mentioning or referencing the derived work.

RSA Data Security, Inc. makes no representations concerning either the merchantability of this software or the suitability of this software for any particular purpose. It is provided "as is" without express or implied warranty of any kind.

These notices must be retained in any copies of any part of this documentation and/or software.

Wei Dai

Compilation Copyright (c) 1995-2003 by Wei Dai. All rights reserved.

This copyright applies only to this software distribution package as a compilation, and does not imply a copyright on any particular file in the package.

The following files are copyrighted by their respective original authors, and their use is subject to additional licenses included in these files.

mars.cpp - Copyright 1998 Brian Gladman.

All other files in this compilation are placed in the public domain by Wei Dai and other contributors.

I would like to thank the following authors for placing their works into the public domain:

Joan Daemen - 3way.cppLeonard Janke - cast.cpp, seal.cppSteve Reid - cast.cppPhil Karn - des.cppMichael Paul Johnson - diamond.cppAndrew M. Kuchling - md2.cpp, md4.cppColin Plumb - md5.cpp, md5mac.cppSeal Woods - rc6.cppChris Morgan - rijndael.cppPaulo Baretto - rijndael.cpp, skipjack.cpp, square.cppRichard De Moliner - safer.cppMatthew Skala - twofish.cpp

Permission to use, copy, modify, and distribute this compilation for any purpose, including commercial applications, is hereby granted without fee, subject to the following restrictions:

1. Any copy or modification of this compilation in any form, except in object code form as part of an application software, must include the above copyright notice and this license.

2. Users of this software agree that any modification or extension they provide to Wei Dai will be considered public domain and not copyrighted unless it includes an explicit copyright notice.

3. Wei Dai makes no warranty or representation that the operation of the software in this compilation will be error-free, and Wei Dai is under no obligation to provide any services, by way of maintenance, update, or otherwise. THE SOFTWARE AND ANY DOCUMENTATION ARE PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL WEI DAI OR ANY OTHER CONTRIBUTOR BE LIABLE FOR DIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

4. Users will not use Wei Dai or any other contributor's name in any publicity or advertising, without prior written consent in each case.

5. Export of this software from the United States may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting.

6. Certain parts of this software may be protected by patents. It is the users' responsibility to obtain the appropriate licenses before using those parts.

If this compilation is used in object code form in an application software, acknowledgement of the author is not required but would be appreciated. The contribution of any useful modifications or extensions to Wei Dai is not required but would also be appreciated.

Maarten Hoeben

ReportCtrl.h 2.0.1

Stac Electronics

Copyright (C) Stac Electronics 1993, including one or more U.S. patents No. 4701745, 5016009, 5126739 and 5146221 and other pending patents.

Table of Contents

Updating Scripts for Use with Command Line Applet 10.0 . . . . . . . . . . . . . . . . . . . . . . . 3

Command Line Applet Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Using the Command Line Applet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Using Command Line Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Switches Used With All Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Backup Job Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Switches for Administrating Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Restore Job Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Switches for Viewing and Responding to Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Switches for Error-Handling Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Switches for Managing Media and Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Backup Exec Services Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Logon Account Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Report Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Setting Default Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Using Job Script Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Creating a Backup Job Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Creating a Restore Job Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Creating a Catalog Job Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Creating a Discovery Job Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Creating a Duplicate Backup Job Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Creating a Test Run Job Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Saving and Launching the Job Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

1

Using Scripts and Selection Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Creating a Selection List Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Using Policy Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Creating a Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Using Job Template Script Files Within a Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Using a Schedule Script with Device and Media Operations . . . . . . . . . . . . . . . . . . . . 165

Understanding Job Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

2 Command Line Interface Guide

VERITAS Backup Exec - Command Line Applet

Co

mm

anL

ine

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.

Updating Scripts for Use with Command Line Applet 10.0This 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.

VERITAS 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 Backup Exec Command Line Applet 10.0, you can continue to use the previous version of the Command Line Applet, version 9.1.

Backup Exec Command Line Applet version 9.1 is installed with Backup Exec 10.0 for Windows Servers as bemcmd91.exe. The latest Command Line Applet version continues to be installed as bemcmd.exe.

3

d

Command Line Applet Requirements

Command Line Applet RequirementsThe Backup Exec Command Line Applet works with a local or remote Backup Exec server installation. Minimum system requirements include:

Using the Command Line AppletThe 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, sigcomp230.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.

Command Line Applet requirements

Operating System Microsoft Windows 2000 Professional or Server version, Microsoft Windows 2000 Advanced Server, or Microsoft Windows 2000 Datacenter.

Windows XP

Windows Server 2003 family

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

4 Administrator’s Guide

Using Command Line Switches

Co

mm

an
L
ine

◆ Create protection policies that include job templates and rules.

◆ Create, run, and monitor utility jobs.

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

◆ Set default options for all jobs.

◆ Obtain job status and the number of scheduled, active, and completed jobs.

◆ Create media sets and drive pools.

◆ Perform drive utilities and get information about the status of drives.

◆ Start and stop Backup Exec system services.

◆ Retrieve information on and respond to job alerts.

◆ Determine if the media server is available on the network.

◆ View and print Backup Exec reports.

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

Using Command Line SwitchesTo 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.

5

d


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

-?operation number -? -ooperation number -ooperation number -?

Displays help about a command line operation.

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



Co

mm

an
L
ine

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

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

Specifies the type of OS the server is running. The default is Windows.

To specify a NetWare server, type -tNW. This switch functions as an ExecView client for Backup Exec for NetWare Server versions 8.0, 8.5, and 9.0. The Backup Exec for NetWare Server must also have ExecView enabled.

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. This switch can be used with options -o1 through -o9, -o17, -o18, -o19,-o42, -o46, -o80, -o81, -o90, -o100, -o103, -o104, -o105, -o111 through -o115, and -o117. The commands with switch -w returns a 1 if successful or -1 on failure.

Command line switches for all operations

Item Description

7

d


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

Backup Job Commands

Operation Additional Switches

Function Description

-o1 Run backup job Runs a backup job that has been previously defined. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails.

-jjob name or -ijob ID

Required. Specifies the name or the job ID of the previously defined job that Backup Exec should run.

Note If there are jobs with the same name, only one of the jobs will run. To ensure that the correct job runs, you should use the job ID instead of the job name to specify which job will run.

-pr:priority Specifies the priority for the job. Priority options include:

Highest

High

Medium

Low

Lowest

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

-w Wait for job completion

Instructs the Command Line Applet to wait for the operation to complete before returning.

-o2 Create backup job

Creates and runs a backup job for a specified list of files. This operation returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails.



Co

mm

an
L
ine

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

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

-si:server ID or -pi:pool ID

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


Highest

High

Medium

Low

Lowest


Backup Job Commands (continued)



9

d


-sfile list or -sf:file name

Required. Specifies a list of files or the name of a file that contains a list (one per line) of files to be backed up.

The list should be comma delimited. Selections that end with a backslash indicate the selection is a directory. Selections that do not end with a backslash indicate the selection is a file.

To back up System State, type "\\server name\System?State\*.*" after -s.

Note To back up Shadow Copy Components on a Windows 2003 computer, type "\\server name\Shadow?Copy ?Components\*.*" after -s.

By default, subdirectories will be recursed; to skip subdirectories during backup, the characters /n should appear before the comma separating the entries, and the last quotation mark. Include a space between the list of files and the /n entry. For example, "c:\winnt\*.* /n".

If Unix files are included in the selections, the characters /u should appear before the comma separating the entries, and the last quotation mark. If the sudirectories are skipped during backup, the /n characters must precede the /u characters. If the /n characters are in the entry, include a space between the list of files and the /n entry. For example, "c:\winnt\*.* /n/u".

The order in which resource selections are specified is the order in which the resources will be backed up. Note the following about the order in which selections can be backed up:






Co

mm

an
L
ine

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 protection level

Specifies the media protection level:

0 = Overwrite

1 = Append to media, overwrite if not available

2 = Append to media, terminate if not available

-r Replace existing job

Instructs Backup Exec to replace a previously 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.



-e or -ef:file name

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

-rl: List of server and logon accounts

Specifies the server name and logon account GUIDs.




11

d


-rf: File name of server and logon accounts

Specifies the name of the file that contains the server name and logon account GUIDs. Each entry must be typed on a separate line.

-o3 Back up server drive

Creates and runs a backup job to back up the specified drive on the media server. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails.

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




Highest

High

Medium

Low

Lowest



Instructs Backup Exec to replace a previously 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.






Co

mm

an
L
ine



-o4 Back up Exchange server

This operation is not for Exchange 2000. If 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.





Highest

High

Medium

Low

Lowest





13

d



Instructs Backup Exec to replace a previously 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.



-o5 Back up SQL server

This option is not for SQL 2000. If you are 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.


-lo:database mode

Specifies the log backup option.

-db:database name

Specifies the name of a database to back up.








Co

mm

an
L
ine


Highest

High

Medium

Low

Lowest






-o6 Back up Exchange 2000 server

Creates and runs a backup job for Exchange 2000 Server. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails.

Note The Agent for Microsoft Exchange Server must be enabled from the media server in order for this command to work.


-sg:storage group

Required. Specifies the storage group to back up.






15

d



Highest

High

Medium

Low

Lowest






-o8 Back up SQL Server 2000

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


-db:database name

Specifies the name of the database to back up.

-ni:named instance

Specifies the named instance to back up.








Co

mm

an
L
ine


Highest

High

Medium

Low

Lowest






-lo:database mode

Places a Microsoft SQL Server database in either standby mode or in a loading state. Values are:

0 = None.

1 = Standby. Place database in standby mode.

2 = No recover. Place database in a loading state.

-o9 Back up SharePoint Portal Server

Creates and runs a backup job for the Microsoft SharePoint Portal Server. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails.

Note The Agent for Microsoft SharePoint Portal Server must be enabled on the media server in order for this command to work.




17

d





Highest

High

Medium

Low

Lowest







-o17 Back up Lotus Notes server

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


-ddrive name Required. Specifies the drive letter where Lotus Notes is installed.

-tl:path Specifies the complete path to the transaction log file.






Co

mm

an
L
ine




Highest

High

Medium

Low

Lowest






-o18 Back up Oracle server

Creates and runs a backup job of the Oracle server. Returns a 1 if the command succeeds or -1 if the command fails.

Note Only one SID can be specified per command. Use -si to indicate the SID name to back up.


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






19

d



Highest

High

Medium

Low

Lowest











Co

mm

an
L
ine

-o19 Create alias backup job

Creates and runs an alias backup. Files to be 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.


-mmedia set Specifies the name of the media set that Backup Exec should target.

-mp:media protection level

Specifies the media protection level:

0 = Overwrite

1 = Append to media, overwrite if not available

2 = Append to media, terminate if not available




21

d


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






Co

mm

an
L
ine

-sfile list or -sf:file name

Required. Specifies the host path of files or 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:


For any given server, System State or shadow copy components must be ordered last.




23

d


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




Highest

High

Medium

Low

Lowest



Specifies that the Command Line Applet should wait for the operation to complete before returning.

-g Specifies that the a frozen image is to be backed up.






Co

mm

an
L
ine

-o90 Launch job using job script file

Executes a job based on the contents of a script file. Return values depend on the type of script. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails.

For more information about Backup Job Script Files, see “Using Job Script Files” on page 81.

-fscript file Required. Specifies the name of the Backup Exec job script file.


Instructs the Command Line Applet to wait for the operation to complete before returning. If the job is a scheduled job (not a run now job), the -w is ignored.

-o220 Create selection list

Creates a list of resource selections to be used when creating a backup job.

-sselection name

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






25

d


Switches for Administrating JobsSeveral 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:

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




Job monitoring switches



-o10 Get number of scheduled jobs

Displays the number of scheduled jobs on a computer. Returns a 1 if the command succeeds or a -1 if the command fails.

-i Dump job IDs Instructs Backup Exec to dump the job IDs to the screen.

-j Dump job names Instructs Backup Exec to dump the job names to the screen.

-o11 Get number of active jobs

Displays the number of active jobs on a computer. Returns a 1 if the command succeeds or a -1 if the command fails.



-o12 Get number of completed jobs

Displays the number of completed jobs on a computer. Returns a 1 if the command succeeds or a -1 if the command fails.




Co

mm

an
L
ine


-o13 Get number of active utility jobs

Displays the number of active utility jobs on a computer. Returns a 1 if the command succeeds or a -1 if the command fails.

A utility job is one involving drive utility operations such as inventory, erase, retension, format, label media, and eject.

-o14 Get number of completed utility jobs

Displays the number of completed utility jobs on a computer. Also returns a 1 if the command succeeds or a -1 if the command fails.

A utility job is one involving drive utility operations such as inventory, erase, retension, format, label media, and eject.

-o15 Get job status Displays one of many predefined job statuses if the command was successful. Also returns a 1 if the command succeeds or a -1 if the command fails.


Required. Specifies the name or the job ID that contains the job statuses to display.

-o16 Dump job status for scheduled and active job

Copies to the console the job information and descriptive headings for each item associated with the job ID. Returns a 1 if the command succeeds or a -1 if the command fails.

-ijob ID Specifies the job ID of a specific job.

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


Required. Specifies the name or the job ID of the job to cancel.

-o21 Dump completed job status

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

Job monitoring switches (continued)



27

d


-ijob ID or -hi:job history ID

Specifies the job ID or job history ID that contains the job statuses to display.

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

-o30 Dump job log name of completed job

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

-ijob ID Required. Use this switch to specify the job ID of a specific job.

-o31 Dump job log contents

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

-ffile name Specifies the job log name.

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

-i<job id> Rename job associated with the job ID.

Instructs Backup Exec to rename the job associated with the job IDs.

-j<job name> Current name of the job to rename.

Instructs Backup Exec to rename the job.

-jn<new job name> New name for the job.

Provides the new name for 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.






Co

mm

an
L
ine

-jjob name Required. Specifies the name of the job to be placed 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.

-jjob name Required. Specifies the name of the job to be taken off hold.

-o202 -ijobID Delete scheduled job

Required. Use this switch to specify a job ID of a specific job. Returns a 1 if the command succeeds or a -1 if the command fails.

-ds: Delete the selection list if no other jobs are using it

If the scheduled job is not deleted, the selection list is not deleted, and a -1 is returned.

If the scheduled job is deleted, the selection list will be deleted, and a 1 is returned.

If the selection list is not deleted, a 0 is returned.

-o251 List all backup selection lists

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

-o263 List all backup job templates

Displays all available backup job templates. Returns a 1 if the command succeeds or a -1 if the command fails.

-o312 Disable error handling rule

Disables an error-handling rule.

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

-o506 Dump job information

Displays job, selection, and schedule information stored on this server. Also returns a 1 if the command succeeds or a -1 if the command fails.

-jjob name Specifies the name of the job that contains information that you want to be dumped.




29

d


-ddisplay type Display type of job information

Specifies the type of job information to display. Enter one of the following values:

1 = Display only the job information. Do not display the selection list or schedule information.

2 = Display only the selection list information. Do not display the job or schedule information.

3 = Display only the schedule information. Do not display the job or selection list information.

If you do not use the -d switch, all job information is displayed.

-o507 Dump selection lists

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

-sselection list name

Specifies the name of the selection list.

-o509 Dump policy information

Displays the contents of the specified policy. If a policy is not specified, all policies will be dumped.

-ipolicy ID Required. Specifies the GUID for the policy. To find the ID for a policy, use operation -o263 to display the policies

d on a computer.






Co

mm

an
L
ine

Restore Job SwitchesYou can run a previously created restore job or launch a restore job script file through the following command line switches:

Restore job commands



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


Required. Specifies the name or the job ID of the previously defined job that Backup Exec should run.


Highest

High

Medium

Low

Lowest




-o90 Launch job using job script file

Executes a job based on the contents of a script file. Return values depend on the type of script. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails.

For more information about Backup Job Script Files, see “Using Job Script Files” on page 81.

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

31

d


See also:

“Using Job Script Files” on page 81

Switches for Viewing and Responding to AlertsAlerts are events that require administrator attention. Several command switches allow you to view and respond to alerts. These include:


Instructs the Command Line Applet to wait for the operation to complete before returning. If the job is a scheduled job (not a run now job), the -w is ignored.

Restore job commands (continued)



Managing alerts switches



-o40 Get number of alerts

Displays the number of alerts on the computer. Returns a 1 if the command succeeds or a -1 if the command fails.

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



Co

mm

an
L
ine

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

-i Displays the alert ID of the text.


Instructs the Command Line Applet to prompt for a response to the alert.

-o43 Get number of information only alerts

Displays the number of non-critical (information only alerts) on the computer. Also returns a 1 if the command succeeds or a -1 if the command fails.

-i Dump all alert IDs

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

-tl: Show titles Displays alert titles.




-o44 Get number of user intervention (critical) alerts

Displays the number of user intervention alerts on the computer. Also returns a 1 if the command succeeds or a -1 if the command fails.






Managing alerts switches (continued)



33

d



-o45 Clear all information only alerts

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

-o46 Respond to alert Allows you to respond to an alert. Returns 1 if the command succeeds, 0 if the alert was already responded to, or -1 if the command fails.

-ialert ID Required. Specifies the alert ID that you want to respond to.

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

-o47 Get all warning alerts

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


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





-o48 Get all error alerts

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


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






Co

mm

an
L
ine





-o49 List alert categories

Displays alert categories. Returns a 1 if the command succeeds or a -1 if the command fails.



-j Display alert category name

Displays alert names on screen.

-ac: Display event category

Displays the alert category on screen.

-o50 Dump alert configuration

Displays the configuration for alerts on screen. Returns a 1 if the command succeeds or a -1 if the command fails.

-ialert category ID

Required. Specifies an alert ID to display configuration information for.

-o51 Set alert configuration

Modifies the alert configuration.

-ialert category ID

Required. Specifies an alert ID to display configuration information for.

-e or -d Enable alert or disable alert

Enables or disables the specified alert for reporting by Backup Exec. Some alerts types, such as error and attention required, are always enabled.




35

d


-no: or -nn: Enable notification or disable notification

Enables or disables the sending of a notification when the alert occurs. Recipients must be configured to use this option.

-jl: or -nj: Enable inclusion of job log or disable inclusion of job log

Sends the job log or disables the inclusion of the job log to the alert recipient that is configured for notification.

-s or -ns: Enable sending of SNMP notifications or disable sending of SNMP notifications

Enables or disables the sending of alert notifications through SNMP.

-rl: or -nr: Enable event logging or disable event logging

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

-ac:timeout or -na:

Set time for automatic clearing of alert or disable automatic alert clearing

Sets the time in minutes for Backup Exec to automatically clear the alert or disables the automatic clearing of alerts. The length of time entered cannot be more than seven days.

-ar:response Set the automatic response for an alert.

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

-o150 Dump notification recipients

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






Co

mm

an
L
ine

Switches for Error-Handling RulesBackup 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



-o310 Display error-handling rules

Displays the error-handling rules.

-o311 Enable error handling rule

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

-mr:maximum retries

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

-ri:retry interval

Indicates that the job should be retried and the number of minutes to wait before the job is retried. The range for the retry interval is 1 to 1,440.

-pj: Pause job on error

Indicates the job is to be paused until the user has taken action to clear the error. If this switch is absent, the job will be canceled until its next scheduled run.

-cj: Cancel job on error

Indicates the job is to be canceled if an error occurs.

-no:notes Specifies miscellaneous information for the error-handling rule.

-o312 Disable error handling rule

Disables the specified error-handling rule.

37

d


Switches for Managing Media and DevicesThrough 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:

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

Error-Handling Rules switches (continued)



Device and media management switches



-o60 Pause drive Pauses the specified drive. Returns a 1 if the command succeeds or a -1 if the command fails.

-ddrive name or -idrive ID

Required. Specifies the name or the ID of the drive.

-o61 Resume drive Resumes a previously paused drive. Returns a 1 if the command succeeds or a -1 if the command fails.



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



-o63 Get number of drives

Displays the number of managed drives. Returns a 1 if the command succeeds or a -1 if the command fails.



Co

mm

an
L
ine

-i Displays drive IDs for all drives.

-j Displays names for all drives.

-o64 Get number of drives available

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



-o65 Get number of drives paused

Displays the number of managed drives that are paused. Returns a 1 if the command succeeds or a -1 if the command fails.



-o66 Get number of drives offline

Displays the number of managed drives that are offline. Returns a 1 if the command succeeds or a -1 if the command fails.



-o67 Dump drive properties

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



-o68 Query devices

Device and media management switches (continued)



39

d


-o69 Get number of media sets

Displays the number of media sets. Returns a 1 if the command succeeds or a -1 if the command fails.

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

-j Displays the names of all media sets.

-o70 Dump media set properties

Displays properties of the media set. Returns a 1 if the command succeeds or a -1 if the command fails.

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

-o71 Dump media label properties

Displays properties of the media label. Returns a 1 if the command succeeds or a -1 if the command fails.

-imedia set ID Required. Specifies the media label ID.

-o80 Import drive slots

Imports a list of backup tapes. Returns job ID and 1 if the command succeeds, or a -1 if the command fails.

-arobotic library

Required. Specifies the robotic library to 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. For more information about schedule file scripts, see “Using a Schedule Script with Device and Media Operations” on page 165.






Co

mm

an
L
ine


Highest

High

Medium

Low

Lowest




-o81 Export drive slots

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

-arobotic library







41

d



Highest

High

Medium

Low

Lowest




-x Specifies the export of expired media only.

-o82 Designate cleaning slot

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

-arobotic library or -sslot number

Required. Specifies the robotic library or the slots in the robotic library to target for this 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 non-cleaning slot

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

-arobotic library or -sslot number

Required. Specifies the robotic library or the slots in the robotic library to target for this 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.






Co

mm

an
L
ine

-o84 Get number of robots

Displays the number of managed robots. Returns a 1 if the command succeeds or a -1 if the command fails.

-i Displays the robot IDs.

-o85 Dump robot properties

Displays property information for the specified robotic library. Returns a 1 if the command succeeds or a -1 if the command fails.

-irobot ID or -drobot name

Required. Specifies the ID or the name of the robotic library to display properties for.

If both -i and -d are provided, the -d parameter is used.

-o86 Dump slot content

Displays the slot information with header descriptions.


Required. Specifies the ID or the name of the robotic library to display properties for.

If both -i and -d are provided, the -d parameter is used.

-sslot number Specifies the slot number to display information for. If the slot number is not specified, the contents of all slots for the robotic library are displayed.

-o100 Create cleaning job

Creates and runs a cleaning job on the specified drive. Returns the job ID and a 1 if the command succeeds or a -1 if the command fails.

-ddrive name Required. Specifies the name of the robotic library drive you want to target.




43

d




Highest

High

Medium

Low

Lowest




-o101 Create media set Creates a media set with the specified name. Returns a 1 if the command succeeds or a -1 if the command fails.

-mmedia set name

Required. Specifies the name of the new media set.

-op:overwrite protection period

Required. Specifies the overwrite protection period for the new media set. Enter the length of time in hours.

Enter the value -1 to set the overwrite protection level to infinite.

-ap:append Required. Specifies the append period for the new media set. Enter the length of time in hours.






Co

mm

an
L
ine

-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 job for robotic library

Creates an inventory job on a specified robotic library.

Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. When using this command, you must also use the -arobotic library switch, which inventories all slots and drives on a specified robotic library.

-arobotic library


-jjob name Specifies a name for the job.






45

d



Highest

High

Medium

Low

Lowest




-o104 Lock library door

Locks the specified robotic library door.

Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. When using this command, you must also use the -arobotic library switch.

-arobotic library




Highest

High

Medium

Low

Lowest







Co

mm

an
L
ine



-o105 Unlock library door

Unlocks the specified robotic library door.

Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. When using this command, you must also use the -arobotic library switch.

-arobotic library


-fschedule file Schedule the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. For more information about schedule file scripts, see “Using a Schedule Script with Device and Media Operations” on page 165.


Highest

High

Medium

Low

Lowest







47

d


-o106 Set media overwrite protection period

Specifies the media overwrite level and overwrite options.

Returns a 1 if the command succeeds or a -1 if the command fails. When using this command, you must also use the -o1 and -o0 switches.

-ol:overwrite level

Required. Specifies the overwrite level; for example, -o1:4.

Overwrite Levels include:

1 = None

2 = None with prompt

3 = Partial

4 = Partial with prompt

5 = Full

-oo:recyclable Required. Specifies the overwrite options; for example, -o0:0.

Overwrite options include:

0 = Use scratch media first

1 = Use recyclable media first

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

-ddrive name Required. Specifies the drive name you want to target. If -s is used, -ddrive name will be the name of the robotic library.

-eerase type Required. Specifies the erase type. Erase types are:

1 = quick erase

3 = long erase







Co

mm

an
L
ine

-fschedule file Schedule the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. For more information about schedule file scripts, see “Using a Schedule Script with Device and Media Operations” on page 165.

-sslot numbers Specifies the slot numbers containing the media to be erased. If this switch is used, -d will represent the robotic library name.


Highest

High

Medium

Low

Lowest




-o112 Retension media Retensions the tape in the specified drive.


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




49

d



Highest

High

Medium

Low

Lowest




-o113 Label media Labels the tape in the specified drive.



-mmedia name Required. Specifies the media name.

-sslot numbers Specifies the slot numbers containing the media to be labeled.


Highest

High

Medium

Low

Lowest







Co

mm

an
L
ine



-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. When using this command, you must also use the -ddrive name command.


-sslot numbers Specifies the slot numbers containing the media to be formatted.


Low

Lowest

Medium

High

Highest

If this switch is absent, the priority is set to medium.



-o115 Eject media from drive

Ejects the tape in the specified drive.

Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. When using this command, you must also use the -ddrive name command.

-ddrive name Required. Specifies the drive name.




51

d



Highest

High

Medium

Low

Lowest




-o116 Create a backup folder

Creates a Backup Folder. Backup Exec allows 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.






Co

mm

an
L
ine

-ddirectory Specifies the location for the folder.

Note 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 stand-alone drive

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

-ddrive name Required. Specifies the drive name.


-fschedule file Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored.


Highest

High

Medium

Low

Lowest





53

d


-x Uses media auxiliary memory for inventory, which allows the media to be identified without having to be mounted.


Instructs the Command Line Applet to prompt for a response.

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

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

This operation is only available if the Central Admin Server Option (CASO) is installed. Creates a media server pool with the specified name. Returns a 1 if the command succeeds or a -1 if the command fails.

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

-pd:pool description

Specifies a description for the media server pool.

-si:server IDs or -sn:server names

Specifies the media server IDs or names to add to the media server pool.

-o123 Delete media server pool

This operation is only available if the Central Admin Server Option (CASO) is installed. Deletes the media server pool with the specified name. Returns a 1 if the command succeeds or a -1 if the command fails.

Note Use only one of the required switches for this command.






Co

mm

an
L
ine

-ipool IDs or -nm:pool names

Required. Specifies the IDs or the names of the media server pool to be deleted.

-o124 Rename a media server pool or set a new media pool description

This operation is only available if the Central Admin Server Option (CASO) is installed. Renames the specified media server pool or specifies a new media pool description. Returns a 1 if the command succeeds or a -1 if the command fails.

Note Use only one of the required switches for this command.

-ipool ID or -onm:old pool name

Required. Specifies the ID of the media server pool or the name of the media server pool to be renamed.

-nm:new pool name

Specifies the new name of the media server pool.

-pd:pool description

Specifies a description of the media server pool.

-o125 Get media server pools

This operation is only available if the Central Admin Server Option (CASO) is installed. Displays the media server pools. Returns a 1 if the command succeeds or a -1 if the command fails.

-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 -sn:server name

Instructs Backup Exec to only display the media server pools associated with the media server ID or media server name specified.




55

d


-o126 Add a media server to a media server pool

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

-pi:pool ID or -pn:pool name

Required. Specifies the ID of the media server pool or the name of the media server pool.


Specifies the media server IDs or names to add to the media server pool.

-o127 Remove a media server from a media server pool

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

-pi:pool ID or -pn:pool name



Specifies the media server IDs or names to remove from the media server pool.

-o128 Get media servers in a media server pool

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

-ipool ID or -pn:pool name


-i Instructs Backup Exec to display the media server ID.

-j Instructs Backup Exec to display the media server name.






Co

mm

an
L
ine

-o130 Move media Moves the specified media. Returns a 1 if the command succeeds or a -1 if the command fails.

-imedia ID Required. Specifies the ID of the media to be moved.

-ms:media set ID

Required. Specifies the media set ID to which you want to move the media.

-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 set that contains the media labels to be listed.

-o133 Create media vault

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

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

-vd:vault description

Specifies a description for the media vault.

-o134 Delete media vault

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




57

d


-ivault ID or -vn: vault name

Required. Specifies the ID of the media vault or the name of the media vault to be deleted.

-o135 Create robotic library partitions

Creates a partition consisting of one or more slots on the specified robotic library. Returns a 1 if the command succeeds or a -1 if the command fails.


Required. Specifies the ID or the name of the robotic library on which the partitions will be created.

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

Displays the managed media vaults. Returns 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 media vault

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

-imedia ID Required. Specifies the ID of the media to be added to the media vault.

-mv:media vault ID

Required. Specifies the ID of the media vault that the media will be added to.

-o140 Get number of media servers

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

-i Displays the media server IDs for all media servers.






Co

mm

an
L
ine

-j Displays the names of all managed media servers.




59

d


Backup Exec Services CommandsSeveral command line switches allow you to monitor and manage the Backup Exec services. These commands include:

Backup Exec service switches



-o107 Set wizards as run

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

-o500 Is Backup Exec server available

Checks if the Backup Exec server is 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 system services running

Checks if the Backup Exec system services are running. Returns 1 if the Backup Exec 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 Exec system services

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

-o503 Stop Backup Exec system services

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

-o504 Dump Backup Exec system services status

Copies to the console each Backup Exec system service name and status. Returns a 1 if the command succeeds or a -1 if the command fails.

-o505 Dump Backup Exec server properties

Outputs properties for a specified Backup Exec server. Returns a 1 if the command succeeds or a -1 if the command fails.



Co

mm

an
L
ine

Logon Account SwitchesThe following switch and subswitches enable you to create and modify logon accounts used for accessing specific systems:

Logon Account switches



-o210 Create logon account

Creates a logon account for accessing specific systems being backed up or restored. This operation returns a logon account ID and a 1 if the command succeeds or a -1 if the command fails.

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

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

-ddescription Provides a description for this logon account.

-pa:account type

Specifies if the logon account is restricted or common.

-dl: Use as default login account.

-o211 Dump logon accounts

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

Deletes the specified logon account. Returns 1 if the command is successful or -1 if it failed.

-ilogon account GUID

Required. Specifies the GUID of the logon account to be deleted.

-o213 Modify logon account

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

61

d


-ilogon account ID

Required. Specifies the ID of the logon account to be deleted.

-pw:password Specifies the current password for this logon account.

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

-ddescription Specifies a description for this logon account.

-pa:account type

-dl: Specifies the login account as the default.

Logon Account switches (continued)





Co

mm

an
L
ine

Report SwitchesThe following switch and subswitches allow you to view and manage Backup Exec reports from the command line:

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





-o402 Copy report to selected file format

Copies the report to a selected file format.




63

d



-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:0 to use .rpt with save data file type (default).

-ft:1 for HTML file type.

-ft:2 for XML file type.

-ft:3 for Microsoft Excel file type.

-ft:4 for Microsoft Word file type.

-o403 Insert report Adds a report to the available file list.


-ffilename Fully qualified filename for storage location of report file.

Report switches (continued)





Co

mm

an
L
ine

Setting Default OptionsThe 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 switch, 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.

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

65

d


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_ENABLESTATS

Display progress indicators for backup jobs

Enter 1 to display the percent complete number and gauge while a backup job is processing; otherwise, enter 0. These indicators allow you to monitor the progress of the job. Backup jobs may take a little longer to complete when this option is set because the target device must be scanned to determine the amount of data to be backed up.

Note Due to the time required to scan the target device, selecting this option when backing up remote devices is not recommended.

DO_GENERAL_STARTUPINVENTORY

Inventory all drives on Backup Exec services startup

Enter 1 to inventory all of the media in the storage devices when Backup Exec services are starting; otherwise, enter 0. Depending on the number of storage devices attached to the system, this process may take a few minutes. If you are using a robotic library, all of the robotic library’s slots are inventoried.



Co

mm

an
L
ine

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_CMDEXELOC Select systems for pre- and post-job commands

Specifies whether an .EXE or batch file command should run on both local and remote systems, on local systems only, or on remote systems only. Values that can be used with this command are:

0 = The command should run on both local and remote systems.

1 = The command should run only on the local system.

2 = The command should run only on the remote systems.

DO_JOB_RUNJOBIFPRESUCCESS

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

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

DO_JOB_RUNPOSTIFJOBFAILS

Run post-job command even if the job fails.

Enter 1 to run the post-job command even if the job fails; otherwise, enter 0.

DO_JOB_RUNPOST Run post-job command if pre-job command is successful

Enter 1 to run the post-job command only if the pre-job command is successful; otherwise, enter 0.

Default option parameters (continued)


67

d


DO_JOB_CMDTIMEOUT Specify time interval for command

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

DO_JOB_FAILIFCMDFAILS Mark job as failed if either command fails

Enter 1 to have the job marked as failed if either the pre-job or post-job command fails; otherwise, enter 0.

DO_JOB_CANCELTHRESHOLD

Cancel the job if not completed within the specified time.

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

DO_JOB_DEVICEGUID

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

DO_JOB_MEDIASETGUID

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

Backup Default Options

DO_BACKUP_TYPE Select default backup method

Specifies the backup method to be 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_LASTACCCESSEDDAY





Co

mm

an
L
ine

DO_BACKUP_SINGLEBACKUPNTFS

Enable single instance backup for NTFS volumes

Enter 1 to ensure that only one 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_LASTACCCESSEDDAYS

Set last access date Note If 5 was entered as the value for DO_BACKUPT_TYPE, the DO_BACKUP_LASTACCESSEDDAYS entry must be completed.

Enter the number of days during which files that you want to include in the backup were last accessed. For example, to specify a working set backup to include all files last accessed within 30 days, type:

-do:DO_BACKUP_LASTACCESSEDDAYS -dv:30

DO_BACKUP_MEDIAOVERWRITE

Set media overwrite protection

Specify one of the following values:

0 = Overwrite

1 = Append, overwrite if no media available

2 = Append, no overwrite

DO_BACKUP_COMPRESSIONTYPE

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

0 = Hardware compression

1 = Software compression

2 = Hardware if available, otherwise software

3 = None

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



69

d


DO_BACKUP_INSERTCHECKSUMS

Calculate checksums Enter 1 if the checksums are to be calculated for each data stream written to tape, and then written in a separate stream immediately following the data stream. If 0 is entered, backup performance may be improved, but there will be no way to verify the integrity of the data on the tape.

DO_BACKUP_TRAVERSEPOINTS

Back up local mount points

Enter 1 to back up mount points that direct a file or directory to a local disk or directory path; otherwise, enter 0. Using this option allows you to back up data that is linked to local files, but stored on another device without having to actually select the data.

DO_BACKUP_HSM Back up data in remote storage

Enter 1 to back up data that has been migrated from primary storage to secondary storage; otherwise, enter 0. When using this option, the data will not be recalled to its original location; it will be backed up directly to the backup media.

This option should not be used if:

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.





Co

mm

an
L
ine

DO_BACKUP_USECHANGEJOURNAL

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

DO_BACKUP_USEOPENFILEOPTION

Use Open File Option if available

Enter 1 to use the Open File Option if available; otherwise, enter 0.

DO_BACKUP_OPENFILEMETHOD

Back up open files if Open File Option is not available

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

0 = Never

1 = With a lock

2 = Without a lock

3 = If closed within x seconds

DO_BACKUP_OPENFILESKIPSECS

Back up open file if closed within x seconds

If 3 was entered for the value for 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_EXISTINGMETHOD

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



71

d


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_JUNCMETHOD

Restore junction points method

Enter 0 if you want to restore the information for the junction points and the files and directories to which they are linked, overwriting existing junction points on your system.

Enter 1 if you want to restore files and directories backed up from junction point links while retaining the system’s current junction points.

Trial Job Default Options

DO_TRIAL_CHECKCREDENTIALS

Check logon credentials for trial run job

Enter 1 to verify that the logon account is correct for the volumes being backed up; otherwise, enter 0.

DO_TRIAL_CHECKCAPACITY

Check media capacity for trial run job

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.

DO_TRIAL_CHECKMEDIA Check media for trial run job

Enter 1 to test whether the media is online and overwritable for a trial run job; otherwise, enter 0.

DO_TRIAL_DETERMINESIZEMETHOD

Select method for determining trial run job size

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.





Co

mm

an
L
ine

DO_TRIAL_HOLDONFAILURE

Place job on hold if trial job fails

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

Advanced Open File Options

DO_OPENFILE_METHOD Enter one of the following values:

0 = None

2 = Use ServerFree Option

DO_OPEN_FILE_CONFIGURATION=0-4

Specify the open file technology to back up open files

Enter a number from 0 through 4 to specify the open file technology to back up open files. Selections include:

0 = Do not use the open file technology

1 = Automatically select open file technology

2 = Use Microsoft Volume Shadow Copy Service

3 = Use VERITAS Volume Snapshot Provider

4= Use VERITAS Storage Foundation for Windows FlashSnap Option

DO_SNAPSHOT_PROVIDER=0-3

Specify the snapshot provider for the selected volume

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

0 = Automatic - Allows VSS to select the snapshot provider

1 = System - Use Microsoft software shadow copy provider

2 = Software - Use VERITAS Storage Foundation for Windows

3 = Use technology provided by hardware manufacturer



73

d


DO_USE_SINGLE_VOLUME_SNAPSHOT=0 or 1

Process logical volumes for backup one at a time

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

DO_SELECTIONLIST_CREATE

Specify separate selection lists for resources or computers

Enter a number from 0 through 2 to specify separate selection lists for resources or computers. Selections include:

0 = Single backup selection list for all selections

1 = Separate backup selection list for each computer

2 = Separate backup selection list for each resource

Job Log Default Options

DO_LOG_SUMMARYLEVEL Select summary level for job log

Enter one of the following values for 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.

SQL Default Options

DO_SQL_BACKUPMETHOD Select the SQL backup method

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

0 = full

1 = log

2 = log no truncate

3 = differential





Co

mm

an
L
ine

DO_SQL_CHECBEFOREBACKUP

Consistency check before backup

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

0 = none

1 = full

2 = full with indexes

3 = physical

DO_SQL_CONTINUEIFCHECKFAILS

Continue with backup if consistency check fails

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

DO_SQL_CHECKAFTERBACKUP

Consistency check after backup

Select a consistency check to run after a backup. Values are:

0 = none

1 = full


3 = physical

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 filegroups

Enter 1 if you want to replace a 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.

DO_SQL_CHECKAFTERRESTORE

Consistency check after restore

Select a consistency check to run after a restore. Values include:

0 = none

1 = full


3 = physical

DO_SQL_ENABLEFGSUPPORT

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



75

d


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_MBOXBACKUPMETHOD

Exchange mailbox backup method

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

0 = full

1 = copy

2 = differential

3 = incremental

DO_XCH_SINGLEINSTANCEBACKUP

Enable single instance backup for message attachments

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

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.

DO_XCH_PRIVATE Restore private mailboxes Enter 1 to restore private mailboxes; otherwise, enter 0.

DO_XCH_LOGPATH Select temporary location for log and patch files

Enter the temporary location for log and patch files.

DO_XCH_AUTOCREATEMAILBOX

Automatically recreate user accounts and mailboxes

Enter 1 to have Backup Exec automatically recreate user accounts and mailboxes if they do not already exist on the server; otherwise, enter 0.





Co

mm

an
L
ine

Lotus Domino Default Options

DO_DOMINO_BACKUPMETHOD

Lotus Domino backup method

Select the default method for backing up Lotus Domino databases. Values include:

0 = full

1 = differential

2 = incremental

DO_DOMINO_RECYCLELOGS

Mark archive logs for recycling

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

DO_DOMINO_SECONDSTOWAIT

Seconds to wait for database

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

DO_DOMINO_RECOVEROPTION

Database identification Select the default option for handling database IDs during a restore. Values include:

0 = retain original IDs

1 = assign new database ID

2 = assign new database ID and replica ID.

NetWare SMS Default Options

DO_SMS_BACKUPASEXPANDED

Back up compressed files in decompressed form

Enter 1 to have Backup Exec decompress, or expand, compressed files as they are backed up; otherwise, enter 0.

DO_SMS_RESTOREVOL RESTRICT

Restore volume restrictions

Enter 1 to restore NetWare volume restrictions; otherwise, enter 0.

Catalog Default Options

DO_CAT_USECATALOGS Use storage media-based catalogs

Enter 1 to use the catalog information from the media; otherwise, enter 0.



77

d


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 truncating catalogs

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

DO_CAT_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 removing unused catalogs

Enter the amount of days before unused catalogs are removed. The 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 folder location

Specify a path on the volume for the Backup-to-Disk folder.

DO_MEDIA_OVERWRITELEVEL

Set media overwrite protection level

Enter one of the following values:

1 = None

2 = None with prompt

3 = Partial

4 = Partial with prompt

5 = Full





Co

mm

an
L
ine

DO_MEDIA_OVERWRITEOPTIONS

Set the media overwrite options

Enter one of the following values:

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

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

Intelligent Disaster Recovery Default Options

DO_DISASTER_DATAPATH Disaster recovery data path

Specify a path where a copy of the DR files for the protected computers will be stored.

DO_DISASTER_ALTERNATEPATH

Alternate disaster recovery data path

Specify an alternate data path where a second copy of the DR files can be stored.

Database Maintenance Default Options

DO_DB_GROOM Remove old data from the Backup Exec database

Enter 1 if you want Backup Exec to automatically delete old data from its database, using specified criteria. Otherwise, enter 0.

DO_DB_JOBHISTORYDAYS Number of days to keep job history data

Enter the number of days for job history data to remain on the Backup Exec database.

DO_DB_ALERTHISTORYDAYS

Number of days to keep alert history data

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

DO_DB_JOBLOGDAYS Number of days to keep job logs

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

DO_DB_REPORTDAYS Number of days to keep report data

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

DO_DB_CONSISTENCY Perform database consistency check

Enter 1 if you want to perform a database consistency check; otherwise, enter 0.



79

d


DO_DB_COMPACT Compact the Backup Exec database

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

DO_DB_DUMP Dump contents of Backup Exec database

Enter 1 if you want to dump the contents of the Backup Exec database to the Backup Exec data directory so that it can be backed up. Otherwise, enter 0.




Using Job Script Files

Co

mm

an
L
ine

Using Job Script FilesA 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

◆ Test run jobs - testrunscript.txt

◆ Discovery resource jobs - discoveryscript.txt

◆ Duplicate backup jobs - djscript.txt

Creating a Backup Job Script FileUse 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]

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:

81

d


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



Co

mm

an
L
ine

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

[Backup Options]

BK_SET_NAME=backup set name Type the name of the backup set to be used by the job.

83

d


BK_METHOD=# Enter a number from 0 through 9 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

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

IMAGE_BACKUP=0 or 2 Enter a number from 0 through 2 that corresponds to the image backup method. Methods are:

0 = Do not use image backup

1 = Use image backup, but does not include ServerFree Option by default

2 = Use the ServerFree Option

DEVICE_NAME=device name Type the name of the device to be used for the backup.

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.

Possible backup job script file entries (continued)




Co

mm

an
L
ine

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

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

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.



85

d


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.





Co

mm

an
L
ine

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 1

Enter 1 to perform a consistency check 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_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



87

d


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

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

1 = Recycle logs

0 = Do not recycle logs

NW_BK_MIGRATED=0 or 1 Enter 1 to back up migrated NetWare SMS files; otherwise, enter 0.

NW_BK_DECOMPRESS_FILES=0 or 1

If you are backing up NetWare shares or volumes, include this entry in the Backup Job Script File. If you want to back up compressed files in decompressed form, enter 1 as the value; otherwise, enter 0.

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.





Co

mm

an
L
ine

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)

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



89

d


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.

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





Co

mm

an
L
ine

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 1

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

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



91

d


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.





Co

mm

an
L
ine

[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_PRE_SUCCESS=0 or 1

Enter 1 to execute the post-job command only if the pre-job command is successful; otherwise, enter 0.

COMMAND_RUN_JOB_IF_PRE_SUCCESS=0 or 1

Enter 1 to execute the job only if the pre-job command is successful; otherwise, enter 0.

COMMAND_RUN_POST_IF_JOB_FAILS=0 or 1

Enter 1 to execute the post-job command even if the job fails; otherwise, enter 0.

COMMAND_FAIL_JOB_IF_FAILS=0 or 1

Enter 1 to allow the pre- and post-job commands to be successful only if completed with a return code of zero. Otherwise, enter 0.

An return code of zero returned to the operating system by the pre- or post-job command is interpreted by Backup Exec to mean the job completed successfully. A non-zero return code is interpreted by Backup Exec to mean the job ended with an error.

After checking the return codes, Backup Exec continues processing according to selections you made for running the pre- and post-job commands.

If you enter 0, the success of the pre- and post-job commands is not determined based on the return code.



93

d


COMMAND_AUTO_CANCEL_TIME=# Enter the number of minutes Backup Exec should wait before canceling 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.





Co

mm

an
L
ine

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.


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

Enter a value of 1 to back up mount points, which direct a file or directory to a local disk or directory path. Using this command allows you to back up data that is linked to local files, but is stored on another device without having to actually select the device.



95

d


BACKUP_REMOTE_STORAGE_HSM=0 or 1

Enter a value of 1 to back up data that has been migrated from primary storage to secondary storage. The data will not be recalled to its original location; it will be backed up directly to the backup media.

This command should not be used if:

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]

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





Co

mm

an
L
ine

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




97

d


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


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 to 1, the job will be created but not scheduled.

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.





Co

mm

an
L
ine

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

PATHx=string Specify which files or directories get backed up. For example, PATH1=\\Myserver1\Myshare1\Mydir1\*.*

or

PATH2=\\Myserver2\Myshare2\Mydir2\*.*

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.



99

d


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.

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 name

Specifies the name of the Exchange 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 storage group name

Specifies the name of the Exchange 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.”





Co

mm

an
L
ine

EXCH2DB?=Exchange 2000 Server database name

Specifies the name of the Exchange 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


EXCH2SG2=Second Storage Group

EXHC2DB2=Mailboxes



EXHC2DB3=Users

SQLx=SQL Server name Change x to a unique number and specify the name of the SQL Server to back up.



101

d


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 name

Specifies the name of the SQL Server 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 instance name

Specifies the named instance on the 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





Co

mm

an
L
ine

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


LNDRIVE2=E

ORCLSRV?=SERVER_NAME Specifies the name of the Oracle server that contains this selection.

Change ? to a number that corresponds to the number of the selection. The selections must be in a sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. See the example name in “ORCLSID?=System identifier for database.”



103

d


ORCLSID?=System identifier for database

Specifies the SID (System Identifier) for the Oracle database to back up.

Change ? to the same number used to identify the selection for the Oracle server.

In the following example, SERVER_NAME is an Oracle server name, and it is the same server in all of the selections. To back up the databases SID1 and SID2 on the Oracle server, the entries would be:

ORCLSRV1=SERVER_NAME

ORCLSID1=SID1


ORCLSID2=SID2

SPPSx=SharePoint Portal Server name

Change x to a unique number and specify the name of the Microsoft SharePoint Portal Server to back up.





Co

mm

an
L
ine

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


Note The schedule option RUN_IMMEDIATE=1 must be included or the alias selection will be ignored.



105

d


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.


AALIASx=String Specify the share from which the backup will appear to have originated, when running an alias backup.


For example:


See also the example for APATHx=String

[Media_server]

PREFERRED_SERVER=Media server GUID

This operation is only available if the Central Admin Server Option (CASO) is installed.

Specify the preferred media server on which backup jobs run.

MEDIA_SERVER_POOL=Media server pool GUID


Specify the media server pool to use for the backup job.





Co

mm

an
L
ine

Creating a Restore Job Script FileUse 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 -o12 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


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

107

d


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.


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

RESTORE_SECURITY=0 or 1 Enter 1 to restore file level security information on NTFS partitions if it exists in the selected data; otherwise, enter 0.

Possible restore job script file entries (continued)




Co

mm

an
L
ine

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 letter

Type a destination drive, other than 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=SQL Server name

If you are redirecting SQL data, type the name of the SQL server where the data is to be restored.

SQL_REDIRECT_INSTANCE=Instance name

If you are redirecting SQL data to a named instance, specify the instance name. Otherwise, the data is restored to the default instance.

SQL_REDIRECT_DATABASE=Database name

If you are redirecting this restore to a different database on the target server, specify the target database name. If you are restoring a differential or log backup, and the associated database backup was restored to a renamed database, the new database name must be entered.

XCH_REDIRECT_SERVER=Exchange Server name

If you are redirecting Exchange data, specify the Exchange server where the data is to be restored.



109

d


XCH_REDIRECT_MAILBOX=Exchange mailbox name

If you are redirecting an Exchange mailbox, specify the name of the target mailbox. The mailbox must already exist before you can restore to it.

SP_REDIRECT_SETS_SERVER=Server/Documents

Specify whether server sets or 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=Workspace name

Type the name of the workspace to which you want to redirect the restore.

Note You must type an entry in this field, even if you are restoring the data to the original workspace. You cannot redirect the restore to a different folder in the workspace.

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

Enter 1 to restore the Terminal Services database, which contains licensing data for client licenses; otherwise, enter 0.





Co

mm

an
L
ine

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

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

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

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.



111

d


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

Enter 1 to execute the post-job command only if the pre-job command is successful; otherwise, enter 0.

COMMAND_RUN_JOB_IF_PRE_SUCCESS=0 or 1

Enter 1 to execute the job only if the pre-job command is successful; otherwise, enter 0.

COMMAND_RUN_POST_IF_JOB_FAILS=0 or 1

Enter 1 to execute the post-job command even if the job fails; otherwise, enter 0.

COMMAND_FAIL_JOB_IF_FAILS=0 or 1

Enter 1 to allow the pre- and post-job commands to be successful only if completed with a return code of zero. Otherwise, enter 0.

An return code of zero returned to the operating system by the pre- or post-job command is interpreted by Backup Exec to mean the job completed successfully. A non-zero return code is interpreted by Backup Exec to mean the job ended with an error.

After checking the return codes, Backup Exec continues processing according to selections you made for running the pre- and post-job commands.

If you enter 0, the success of the 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 canceling a command that did not complete.





Co

mm

an
L
ine

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.

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.



113

d


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,HH:MM:SS

Enter the date and time to restore transactions for a transaction log up to and including a point in time in the transaction log. After the point in time, recovery from the transaction log is stopped.

SQL_LOGMARK_NAME=Named transaction

Enter the named transaction to 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:MM:SS

Enter the date and time after which the restore operation is to search for the named transaction.

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.





Co

mm

an
L
ine

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.

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; otherwise, enter 0.

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.



115

d


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.





Co

mm

an
L
ine

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:MM:SS

Enter a date and time from which to 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.



117

d


NIC_ADDRESS For Windows 2000 and later operating systems, enter the Media Access Control (MAC) address for the network card you selected. For Windows NT 4 and earlier operating systems, enter the service entry name. An example is 00-B0-D0-D3-99-33.

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.


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.


You must also enter the NIC_SUBNET_ADDRESS.





Co

mm

an
L
ine

NIC_SUBNET_AUTOGET=0 or 1 Enter 1 to have Backup Exec use any available network adapter; otherwise, enter 0.

[Selections]

JOBHISTORY_GUID Required. Specifies the backup job that has already run To obtain the Job History GUID, first use -o12 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_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:00.


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.



119

d


SCHED_DAYSOFMONTH=x Enter the days of the month you want the job to run in a comma delimited string. For example, to run the job on the first and 15th of the month, type:


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.



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








Co

mm

an
L
ine



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.



121

d


INTERVAL_HOURS=# If a number is specified, the job is scheduled to run every specified number of hours.


INTERVAL_DAYS=# If a number is specified, the job is scheduled to run every specified number of days.






Co

mm

an
L
ine

INTERVAL_WEEKS=# If a number is specified, the job is scheduled to run every specified number of weeks.


WEEKS=FIRST,SECOND,THIRD,FOURTH,LAST

or

WEEKS=1,2,3,4,5

The job will be scheduled for the specified week of the month. For example, if the entry appears as WEEKS=FIRST, the job will be scheduled to run the first week of the month.

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/THU/FRI/SAT

Note If the entry WEEKS is included 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.



123

d


DAYS=SUN/MON/TUES/WED/THU/FRI/SAT

If this entry is included in the Restore 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.

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.



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.





Co

mm

an
L
ine

HOLD_ON_JOB_FAILURE=

0 or 1

Enter the value of 1 to place a job on hold if it fails; otherwise, enter 0.



125

d


Creating a Catalog Job Script FileUse 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.



Co

mm

an
L
ine

Possible catalog job script file entries


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


Lowest

Low

Medium

High

Highest

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.

127

d


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

[Schedule]





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


Possible catalog job script file entries (continued)




Co

mm

an
L
ine

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.









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



129

d




RUN_IMMEDIATE=0 or 1 Enter 1 to run the catalog job immediately; 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. 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.





Co

mm

an
L
ine

Creating a Discovery Job Script FileUse 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.

131

d


Possible discovery job script file entries


[General]

JOB_TYPE=Job type This entry must be completed with a value of Discovery.



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.




[Discovery_Options]

DISCOVER_ADMINISTRATIVE_SHARES=0 or 1

Enter 1 to have Backup Exec search for new administrative network shares or volumes; otherwise, enter 0.



Co

mm

an
L
ine

DISCOVER_USER_SHARES=0 or 1 Enter 1 to have Backup Exec search for new user-defined shares; otherwise, enter 0.

DISCOVER_SQL_DATABASES=0 or 1 Enter 1 to have Backup Exec search for new SQL databases; otherwise, enter 0.

DISCOVER_EXCHANGE_DATABASES=0 or 1

Enter 1 to have Backup Exec search for new Exchange databases; otherwise, enter 0.

Backup Exec searches for Information Store, Exchange Directory, or Storage Groups; it does not discover individual databases under storage groups.

DISCOVER_DOMINO_DATABASES=0 or 1

Enter 1 to have Backup Exec search for new Lotus Domino databases; otherwise, enter 0.

DISCOVER_SYSTEMSTATE=0 or 1 Enter 1 to have Backup Exec search for new System State resources; otherwise, enter 0.

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.

Possible discovery job script file entries (continued)


133

d


[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-0101010101}

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]









Co

mm

an
L
ine













135

d









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 to 1, the job will be created but not scheduled







Co

mm

an
L
ine

Creating a Duplicate Backup Job Script FileUse 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.

137

d


Possible duplicate job script file entries


[General]

JOB_TYPE=Job type This entry must be completed with a value of Setcopy.



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=Source device guid

Enter the GUID of the device used as the destination device for the original backup job. Use operation -o63 to display managed drives.





Co

mm

an
L
ine


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

Enter 1 to have Backup Exec automatically eject the media in the drive when the operation completes.


Possible duplicate job script file entries (continued)


139

d




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]

JOBHISTORY_GUID Specifies the backup job that has already run to obtain the Job History GUID, first use -o12 and /or -o506 to obtain the Job Instance GUID. Then use the Job Instance GUID with -o21 to obtain the Job History GUID.

[Schedule]








Co

mm

an
L
ine











141

d


Co

mm

an
L
ine





143

d


Creating a Test Run Job Script FileUse 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..



Co

mm

an
L
ine

Possible test run job script file entries


[General]

JOB_TYPE=Job type This entry must be completed with a value of TestRun.



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.

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.



[TestRun_Options]

JOBINSTANCE_GUID=0 or 1 Enter 1 as the value if you want Backup Exec to overwrite a duplicate job if one exists; otherwise, enter 0.

145

d


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 1

Enter 1 to have Backup Exec automatically eject the media in the drive when the operation completes.




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.

Possible test run job script file entries (continued)




Co

mm

an
L
ine

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

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]





147

d


Co

mm

an
L
ine














149

d

Using Scripts and Selection Lists

Saving and Launching the Job Script FileAfter 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”

Using Scripts and Selection ListsSelection 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.







Co

mm

an
L
ine

Creating a Selection List Script FileUse 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


[Selections]

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:


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.

151

d


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.

EXCH2ROOTx=Exchange 2000 Server name

Specifies the name of the Exchange 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 101.

EXCH2SGx=Exchange 2000 Server storage group name

Specifies the name of the Exchange 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.

Values for selection list script (continued)




Co

mm

an
L
ine

EXCH2DBx=Exchange 2000 Server database name

Specifies the name of the Exchange 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.


EXCH2SG1=First Storage Group



EXHC2DB2=Mailboxes



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



153

d


SQL2DB?=SQL Server 2000 database name

Specifies the name of the SQL Server 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 instance name

Specifies the named instance on the 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

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





Co

mm

an
L
ine

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:


LNDRIVE1=D


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



155

d


ORCLSID?=System identifier for database

Specifies the SID (System Identifier) for the Oracle database you want to back up.

Change ? to the same number used to identify the selection for the Oracle server.

In the following example, SERVER_NAME is an Oracle server name, and it is the same server in all of the selections. To back up the databases SID1 and SID2 on the Oracle server, the entries would be


ORCLSID1=SID1


ORCLSID2=SID2

SPPSx=SharePoint Portal Server name

Change x to a unique number and 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.





Co

mm

an
L
ine

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 GUID


Specify the preferred media server on which backup jobs run.

MEDIA_SERVER_POOL=Media server pool GUID


Specify the media server pool to use for the backup job.



157

d


APATHx=String Note This does not apply to the -o220 command. Also, the schedule option RUN_IMMEDIATE=1 must be included or the alias selection will be ignored.

Specify which files or directories get 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


indicates that \\MachineA\C$\*.* and all its subdirectories should be backed up and aliased as \\MachineB\D$.






Co

mm

an
L
ine

AINCLUDEx=0 or 1 Note This does not apply to the -o220 command.

Enter a value of 1 if you want 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 Note This does not apply to the -o220 command.

Enter a value of 1 if you want to include all subdirectories when running an alias backup; otherwise, enter 0.


AALIASx=String Note This does not apply to the -o220 command.

Specify the share from which the backup will appear to have originated, when running an alias backup.


For example:


See also the example for APATHx=String



159

d

Using Policy Commands

Using Policy CommandsYou 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



-o260 Create new policy

Executes a policy based on the contents of a file. Returns a 1 if the command succeeds or a -1 if the command fails.

-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 -j:policy name

Required. Specifies the ID or the name of the policy to be deleted.

-o263 Get number of policies

Displays the number of policies created on a computer. Returns a 1 if the command succeeds or a -1 if the command fails. If -tl: or -r is specified, -i or -j is required

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

-r Instructs Backup Exec to display templates rules for the specified policy ID or policy name.



Co

mm

an
L
ine

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:

-o264 Apply policy to selection lists

Applies the specified policy to selection lists. The selection list IDs or names must be separated by a comma. Returns a 1 if the command succeeds or a -1 if the command fails.


Required. Specifies the ID or name of the policy to apply to the selection list.

-siselection list IDs or -j:selection list names

Required. Specifies the selection list IDs or names to apply to the policy.

-o265 Remove policy from script

Removes the specified policy from a script. Returns a 1 if the command succeeds or a -1 if the command fails.


Required. Specifies the ID or name of the policy to remove from the script.

-siselection list IDs or -j:selection list names

Required. Specifies the selection list IDs or names to apply to the policy.

Policy Commands (continued)



161

d


◆ [General]

◆ [Templates]

◆ [Rules]

Policy file values


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

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

3 = Synthetic backup template

[Rules]

RULE_FIRST_TEMPLATEx=Name of first template

Specifies the name of the template in the [Template} section with the highest precedence.



Co

mm

an
L
ine

RULE_SECOND_TEMPLATEx=Name of second template

Specifies the name of the template in the [Template} section with the lowest precedence.

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.

Policy file values (continued)


163

d


Using Job Template Script Files Within a PolicyWhen 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 backup template - sftemplatescript.txt

If you specify a synthetic backup template, you must also specify a baseline backup template and a incremental template. If a baseline backup is not specified, the first incremental backup job will run as a baseline backup job. Additionally, the incremental backup template used in the synthetic backup policy must use a backup-to-disk folder as the destination device.

The duplicate backup sets template and the synthetic backup template can not 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.

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.

Policy file values (continued)



Using a Schedule Script with Device and Media Operations

Co

mm

an
L
ine

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"

Using a Schedule Script with Device and Media OperationsUse a text editor, such as Notepad, to create a schedule script file that contains all settings and options for a device and media operation, such as cleaning a robotic library drive, that can be scheduled as a recurring job.

Each entry included in the schedule script file must be typed in capital letters and must be immediately followed by an equal (=) sign. The value for the entry must immediately follow the equal sign and contain no spaces or quotes unless they are part of the value itself.

All possible entries for a schedule script file are described in the following table. Do not include all entries in the script file.

The following values are in the schedule script file:

Values for schedule script file


[Schedule]




165

d





SCHED_DAYSOFMONTH Enter the days of the month you want the job to run in a comma delimited string. For example, to run the job on the first and 15th of the month, type:


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.



Values for schedule script file (continued)




Co

mm

an
L
ine

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




Note The start date month, day, and year must be separated by forward slashes.





167

d


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.

INTERVAL_HOURS=# If a number is specified, the job is scheduled to run every specified number of hours.






Co

mm

an
L
ine

INTERVAL_DAYS=# If a number is specified, the job is scheduled to run every specified number of days.


INTERVAL_WEEKS=# If a number is specified, the job is scheduled to run every specified number of weeks.




169

d


WEEKS=FIRST,SECOND,THIRD,FOURTH,LAST

or

WEEKS=1,2,3,4,5

The job will be scheduled for the specified week of the month. For example, if the entry appears as WEEKS=FIRST, the job will be scheduled to run the first week of the month.

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/THU/FRI/SAT

Note If the entry WEEKS is included 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.

DAYS=SUN/MON/TUES/WED/THU/FRI/SAT

If this entry is included in the Backup 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.





Co

mm

an
L
ine

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.



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.




171

d

Understanding Job Status Messages

Understanding Job Status MessagesThe 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_EXCEPTIONS = 3

The job has completed successfully with some 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.



Co

mm

an
L
ine

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 = 21

The job was canceled because it was not completed within the number of hours or minutes that were set for the Enable automatic cancellation option on the job schedule.

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.

Possible job statuses (continued)

Job Status Code Description

173

d

Index

Aadministrating jobs using command line applet 26alert switches for command line applet 32alerts

using command line applet 32alias backup, in backup job script file 21, 105, 158

BBackup Exec services

commands 60managing using command line applet 60

backup jobalias backup in script file 21, 105, 158creating using command line applet 8creating using script file 81running from command line 8script file, creating and using 81switches for command line applet 8using command line applet to back up server drive 12

backup job script filecreating 81

bemcmd command, in command line applet 4bjscript.txt 81bjtemplatescript.txt 164

Ccatalog job

creating using script file 126script file, creating and using 126

catalog job script filecreating 126

catalogscript.txt 81clone, using alias backup for a 21, 105, 158command line applet

administrating jobs 26

alert switches 32alias backup 21, 105, 158backup job switches 8bemcmd command 4defined 3error-handling rules 37job status messages 172logon account switches 61managing Backup Exec services 60managing devices 38media management switches 38online help 6report switches 63requirements 4restore job switches 31script files 81setting default options 65switches for administrating jobs 26using 4

command line switches, used with all operations 6

Ddefault options

setting using command line applet 65devices

managing using command line applet 38discovery job


discovery job script filecreating 131

discoveryscript.txt 81djscript.txt 81djtemplatescript.txt 164duplicate backup job


duplicate job

1

creating using script file 137duplicate job script file

creating 137

Eerror-handling rules

using command line applet 37Exchange Server Agent, backing up

command linefor Exchange 2000 15using for backup job 13

Jjob

script file, saving and launching 150job monitor

command line switches 26job priority

specifying using command line applet 8job status messages, descriptions 172

Llogon accounts

command line applet switches 61Lotus Domino Agent

backup job script method, using 88command line, using for backup 18

Mmedia

managing using command line applet 38mirror, using alias backup for split mirror 21, 105, 158

OOracle Agent, backing up

command line, using for backup 19

Ppolicy job


policy job script filecreating 160

policy valuesCommand Line applet 162

Rreports

using command line applet 63restore job

creating using script file 107running from command line 31script file, creating and using 107

restore job script filecreating 107

rjscript.txt 81

Sschedule script file

using with device and media operations 165values 165

selection listscreating using script file 150script file

using in command line applet 150values for 151

sftemplatescript.txt 164SharePoint Portal Server

command line, backing up from 17SQL 2000, backing up

command line 16SQL 7.0, backing up

command line 14command line, using for standby or recover 17

Ttest run job


test run script filecreating 144

testrunscript.txt 81

2 Command Line Guide