Professional Documents
Culture Documents
September 2004
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 Corporation 350 Ellis Street Mountain View, CA 94043 USA Phone 6505278000 Fax 6505272908 www.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.
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.
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.
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.cpp Leonard Janke - cast.cpp, seal.cpp Steve Reid - cast.cpp Phil Karn - des.cpp Michael Paul Johnson - diamond.cpp Andrew M. Kuchling - md2.cpp, md4.cpp Colin Plumb - md5.cpp, md5mac.cpp Seal Woods - rc6.cpp Chris Morgan - rijndael.cpp Paulo Baretto - rijndael.cpp, skipjack.cpp, square.cpp Richard De Moliner - safer.cpp Matthew 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
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
Command Line
Other Hardware
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.
Administrators Guide
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.
Command Line
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.
Specifies the name of the media server where the operation is to be performed. If a media server name is not specified, the local computer name is used by default. Directs all output to a specified logfile and to the console. You must specify the logfile name where the output is to be written.
-llogfile
Administrators Guide
Using Command Line Switches Command line switches for all operations Item -la:logfile Description Appends all output to the specified logfile and to the console. You must specify the logfile name where the output is to be written. Specifies the user name credential for logging on to a remote Backup Exec server. If a user name is not specified, the current credential is used. Specifies the password credential for logging on to a remote Backup Exec server. If a password is not specified, the current password credential is used. Specifies the type of OS the server is running. The default is Windows. To specify a NetWare server, type -tNW. 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. 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.
-nuser name
-ppassword
-w
Command Line
-o1
Runs a backup job that has been previously defined. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name or the job ID of the previously defined job that Backup Exec should run. Note If there are jobs with the same name, only one of the jobs will run. To ensure that the correct job runs, you should use the job ID instead of the job name to specify which job will run.
-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
Instructs the Command Line Applet to wait for the operation to complete before returning. Creates and runs a backup job for a specified list of files. This operation returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails.
-o2
Administrators Guide
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -jjob name Function Description
Required. Specifies the name Backup Exec will assign to this job. Specifies the name of the device Backup Exec should use for backup. When backing up a remote server, the device name will be the name of the remote server. Use this switch instead of the -d switch to indicate that this device name should be checked against the devices (and device pools) on the target server, and the job should only run if the device exists. If the device does not exist, and if the -v (verbose) switch is used, the following message appears: Device or Device Pool specified does not exist. Specifies a preferred server ID or media server pool ID for the job. Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-ddevice name
-sd:device name
Command Line
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -sfile list or -sf:file name Function Description
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:
10
Administrators Guide
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches Function Description
You can order resources within a server, but you cannot alternate selections across servers. For example, you can select C: and D: from Server A followed by selections from Server B. However, you cannot order selections as C: from Server A and then C: from Server B and then D: from both servers. For any given server, System State or shadow copy components must be ordered last. -mmedia set Specifies the name of the media set Backup Exec should target. Specifies the media protection level: 0 = Overwrite 1 = Append to media, overwrite if not available 2 = Append to media, terminate if not available -r Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec administration console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Specifies a list of items or the name of a file that contains a list of items to exclude from the backup job. List of server and logon accounts Specifies the server name and logon account GUIDs.
-w
-e or -ef:file name
-rl:
Command Line
11
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -rf: Function Description
File name of Specifies the name of the file that contains the server and logon server name and logon account GUIDs. Each accounts entry must be typed on a separate line. Back up server drive Creates and runs a backup job to back up the specified drive on the media server. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. Specifies the name that Backup Exec will assign to this job. Specifies the drive letter of the drive that Backup Exec should backup. If no drive letter is specified, the job will default to C: drive. When backing up a remote server, the device name will be the name of the remote server. Specifies a preferred server ID or media server pool ID for the job. Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-o3
-jjob name
-ddrive name
-r
Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec Administration Console, as long as that job has already been created and saved.
12
Administrators Guide
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -w Function Description
Instructs the Command Line Applet to wait for the operation to complete before returning.
-o4
Back up This operation is not for Exchange 2000. If you Exchange server are running Exchange 2000, use operation -o6. Creates and runs a backup job to back up the Microsoft Exchange Server on the media server. Returns a job instance ID. Also returns a 1 if the command succeeds or a -1 if the command fails. Note While individual mailboxes cannot be selected for backup, all mailboxes are included in a server backup. The Agent for Microsoft Exchange Server must be enabled on the Backup Exec server in order to back up the Exchange Server. -jjob name Specifies the name that Backup Exec will assign to this job. Specifies a preferred server ID or media server pool ID for the job. Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
Command Line
13
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -r Function Description
Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the Command Line Applet or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. 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.
-w
-o5
-jjob name
Specifies the name that Backup Exec will assign to this job. Specifies the log backup option.
14
Administrators Guide
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -pr:priority Function Description
Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-r
Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. 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.
-w
-o6
-jjob name
Specifies the name that Backup Exec will assign to this job. Required. Specifies the storage group to back up. Specifies a preferred server ID or media server pool ID for the job.
Command Line
15
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -pr:priority Function Description
Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-r
Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the Command Line Applet or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Creates and runs a backup job for SQL Server 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.
-w
-o8
-jjob name
Specifies the name that Backup Exec will assign to this job. Specifies the name of the database to back up.
16
Administrators Guide
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -pr:priority Function Description
Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-r
Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Places a Microsoft SQL Server database in either standby mode or in a loading state. Values are: 0 = None. 1 = Standby. Place database in standby mode. 2 = No recover. Place database in a loading state.
-w
-lo:database mode
-o9
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.
Command Line
17
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -si:server ID or -pi:pool ID -pr:priority Function Description
Specifies a preferred server ID or media server pool ID for the job. Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-r
Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Specifies the name that Backup Exec will assign to this job. Back up Lotus Notes server Creates and runs a backup job of the Lotus Notes server. Returns a 1 if the command succeeds or a -1 if the command fails. Specifies the name that Backup Exec will assign to this job. Required. Specifies the drive letter where Lotus Notes is installed. Specifies the complete path to the transaction log file.
-w
-jjob name
-o17
-jjob name
-ddrive name
-tl:path
18
Administrators Guide
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -si:server ID or -pi:pool ID -pr:priority Function Description
Specifies a preferred server ID or media server pool ID for the job. Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-r
Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the command line or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. Creates and runs a backup job of the Oracle server. Returns a 1 if the command succeeds or -1 if the command fails. Note Only one SID can be specified per command. Use -si to indicate the SID name to back up.
-w
-o18
-jjob name
Specifies the name that Backup Exec will assign to this job. Required. Specifies the SID name to back up. Specifies a preferred server ID or media server pool ID for the job.
Command Line
19
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -pr:priority Function Description
Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-r
Replace existing Instructs Backup Exec to replace a previously job defined job with this new one. You can replace a job that was created either through the Command Line Applet or the Backup Exec Administration Console, as long as that job has already been created and saved. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning.
-w
20
Administrators Guide
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches Function Description
-o19
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.
-jjob name
Specifies the name that Backup Exec will assign to this job. Specifies the name of the media set that Backup Exec should target. Specifies the media protection level: 0 = Overwrite 1 = Append to media, overwrite if not available 2 = Append to media, terminate if not available
-mmedia set
Command Line
21
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -ddevice name Function Description
Specifies the name of the device that Backup Exec should use for the alias backup. 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.
-sd:device name
22
Administrators Guide
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -sfile list or -sf:file name Function Description
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: 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.
Command Line
23
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -aalias list Function Description
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.
Specifies a preferred server ID or media server pool ID for the job. Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-w
Specifies that the Command Line Applet should wait for the operation to complete before returning. Specifies that the a frozen image is to be backed up.
-g
24
Administrators Guide
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches Function Description
-o90
Launch job using Executes a job based on the contents of a job script file 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. Wait for job completion Instructs the Command Line Applet to wait for the operation to complete before returning. If the job is a scheduled job (not a run now job), the -w is ignored. Creates a list of resource selections to be used when creating a backup job. Required. Specifies the name of the selection list. A brief description of the selection list. Required. Specifies the selections to be contained in this selection list. Format for scripts is [MACHINE] MACHINE1=machine name|logon GUID Each path must be on a separate line. For example: PATH1=C:\test\*.*|{1950A99C-2423-451E-B9 77-225717870CEE} PATH2=C:\test2\*.* An example script is available in the selectionscript.txt file in the WINNT\UTILS\I386 directory on the Backup Exec CD. -si:server ID or -pi:pool ID Specifies a preferred server ID or media server pool ID for the job.
-w
-o220
Command Line
25
Using Command Line Switches Backup Job Commands (continued) Operation Additional Switches -pi:pool ID Function Description
-o10
Displays the number of scheduled jobs on a computer. Returns a 1 if the command succeeds or a -1 if the command fails. Instructs Backup Exec to dump the job IDs to the screen.
-i
-j
Dump job names Instructs Backup Exec to dump the job names to the screen. 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. Instructs Backup Exec to dump the job IDs to the screen.
-o11
-i
-j
Dump job names Instructs Backup Exec to dump the job names to the screen. 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. Instructs Backup Exec to dump the job IDs to the screen.
-o12
-i
26
Administrators Guide
Using Command Line Switches Job monitoring switches (continued) Operation Additional Switches -j Function Description
Dump job names Instructs Backup Exec to dump the job names to the screen. Get number of Displays the number of active utility jobs on a active utility jobs 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.
-o13
-o14
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
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.
Dump job status Copies to the console the job information and for scheduled descriptive headings for each item associated and active job with the job ID. Returns a 1 if the command succeeds or a -1 if the command fails. -ijob ID Specifies the job ID of a specific job. 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.
-o20
Command Line
Displays completed job status. Returns a 1 if the command succeeds or a -1 if the command fails. 27
Using Command Line Switches Job monitoring switches (continued) Operation Additional Switches -ijob ID or -hi:job history ID -e Function Description
Specifies the job ID or job history ID that contains the job statuses to display.
Use this switch with -ijob ID to display details for the last instance of the job. Use this switch to display a list of all job history IDs for the specified job ID. 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. Required. Use this switch to specify the job ID of a specific job. Dump job log contents Copies to the console the contents of the job log specified on the command line. Returns a 1 if the command succeeds or a -1 if the command fails. Specifies the job log name. Rename a job Renames a job. Returns a 1 if the command succeeds or a -1 if the command fails. Instructs Backup Exec to rename the job associated with the job IDs.
-li:job ID
-o30
-ijob ID
-o31
-i<job id>
-j<job name>
Current name of Instructs Backup Exec to rename the job. the job to rename. Provides the new name for the job.
Place job on hold Places the specified job on hold. Returns a 1 if the command succeeds or a -1 if the command fails.
28
Administrators Guide
Using Command Line Switches Job monitoring switches (continued) Operation Additional Switches -jjob name Function Description
Required. Specifies the name of the job to be placed on hold. Take job off hold Takes the specified job off hold. Returns a 1 if the command succeeds or a -1 if the command fails.
-o201
-jjob name
Required. Specifies the name of the job to be taken off hold. 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. 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.
-o202
-ijobID
-ds:
-o251
Displays all available backup selection lists. Returns a 1 if the command succeeds or a -1 if the command fails. Displays all available backup job templates. Returns a 1 if the command succeeds or a -1 if the command fails. Disables an error-handling rule.
-o263
-o312
Specifies the ID of the rule being disabled. 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.
-o506
Command Line
-jjob name
Specifies the name of the job that contains information that you want to be dumped. 29
Using Command Line Switches Job monitoring switches (continued) Operation Additional Switches -ddisplay type Function Description
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
Displays the contents of the specified selection list. If a selection list is not specified, all selection lists will be dumped. Specifies the name of the selection list.
Displays the contents of the specified policy. If a policy is not specified, all policies will be dumped. Required. Specifies the GUID for the policy. To find the ID for a policy, use operation -o263 to display the policies d on a computer.
-ipolicy ID
30
Administrators Guide
-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. 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.
-pr:priority
-w
Instructs the Command Line Applet to wait for the operation to complete before returning.
-o90
Launch job using Executes a job based on the contents of a job script file 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.
Command Line
31
Using Command Line Switches Restore job commands (continued) Operation Additional Switches -w Function Description
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.
-o40
Displays the number of alerts on the computer. Returns a 1 if the command succeeds or a -1 if the command fails. Displays all the alert IDs on the screen. Displays titles of alerts. Displays alerts generated from the specified server only. Displays history alerts. Displays the name of the server that generated the alert. Displays the date the alert was generated.
-h -s
-d
32
Administrators Guide
Using Command Line Switches Managing alerts switches (continued) Operation Additional Switches Function Description
-o42
Dumps the alert title and message to the console. Returns a 1 if the command succeeds or a -1 if the command fails. Displays the alert ID of the text.
Instructs the Command Line Applet to prompt for a response to the alert.
-o43
Get number of Displays the number of non-critical information only (information only alerts) on the computer. alerts Also returns a 1 if the command succeeds or a -1 if the command fails. -i Dump all alert IDs Show titles If -i is used with this command, all alert IDs will be displayed on the screen. Displays alert titles. Displays alerts generated from the specified server only. Displays the name of the server that generated the alert. Displays the date the alert was generated. Get number of user intervention (critical) alerts -i Dump all alert IDs Show titles Displays the number of user intervention alerts on the computer. Also returns a 1 if the command succeeds or a -1 if the command fails. If -i is used with this command, all alert IDs will be displayed on the screen. Displays alert titles. Displays alerts generated from the specified server only.
-s
-d -o44
Command Line
-s
33
Using Command Line Switches Managing alerts switches (continued) Operation Additional Switches -d -o45 Function Description
Displays the date the alert was generated. Clear all Clears all current information only alerts. information only Returns a 1 if the command succeeds or a -1 if alerts the command fails. 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.
-o46
-ialert ID
Required. Specifies the alert ID that you want to respond to. Required. Specifies a response. Responses are OK, YES, NO, CANCEL, RETRY,or IGNORE or instructs the Command Line Applet to prompt for a response. Get all warning alerts Displays the number of warning alerts on the computer. Also returns a 1 if the command succeeds or a -1 if the command fails. If -i is used with this command, all alert IDs display on the screen. Displays alert titles. Displays alerts generated from the specified server only. Displays the name of the server that generated the alert. Displays the date the alert was generated. 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.
-rresponse or -w
-o47
-i
-s
-d -o48
-i
34
Administrators Guide
Using Command Line Switches Managing alerts switches (continued) Operation Additional Switches -tl: -jserver name Function Description
Show titles
Displays alert titles. Displays alerts generated from the specified server only. Displays the name of the server that generated the alert. Displays the date the alert was generated.
-s
Displays alert categories. Returns a 1 if the command succeeds or a -1 if the command fails. If -i is used with this command, all alert IDs will be displayed on the screen. Displays alert names on screen.
-i
Dump all alert IDs Display alert category name Display event category Dump alert configuration
-j
-ac:
-o50
Displays the configuration for alerts on screen. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies an alert ID to display configuration information for.
-ialert category ID -o51 Set alert configuration -ialert category ID -e or -d Enable alert or disable alert
Required. Specifies an alert ID to display configuration information for. Enables or disables the specified alert for reporting by Backup Exec. Some alerts types, such as error and attention required, are always enabled.
Command Line
35
Using Command Line Switches Managing alerts switches (continued) Operation Additional Switches -no: or -nn: Function Description
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 Sends the job log or disables the inclusion of of job log or the job log to the alert recipient that is disable inclusion configured for notification. of job log Enable sending of SNMP notifications or disable sending of SNMP notifications Enable event logging or disable event logging Set time for automatic clearing of alert or disable automatic alert clearing Set the automatic response for an alert. Dump notification recipients Enables or disables the sending of alert notifications through SNMP.
-s or -ns:
-rl: or -nr:
-ac:timeout or -na:
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
Sets the automatic response for an alert. The possible responses are Yes, No, and Cancel.
-o150
Displays the recipients that have defined notification methods. Returns a 1 if the command succeeds or a -1 if the command fails.
36
Administrators Guide
-o310
Display error-handling rules Enable error handling rule -irule ID -mr:maximum retries
-o311
Required. ID of the rule that is to be enabled. Indicates that the job should be retried and the number of times the job is to be retried. The range for maximum retries is 1 to 99. Indicates that the job should be retried and the number of minutes to wait before the job is retried. The range for the retry interval is 1 to 1,440. Pause job on error Indicates the job is to be paused until the user has taken action to clear the error. If this switch is absent, the job will be canceled until its next scheduled run. Indicates the job is to be canceled if an error occurs.
-ri:retry interval
-pj:
-cj:
Cancel job on error Specifies miscellaneous information for the error-handling rule.
-no:notes
Command Line
-o312
37
Using Command Line Switches Error-Handling Rules switches (continued) Operation Additional Switches -irule ID Function Description
-o60
Pause drive
Pauses the specified drive. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name or the ID of the drive.
Resumes a previously paused drive. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name or the ID of the drive.
Returns a 1 if the drive is paused, a 0 if the drive is not paused, and a -1 if the command fails. Required. Specifies the name or the ID of the drive.
Displays the number of managed drives. Returns a 1 if the command succeeds or a -1 if the command fails.
38
Administrators Guide
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -i -j -o64 Get number of drives available Function Description
Displays drive IDs for all drives. Displays names for all drives. Displays the number of managed drives that are online and not paused. Drives that are being used are considered online and are included in the number displayed. Returns a 1 if the command succeeds or a -1 if the command fails. Displays drive IDs for all drives. Displays names for all drives. Get number of drives paused Displays the number of managed drives that are paused. Returns a 1 if the command succeeds or a -1 if the command fails. Displays drive IDs for all drives. Displays names for all drives. Get number of drives offline Displays the number of managed drives that are offline. Returns a 1 if the command succeeds or a -1 if the command fails. Displays drive IDs for all drives. Displays names for all drives. Dump drive properties Displays general properties of a drive. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name or the ID of the drive. Query devices
-i -j -o65
-i -j -o66
-i -j -o67
Command Line
39
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches Function Description
-o69
Displays the number of media sets. Returns a 1 if the command succeeds or a -1 if the command fails. Displays the media set IDs for all media sets. Displays the names of all media sets.
-i -j -o70
Dump media set Displays properties of the media set. Returns properties a 1 if the command succeeds or a -1 if the command fails. -imedia set ID Required. Specifies the media set ID. Dump media label properties Displays properties of the media label. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the media label ID. Import drive slots Imports a list of backup tapes. Returns job ID and 1 if the command succeeds, or a -1 if the command fails. Required. Specifies the robotic library to target for this operation. Instructs Backup Exec to auto inventory all slots. Specifies the slots in the robotic library to target. This list should be comma delimited. If no slots are specified, then all will be targeted by default. Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. For more information about schedule file scripts, see Using a Schedule Script with Device and Media Operations on page 165.
-o71
-sslot numbers
-fschedule file
40
Administrators Guide
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -pr:priority Function Description
Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-w
Instructs the Command Line Applet to wait for the operation to complete before returning. Exports a list of backup tapes. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. Required. Specifies the robotic library to target for this operation. Specifies the slots in the robotic library to target. This list should be comma delimited. If no slots are specified, then all will be targeted by default. Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. For more information about schedule file scripts, see Using a Schedule Script with Device and Media Operations on page 165.
-o81
-fschedule file
Command Line
41
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -pr:priority Function Description
Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-w
Instructs the Command Line Applet to wait for the operation to complete before returning. Specifies the export of expired media only.
Designates a slot to be a cleaning slot. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the robotic library 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
Designates a slot to be a non-cleaning slot. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the robotic library 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.
42
Administrators Guide
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches Function Description
-o84
Displays the number of managed robots. Returns a 1 if the command succeeds or a -1 if the command fails. Displays the robot IDs.
Displays property information for the specified robotic library. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID or the name of the robotic library to display properties for. If both -i and -d are provided, the -d parameter is used.
-o86
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. Create cleaning job Creates and runs a cleaning job on the specified drive. Returns the job ID and a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name of the robotic library drive you want to target.
-o100
-ddrive name
Command Line
43
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -fschedule file Function Description
Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. For more information about schedule file scripts, see Using a Schedule Script with Device and Media Operations on page 165. 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.
-pr:priority
-w
Instructs the Command Line Applet to wait for the operation to complete before returning.
-o101
Create media set Creates a media set with the specified name. Returns a 1 if the command succeeds or a -1 if the command fails. -mmedia set name -op:overwrite protection period Required. Specifies the name of the new media set. 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.
44
Administrators Guide
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches Function Description
-o102
Creates a drive pool with the specified name and assigns the given drives to it. Returns a 1 if the command succeeds, a 0 if one or more specified drives cannot be found, or a -1 if the command fails.
-dp:drive pool
Required. Specifies the name of the new drive pool. Specifies a list of drives to add to the drive pool. The list should be comma delimited. Create inventory Creates an inventory job on a specified robotic job for robotic library. library Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. When using this command, you must also use the -arobotic library switch, which inventories all slots and drives on a specified robotic library.
-ddrives
-o103
Required. Specifies the robotic library to target for this operation. Specifies a name for the job. Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. For more information about schedule file scripts, see Using a Schedule Script with Device and Media Operations on page 165. 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.
-sslot numbers
Command Line
45
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -pr:priority Function Description
Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-w
Instructs the Command Line Applet to wait for the operation to complete before returning. Locks the specified robotic library door. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. When using this command, you must also use the -arobotic library switch. Required. Specifies the robotic library to target for this operation. Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. For more information about schedule file scripts, see Using a Schedule Script with Device and Media Operations on page 165. 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.
-o104
-pr:priority
46
Administrators Guide
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -w Function Description
Instructs the Command Line Applet to wait for the operation to complete before returning. Unlocks the specified robotic library door. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. When using this command, you must also use the -arobotic library switch. Required. Specifies the robotic library to target for this operation. Schedule the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. For more information about schedule file scripts, see Using a Schedule Script with Device and Media Operations on page 165. 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.
-o105
-pr:priority
-w
Instructs the Command Line Applet to wait for the operation to complete before returning.
Command Line
47
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches Function Description
-o106
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. 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
-ol:overwrite level
-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. Required. Specifies the erase type. Erase types are: 1 = quick erase 3 = long erase
-eerase type
-jjob name
48
Administrators Guide
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -fschedule file Function Description
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. Specifies the slot numbers containing the media to be erased. If this switch is used, -d will represent the robotic library name. 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.
-sslot numbers
-pr:priority
-w
Instructs the Command Line Applet to wait for the operation to complete before returning.
-o112
Retension media Retensions the tape in the specified drive. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. -ddrive name Required. Specifies the drive name. If -s is used, -ddrive name will be the name of the robotic library. Specifies the slot numbers containing the media to be retensioned.
-sslot numbers
Command Line
49
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -pr:priority Function Description
Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-w
Instructs the Command Line Applet to wait for the operation to complete before returning. Labels the tape in the specified drive. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails.
-o113
Label media
-ddrive name
Required. Specifies the drive name. If -s is used, -ddrive name will be the name of the robotic library. Required. Specifies the media name. Specifies the slot numbers containing the media to be labeled. Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-pr:priority
50
Administrators Guide
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -w Function Description
Instructs the Command Line Applet to wait for the operation to complete before returning. Formats the tape in the specified drive. Returns the job ID and a 1 if the command succeeds, or a -1 if the command fails. When using this command, you must also use the -ddrive name command.
-o114
Format media
-ddrive name
Required. Specifies the drive name. If -s is used, -ddrive name will be the name of the robotic library. Specifies the slot numbers containing the media to be formatted. Specifies the priority for the job. Priority options include: Low Lowest Medium High Highest If this switch is absent, the priority is set to medium.
-sslot numbers
-pr:priority
-w
Instructs the Command Line Applet to wait for the operation to complete before returning.
-o115
Eject media from Ejects the tape in the specified drive. 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.
Command Line
-ddrive name
51
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -pr:priority Function Description
Specifies the priority for the job. Priority options include: Highest High Medium Low Lowest If this switch is absent, the priority will be set as Medium.
-w
Instructs the Command Line Applet to wait for the operation to complete before returning.
-o116
Create a backup Creates a Backup Folder. Backup Exec allows folder you to create virtual devices called Backup Folders on the hard disk. These Backup Folders are used as destination devices for backup jobs. When you direct a backup job to a Backup Folder, the data is saved on disk as backup files. Returns a 1 if the command succeeds or a -1 if the command fails. -r Makes the backup folder being created into a removable backup-to-disk folder. Otherwise, the folder will be a fixed (non-removable) folder. Specifies the folder name. When you create a Backup Folder, Backup Exec initially assigns a name and path to it. You can rename a Backup Folder as long as you use a unique name. Renaming a Backup Folder changes the way it appears in Backup Exec, but does not change the location of the Backup Folder on the disk.
-ffolder name
52
Administrators Guide
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -ddirectory Function Description
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
Creates an inventory job on a specified stand-alone drive. Displays the job instance ID. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the drive name. Specifies a name for the job. Schedules the job. If -fschedule file represents a scheduled job (not a run now job), then the -w option is ignored. 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.
-pr:priority
Command Line
53
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -x Function Description
Uses media auxiliary memory for inventory, which allows the media to be identified without having to be mounted. Wait for job completion Instructs the Command Line Applet to prompt for a response.
-w
-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. Delete drive pool Deletes the specified drive pool. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name of the drive pool. Create media server pool This operation is only available if the Central Admin Server Option (CASO) is installed. Creates a media server pool with the specified name. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name of the media server pool. Specifies a description for the media server pool. Specifies the media server IDs or names to add to the media server pool. Delete media server pool This operation is only available if the Central Admin Server Option (CASO) is installed. Deletes the media server pool with the specified name. Returns a 1 if the command succeeds or a -1 if the command fails. Note Use only one of the required switches for this command.
-o121
-dp:drive pool
-o122
-nm:pool name
54
Administrators Guide
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -ipool IDs or -nm:pool names Function Description
Required. Specifies the IDs or the names of the media server pool to be deleted.
-o124
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 -nm:new pool name -pd:pool description -o125
Required. Specifies the ID of the media server pool or the name of the media server pool to be renamed. Specifies the new name of the media server pool. Specifies a description of the media server pool. Get media server This operation is only available if the Central pools Admin Server Option (CASO) is installed. Displays the media server pools. Returns a 1 if the command succeeds or a -1 if the command fails.
-i
Instructs Backup Exec to display the media server pool ID. Instructs Backup Exec to display the media server pool name. Instructs Backup Exec to only display the media server pools associated with the media server ID or media server name specified.
-j
Command Line
55
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches Function Description
-o126
Add a media This operation is only available if the Central server to a media Admin Server Option (CASO) is installed. server pool 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 -si:server IDs or -sn:server names 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. Remove a media server from a media server pool This operation is only available if the Central Admin Server Option (CASO) is installed. Removes a media server from the specified media server pool. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID of the media server pool or the name of the media server pool. Specifies the media server IDs or names to remove from the media server pool. Get media servers in a media server pool This operation is only available if the Central Admin Server Option (CASO) is installed. Displays the media servers in the media server pools. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID of the media server pool or the name of the media server pool. Instructs Backup Exec to display the media server ID. Instructs Backup Exec to display the media server name.
-o127
-j
56
Administrators Guide
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches Function Description
-o130
Move media
Moves the specified media. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID of the media to be moved. Required. Specifies the media set ID to which you want to move the media.
-imedia ID
Renames the specified media. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name of the media to be renamed. Required. Specifies the new name of the media.
-imedia ID
-mn:media name
-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. 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. Required. Specifies the name of the media vault. Specifies a description for the media vault.
-o133
-vn:vault name
Deletes the specified media vault. Returns a 1 if the command succeeds or a -1 if the command fails.
Command Line
57
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -ivault ID or -vn: vault name -o135 Function Description
Required. Specifies the ID of the media vault or the name of the media vault to be deleted. Create robotic Creates a partition consisting of one or more library partitions slots on the specified robotic library. Returns a 1 if the command succeeds or a -1 if the command fails.
Required. Specifies the ID or the name of the robotic library on which the partitions will be created. Specifies the slots in the robotic library to include in the partition. This list should be comma delimited. If no slots are specified, then all will be targeted by default. Get list of media Displays the managed media vaults. Returns vaults a 1 if the command succeeds or a -1 if the command fails.
-sslot numbers
-o136
-i -j
Displays the IDs for all media vaults. Displays the names of all managed media vaults. Add media to a media vault Adds media to the specified media vault. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID of the media to be added to the media vault. Required. Specifies the ID of the media vault that the media will be added to. Get number of media servers Displays the managed media servers. Returns a 1 if the command succeeds or a -1 if the command fails. Displays the media server IDs for all media servers.
-o137
-imedia ID
-i
58
Administrators Guide
Using Command Line Switches Device and media management switches (continued) Operation Additional Switches -j Function Description
Command Line
59
-o107
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. 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. Required. Specifies the name of the media server.
-o500
-cserver_name
-o501
Are Backup Exec Checks if the Backup Exec system services are system services running. Returns 1 if the Backup Exec services are running on the computer. If the system running services are not running, a 0 is displayed. If the command fails, a -1 is displayed. Start Backup Exec system services Starts all Backup Exec services on the specified computer. Returns a 1 if all services start, a 0 if any services fail, or a -1 if the command fails. Stops all Backup Exec services on the specified computer. Returns 1 if all services stop, a 0 if any services fail, or a -1 if the command fails. Copies to the console each Backup Exec system service name and status. Returns a 1 if the command succeeds or a -1 if the command fails. Outputs properties for a specified Backup Exec server. Returns a 1 if the command succeeds or a -1 if the command fails.
-o502
-o503
-o504
-o505
60
Administrators Guide
-o210
Creates a logon account for accessing specific systems being backed up or restored. This operation returns a logon account ID and a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the user name for this logon account. Specifies the password for this logon account. Provides a description for this logon account. Specifies if the logon account is restricted or common. Use as default login account.
-nl:user name
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. Deletes the specified logon account. Returns 1 if the command is successful or -1 if it failed. Required. Specifies the GUID of the logon account to be deleted.
-o212
-o213
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
Command Line
Using Command Line Switches Logon Account switches (continued) Operation Additional Switches -ilogon account ID -pw:password Function Description
Required. Specifies the ID of the logon account to be deleted. Specifies the current password for this logon account. Specifies the new password for this logon account. Specifies a description for this logon account.
-pl:password
62
Administrators Guide
Report Switches
The following switch and subswitches allow you to view and manage Backup Exec reports from the command line:
Report switches Operation Additional Switches Function Description
Display report
Displays the report on the screen. Lists all available report IDs. Specifies the report ID to view. Lists available parameter names. Specifies parameters and values to use in the form @param1name=value, =value..., @param2name=value, =value....
Print report
Prints the report on the default printer. Lists all available report IDs. Specifies the report ID to view. Lists available parameter names. Specifies parameters and values to use in the form @param1name=value, =value..., @param2name=value, =value....
-o402
Lists all available report IDs. Specifies the report ID to view. Lists available parameter names.
Command Line
63
Using Command Line Switches Report switches (continued) Operation Additional Switches -ps:paramstr Function Description
Specifies parameters and values to use in the form @param1name=value, =value..., @param2name=value, =value.... Fully qualified filename for the storage location of the output file. Not valid for -ft:1 (HTML) file types. Fully qualified directory name for storage location of output files. Only valid for -ft:1 (HTML) file types. Use: -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.
-ffilename
-ddirectory
-ft:format
-o403 -i -ffilename
Insert report
Adds a report to the available file list. Lists all available report IDs. Fully qualified filename for storage location of report file.
64
Administrators Guide
Command Line
65
The default parameters set through the -o300 switch can be overridden when creating an individual job. The following default options can be set using the -o300 switch:
Default option parameters Option Name General Default Options DO_GENERAL_ ENABLESTATS Display progress Enter 1 to display the percent indicators for backup jobs complete number and gauge while a backup job is processing; otherwise, enter 0. These indicators allow you to monitor the progress of the job. Backup jobs may take a little longer to complete when this option is set because the target device must be scanned to determine the amount of data to be backed up. Note Due to the time required to scan the target device, selecting this option when backing up remote devices is not recommended. DO_GENERAL_ STARTUPINVENTORY Inventory all drives on Backup Exec services startup Enter 1 to inventory all of the media in the storage devices when Backup Exec services are starting; otherwise, enter 0. Depending on the number of storage devices attached to the system, this process may take a few minutes. If you are using a robotic library, all of the robotic librarys slots are inventoried. Function Description
66
Administrators Guide
Using Command Line Switches Default option parameters (continued) Option Name Job Default Options DO_JOB_PRIORITY Set job priority Specifies the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Priority options include: 0 = Low 1 = Lowest 2 = Medium 3 = High 4 = Highest DO_JOB_CMDEXELOC Select systems for preand 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_RUNJOBIFPRE SUCCESS Run job only if the pre-job Enter 1 to run the job only if the pre-job command is successful. command is successful; otherwise, enter 0. If the pre-job command is not successful, the job does not run, and is marked as failed. 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. Function Description
Run post-job command if Enter 1 to run the post-job command pre-job command is only if the pre-job command is successful successful; otherwise, enter 0.
Command Line
67
Using Command Line Switches Default option parameters (continued) Option Name DO_JOB_CMDTIMEOUT Function Specify time interval for command Description 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 Enter 1 to have the job marked as command fails failed if either the pre-job or post-job command fails; otherwise, enter 0. 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. Specifies the drive pool or stand-alone drive to be used for processing the backup. Specifies the media set for the job.
DO_JOB_ CANCELTHRESHOLD
DO_JOB_ DEVICEGUID
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
68
Administrators Guide
Using Command Line Switches Default option parameters (continued) Option Name DO_BACKUP_ SINGLEBACKUPNTFS Function Description
Enable single instance Enter 1 to ensure that only one instance backup for NTFS volumes of the backing file for NTFS volumes will be backed up regardless of the number of single instance store (SIS) links that point to it; otherwise, enter 0. Set last access date Note If 5 was entered as the value for DO_BACKUPT_TYPE, the DO_BACKUP_ LASTACCESSEDDAYS entry must be completed. Enter the number of days during which files that you want to include in the backup were last accessed. For example, to specify a working set backup to include all files last accessed within 30 days, type: -do:DO_BACKUP_ LASTACCESSEDDAYS -dv:30
DO_BACKUP_ LASTACCCESSEDDAYS
DO_BACKUP_ MEDIAOVERWRITE
Specify one of the following values: 0 = Overwrite 1 = Append, overwrite if no media available 2 = Append, no overwrite
DO_BACKUP_ COMPRESSIONTYPE
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
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.
Command Line
69
Using Command Line Switches Default option parameters (continued) Option Name DO_BACKUP_ INSERTCHECKSUMS Function Calculate checksums Description 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. Enter 1 to back up mount points that direct a file or directory to a local disk or directory path; otherwise, enter 0. Using this option allows you to back up data that is linked to local files, but stored on another device without having to actually select the data. Enter 1 to back up data that has been migrated from primary storage to secondary storage; otherwise, enter 0. When using this option, the data will not be recalled to its original location; it will be backed up directly to the backup media. This option should not be used if: A single device containing one drive is used for secondary storage and backups because Remote Storage and Backup Exec will compete for use of the drive. You want to run a backup of the entire system because Backup Exec attempts to access all data that has been migrated to secondary storage and this may take a considerable amount of time.
DO_BACKUP_ TRAVERSEPOINTS
DO_BACKUP_HSM
70
Administrators Guide
Using Command Line Switches Default option parameters (continued) Option Name DO_BACKUP_ USECHANGEJOURNAL Function Use change journal Description 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. Enter 1 to use the Open File Option if available; otherwise, enter 0.
Back up open files if Open Enter a number from 0 to 3 to specify File Option is not how to back up open files if the Open File Option is not available. Values available include: 0 = Never 1 = With a lock 2 = Without a lock 3 = If closed within x seconds
DO_BACKUP_ OPENFILESKIPSECS
Back up open file if closed If 3 was entered for the value for within x seconds DO_BACKUP_OPENFILEMETHOD, enter a number from 1 to 999 to specify the number of seconds Backup Exec is to wait for an open file to close before continuing the backup. If the files do not close during the specified interval, they are skipped.
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.
Command Line
71
Using Command Line Switches Default option parameters (continued) Option Name DO_RESTORE_CORRUPT Function Restore corrupt files Description 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. Enter 0 if you want to restore the information for the junction points and the files and directories to which they are linked, overwriting existing junction points on your system. Enter 1 if you want to restore files and directories backed up from junction point links while retaining the systems current junction points. 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_RESTORE_ JUNCMETHOD
DO_TRIAL_ CHECKCAPACITY
Check media capacity for Enter 1 to test whether enough tape is trial run job available to complete the job; otherwise, enter 0. Note During the test run job, the number of scheduled jobs in the queue is not checked; therefore, jobs that are scheduled before the test run job may use the media that was available when the test run job was performed.
DO_TRIAL_CHECKMEDIA
Check media for trial run Enter 1 to test whether the media is job online and overwritable for a trial run job; otherwise, enter 0. Select method for 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.
DO_TRIAL_ DETERMINESIZEMETHOD
72
Administrators Guide
Using Command Line Switches Default option parameters (continued) Option Name DO_TRIAL_ HOLDONFAILURE Function Place job on hold if trial job fails Description 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_CONFIGUR Specify the open file ATION=0-4 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 Specify the snapshot =0-3 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
Command Line
73
Using Command Line Switches Default option parameters (continued) Option Name Function Description Enter 1 to process logical volumes for backup one at a time; otherwise, enter 0. 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 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
74
Administrators Guide
Using Command Line Switches Default option parameters (continued) Option Name DO_SQL_ CHECBEFOREBACKUP Function Description
Consistency check before Select a consistency check to run before backup a backup. Values are: 0 = none 1 = full 2 = full with indexes 3 = physical
DO_SQL_ CONTINUEIFCHECKFAILS
Enter 1 if you want the backup job to continue if the consistency check fails; otherwise, enter 0. Select a consistency check to run after a backup. Values are: 0 = none 1 = full 2 = full with indexes 3 = physical
DO_SQL_ CHECKAFTERBACKUP
Select the default restore method for SQL databases. Values include: 0 = no recover 1 = recover 2 = standby
DO_SQL_REPLACE
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. Select a consistency check to run after a restore. Values include: 0 = none 1 = full 2 = full with indexes 3 = physical
DO_SQL_ CHECKAFTERRESTORE
Command Line
DO_SQL_ ENABLEFGSUPPORT
Enable filegroup support Enter 1 if you want to enable filegroup support; otherwise, enter 0. 75
Using Command Line Switches Default option parameters (continued) Option Name Exchange Default Options DO_XCH_ENABLE Enable Exchange support Enter 1 if you want to enable Exchange support; otherwise, enter 0. Function Description
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 No loss restore Enter 1 if you want to enable single instance backup for message attachments; otherwise, enter 0. Enter 1 to restore without deleting existing job logs; otherwise, enter 0. Enter 1 to restore a public folder; otherwise, enter 0.
DO_XCH_NOLOSS
DO_XCH_PUBLIC
DO_XCH_PRIVATE
Restore private mailboxes Enter 1 to restore private mailboxes; otherwise, enter 0. Select temporary location Enter the temporary location for log for log and patch files and patch files. Automatically recreate user accounts and mailboxes Enter 1 to have Backup Exec automatically recreate user accounts and mailboxes if they do not already exist on the server; otherwise, enter 0.
DO_XCH_LOGPATH
DO_XCH_ AUTOCREATEMAILBOX
76
Administrators Guide
Using Command Line Switches Default option parameters (continued) Option Name Function Description
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 DO_DOMINO_ SECONDSTOWAIT Mark archive logs for recycling Seconds to wait for database Enter 1 to mark archive logs for recycling; otherwise, enter 0. Specify the number of seconds for the restore process to wait for a database that is in use by entering a value from 0 to 999. Select the default option for handling database IDs during a restore. Values include: 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 Enter 1 to have Backup Exec in decompressed form decompress, or expand, compressed files as they are backed up; otherwise, enter 0. Restore volume restrictions Enter 1 to restore NetWare volume restrictions; otherwise, enter 0.
DO_DOMINO_ RECOVEROPTION
Database identification
Use storage media-based Enter 1 to use the catalog information catalogs from the media; otherwise, enter 0.
Command Line
77
Using Command Line Switches Default option parameters (continued) Option Name DO_CAT_TRUNCATEFLAG Function Truncate catalogs Description Enter 1 to retain only the header information and to remove all file and directory details after the specified number of days; otherwise, enter 0. If you select this option, you must enter a value for DO_CAT_TRUNCATEDAYS. Enter the amount of days before file and directory details are removed from the catalogs. The value can be between 1 and 999.
DO_CAT_REMOVEFLAG
Remove unused catalogs Enter 1 to remove unused catalogs after a specified number of days; otherwise, enter 0. If you select this option, you must enter a value for DO_CAT_REMOVEDAYS. Amount of days before removing unused catalogs Set catalog path Enter the amount of days before unused catalogs are removed. The value can be between 1 and 999. Specify a path on the volume for the catalog files.
DO_CAT_REMOVEDAYS
DO_CAT_PATH
Media Default Options DO_MEDIA_B2DLOCATION Backup-to-Disk default folder location DO_MEDIA_ OVERWRITELEVEL Set media overwrite protection level Specify a path on the volume for the Backup-to-Disk folder. Enter one of the following values: 1 = None 2 = None with prompt 3 = Partial 4 = Partial with prompt 5 = Full
78
Administrators Guide
Using Command Line Switches Default option parameters (continued) Option Name DO_MEDIA_ OVERWRITEOPTIONS Function Set the media overwrite options Description 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. Specify an alternate data path where a second copy of the DR files can be stored.
DO_DISASTER_ ALTERNATEPATH
Database Maintenance Default Options DO_DB_GROOM Remove old data from the Enter 1 if you want Backup Exec to Backup Exec database automatically delete old data from its database, using specified criteria. Otherwise, enter 0. Number of days to keep job history data Enter the number of days for job history data to remain on the Backup Exec database. Enter the number of days for alert history data to remain on the Backup Exec database. Enter the number of days for job logs to remain on the Backup Exec database. Enter the number of days for report data to remain on the Backup Exec database.
DO_DB_JOBHISTORYDAYS
DO_DB_ ALERTHISTORYDAYS
DO_DB_JOBLOGDAYS
Number of days to keep job logs Number of days to keep report data
DO_DB_REPORTDAYS
Command Line
DO_DB_CONSISTENCY
Using Command Line Switches Default option parameters (continued) Option Name DO_DB_COMPACT Function Description
Compact the Backup Exec Enter 1 if you want to compact the database Backup Exec database; otherwise, enter 0. Dump contents of Backup Enter 1 if you want to dump the Exec database contents of the Backup Exec database to the Backup Exec data directory so that it can be backed up. Otherwise, enter 0.
DO_DB_DUMP
80
Administrators Guide
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
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
Command Line
[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.
82
Administrators Guide
Using Job Script Files Possible backup job script file entries Section [General] JOB_TYPE=job type This entry must be completed with a value of Backup. Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Options are: Lowest Low Medium High Highest JOB_NAME=job name SERVER Type the name of the backup job. Type the name of the Backup Exec server where the operation is to be performed. If a server is not specified, the local server is used by default. Type the user name for logging into a remote Backup Exec server. If a user name is not specified, the current user name is used. Enter the password for logging into a remote Backup Exec server. If a password is not specified, the current password is used. Entry Description
JOB_PRIORITY=priority
USERNAME=username
PASSWORD=password
[Backup Options] BK_SET_NAME=backup set name Type the name of the backup set to be used by the job.
Command Line
83
Using Job Script Files Possible backup job script file entries (continued) Section Entry BK_METHOD=# Description 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. 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.
USE_OPEN_FILE_OPTION=0 or 1
84
Administrators Guide
Using Job Script Files Possible backup job script file entries (continued) Section Entry OPEN_FILES_METHOD=# Description Enter a number from 0 through 3 to specify how to back up open files. Selections include: 0 = Never 1 = If closed within a specified number of seconds. If this method is selected, use the flag OPEN_FILE_WAIT_TIME to set the number of seconds for Backup Exec to wait; otherwise, the value set for default options will be used. 2 = With a lock 3 = Without a lock Note If 1 is entered as the value, Backup Exec will wait the number of seconds specified in OPEN_FILE_WAIT_TIME for the file to close before continuing the backup. If the files do not close during the specified interval, they are skipped. OPEN_FILE_WAIT_TIME=# Specifies the number of seconds Backup Exec is to wait for a file to close before continuing with the backup. Enter 1 to retension the media before backup; otherwise, enter 0. Enter 1 to retain the directory structure of the files that were backed up in an archive job on the hard drive; otherwise, enter 0. Enter 1 if single instance store is being used, and you want to ensure that only one instance of a file for NTFS volumes will be backed up regardless of the number of single instance store (SIS) links that point to it. Otherwise, enter 0.
RETENSION_MEDIA=0 or 1
PRESERVE_TREE_ON_ARCHIVE= 0 or 1
SINGLE_INSTANCE_FOR_NTFS=0 or 1
Command Line
85
Using Job Script Files Possible backup job script file entries (continued) Section Entry REMOTE_AGENT_PRIORITY=# Description Select the number of CPU cycles the media server will use to maintain optimal server performance while Remote Agent backups are running. The higher the priority, the more the protected servers CPU processing power is used during backup operations. Note Allocating fewer CPU cycles to a backup job results in slower backup performance. This entry contains the following options: MEDIUM. Select this option to allocate the default number of CPU cycles the protected server will use during a Remote Agent backup. LOW. Select this option to allocate fewer server CPU cycles to the backup job. LOWEST. Select this option to allocate the fewest number of CPU cycles to the backup job. 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.
86
Administrators Guide
Using Job Script Files Possible backup job script file entries (continued) Section Entry EXCHANGE_MBOX_METHOD=# Description If you are backing up an Exchange server, use this entry. Enter a number from 0 through 3 that corresponds to the backup method you want for the Exchange database. Methods are: 0 = 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. 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. Enter 1 to continue the backup job even if the consistency check fails; otherwise, enter 0. If you are backing up an Exchange server, use this entry. Enter a number from 0 through 3 that corresponds to the backup method you want for the Exchange database. Methods are: 0 = Backup All 1 = Backup Copy 2 = Backup Log Differential 3 = Backup Log Incremental
EXCHANGE_CONSISTENCY_CHECK=0 or 1
EXCHANGE_CONTINUE=0 or 1
EXCHANGE_METHOD=#
Command Line
87
Using Job Script Files Possible backup job script file entries (continued) Section Entry SQL_METHOD=# Description 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. If you are backing up NetWare shares or volumes, include this entry in the Backup Job Script File. If you want to back up compressed files in decompressed form, enter 1 as the value; otherwise, enter 0. Enter 1 as the value if you want Backup Exec to overwrite a duplicate job if one exists; otherwise, enter 0.
NW_BK_DECOMPRESS_FILES= 0 or 1
OVERWRITE_JOB=0 or 1
88
Administrators Guide
Using Job Script Files Possible backup job script file entries (continued) Section Entry CONTINUE_ON_DBCC=0 or 1 Description Enter 1 if you are backing up a SQL server, have specified that a database consistency check is to be performed before the backup, and want the job to continue if the pre-backup database consistency check failed. If you are backing up a SQL server, include this entry. Enter a value from 0 to 3 that corresponds to an option for performing a pre-backup database consistency check. Options are: 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
PRE_BK_DBCC=#
Command Line
89
Using Job Script Files Possible backup job script file entries (continued) Section Entry OFFHOST_PROVIDER=0 or 3 Description Enter a value from 0 to 3 that corresponds to the snapshot provider options for an offhost backup jobs. Options are: 0 = Disable offhost backup 1 = Automatic Use hardware if available 2 = Software Use VERITAS Storage Foundation for Windows 3 = Hardware Use technology provided by hardware manufacturer OFFHOST_DISPOSITION=0 or 1 Enter 1 to allow the backup job to complete even if any of the volumes selected do not support offhost backup; otherwise, to fail the backup job, enter 0. Enter 1 to process logical volumes for offhost backup one at a time; otherwise, enter 0. 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
OFFHOST_SINGLESNAP=0 or 1
OPEN_FILE_CONFIGURATION=1-4
90
Administrators Guide
Using Job Script Files Possible backup job script file entries (continued) Section Entry SNAPSHOT_PROVIDER=0-3 Description Enter a number from 0 through 3 to specify the best provider for the selected volume. Selections include: 0 = Automatic - Allows VSS to select the snapshot provider 1 = System - Use Microsoft software shadow copy provider 2 = Software - Use VERITAS Storage Foundation for Windows 3 = Use technology provided by hardware manufacturer USE_SINGLE_VOLUME_SNAPSHOT=0 or 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. Enter the name of the media set to be used for the backup. If the media has a password, specify the password. To append the job to the media set specified in the MEDIA_SET entry or overwrite if no appendable media is available, enter 1 as the value. If you want the job to overwrite the media set specified in the MEDIA_SET entry, enter 0 as the value. If you do not enter a value, by default the job will be an overwrite job.
MEDIA_PASSWORD=Media Password
APPEND=0 or 1
Command Line
91
Using Job Script Files Possible backup job script file entries (continued) Section Entry APPEND_NO_OVERWRITE=0 or 1 Description If you want the job to either append to the media set specified in the MEDIA_SET entry, or if no appendable media is available then to terminate, enter 1. To have the job append to the media set, or overwrite if no appendable media is available, enter 0. Enter 1 as the value to have Backup Exec automatically perform a verify operation to make sure the media can be read once the backup has been completed; otherwise, enter 0. Verifying all backups is recommended. Enter a number from 0 to 3 that corresponds with the type of compression to use. Options include: 0 = Hardware compression 1 = Software compression 2 = Hardware if available, otherwise software 3 = None Note To use the default Backup Exec compression type, do not include this entry in the script. CHECKSUM=0 or 1 Enter 1 as the value if checksums are to be calculated for each data stream written to tape, and then written in a separate stream immediately following the data stream. If 0 is entered as the value, backup performance may be improved, but there will be no way to verify the integrity of the data on the tape. Enter 1 to eject the media when the job completes; otherwise, enter 0.
VERIFY=0 or 1
COMPRESSION_TYPE=#
EJECT_MEDIA=0 or 1
92
Administrators Guide
Using Job Script Files Possible backup job script file entries (continued) Section Entry Description
[Miscellaneous] PRE_JOB_COMMAND=command Specify a .exe or batch file command that is to run on the media server before the backup operation starts. Specify a .exe or batch file command that is to run after the backup operation completes. Enter 1 to execute the post-job command only if the pre-job command is successful; otherwise, enter 0.
POST_JOB_COMMAND=command
COMMAND_RUN_POST_IF_ PRE_SUCCESS=0 or 1
COMMAND_RUN_JOB_IF_PRE_SUCCESS Enter 1 to execute the job only if the =0 or 1 pre-job command is successful; otherwise, enter 0. COMMAND_RUN_POST_ IF_JOB_FAILS=0 or 1 Enter 1 to execute the post-job command even if the job fails; otherwise, enter 0. Enter 1 to allow the pre- and post-job commands to be successful only if completed with a return code of zero. Otherwise, enter 0. An return code of zero returned to the operating system by the pre- or post-job command is interpreted by Backup Exec to mean the job completed successfully. A non-zero return code is interpreted by Backup Exec to mean the job ended with an error. After checking the return codes, Backup Exec continues processing according to selections you made for running the pre- and post-job commands. If you enter 0, the success of the preand post-job commands is not determined based on the return code.
COMMAND_FAIL_JOB_IF_FAILS= 0 or 1
Command Line
93
Using Job Script Files Possible backup job script file entries (continued) Section Entry COMMAND_AUTO_CANCEL_TIME=# Description Enter the number of minutes Backup Exec should wait before canceling a command that did not complete. Enter 0 to run the command on this media server or 1 to run the command on each server being backed up. Enter 1 to use the job defaults from the Backup Exec Administration Console for this job. All other options will be overwritten. Enter 0 if you do not want to use the job defaults. Enter 1 to include the job log with a notification to an email or printer recipient; otherwise, enter 0. Enter 1 to use the MAC address 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.
COMMAND_RUN_OPTION=#
USE_JOB_DEFAULTS=0 or 1
PRINT_LOG_FILE=0 or 1
NIC_ENABLED=0 or 1
94
Administrators Guide
Using Job Script Files Possible backup job script file entries (continued) Section Entry NIC_SUBNET_ADDRESS Description If the setting used in NIC_ADDRESS is connected to multiple subnets, then enter the network ID based on the IP address and the subnet mask of the network interface card you selected. To view this ID, on the Tools menu, click Options, then under Properties, click Network, and view the Network ID field. This setting corresponds to the network interface used in NIC_ADDRESS. You must also enter the NIC_SUBNET_MASK. NIC_SUBNET_MASK If the setting used in NIC_ADDRESS is connected to multiple subnets, then enter the mask that determines the subnet to which the network interface belongs. To view this ID, on the Tools menu, click Options, then under Properties, click Network, and view the Subnet mask field. This setting corresponds to the network interface used in NIC_ADDRESS. You must also enter the NIC_SUBNET_ADDRESS. NIC_SUBNET_AUTOGET=0 or 1 Enter 1 to have Backup Exec use any available network adapter.
[W2K] BACKUP_LOCAL_MOUNT_POINTS= 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.
Command Line
95
Using Job Script Files Possible backup job script file entries (continued) Section Entry BACKUP_REMOTE_STORAGE_HSM= 0 or 1 Description 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. Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format.
SCHED_STARTTIME=HH:MM:SS
SCHED_ENDTIME=HH:MM:SS
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.
96
Administrators Guide
Using Job Script Files Possible backup job script file entries (continued) Section Entry SCHED_REPEAT_INTERVAL=X Description Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date, in mm/dd/yyyy format, from which the interval is calculated. Enter the days of the month you want the job to run in a comma delimited string. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002
SCHED_ANCHOR=MM/DD/YYYY
SCHED_DAYSOFMONTH=x
Command Line
97
Using Job Script Files Possible backup job script file entries (continued) Section Entry SCHED_EXCLUDEDATEx=MM/DD/YYYY Description Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in mm/dd/yyyy format. 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. Enter 1 as the value if you want to schedule the job on hold; otherwise, enter 0.
TIME=hh:mm:ss
HOLD=0 or 1
98
Administrators Guide
Using Job Script Files Possible backup job script file entries (continued) Section [Machine] MACHINEx=machine name|logon GUID Specify the logon account used to log on to remote machines and back up remote data and databases. Entry Description
[Selections] PATHx=string Specify which files or directories get backed up. For example, PATH1=\\Myserver1\Myshare1\Myd ir1\*.* or PATH2=\\Myserver2\Myshare2\Myd ir2\*.* 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.
Command Line
SUBDIRSx=0 or 1
99
Using Job Script Files Possible backup job script file entries (continued) Section Entry UNIXx=x Description Change x to the number that corresponds to the path that contains the Unix files or directories to be backed up. Enter a 1 if it is a Unix selection. Change x to a unique number and specify the name of the Exchange Server to back up. 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.
100
Administrators Guide
Using Job Script Files Possible backup job script file entries (continued) Section Entry EXCH2DB?=Exchange 2000 Server database name Description 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 EXCH2ROOT2=SERVER_NAME EXCH2SG2=Second Storage Group EXHC2DB2=Mailboxes EXCH2ROOT3=SERVER_NAME EXCH2SG3=Second Storage Group EXHC2DB3=Users SQLx=SQL Server name Change x to a unique number and specify the name of the SQL Server to back up.
Command Line
101
Using Job Script Files Possible backup job script file entries (continued) Section Entry SQL2S? =SERVER_NAME Description 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. 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
102
Administrators Guide
Using Job Script Files Possible backup job script file entries (continued) Section Entry LNSERVER?=SERVER_NAME Description Specifies the name of the Lotus Notes server that contains this selection. Change ? to a number that corresponds to the number of the selection. The selections must be in a sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. See the example in LNDRIVE?=Drive letter. LNDRIVE?=Drive letter Change ? to the same number used to identify the selection for the Lotus Notes server. In the following example, SERVER_NAME is a Lotus Notes server name, and it is the same server in all of the selections. To back up the D drive and the E drive on the Lotus Notes server SERVER_NAME, the entries would be: LNSERVER1=SERVER_NAME LNDRIVE1=D LNSERVER2=SERVER_NAME LNDRIVE2=E 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.
Command Line
103
Using Job Script Files Possible backup job script file entries (continued) Section Entry ORCLSID?=System identifier for database Description Specifies the SID (System Identifier) for the Oracle database to back up. Change ? to the same number used to identify the selection for the Oracle server. In the following example, SERVER_NAME is an Oracle server name, and it is the same server in all of the selections. To back up the databases SID1 and SID2 on the Oracle server, the entries would be: ORCLSRV1=SERVER_NAME ORCLSID1=SID1 ORCLSRV2=SERVER_NAME ORCLSID2=SID2 SPPSx=SharePoint Portal Server name Change x to a unique number and specify the name of the Microsoft SharePoint Portal Server to back up.
104
Administrators Guide
Using Job Script Files Possible backup job script file entries (continued) Section Entry APATHx=String Description Specify which files or directories are backed up and aliased when running an alias backup. The order in which resource selections are specified is the order in which the resources will be backed up. Change x to a unique number for each device aliasing backup selection. An alias backup allows you to specify a share to back up, and then specify another share from which the backup will appear to have originated. This type of backup is useful when the location of the data to be backed up is temporary. For example, a temporary share may be created when a mirror is split. Or a share may be cloned and placed on another device while it is backed up in order to off-load traffic from a busy device. If a temporary share is backed up, the restore path for the share may not exist if a restore becomes necessary. Instead, you can specify an alias to a location where you want the share to appear to have been backed up from. For example: APATH1=\\MachineA\C$\*.* AINCLUDE1=1 ASUBDIRS1=1 AALIAS1=\\MachineB\D$ indicates that \\MachineA\C$\*.* and all its subdirectories should be backed up and aliased as \\MachineB\D$. Alias jobs support both UNC and local devices. However, both the target and the source must be the same, either both UNC or both local devices. You cannot mix them.
Command Line
Note The schedule option RUN_IMMEDIATE=1 must be included or the alias selection will be ignored. 105
Using Job Script Files Possible backup job script file entries (continued) Section Entry AINCLUDEx=0 or 1 Description Enter 1 to include this item in the backup job when running an alias backup; otherwise, enter 0. Change x to a unique number for each alias backup selection. ASUBDIRSx=0 or 1 Enter 1 to include all subdirectories when running an alias backup; otherwise, enter 0. Change x to a unique number for each device aliasing backup selection. AALIASx=String Specify the share from which the backup will appear to have originated, when running an alias backup. Change x to a unique number for each device aliasing backup selection. For example: AALIAS1=\\MachineB\D$ See also the example for APATHx=String [Media_server] PREFERRED_SERVER=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 This operation is only available if the Central Admin Server Option (CASO) is installed. Specify the media server pool to use for the backup job.
106
Administrators Guide
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 Section [General] JOB_TYPE=Job type This field must be completed with a value of Restore. Type the name of the restore job. Type the name of the media server where the operation is to be performed. If a server is not specified, the local server is used by default. Entry Description
Command Line
107
Using Job Script Files Possible restore job script file entries (continued) Section Entry USERNAME=User name Description Type the user name for logging into the system being restored. If a user name is not specified, the current user name is used. Type the password for logging into the system being restored. If a password is not specified, the current password is used. Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority set determines which job runs first. If a priority is not entered, the priority will be Medium. Options are: 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. 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.
PASSWORD=Password
JOB_PRIORITY=Priority
RESTORE_EXISTING=x
108
Administrators Guide
Using Job Script Files Possible restore job script file entries (continued) Section Entry RESTORE_PRESERVE=0 or 1 Description Enter 1 to restore the data with its original directory structure intact. Enter 0 to restore all data (including the data in subdirectories) to the path specified in SHARE_REDIRECT_PATH. Type the name of the device, such as a drive or backup-to-disk folder, containing the data to be restored. Type a destination drive, other than where the data was originally backed up, to which the data is to be restored. Type the target path on the drive specified in SHARE_REDIRECT_DRIVE. To retain the original directory structure, make sure that the value for RESTORE_PRESERVE=1. 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. If you are redirecting SQL data to a named instance, specify the instance name. Otherwise, the data is restored to the default instance. If you are redirecting this restore to a different database on the target server, specify the target database name. If you are restoring a differential or log backup, and the associated database backup was restored to a renamed database, the new database name must be entered. If you are redirecting Exchange data, specify the Exchange server where the data is to be restored.
DEVICE_NAME=Device name
SHARE_REDIRECT_DRIVE=Drive letter
SHARE_REDIRECT_PATH=Path name
Command Line
109
Using Job Script Files Possible restore job script file entries (continued) Section Entry XCH_REDIRECT_MAILBOX=Exchange mailbox name Description 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. Specify whether server sets or document sets are being restored. Enter the name of the local drive or the UNC path to which you want to redirect the restore. If you type a UNC path, use the format server name\share name. Type the folder location on the drive to which you want to redirect the restore.
SP_REDIRECT_PATH=Path
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. Enter 1 to restore disk quota data; otherwise, enter 0. Disk quotas track and control disk usage on a per user, per volume basis; the values can be restored to the limits that were set before the backup. Enter 1 to restore the Terminal Services database, which contains licensing data for client licenses; otherwise, enter 0.
RESTORE_DISK_QUOTA=0 or 1
RESTORE_TERMINAL_SERVICES= 0 or 1
110
Administrators Guide
Using Job Script Files Possible restore job script file entries (continued) Section Entry RESTORE_WMI=0 or 1 Description Enter 1 to restore the Windows Management Instrumentation (WMI) respository, which provides support for monitoring and controlling system resources and provides a consistent view of your managed environment; otherwise, enter 0. Enter 1 to restore the cluster configuration; otherwise, enter 0. Enter 1 to force the recovery of the cluster quorum even if other nodes are online the and/or disk signatures do not match option; otherwise, enter 0. Enter 1 if all the domain controllers in the domain are being restored and you want to designate this server as the primary arbitrator. If you enter 0, replication may not function. Use this option when you perform a restore of a domain controller in a domain that does not have any other domain controllers. RESTORE_REGISTRY=0 or 1 Enter 1 to restore registry information if it exists in the selected data; otherwise, enter 0. Enter 1 to merge existing hardware configuration and registry services with the data to be restored when restoring registry information; otherwise, enter 0. Enter 1 to 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.
RESTORE_CLUSTER_DB=0 or 1
RESTORE_FORCE_RECOVERY= 0 or 1
RESTORE_PRIMARY_REPLICA=0 or 1
RESTORE_PNP_MERGE=0 or 1
RESTORE_JUNCSASDIRS=0 or 1
Command Line
111
Using Job Script Files Possible restore job script file entries (continued) Section Entry PRE_JOB_COMMAND=Command Description Specify a .exe or batch file command to run on the media server before the restore operation starts. Specify a .exe or batch file command to run after the restore operation completes. Enter 1 to execute the post-job command only if the pre-job command is successful; otherwise, enter 0.
POST_JOB_COMMAND=Command
COMMAND_RUN_POST_IF_ PRE_SUCCESS=0 or 1
COMMAND_RUN_JOB_IF_PRE_SUCCESS Enter 1 to execute the job only if the =0 or 1 pre-job command is successful; otherwise, enter 0. COMMAND_RUN_POST_ IF_JOB_FAILS=0 or 1 Enter 1 to execute the post-job command even if the job fails; otherwise, enter 0. Enter 1 to allow the pre- and post-job commands to be successful only if completed with a return code of zero. Otherwise, enter 0. An return code of zero returned to the operating system by the pre- or post-job command is interpreted by Backup Exec to mean the job completed successfully. A non-zero return code is interpreted by Backup Exec to mean the job ended with an error. After checking the return codes, Backup Exec continues processing according to selections you made for running the pre- and post-job commands. If you enter 0, the success of the preand post-job commands is not determined based on the return code. COMMAND_AUTO_CANCEL_ TIME=# Enter the number of minutes Backup Exec should wait before canceling a command that did not complete. Administrators Guide
COMMAND_FAIL_JOB_IF_FAILS= 0 or 1
112
Using Job Script Files Possible restore job script file entries (continued) Section Entry COMMAND_RUN_OPTION=# Description Enter 0 to run the command on this media server or 1 to run the command on each server being restored to. Enter one of the following values for recovering the database: 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. Enter 1 to enable Backup Exec to stop SQL so that the master can be restored; otherwise, enter NO. If you enter 1, all existing users are logged off, and the master is put into single-user mode. SQL_POSTRESTORE_DBCC=# Enter one of the following values for performing a consistency check after restore: 0 = None 1 = Full check, excluding indexes 2 = Full check, including indexes 3 = Physical check only (SQL 2000 only) SQL_DEFAULT_DRIVE=Drive letter Enter the drive letter for an alternate drive to which SQL database files will be restored.
SQL_DATABASE_RECOVER=#
SQL_AUTOMASTER=0 or 1
Command Line
113
Using Job Script Files Possible restore job script file entries (continued) Section Entry SQL_USE_ALLDEFAULT=0 or 1 Description 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 instances data location; otherwise, enter 0. Enter the date and time to restore transactions for a transaction log up to and including a point in time in the transaction log. After the point in time, recovery from the transaction log is stopped. Enter the named transaction to include in the recovery of the transaction log. Recovery will be stopped after this named transaction is restored. Enter 1 to restore transactions from a transaction log up to a named transaction in the transaction log. After the named transaction, recovery from the transaction log is stopped. Otherwise, enter 0. Enter the date and time after which the restore operation is to search for the named transaction. Enter 1 if you are restoring Exchange data and want Backup Exec to automatically recreate user accounts and mailboxes; otherwise, enter 0.
SQL_POINTINTIME=MM/DD/YYYY, HH:MM:SS
SQL_LOGMARK_NAME=Named transaction
SQL_LOGMARK_INCLUDE=0 or 1
SQL_LOGMARK_TIME=MM/DD/YYYY,HH :MM:SS
XCH_AUTOCREATE_MAILBOX=0 or 1
114
Administrators Guide
Using Job Script Files Possible restore job script file entries (continued) Section Entry XCH_NOLOSS_RESTORE=0 or 1 Description Enter 1 if you are restoring Exchange 2000 data and do not want to delete the existing job logs; otherwise, enter 0. Enter 1 if you are restoring Exchange data and want to restore public folders; otherwise, enter 0. Enter 1 if you are restoring Exchange data and want to restore private mailboxes; otherwise, enter 0. 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.
XCH_RESTORE_PUBLIC=0 or 1
XCH_RESTORE_PRIVATE=0 or 1
ESE_NOLOSS_RESTORE=0 or 1
Command Line
115
Using Job Script Files Possible restore job script file entries (continued) Section Entry ESE_TEMPLOG_PATH=Path Description Enter a location where the associated log and patch files are to be kept until the database is restored. The default location is \temp. If storage groups are being restored, a subdirectory in \temp is created for each storage group. The log and patch files for each storage group are kept in the corresponding subdirectory. After the 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.
116
Administrators Guide
Using Job Script Files Possible restore job script file entries (continued) Section Entry ESE_DISMOUNT_BEFORE=0 or 1 Description Enter 1 to automatically take the database offline before the restore job runs; otherwise, enter 0. Specify the number of seconds for the restore process to wait for a database that is in use. When a Lotus database is restored it must first be taken offline. This will ensure that the database is not being accessed, closed, or deleted while the restore operation is being processed. If the database is still in use and cannot be taken offline after the specified wait time, the restore will fail. Enter one of the following options for recovering a Lotus Domino database: 0 = Retain original IDs 1 = Assign new database IDs 2 = Assign new database IDs and replica IDs LOTUS_POINTINTIME=MM/DD/YYYY,HH: Enter a date and time from which to MM:SS restore the Lotus Domino database. RESTORE_VOL_RESTRICT=0 or 1 Enter 1 if you are restoring NetWare data and want to restore volume restrictions; otherwise, enter 0. 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.
LOTUS_WAIT_MSECS=x
LOTUS_DBRECOVER_OPTION=#
NIC_ENABLED=0 or 1
Command Line
117
Using Job Script Files Possible restore job script file entries (continued) Section Entry NIC_ADDRESS Description 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. This setting corresponds to the network interface used in NIC_ADDRESS. You must also enter the NIC_SUBNET_MASK. NIC_SUBNET_MASK If the setting used in NIC_ADDRESS is connected to multiple subnets, then enter the mask that determines the subnet to which the network interface belongs, for example, 255.255.254.0. To view this ID, on the Tools menu, click Options, then under Properties, click Network, and view the Subnet mask field. This setting corresponds to the network interface used in NIC_ADDRESS. You must also enter the NIC_SUBNET_ADDRESS.
118
Administrators Guide
Using Job Script Files Possible restore job script file entries (continued) Section Entry NIC_SUBNET_AUTOGET=0 or 1 Description 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_STARTTIME=HH:MM:SS Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format.
SCHED_ENDTIME=HH:MM:SS
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_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. Enter the date in mm/dd/yyyy format the interval is calculated from. Enter the date in mm/dd/yyyy format that the schedule becomes effective.
SCHED_ANCHOR=MM/DD/YYYY
SCHED_EFFECTIVE=MM/DD/YYYY
Command Line
119
Using Job Script Files Possible restore job script file entries (continued) Section Entry SCHED_DAYSOFMONTH=x Description Enter the days of the month you want the job to run in a comma delimited string. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK In a comma delimited string, enter the day of the week, a forward slash, and the week of the month you want the job to run. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, if you want the job to run the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, if you do not want the job to run on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in mm/dd/yyyy format.
120
Administrators Guide
Using Job Script Files Possible restore job script file entries (continued) Section Entry TIME=hh:mm:ss Description Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. 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.
Command Line
121
Using Job Script Files Possible restore job script file entries (continued) Section Entry INTERVAL_HOURS=# Description If a number is specified, the job is scheduled to run every specified number of hours. Note Only one of the INTERVAL values should be specified (i.e., if you specify a value for INTERVAL_MINUTES, do not specify a value for INTERVAL_HOURS, INTERVAL_DAYS, or INTERVAL_WEEKS. Also, use either one of the INTERVAL values, or the WEEKS and WEEKDAYS, or the DAYS, or the DAYS_OF_MONTH entries. Unless specifically noted, these scheduling options should not be used in conjunction with each other. INTERVAL_DAYS=# If a number is specified, the job is scheduled to run every specified number of days. Note Only one of the INTERVAL values should be specified (i.e., if you specify a value for INTERVAL_MINUTES, do not specify a value for INTERVAL_HOURS, INTERVAL_DAYS, or INTERVAL_WEEKS. Also, use either one of the INTERVAL values, or the WEEKS and WEEKDAYS, or the DAYS, or the DAYS_OF_MONTH entries. Unless specifically noted, these scheduling options should not be used in conjunction with each other.
122
Administrators Guide
Using Job Script Files Possible restore job script file entries (continued) Section Entry INTERVAL_WEEKS=# Description If a number is specified, the job is scheduled to run every specified number of weeks. Note Only one of the INTERVAL values should be specified (i.e., if you specify a value for INTERVAL_MINUTES, do not specify a value for INTERVAL_HOURS, INTERVAL_DAYS, or INTERVAL_WEEKS. Also, use either one of the INTERVAL values, or the WEEKS and WEEKDAYS, or the DAYS, or the DAYS_OF_MONTH entries. Unless specifically noted, these scheduling options should not be used in conjunction with each other. 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. 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.
WEEKDAY=SUN/MON/TUES/WED/ THU/FRI/SAT
Command Line
123
Using Job Script Files Possible restore job script file entries (continued) Section Entry Description
DAYS=SUN/MON/TUES/WED/THU/FRI/SA If this entry is included in the Restore T Job Script File, the restore job will be scheduled for the indicated day or days. Multiple days can be included, but must be separated by commas. For example: DAYS=MON,WED,FRI Note Do not use this entry in conjunction with the INTERVAL entries, the WEEKS, or the DAY_OF_MONTH entries. DAY_OF_MONTH=# If this entry is included in the Restore Job Script File, the backup job will be scheduled for the indicated day of the month. The value can range from 1 to 31. Only one number can be specified. Note Do not use this entry in conjunction with the INTERVAL entries, the WEEKS, or the DAYS entries. RUN_IMMEDIATE=0 or 1 Enter a value of 1 if the job is to run immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set to 1, the job will be created but not scheduled. HOLD=0 or 1 Enter 1 as the value if you want to schedule the job on hold; otherwise, enter 0. 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.
AUTO_CANCEL_TIME=#
124
Administrators Guide
Using Job Script Files Possible restore job script file entries (continued) Section Entry HOLD_ON_JOB_FAILURE= 0 or 1 Description Enter the value of 1 to place a job on hold if it fails; otherwise, enter 0.
Command Line
125
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.
126
Administrators Guide
Using Job Script Files Possible catalog job script file entries Section [General] JOB_TYPE=Job type This entry must be completed with a value of Catalog. Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Options are: 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. Type the name of the Backup Exec server where the operation is to be performed. If a server is not specified, the local server is used by default. Type the user name for logging into a remote Backup Exec server. If a user name is not specified, the current user name is used. Enter the password for logging into a remote Backup Exec server. If a password is not specified, the current password is used. Entry Description
JOB_PRIORITY=Priority
SERVER=Server name
USERNAME=Username
PASSWORD=Password
Command Line
127
Using Job Script Files Possible catalog job script file entries (continued) Section Entry MEDIA_PASSWORD=Media password Description If the media has a password, specify the password.
[Schedule] SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in mm/dd/yyyy format, that the schedule becomes effective. Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format.
SCHED_STARTTIME=HH:MM:SS
SCHED_ENDTIME=HH:MM:SS
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. 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. Enter the date, in mm/dd/yyyy format, from which the interval is calculated. Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15
SCHED_ANCHOR=MM/DD/YYYY
SCHED_DAYSOFMONTH=x
128
Administrators Guide
Using Job Script Files Possible catalog job script file entries (continued) Section Entry SCHED_DAYSOFWEEK=x Description Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in mm/dd/yyyy format. If schedule values are not entered, then the DATE==MM/DD/YYYY and TIME=hh:mm:ss entries will be used to set the
Command Line
129
Using Job Script Files Possible catalog job script file entries (continued) Section Entry TIME=hh:mm:ss Description Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter 1 to run the catalog job immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set 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. To specify hours, enter a value divisible by 60. Enter 1 if you want the job to be submitted on hold; otherwise, enter 0.
HOLD=0 or 1
130
Administrators Guide
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.
Command Line
131
Using Job Script Files Possible discovery job script file entries Section [General] JOB_TYPE=Job type This entry must be completed with a value of Discovery. Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Options are: Lowest Low Medium High Highest JOB_NAME=Job name Type the name of the discovery job. If a name is not provided, one will automatically be generated. Type the name of the Backup Exec server where the operation is to be performed. If a server is not specified, the local server is used by default. Type the user name for logging into a remote Backup Exec server. If a user name is not specified, the current user name is used. Enter the password for logging into a remote Backup Exec server. If a password is not specified, the current password is used. Entry Description
JOB_PRIORITY=Priority
SERVER=Server name
USERNAME=Username
PASSWORD=Password
[Discovery_Options] DISCOVER_ADMINISTRATIVE_SHARES= Enter 1 to have Backup Exec search for 0 or 1 new administrative network shares or volumes; otherwise, enter 0.
132
Administrators Guide
Using Job Script Files Possible discovery job script file entries (continued) Section Entry DISCOVER_USER_SHARES=0 or 1 Description Enter 1 to have Backup Exec search for new user-defined shares; otherwise, enter 0. Enter 1 to have Backup Exec search for new SQL databases; otherwise, enter 0. Enter 1 to have Backup Exec search for new Exchange databases; otherwise, enter 0. Backup Exec searches for Information Store, Exchange Directory, or Storage Groups; it does not discover individual databases under storage groups. DISCOVER_DOMINO_DATABASES=0 or Enter 1 to have Backup Exec search for 1 new Lotus Domino databases; otherwise, enter 0. DISCOVER_SYSTEMSTATE=0 or 1 Enter 1 to have Backup Exec search for new System State resources; otherwise, enter 0. Enter 1 to have Backup Exec search for new SharePoint servers; otherwise, enter 0. Enter 1 to have Backup Exec send separate notifications when each new resource is found; otherwise, enter 0. Enter 1 to have Backup Exec send a notification that includes all resources previously found during resource discovery jobs; otherwise, enter 0.
DISCOVER_SQL_DATABASES=0 or 1
DISCOVER_EXCHANGE_DATABASES=0 or 1
DISCOVER_SHAREPOINT=0 or 1
NOTIFY_SEPARATE=0 or 1
NOTIFY_INCLUDE_PREVIOUS=0 or 1
Command Line
133
Using Job Script Files Possible discovery job script file entries (continued) Section [Selections] DOMAINx Specifies the domains you want Backup Exec to search for new resources. You can also specify the logon account GUID for the domain. If logon account credentials are not entered, the current logged on users default logon account is used. Each entry must be comma delimited string. For example, DOMAIN1, DOMAIN2 or DOMAIN1=domain1, {10011001-1001-1001-0101-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. Entry Description
[Schedule] SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in mm/dd/yyyy format, that the schedule becomes effective. Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format.
SCHED_STARTTIME=HH:MM:SS
SCHED_ENDTIME=HH:MM:SS
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.
134
Administrators Guide
Using Job Script Files Possible discovery job script file entries (continued) Section Entry SCHED_REPEAT_INTERVAL=x Description Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date, in mm/dd/yyyy format, from which the interval is calculated. Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3 SCHED_INCLUDEDATEx=MM/DD/YYYY Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002
SCHED_ANCHOR=MM/DD/YYYY
SCHED_DAYSOFMONTH=x
Command Line
135
Using Job Script Files Possible discovery job script file entries (continued) Section Entry SCHED_EXCLUDEDATEx=MM/DD/YYYY Description Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in mm/dd/yyyy format. If schedule values are not entered, then the DATE==MM/DD/YYYY and TIME=hh:mm:ss entries will be used to set the Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter 1 to run the catalog job immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set 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. To specify hours, enter a value divisible by 60. Enter 1 if you want the job to be submitted on hold; otherwise, enter 0.
TIME=hh:mm:ss
HOLD=0 or 1
136
Administrators Guide
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.
Command Line
137
Using Job Script Files Possible duplicate job script file entries Section [General] JOB_TYPE=Job type This entry must be completed with a value of Setcopy. Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Options are: Lowest Low Medium High Highest JOB_NAME=Job name Type the name of the duplicate job. If a name is not provided, one will automatically be generated. Type a description of the information you are backing up. Enter the GUID of the device used as the destination device for the original backup job. Use operation -o63 to display managed drives. Type the name of the Backup Exec server where the operation is to be performed. If a server is not specified, the local server is used by default. Type the user name for logging into a remote Backup Exec server. If a user name is not specified, the current user name is used. Entry Description
JOB_PRIORITY=Priority
JOB_DESCRIPTION=Description
SERVER=Server name
USERNAME=Username
138
Administrators Guide
Using Job Script Files Possible duplicate job script file entries (continued) Section Entry PASSWORD=Password Description Enter the password for logging into a remote Backup Exec server. If a password is not specified, the current password is used.
[Setcopy_Options] DEVICE_NAME=Device name Type the name of the device to be used for the duplicate job. Enter the name of the media set to be used for the duplicate job. Use operation -o69 to display media sets. Enter 1 as the value if you want Backup Exec to overwrite a duplicate job if one exists; otherwise, enter 0. 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. 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. Enter 1 to have Backup Exec automatically eject the media in the drive when the operation completes. 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.
OVERWRITE_MEDIA=0 or 1
APPEND_OVERWRITE=0 or 1
APPEND_TERMINATE=0 or 1
EJECT _MEDIA_AFTER_COMPLETES=0 or 1
CHECKSUM=0 or 1
Command Line
139
Using Job Script Files Possible duplicate job script file entries (continued) Section Entry RETENSION_MEDIA=0 or 1 Description Enter 1 to retension the media before backup; otherwise, enter 0. If the media has a password, specify the password. Enter 1 to have Backup Exec automatically perform a verify operation to make sure the media can be read after the backup has been completed; otherwise, enter 0. Enter 1 to select hardware compression; otherwise, enter 0.
MEDIA_PASSWORD=Media password
AUTO_VERIFY=0 or 1
COMPRESSION_TYPE=0 or 1
[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] SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in mm/dd/yyyy format, that the schedule becomes effective. Enter the start time in HH:MM:SS format for this job. Enter the latest time this job can start in HH:MM:SS format.
SCHED_STARTTIME=HH:MM:SS
SCHED_ENDTIME=HH:MM:SS
140
Administrators Guide
Using Job Script Files Possible duplicate job script file entries (continued) Section Entry Description
SCHED_RESTART_INTERVAL=HH:MM:SS Enter the interval in HH:MM:SS format for the job to restart on each run day. For example, if you have set up the job to run every seven days, you can also set it up to run every four hours on its run day by entering SCHED_RESTART_INTERVAL=04:00: 00. 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. Enter the date, in mm/dd/yyyy format, from which the interval is calculated. Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3
SCHED_ANCHOR=MM/DD/YYYY
SCHED_DAYSOFMONTH=x
Command Line
141
Using Job Script Files Possible duplicate job script file entries (continued) Section Entry SCHED_INCLUDEDATEx=MM/DD/YYYY Description Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in mm/dd/yyyy format. If schedule values are not entered, then the DATE==MM/DD/YYYY and TIME=hh:mm:ss entries will be used to set the Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter 1 to run the catalog job immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set to 1, the job will be created but not scheduled
TIME=hh:mm:ss
142
Administrators Guide
Using Job Script Files Possible duplicate job script file entries (continued) Section Entry AUTO_CANCEL_TIME=# Description Enter the number of minutes after which the job is canceled if it is not completed. Backup Exec starts timing the job when the job is queued, not when the job begins. To specify hours, enter a value divisible by 60. Enter 1 if you want the job to be submitted on hold; otherwise, enter 0.
HOLD=0 or 1
Command Line
143
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..
144
Administrators Guide
Using Job Script Files Possible test run job script file entries Section [General] JOB_TYPE=Job type This entry must be completed with a value of TestRun. Enter the priority for the job. If another job is scheduled to run at the same time as this job, the priority determines which job runs first. If a priority is not entered, the priority will be Medium. Options are: Lowest Low Medium High Highest JOB_NAME=Job name Type the name of the duplicate job. If a name is not provided, one will automatically be generated. Type the name of the Backup Exec server where the operation is to be performed. If a server is not specified, the local server is used by default. Type the user name for logging into a remote Backup Exec server. If a user name is not specified, the current user name is used. Enter the password for logging into a remote Backup Exec server. If a password is not specified, the current password is used. Entry Description
JOB_PRIORITY=Priority
SERVER-Server name
USERNAME=Username
PASSWORD=Password
[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.
Command Line
145
Using Job Script Files Possible test run job script file entries (continued) Section Entry APPEND_OVERWRITE=0 or 1 Description 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. 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. Enter 1 to have Backup Exec automatically eject the media in the drive when the operation completes. Enter 1 as the value if checksums are to be calculated for each data stream written to tape, and then written in a separate stream immediately following the data stream. If 0 is entered as the value, backup performance may be improved, but there will be no way to verify the integrity of the data on the tape. Enter 1 to retension the media before backup; otherwise, enter 0. If the media has a password, specify the password. Enter 1 to have Backup Exec automatically perform a verify operation to make sure the media can be read after the backup has been completed; otherwise, enter 0. Enter 1 to select hardware compression; otherwise, enter 0.
APPEND_TERMINATE=0 or 1
EJECT _MEDIA_AFTER_COMPLETES=0 or 1
CHECKSUM=0 or 1
RETENSION_MEDIA=0 or 1
MEDIA_PASSWORD=Media password
AUTO_VERIFY=0 or 1
COMPRESSION_TYPE=0 or 1
146
Administrators Guide
Using Job Script Files Possible test run job script file entries (continued) Section [Selections] JOBINSTANCE_GUID=Job GUID Specifies the job ID of the existing job to use for the test run job. Enter 1 to verify that the logon account is correct for the resources being backed up; otherwise, enter 0. Enter 1 to test whether enough tape is available to complete the job; otherwise, enter 0. Note During the test run job, the number of scheduled jobs in the queue is not checked; therefore, jobs that are scheduled before the test run job may use the media that was available when the test run job was performed. MEDIA_CHECK=0 or 1 Enter 1 to test whether the media is online and overwritable for a trial run job; otherwise, enter 0. Enter 0 if you want to determine job size from a previous job history, or enter a 1 if you want to perform a pre-scan. Enter 1 to have the scheduled job placed on hold if any failures are detected during the test run; otherwise, enter 0. Entry Description
CREDENTIALS_CHECK=0 or 1
MEDIA_CAPACITY_CHECK=0 or 1
JOBSIZE_METHOD=0 or 1
HOLD_ON_FAILURE=0 or 1
[Schedule] SCHED_EFFECTIVE=MM/DD/YYYY Enter the date, in mm/dd/yyyy format, that the schedule becomes effective. Enter the start time in HH:MM:SS format for this job.
SCHED_STARTTIME=HH:MM:SS
Command Line
147
Using Job Script Files Possible test run job script file entries (continued) Section Entry SCHED_ENDTIME=HH:MM:SS Description 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. 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. Enter the date, in mm/dd/yyyy format, from which the interval is calculated. Enter the days of the month you want the job to run in a comma delimited string. The value is 1 through 32 with 32 being the last day of the month. For example, to run the job on the first and 15th of the month, type: SCHED_DAYSOFMONTH=1,15 SCHED_DAYSOFWEEK=x Enter the day of the week, a forward slash, and the week of the month you want the job to run in a comma delimited string. Enter a value of 1-7 for the day of the week with 1 equaling Sunday, 2 equaling Monday, and so on. For the week of the month, values can be 1 for the first week, 2 for the second week, 3 for the third week, 4 for the fourth week, and 5 for the last week. For example, to run the job on Sunday for the first three weeks of the month, type: SCHED_DAYSOFWEEK=1/1,1/2,1/3
SCHED_ANCHOR=MM/DD/YYYY
SCHED_DAYSOFMONTH=x
148
Administrators Guide
Using Job Script Files Possible test run job script file entries (continued) Section Entry SCHED_INCLUDEDATEx=MM/DD/YYYY Description Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to run the job on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in mm/dd/yyyy format. If schedule values are not entered, then the DATE==MM/DD/YYYY and TIME=hh:mm:ss entries will be used to set the Enter the start time for the job in hh:mm:ss format. Note The hour, minutes, and seconds must be separated by colons. RUN_IMMEDIATE=0 or 1 Enter 1 to run the catalog job immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set to 1, the job will be created but not scheduled
TIME=hh:mm:ss
Command Line
149
Using Scripts and Selection Lists Possible test run job script file entries (continued) Section Entry AUTO_CANCEL_TIME=# Description Enter the number of minutes after which the job is canceled if it is not completed. Backup Exec starts timing the job when the job is queued, not when the job begins. To specify hours, enter a value divisible by 60. Enter 1 if you want the job to be submitted on hold; otherwise, enter 0.
HOLD=0 or 1
150
Administrators Guide
Command Line
SUBDIRSx-0 or 1
Enter a value of 1 if you want to include all subdirectories; otherwise, enter 0. 151
Using Scripts and Selection Lists Values for selection list script (continued) Section Entry EXCHANGEx=Exchange Server name Description Change x to a unique number and specify the name of the Exchange Server you want to back up. Change x to a unique number and specify the name of the SQL Server you want to back up.
EXCH2ROOTx=Exchange 2000 Server Specifies the name of the Exchange name 2000 Server that contains this selection. Change x to a number that corresponds to the number of the selection. The selections must be in a sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. Each selection must specify at least the server name and the storage group. See the example in EXCH2DB?=Exchange 2000 Server database name on page 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.
152
Administrators Guide
Using Scripts and Selection Lists Values for selection list script (continued) Section Entry EXCH2DBx=Exchange 2000 Server database name Description 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. EXCH2ROOT1=SERVER_NAME EXCH2SG1=First Storage Group EXCH2ROOT2=SERVER_NAME EXCH2SG2=Second Storage Group EXHC2DB2=Mailboxes EXCH2ROOT3=SERVER_NAME EXCH2SG3=Second Storage Group EXHC2DB3=Users SQL2S?=SERVER_NAME Specifies the name of the SQL Server 2000 that contains this selection. Change ? to a number that corresponds to the number of the selection. The selections must be in sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. See the example in SQL2NI?=SQL Server 2000 named instance name.
Command Line
153
Using Scripts and Selection Lists Values for selection list script (continued) Section Entry SQL2DB?=SQL Server 2000 database name Description 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. 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.
154
Administrators Guide
Using Scripts and Selection Lists Values for selection list script (continued) Section Entry LNDRIVE?=DRIVE_LETTER Description Change ? to the same number used to identify the selection for the Lotus Notes server. In the following example, SERVER_NAME is a Lotus Notes server name, and it is the same server in all of the selections. To back up the D drive and the E drive on the Lotus Notes server SERVER_NAME, the entries would be: LNSERVER1=SERVER_NAME LNDRIVE1=D LNSERVER2=SERVER_NAME LNDRIVE2=E ORCLSRV?=SERVER_NAME Specifies the name of the Oracle server that contains this selection. Change ? to a number that corresponds to the number of the selection. The selections must be in sequential order. Increase the number by one for each new selection. For example, the first selection would be 1, the second selection would be 2, etc. If the selections are out of sequence, they are not processed. See the example name in ORCLSID?=System identifier for database.
Command Line
155
Using Scripts and Selection Lists Values for selection list script (continued) Section Entry ORCLSID?=System identifier for database Description Specifies the SID (System Identifier) for the Oracle database you want to back up. Change ? to the same number used to identify the selection for the Oracle server. In the following example, SERVER_NAME is an Oracle server name, and it is the same server in all of the selections. To back up the databases SID1 and SID2 on the Oracle server, the entries would be ORCLSRV1=SERVER_NAME ORCLSID1=SID1 ORCLSRV2=SERVER_NAME ORCLSID2=SID2 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. Enter the beginning date when the selection list should be available to be backed up in mm/dd/yyyy format. The list will be available every day from this date onward. Enter the earliest time when the selection list will be available for backup in HH:MM:SS format.
EFFECTIVEDATE=MM/DD/YYYY
STARTTIME=HH:MM:SS
156
Administrators Guide
Using Scripts and Selection Lists Values for selection list script (continued) Section Entry ENDTIME=HH:MM:SS Description 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 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 This operation is only available if the Central Admin Server Option (CASO) is installed. Specify the media server pool to use for the backup job.
Command Line
157
Using Scripts and Selection Lists Values for selection list script (continued) Section Entry APATHx=String Description 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 AALIAS1=\\MachineB\D$ indicates that \\MachineA\C$\*.* and all its subdirectories should be backed up and aliased as \\MachineB\D$. Alias jobs support both UNC and local devices. However, both the target and the source must be the same, either both UNC or both local devices. You cannot mix them. 158 Administrators Guide
Using Scripts and Selection Lists Values for selection list script (continued) Section Entry AINCLUDEx=0 or 1 Description 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. Change x to a unique number for each device aliasing backup selection. 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. Change x to a unique number for each device aliasing backup selection. For example: AALIAS1=\\MachineB\D$ See also the example for APATHx=String
Command Line
159
-o260
Executes a policy based on the contents of a file. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the name of the policy script file to be executed.
-fpolicy file
-o261
Delete a policy
Deletes the specified policy. Returns 1 if the command is successful or -1 if it failed. Required. Specifies the ID or the name of the policy to be deleted.
-o263
Displays the number of policies created on a computer. Returns a 1 if the command succeeds or a -1 if the command fails. If -tl: or -r is specified, -i or -j is required Instructs Backup Exec to display policy IDs. Instructs Backup Exec to display policy name. Instructs Backup Exec to display templates for the specified policy ID or policy name. Instructs Backup Exec to display templates rules for the specified policy ID or policy name.
-i -j -tl:
-r
160
Administrators Guide
Using Policy Commands Policy Commands (continued) Operation Additional Switches Function Description
-o264
Applies the specified policy to selection lists. The selection list IDs or names must be separated by a comma. Returns a 1 if the command succeeds or a -1 if the command fails. Required. Specifies the ID or name of the policy to apply to the selection list. Required. Specifies the selection list IDs or names to apply to the policy.
-ipolicy ID or -j:policy name -siselection list IDs or -j:selection list names -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. Required. Specifies the selection list IDs or names to apply to the policy.
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.
Command 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:
161
Policy file values Section [General] NAME Required. Specifies the name of the policy being created. Specifies a description of the policy being created. Entry Description
DESCRIPTION
[Template] NAMEx=Name of template Required. Specifies the name of the template. Multiple entries can be entered. For example, NAME1=, NAME2=ID, and so on. Required. Specifies the name of a file that contains a job template. Note The FILEx entry is not required for Export media templates. 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.
162
Administrators Guide
Using Policy Commands Policy file values (continued) Section Entry RULE_SECOND_TEMPLATEx=Name of second template Description Specifies the name of the template in the [Template} section with the lowest precedence. 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.
RULE_TYPEx=0-8, or 10
Command Line
163
Using Policy Commands Policy file values (continued) Section Entry Description Rules to limit when jobs run: 8 - <First Template> must complete at least once before any other templates will be allowed to start. 11 - Run <First Template> only once. Rules to export media: 10 - After <First Template> completes, start <Second Template> to export media.
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.
164
Administrators Guide
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"
SCHED_ENDTIME=HH:MM:SS
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.
Command Line
165
Using a Schedule Script with Device and Media Operations Values for schedule script file (continued) Section Entry SCHED_REPEAT_INTERVAL=X Description Enter the interval in days in which the job is to run. For example, if you want the job to run every seven days, enter SCHED_REPEAT_INTERVAL=7. Enter the date, in mm/dd/yyyy format, from which the interval is calculated. Enter the date, in mm/dd/yyyy format, that the schedule becomes effective. Enter the days of the month you want the job to run in a comma delimited string. 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_ANCHOR=MM/DD/YYYY
SCHED_EFFECTIVE=MM/DD/YYYY
SCHED_DAYSOFMONTH
166
Administrators Guide
Using a Schedule Script with Device and Media Operations Values for schedule script file (continued) Section Entry SCHED_INCLUDEDATEx=MM/DD/YYYY Description Enter a specific date when the job should run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, if you want the job to run on the first and 15th of August, type: SCHED_INCLUDEDATE1=08/01/2002 SCHED_INCLUDEDATE2=08/15/2002 SCHED_EXCLUDEDATEx=MM/DD/YYYY Enter a specific date, such as a holiday, when the job should not run. For this field, x is a number starting at 1, which allows you to specify multiple dates. For example, if you want to prevent the job from running on the first and 25th of August, type: SCHED_EXCLUDEDATE1=08/01/2002 SCHED_EXCLUDEDATE2=08/25/2002 DATE=MM/DD/YYYY Enter the start date for the job in mm/dd/yyyy format. Note The start date month, day, and year must be separated by forward slashes. 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.
Command Line
167
Using a Schedule Script with Device and Media Operations Values for schedule script file (continued) Section Entry INTERVAL_MINUTES=# Description 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. 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.
168
Administrators Guide
Using a Schedule Script with Device and Media Operations Values for schedule script file (continued) Section Entry INTERVAL_DAYS=# Description If a number is specified, the job is scheduled to run every specified number of days. Note Only one of the INTERVAL values should be specified. For example, if you specify a value for INTERVAL_MINUTES, do not specify a value for INTERVAL_HOURS, INTERVAL_DAYS, or INTERVAL_WEEKS. Also, use either one of the INTERVAL values, or the WEEKS and WEEKDAYS, or the DAYS, or the DAYS_OF_MONTH entries. Unless specifically noted, these scheduling options should not be used in conjunction with each other. INTERVAL_WEEKS=# If a number is specified, the job is scheduled to run every specified number of weeks. Note Only one of the INTERVAL values should be specified. For example, if you specify a value for INTERVAL_MINUTES, do not specify a value for INTERVAL_HOURS, INTERVAL_DAYS, or INTERVAL_WEEKS. Also, use either one of the INTERVAL values, or the WEEKS and WEEKDAYS, or the DAYS, or the DAYS_OF_MONTH entries. Unless specifically noted, these scheduling options should not be used in conjunction with each other.
Command Line
169
Using a Schedule Script with Device and Media Operations Values for schedule script file (continued) Section Entry WEEKS=FIRST,SECOND,THIRD, FOURTH,LAST or WEEKS=1,2,3,4,5 Description 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. 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.
WEEKDAY=SUN/MON/TUES/WED/ THU/FRI/SAT
170
Administrators Guide
Using a Schedule Script with Device and Media Operations Values for schedule script file (continued) Section Entry DAY_OF_MONTH=# Description If this entry is included in the Backup Job Script File, the backup job will be scheduled for the indicated day of the month. The value can range from 1 to 31. Only one number can be specified. Note Do not use this entry in conjunction with the INTERVAL entries, the WEEKS, or the DAYS entries. RUN_IMMEDIATE=0 or 1 Enter a value of 1 if the job is to run immediately; otherwise, enter 0. Note This entry should be used only if no other entries are specified under the schedule section. If no other scheduling options have been selected and this entry is not set to 1, the job will be created but not scheduled. AUTO_CANCEL_TIME=XMINUTES/HOURS Enter a number and select either MINUTES or HOURS to specify to cancel a job if not completed with the selected time. HOLD=0 or 1 Enter 1 if you want the job to be submitted on hold; otherwise, enter 0.
Command Line
171
JOB_STATE_NOT_IN_WINDOW = 10
172
Administrators Guide
Understanding Job Status Messages Possible job statuses (continued) Job Status Code JOB_STATE_RESUMED = 15 Description During startup, Backup Exec detected that a job was active when the server was shut down, and that the Checkpoint restart option was enabled for this job. The job history log has been marked JOB_STATE_RESUMED, the job has been scheduled to restart immediately, and the job flag has been set to indicate checkpoint restart. The job is currently running on the server. The job is eligible for dispatch. The job has a due date in the future. The job has been completed successfully. The job is ready, but another higher precedence task is eligible to run.
JOB_STATE_THRESHOLD_AUTO_ABORT The job was canceled because it was not completed = 21 within the number of hours or minutes that were set for the Enable automatic cancellation option on the job schedule. JOB_STATE_TO_BE_SCHEDULED = 22 JOB_STATE_LINKED_JOB = 23 The job needs to have the due date calculated. The job is linked to another job, and will not start until that job is finished.
Command Line
173
174
Administrators Guide
Index
A administrating jobs using command line applet 26 alert switches for command line applet 32 alerts using command line applet 32 alias backup, in backup job script file 21, 105, 158 B Backup Exec services commands 60 managing using command line applet 60 backup job alias backup in script file 21, 105, 158 creating using command line applet 8 creating using script file 81 running from command line 8 script file, creating and using 81 switches for command line applet 8 using command line applet to back up server drive 12 backup job script file creating 81 bemcmd command, in command line applet 4 bjscript.txt 81 bjtemplatescript.txt 164 C catalog job creating using script file 126 script file, creating and using 126 catalog job script file creating 126 catalogscript.txt 81 clone, using alias backup for a 21, 105, 158 command line applet administrating jobs 26 alert switches 32 alias backup 21, 105, 158 backup job switches 8 bemcmd command 4 defined 3 error-handling rules 37 job status messages 172 logon account switches 61 managing Backup Exec services 60 managing devices 38 media management switches 38 online help 6 report switches 63 requirements 4 restore job switches 31 script files 81 setting default options 65 switches for administrating jobs 26 using 4 command line switches, used with all operations 6 D default options setting using command line applet 65 devices managing using command line applet 38 discovery job creating using script file 131 script file, creating and using 131 discovery job script file creating 131 discoveryscript.txt 81 djscript.txt 81 djtemplatescript.txt 164 duplicate backup job creating using script file 137 script file, creating and using 137 duplicate job 1
creating using script file 137 duplicate job script file creating 137 E error-handling rules using command line applet 37 Exchange Server Agent, backing up command line for Exchange 2000 15 using for backup job 13 J job script file, saving and launching 150 job monitor command line switches 26 job priority specifying using command line applet 8 job status messages, descriptions 172 L logon accounts command line applet switches 61 Lotus Domino Agent backup job script method, using 88 command line, using for backup 18 M media managing using command line applet 38 mirror, using alias backup for split mirror 21, 105, 158 O Oracle Agent, backing up command line, using for backup 19 P policy job creating using script file 160 script file, creating and using 160 policy job script file creating 160
policy values Command Line applet 162 R reports using command line applet 63 restore job creating using script file 107 running from command line 31 script file, creating and using 107 restore job script file creating 107 rjscript.txt 81 S schedule script file using with device and media operations 165 values 165 selection lists creating using script file 150 script file using in command line applet 150 values for 151 sftemplatescript.txt 164 SharePoint Portal Server command line, backing up from 17 SQL 2000, backing up command line 16 SQL 7.0, backing up command line 14 command line, using for standby or recover 17 T test run job creating using script file 144 script file, creating and using 144 test run script file creating 144 testrunscript.txt 81