bews cli 275538

8/9/2019 BEWS CLI 275538

1/180

September 2004

VERITASTM Backup Exec for

Windows Servers

Command Line Applet

8/9/2019 BEWS CLI 275538

2/180

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 SoftwareCorporation shall not be liable for errors contained herein or for incidental or consequential damagesin 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 ofVERITAS Software Corporation. VERITAS, VERITAS Backup Exec for Windows Servers, the VERITASlogo, Reg. U.S. Pat. & Tm. Off. Other product names and/or slogans mentioned herein may betrademarks or registered trademarks of their respective companies.

VERITAS Software Corporation350 Ellis StreetMountain View, CA 94043USAPhone 6505278000 Fax 6505272908www.veritas.com

Third-Party Copyrights

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

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

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

Apache Software Foundation

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

Apache Software License

Version 1.1

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

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

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

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

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

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

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

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

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

8/9/2019 BEWS CLI 275538

3/180

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 OFTHE 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 informationon the Apache Software Foundation, please see . Portions of this software are based upon public domain softwareoriginally 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 FAR12.212 and DFARS 227.7202 and by a license agreement. Contact: Crystal Decisions, Inc., Attn: Contrcts Department, 895 Emerson Street, Palo Alto,CA 94301.

Nebiru Software Inc. (dba DomAPI)DomAPI LIbrary 5.0 Copyright 2001-2003

Boris Fornitchev

STLPort 3.2.1

Copyright 1999,2000 Boris Fomitchev

This material is provided "as is", with absolutely no warranty expressed or implied. Any use is at your own risk. Permission to use or copy thissoftware for any purpose is hereby granted without fee, provided the above notices are retained on all copies. Permission to modify the code andto 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 aremet; (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, providedthat the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supportingdocumentation. 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 ishereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permissionnotice appear in supporting documentation. Silicon Graphics makes no representations about the suitability of this software for any purpose. It isprovided "as is" without express or implied warranty. Permission to use, copy, modify, distribute and sell this software and its documentation forany purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice andthis permission notice appear in supporting documentation. Moscow Center for SPARC Technology makes no representations about the suitabilityof this software for any purpose. It is provided "as is" without express or implied warranty.

Carnegie Mellon University and The Regents of the University of California

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

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

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

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

8/9/2019 BEWS CLI 275538

4/180

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 allmaterial 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 anyparticular 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 thepackage.

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

mars.cpp - Copyright 1998 Brian Gladman.

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

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

Joan Daemen - 3way.cppLeonard Janke - cast.cpp, seal.cppSteve Reid - cast.cppPhil Karn - des.cppMichael Paul Johnson - diamond.cppAndrew M. Kuchling - md2.cpp, md4.cpp

Colin Plumb - md5.cpp, md5mac.cppSeal Woods - rc6.cppChris Morgan - rijndael.cppPaulo Baretto - rijndael.cpp, skipjack.cpp,square.cppRichard De Moliner - safer.cppMatthew Skala - twofish.cpp

Permission to use, copy, modify, and distribute this compilation for any purpose, including commercial applications, is hereby granted withoutfee, 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 abovecopyright 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 copyrightedunless 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 noobligation to provide any services, by way of maintenance, update, or otherwise. THE SOFTWARE AND ANY DOCUMENTATION AREPROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL WEI DAI OR ANY OTHER CONTRIBUTOR BELIABLE 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 thoseparts.

If this compilation is used in object code form in an application software, acknowledgement of the author is not required but would beappreciated. 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.

8/9/2019 BEWS CLI 275538

5/180

1

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

8/9/2019 BEWS CLI 275538

6/180

8/9/2019 BEWS CLI 275538

7/180

3

Command

Line

VERITAS Backup Exec - Command Line

Applet

The Backup Exec Command Line Applet is a convenient way to access some of the mostuseful features of Backup Exec from a command prompt. The Command Line Appletallows management of only one media server at a time, but allows for remotemanagement of media servers within an enterprise. However, if the Central Admin ServerOption (CASO) is installed, you can administer all servers managed by the centraladministration server.

Backup Exec must be installed and running on a media server in order for the CommandLine Applet to target it, but the Command Line Applet does not have to be run from a

media server. The Command Line Applet uses functional command switches typed in acommand prompt window to perform most Backup Exec functions and utilities.

Updating Scripts for Use with Command Line Applet 10.0

This release of the Backup Exec Command Line Applet provides improved output fromcommand switches and includes support for new features and capabilities in BackupExec.

VERITAS strongly recommends that you use the latest release of the Command LineApplet. You may need to update existing job scripts to take advantage of the improvedcommand switch output. While you update and test your job scripts with Backup ExecCommand Line Applet 10.0, you can continue to use the previous version of theCommand Line Applet, version 9.1.

Backup Exec Command Line Applet version 9.1 is installed with Backup Exec 10.0 forWindows Servers as bemcmd91.exe. The latest Command Line Applet version continuesto be installed as bemcmd.exe.

8/9/2019 BEWS CLI 275538

8/180

8/9/2019 BEWS CLI 275538

9/180

5

Using Command Line Switches

Command

Line

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 orrewind 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 limitationis that the Command Line Applet can target a device pool, but not a specific devicein that device pool.


To use the Command Line Applet on your computer, type the appropriate command lineswitch and any additional information required. For example, to run a previously created

backup job named Operations Weekly, type the following at the command prompt:

bemcmd -o1 -j"Operations Weekly"

In this example, -o1 is the operation to submit the backup job. The command line switch -jspecifies the name of the backup job. Because the job name contains spaces, quotation

marks are required around the job name.The job Operations Weekly was previously created through the Backup Execadministration console. By default, the backup will be done on the computer where theCommand Line applet is executed.

To run this same job on a remote computer named Genesis, type the following at thecommand prompt:

bemcmd -cGenesis -o1 -j"Operations Weekly"

The command line switch -c specifies the name of the media server where the job is to berun.

8/9/2019 BEWS CLI 275538

10/180


6 Administrators Guide

When connecting to a remote server, if you are required to provide a user name andpassword, 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 theswitch contains more than one letter a colon must appear immediately after the switch orthe switch itself must be enclosed in quotation marks. Switches that consist of only asingle 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 thestatus of the job submission by including the Verbose Output command lineswitch -v.

Substitute the text that appears in italics next to the command, such as job name, with avalue, such as the correct job name.

For commands using Job IDs, this version of Backup Exec uses a globally unique identifier(GUID) in a 16-byte hex string format for each job.

Note Command line switches appearing in BOLD are required.

Switches Used With All Operations

The following command line switches can be used with all operations.

Command line switches for all operations

Item Description

-? Displays help on all command line operations.

-?operation number-? -ooperation number

-ooperation number -?

Displays help about a command line operation.

-cmedia server Specifies the name of the media server where the operation is to beperformed. If a media server name is not specified, the localcomputer name is used by default.

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

8/9/2019 BEWS CLI 275538

11/180

7


Command

Line

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

-nuser name Specifies the user name credential for logging on to a remoteBackup Exec server. If a user name is not specified, the currentcredential is used.

-ppassword Specifies the password credential for logging on to a remoteBackup Exec server. If a password is not specified, the currentpassword credential is used.

-tBackup Exec servertype

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

To specify a NetWare server, type -tNW. This switch functions as anExecView client for Backup Exec for NetWare Server versions 8.0,

8.5, and 9.0. The Backup Exec for NetWare Server must also haveExecView enabled.

To specify a Windows server, type -tNT.

-v Displays information detailing what has occurred while runningthe Command Line Applet and the specified option. Thiscommand is useful when tracing the sequence of events using thecommand line applet.

-w Waits for the job to complete before exiting the program. Thisswitch can be used with options -o1 through -o9, -o17, -o18,-o19,-o42, -o46, -o80, -o81, -o90, -o100, -o103, -o104, -o105, -o111through -o115, and -o117. The commands with switch -w returns a1 if successful or -1 on failure.

Command line switches for all operations

Item Description

8/9/2019 BEWS CLI 275538

12/180



Backup Job Switches

You can run a previously created job or submit a new backup job using the commandspresented in the following table. You can also create a backup job script file that theCommand Line Applet can use instead of command line switches.

Backup Job Commands

Operation AdditionalSwitches

Function Description

-o1 Run backup job Runs a backup job that has been previouslydefined. Returns a job instance ID. Alsoreturns a 1 if the command succeeds or a -1 ifthe command fails.

-jjob name or-ijob ID

Required. Specifies the name or the job ID ofthe previously defined job that Backup Execshould run.

Note If there are jobs with the same name,only one of the jobs will run. To ensurethat the correct job runs, you should usethe job ID instead of the job name tospecify which job will run.

-pr:priority Specifies the priority for the job. Priorityoptions include:

Highest High

Medium

Low

Lowest

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

-w Wait for jobcompletion

Instructs the Command Line Applet to waitfor the operation to complete beforereturning.

-o2 Create backupjob

Creates and runs a backup job for a specifiedlist of files. This operation returns a jobinstance ID. Also returns a 1 if the commandsucceeds or a -1 if the command fails.

8/9/2019 BEWS CLI 275538

13/180

9


Command

Line

-jjob name Required. Specifies the name Backup Execwill assign to this job.

-ddevice name Specifies the name of the device Backup Execshould use for backup. When backing up aremote server, the device name will be the

name of the remote server.

-sd:device name Use this switch instead of the -d switch toindicate that this device name should bechecked against the devices (and devicepools) on the target server, and the job shouldonly run if the device exists. If the device doesnot exist, and if the -v (verbose) switch isused, the following message appears: Deviceor Device Pool specified does not exist.

-si:server ID or-pi:pool ID

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


Highest

High

Medium

Low

Lowest


Backup Job Commands (continued)

Operation Additional

Switches


8/9/2019 BEWS CLI 275538

14/180



-sfile list or-sf:file name

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

The list should be comma delimited.Selections that end with a backslash indicatethe selection is a directory. Selections that do

not end with a backslash indicate the selectionis a file.

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

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

By default, subdirectories will be recursed; toskip subdirectories during backup, thecharacters /n should appear before thecomma separating the entries, and the lastquotation mark. Include a space between thelist 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 thecomma separating the entries, and the lastquotation mark. If the sudirectories areskipped during backup, the /n charactersmust precede the /u characters. If the /ncharacters are in the entry, include a space

between the list of files and the /n entry. Forexample, "c:\winnt\*.* /n/u".

The order in which resource selections arespecified is the order in which the resourceswill be backed up. Note the following aboutthe order in which selections can be backedup:



Switches


8/9/2019 BEWS CLI 275538

15/180

11


Command

Line

You can order resources within a server,but you cannot alternate selections acrossservers. For example, you can select C:and D: from Server A followed byselections from Server B. However, youcannot 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 orshadow copy components must beordered last.

-mmedia set Specifies the name of the media set BackupExec should target.

-mp:mediaprotection

level

Specifies the media protection level:

0 = Overwrite

1 = Append to media, overwrite if notavailable

2 = Append to media, terminate if notavailable

-r Replace existingjob Instructs Backup Exec to replace a previouslydefined job with this new one. You can replacea job that was created either through thecommand line or the Backup Execadministration console, as long as that job hasalready been created and saved.


Instructs the Command Line Applet to waitfor the operation to complete before

returning.

-e or -ef:filename

Specifies a list of items or the name of a filethat contains a list of items to exclude fromthe backup job.

-rl: List of serverand logon

accounts

Specifies the server name and logon accountGUIDs.



Switches


8/9/2019 BEWS CLI 275538

16/180



-rf: File name ofserver and logonaccounts

Specifies the name of the file that contains theserver name and logon account GUIDs. Eachentry must be typed on a separate line.

-o3 Back up serverdrive

Creates and runs a backup job to back up thespecified drive on the media server. Returns a

job instance ID. Also returns a 1 if thecommand succeeds or a -1 if the commandfails.

-jjob name Specifies the name that Backup Exec willassign to this job.

-ddrive name Specifies the drive letter of the drive thatBackup Exec should backup. If no drive letteris specified, the job will default to C: drive.When backing up a remote server, the devicename will be the name of the remote server.



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

options include: Highest

High

Medium

Low

Lowest

If this switch is absent, the priority will be set

as Medium.

-r Replace existingjob

Instructs Backup Exec to replace a previouslydefined job with this new one. You can replacea job that was created either through thecommand line or the Backup ExecAdministration Console, as long as that jobhas already been created and saved.



Switches


8/9/2019 BEWS CLI 275538

17/180

13


Command

Line



-o4 Back upExchange server

This operation is not for Exchange 2000. If youare running Exchange 2000, use operation -o6.

Creates and runs a backup job to back up theMicrosoft Exchange Server on the mediaserver. Returns a job instance ID. Also returnsa 1 if the command succeeds or a -1 if thecommand fails.

Note While individual mailboxes cannot beselected for backup, all mailboxes areincluded in a server backup.

The Agent for Microsoft ExchangeServer must be enabled on the BackupExec server in order to back up theExchange Server.





Highest

High

Medium Low

Lowest




Switches


8/9/2019 BEWS CLI 275538

18/180




Instructs Backup Exec to replace a previouslydefined job with this new one. You can replacea job that was created either through theCommand Line Applet or the Backup ExecAdministration Console, as long as that jobhas already been created and saved.



-o5 Back up SQLserver

This option is not for SQL 2000. If you arerunning 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 ifthe command succeeds or a -1 if the commandfails.

Note Although individual tables and filegroups cannot be selected for backup,all subcontainers except for the masterfilegroup are included in a server

backup.

The Agent for Microsoft SQL Servermust be enabled on the Backup Execserver in order to back up a SQL Server.


-lo:databasemode

Specifies the log backup option.

-db:databasename

Specifies the name of a database to back up.





Switches


8/9/2019 BEWS CLI 275538

19/180

15


Command

Line


Highest

High

Medium

Low Lowest



Instructs Backup Exec to replace a previouslydefined job with this new one. You can replacea job that was created either through the

command line or the Backup ExecAdministration Console, as long as that jobhas already been created and saved.



-o6 Back upExchange 2000server

Creates and runs a backup job for Exchange2000 Server. Returns a job instance ID. Alsoreturns a 1 if the command succeeds or a -1 ifthe command fails.

Note The Agent for Microsoft ExchangeServer must be enabled from the mediaserver in order for this command towork.


-sg:storagegroup

Required. Specifies the storage group to backup.





Switches


8/9/2019 BEWS CLI 275538

20/180




Highest

High

Medium

Low Lowest




Command Line Applet or the Backup ExecAdministration Console, as long as that jobhas already been created and saved.



-o8 Back up SQLServer 2000

Creates and runs a backup job for SQL Server2000. Returns a job instance ID. Also returns a1 if the command succeeds or a -1 if thecommand fails.

Note The Agent for Microsoft SQL Servermust be enabled on the media server inorder for this command to work.

-jjob name Specifies the name that Backup Exec will

assign to this job.

-db:databasename

Specifies the name of the database to back up.

-ni:namedinstance

Specifies the named instance to back up.

-si:server ID or-pi:pool ID Specifies a preferred server ID or media serverpool ID for the job.



Switches


8/9/2019 BEWS CLI 275538

21/180

17


Command

Line


Highest

High

Medium

Low Lowest




command line or the Backup ExecAdministration Console, as long as that jobhas already been created and saved.



-lo:databasemode

Places a Microsoft SQL Server database ineither 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 loadingstate.

-o9 Back upSharePointPortal Server

Creates and runs a backup job for theMicrosoft SharePoint Portal Server. Returns ajob instance ID. Also returns a 1 if thecommand succeeds or a -1 if the commandfails.

Note The Agent for Microsoft SharePointPortal Server must be enabled on themedia server in order for this commandto work.



Switches


8/9/2019 BEWS CLI 275538

22/180






Highest

High

Medium

Low

Lowest






returning.


-o17 Back up LotusNotes server

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


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

-tl:path Specifies the complete path to the transaction

log file.



Switches


8/9/2019 BEWS CLI 275538

23/180

19


Command

Line




Highest

High

Medium

Low

Lowest






returning.

-o18 Back up Oracleserver

Creates and runs a backup job of the Oracleserver. Returns a 1 if the command succeedsor -1 if the command fails.

Note Only one SID can be specified percommand. Use -si to indicate the SIDname to back up.


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





Switches


U i C d Li S i h

8/9/2019 BEWS CLI 275538

24/180




Highest

High

Medium

Low Lowest




Command Line Applet or the Backup ExecAdministration Console, as long as that jobhas already been created and saved.





Switches


U i C d Li S it h

8/9/2019 BEWS CLI 275538

25/180

21


Command

Line

-o19 Create aliasbackup job

Creates and runs an alias backup. Files to bebacked up are specified as a comma delimitedlist (for example, c:\dir\file or\\server\share name\...) with a matchingcomma delimited list of aliases.

Returns a job instance ID. Also returns a 1 if

the command succeeds or a -1 if the commandfails.

An alias backup allows you to specify a shareto back up, and then specify another sharefrom which the backup will appear to haveoriginated. This type of backup is useful whenthe location of the data to be backed up istemporary. For example, a temporary sharemay be created when a mirror is split. Or ashare may be cloned and placed on anotherdevice while it is backed up in order tooff-load traffic from a busy device. If atemporary share is backed up, the restore pathfor the share may not exist if a restore

becomes necessary. Instead, you can specifyan alias to a location where you want theshare to appear to have been backed up from.

Alias jobs support both UNC and localdevices. However, both the target and thesource must be the same, either both UNC or

both local devices. You cannot mix them.


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

-mp:mediaprotection

level

Specifies the media protection level:

0 = Overwrite

1 = Append to media, overwrite if notavailable

2 = Append to media, terminate if not

available



Switches



8/9/2019 BEWS CLI 275538

26/180



-ddevice name Specifies the name of the device that BackupExec should use for the alias backup.

-sd:device name Use this switch instead of the -d switch toindicate that this device name should bechecked against the devices (and device

pools) on the target server, and the job shouldonly run if the device exists. If the device doesnot exist, and if the -v (verbose) switch isused, the following message appears:Deviceor Device Pool specified does not

exist.



Switches



8/9/2019 BEWS CLI 275538

27/180

23


Command

Line

-sfile list or-sf:file name

Required. Specifies the host path of files orspecifies the name of a file that contains a list(one per line) of files to be backed up andaliased. The list should be comma delimited.By default, subdirectories will be recursed. Toskip subdirectories during backup, /n should

be placed before the last quotation mark.

Specifies the list of files to back up or specifiesthe name of a file that contains a list (one perline) of files to be backed up.

Specifies the host path of files to be backed upand aliased. The list should be commadelimited. By default, subdirectories will berecursed. To skip subdirectories during

backup, /n should be placed before the lastquotation mark.

For example:

c:\dir\file or \\server\ share name\.../n"

The order in which resource selections arespecified is the order in which the resourceswill be backed up. Please note the followingabout the order in which selections can be

backed up: You can order resources within a server,

but you cannot alternate selections acrossservers. For example, you can select C:and D: from Server A followed byselections from Server B. However, youcannot order selections as C: from ServerA and then C: from Server B and then D:from both servers.

For any given server, System State orshadow copy components must beordered last.



Switches



8/9/2019 BEWS CLI 275538

28/180

g


-aalias list Required. Specifies a second host drive (thedevice alias) for all the selections listed in the-s switch list. The device that you specifymust be a drive letter followed by a colon,such as "G:". You must include a matchingcomma delimited list of aliases for theselections specified in the -s switch list.

Note This switch cannot be used with the -sfswitch.

-sf:filename Use this switch instead of -s and -a to specifythe name of a file that contains a list (one perline) of files to be backed up.

Note This switch cannot be used with the -sand -a switches.




Highest

High Medium

Low

Lowest


-w Wait for job

completion

Specifies that the Command Line Applet

should wait for the operation to completebefore returning.

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



Switches



8/9/2019 BEWS CLI 275538

29/180

25

g

Command

Line

-o90 Launch job usingjob script file

Executes a job based on the contents of ascript file. Return values depend on the typeof script. Returns a job instance ID. Alsoreturns a 1 if the command succeeds or a -1 ifthe 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 BackupExec job script file.


Instructs the Command Line Applet to waitfor the operation to complete beforereturning. If the job is a scheduled job (not arun now job), the -w is ignored.

-o220 Create selectionlist

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

-sselectionname

Required. Specifies the name of the selectionlist.

-ddescription A brief description of the selection list.

-fscript file Required. Specifies the selections to becontained in this selection list. Format forscripts is [MACHINE] MACHINE1=machinename|logon GUID

Each path must be on a separate line. Forexample:PATH1=C:\test\*.*|{1950A99C-2423-451E-B9

77-225717870CEE}PATH2=C:\test2\*.*

An example script is available in theselectionscript.txt file in theWINNT\UTILS\I386 directory on the BackupExec CD.

-si:server ID or

-pi:pool ID

Specifies a preferred server ID or media server

pool ID for the job.



Switches



8/9/2019 BEWS CLI 275538

30/180


Switches for Administrating Jobs

Several command switches allow you to administer your jobs. These switches, which

allow you to obtain information about the jobs, view job histories, and cancel a job,include:

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



Switches


Job monitoring switches


Switches


-o10 Get number ofscheduled jobs

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

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

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

to the screen.

-o11 Get number ofactive jobs

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

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

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

-o12 Get number ofcompleted jobs

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

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

the screen.


8/9/2019 BEWS CLI 275538

31/180

27

Command

Line

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

-o13 Get number ofactive utility jobs

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

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

-o14 Get number ofcompletedutility jobs

Displays the number of completed utility jobson a computer. Also returns a 1 if thecommand succeeds or a -1 if the commandfails.

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

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


Required. Specifies the name or the job IDthat contains the job statuses to display.

-o16 Dump job statusfor scheduledand active job

Copies to the console the job information anddescriptive headings for each item associatedwith the job ID. Returns a 1 if the commandsucceeds or a -1 if the command fails.

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

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


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

-o21 Dumpcompleted jobstatus

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

Job monitoring switches (continued)


Switches



8/9/2019 BEWS CLI 275538

32/180


-ijob ID or-hi:job historyID

Specifies the job ID or job history ID thatcontains the job statuses to display.

-e Use this switch with -ijob ID to displaydetails for the last instance of the job.

-li:job ID Use this switch to display a list of all jobhistory IDs for the specified job ID.

-o30 Dump job logname ofcompleted job

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

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

-o31 Dump job logcontents

Copies to the console the contents of the joblog specified on the command line. Returns a1 if the command succeeds or a -1 if thecommand fails.

-ffile name Specifies the job log name.

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

-i Rename jobassociated withthe job ID.

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

-j Current name ofthe job torename.

Instructs Backup Exec to rename the job.

-jn New name forthe job.

Provides the new name for the job.

-o200 Place job on hold Places the specified job on hold. Returns a 1 if

the command succeeds or a -1 if the commandfails.



Switches



8/9/2019 BEWS CLI 275538

33/180

29

C

ommand

Line

-jjob name Required. Specifies the name of the job to beplaced on hold.

-o201 Take job off hold Takes the specified job off hold. Returns a 1 ifthe command succeeds or a -1 if the commandfails.

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

-o202 -ijobID Deletescheduled job

Required. Use this switch to specify a job IDof a specific job. Returns a 1 if the commandsucceeds or a -1 if the command fails.

-ds: Delete the

selection list ifno other jobs areusing it

If the scheduled job is not deleted, the

selection list is not deleted, and a -1 isreturned.

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

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

-o251 List all backup

selection lists

Displays all available backup selection lists.

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

-o263 List all backupjob templates

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

-o312 Disable error

handling rule

Disables an error-handling rule.

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

-o506 Dump jobinformation

Displays job, selection, and scheduleinformation stored on this server. Also returnsa 1 if the command succeeds or a -1 if thecommand fails.

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



Switches


8/9/2019 BEWS CLI 275538

34/180


8/9/2019 BEWS CLI 275538

35/180

31

C

ommand

Line

Restore Job Switches

You can run a previously created restore job or launch a restore job script file through the

following command line switches:

Restore job commands


Switches


-o7 Restore job Runs a restore job that has been previously

defined for a media server. Returns a jobinstance ID. Also returns a 1 if the commandsucceeds or a -1 if the command fails.


Required. Specifies the name or the job ID ofthe previously defined job that Backup Execshould run.


Highest

High

Medium

Low

Lowest




-o90 Launch job usingjob script file

Executes a job based on the contents of ascript file. Return values depend on the type

of script. Returns a job instance ID. Alsoreturns a 1 if the command succeeds or a -1 ifthe command fails.

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

-fscript file Required. Specifies the name of the BackupExec script file. If the job is a scheduled job

(not a run now job), the -w is ignored.


8/9/2019 BEWS CLI 275538

36/180


See also:

Using Job Script Files on page 81

Switches for Viewing and Responding to Alerts

Alerts are events that require administrator attention. Several command switches allowyou to view and respond to alerts. These include:


Instructs the Command Line Applet to waitfor the operation to complete beforereturning. If the job is a scheduled job (not arun now job), the -w is ignored.

Restore job commands (continued)


Switches


Managing alerts switches


Switches


-o40 Get number ofalerts

Displays the number of alerts on thecomputer. Returns a 1 if the commandsucceeds or a -1 if the command fails.

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

-tl: Show titles Displays titles of alerts.

-jserver name Displays alerts generated from the specifiedserver only.

-h Displays history alerts.

-s Displays the name of the server thatgenerated the alert.

-d Displays the date the alert was generated.


8/9/2019 BEWS CLI 275538

37/180

33

C

ommand

Line

-o42 Dump alert text Dumps the alert title and message to theconsole. Returns a 1 if the command succeedsor a -1 if the command fails.

-i Displays the alert ID of the text.


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

-o43 Get number ofinformation onlyalerts

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

-i Dump all alert

IDs

If -i is used with this command, all alert IDs

will be displayed on the screen.

-tl: Show titles Displays alert titles.


-s Displays the name of the server that

generated the alert.


-o44 Get number ofuserintervention(critical) alerts

Displays the number of user interventionalerts on the computer. Also returns a 1 if thecommand succeeds or a -1 if the commandfails.

-i Dump all alertIDs

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




Managing alerts switches (continued)


Switches



8/9/2019 BEWS CLI 275538

38/180



-o45 Clear allinformation onlyalerts

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

-o46 Respond to alert Allows you to respond to an alert. Returns 1 ifthe command succeeds, 0 if the alert wasalready responded to, or -1 if the commandfails.

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

-rresponseor-w Required. Specifies a response. Responses areOK, YES,NO, CANCEL, RETRY,or IGNORE orinstructs the Command Line Applet toprompt for a response.

-o47 Get all warningalerts

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

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



-s Displays the name of the server that

generated the alert.


-o48 Get all erroralerts

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

-i Dump all alertIDs

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



Switches



8/9/2019 BEWS CLI 275538

39/180

35

C

ommand

Line





-o49 List alertcategories

Displays alert categories. Returns a 1 if thecommand succeeds or a -1 if the commandfails.

-i Dump all alert

IDs

If -i is used with this command, all alert IDs

will be displayed on the screen.

-j Display alertcategory name

Displays alert names on screen.

-ac: Display eventcategory

Displays the alert category on screen.

-o50 Dump alertconfiguration Displays the configuration for alerts onscreen. Returns a 1 if the command succeedsor a -1 if the command fails.

-ialertcategory ID

Required. Specifies an alert ID to displayconfiguration information for.

-o51 Set alertconfiguration

Modifies the alert configuration.

-ialertcategory ID

Required. Specifies an alert ID to displayconfiguration information for.

-e or -d Enable alert ordisable alert

Enables or disables the specified alert forreporting by Backup Exec. Some alerts types,such as error and attention required, arealways enabled.



Switches



8/9/2019 BEWS CLI 275538

40/180


-no: or -nn: Enablenotification ordisablenotification

Enables or disables the sending of anotification when the alert occurs. Recipientsmust be configured to use this option.

-jl: or -nj: Enable inclusionof job log or

disable inclusionof job log

Sends the job log or disables the inclusion ofthe job log to the alert recipient that is

configured for notification.

-s or -ns: Enable sendingof SNMPnotifications ordisable sendingof SNMP

notifications

Enables or disables the sending of alertnotifications through SNMP.

-rl: or -nr: Enable eventlogging ordisable eventlogging

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

-ac:timeout or-na:

Set time forautomaticclearing of alertor disableautomatic alertclearing

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

-ar:response Set theautomaticresponse for an

alert.

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

-o150 Dumpnotificationrecipients

Displays the recipients that have definednotification methods. Returns a 1 if thecommand succeeds or a -1 if the commandfails.



Switches



S it h f E H dli R l

8/9/2019 BEWS CLI 275538

41/180

37

C

ommand

Line

Switches for Error-Handling Rules

Backup Exec has system-defined error-handling rules that determine how job errors are

handled. They apply to all backup jobs and are defined based on the cause of the failure.The rules can be configured to automatically perform operations such as retry, pause, orcancel a job after a failure occurs. Error-handling rules are disabled by default.

Error-Handling Rules switches


Switches


-o310 Displayerror-handlingrules

Displays the error-handling rules.

-o311 Enable errorhandling rule

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

-mr:maximumretries

Indicates that the job should be retried and thenumber of times the job is to be retried. Therange for maximum retries is 1 to 99.

-ri:retryinterval

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

1,440.

-pj: Pause job onerror

Indicates the job is to be paused until the userhas taken action to clear the error. If thisswitch is absent, the job will be canceled untilits next scheduled run.

-cj: Cancel job on

error

Indicates the job is to be canceled if an error

occurs.

-no:notes Specifiesmiscellaneousinformation fortheerror-handlingrule.

-o312 Disable errorhandling rule

Disables the specified error-handling rule.

8/9/2019 BEWS CLI 275538

42/180


Device and media management switches (continued)

8/9/2019 BEWS CLI 275538

43/180

39

C

ommand

Line

-i Displays drive IDs for all drives.

-j Displays names for all drives.

-o64 Get number ofdrives available

Displays the number of managed drives thatare online and not paused. Drives that are

being used are considered online and areincluded in the number displayed. Returns a 1if the command succeeds or a -1 if thecommand fails.



-o65 Get number ofdrives paused

Displays the number of managed drives thatare paused. Returns a 1 if the commandsucceeds or a -1 if the command fails.



-o66 Get number ofdrives offline Displays the number of managed drives thatare offline. Returns a 1 if the commandsucceeds or a -1 if the command fails.



-o67 Dump driveproperties

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

-ddrive name or-idrive ID

Required. Specifies the name or the ID of thedrive.

-o68 Query devices



Switches




8/9/2019 BEWS CLI 275538

44/180


-o69 Get number ofmedia sets

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

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

-j Displays the names of all media sets.

-o70 Dump media setproperties

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

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

-o71 Dump media

label properties

Displays properties of the media label.


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

-o80 Import driveslots

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

-aroboticlibrary

Required. Specifies the robotic library totarget for this operation.

-ai: Instructs Backup Exec to auto inventory allslots.

-sslot numbers Specifies the slots in the robotic library totarget. This list should be comma delimited. If

no slots are specified, then all will be targetedby default.

-fschedule file Schedules the job. If -fschedule filerepresents a scheduled job (not a run now

job), then the -w option is ignored. For moreinformation about schedule file scripts, seeUsing a Schedule Script with Device and

Media Operations on page 165.



Switches




8/9/2019 BEWS CLI 275538

45/180

41

C

ommand

Line


Highest

High

Medium

Low

Lowest




-o81 Export driveslots

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

-aroboticlibrary


-sslot numbers Specifies the slots in the robotic library to

target. This list should be comma delimited. Ifno slots are specified, then all will be targeted

by default.


job), then the -w option is ignored. For moreinformation about schedule file scripts, seeUsing a Schedule Script with Device andMedia Operations on page 165.

g ( )


Switches


8/9/2019 BEWS CLI 275538

46/180



8/9/2019 BEWS CLI 275538

47/180

43

C

ommand

Line

-o84 Get number ofrobots

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

-i Displays the robot IDs.

-o85 Dump robot

properties

Displays property information for the

specified robotic library. Returns a 1 if thecommand succeeds or a -1 if the commandfails.

-irobot IDor-drobot name

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

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

-o86 Dump slotcontent

Displays the slot information with headerdescriptions.

-irobot IDor-drobot name

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

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

-sslot number Specifies the slot number to displayinformation for. If the slot number is notspecified, the contents of all slots for therobotic library are displayed.

-o100 Create cleaningjob

Creates and runs a cleaning job on thespecified drive. Returns the job ID and a 1 ifthe command succeeds or a -1 if the commandfails.

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


Switches




8/9/2019 BEWS CLI 275538

48/180





Highest

High

Medium

Low

Lowest




-o101 Create media set Creates a media set with the specified name.


-mmedia setname

Required. Specifies the name of the newmedia set.

-op:overwriteprotection

period

Required. Specifies the overwrite protectionperiod for the new media set. Enter the lengthof time in hours.

Enter the value -1 to set the overwriteprotection level to infinite.

-ap:append Required. Specifies the append period for thenew media set. Enter the length of time inhours.


Switches




8/9/2019 BEWS CLI 275538

49/180

45

C

ommand

Line

-o102 Create drivepool

Creates a drive pool with the specified nameand assigns the given drives to it.

Returns a 1 if the command succeeds, a 0 ifone or more specified drives cannot be found,or a -1 if the command fails.

-dp:drive pool Required. Specifies the name of the new drivepool.

-ddrives Specifies a list of drives to add to the drivepool. The list should be comma delimited.

-o103 Create inventoryjob for roboticlibrary

Creates an inventory job on a specified roboticlibrary.

Returns the job ID and a 1 if the command

succeeds, or a -1 if the command fails. Whenusing this command, you must also use the-arobotic library switch, whichinventories all slots and drives on a specifiedrobotic library.

-aroboticlibrary


-jjob name Specifies a name for the job.



-sslot numbers Specifies the slots in the robotic library totarget. This list should be comma delimited. Ifno slots are specified, then all will be targeted

by default.


Switches




8/9/2019 BEWS CLI 275538

50/180



Highest

High

Medium

Low

Lowest




-o104 Lock librarydoor

Locks the specified robotic library door.

Returns the job ID and a 1 if the commandsucceeds, or a -1 if the command fails. Whenusing this command, you must also use the-arobotic libraryswitch.

-aroboticlibrary




-pr:priority

Specifies the priority for the job. Priorityoptions include:

Highest

High

Medium

Low

Lowest



Switches




8/9/2019 BEWS CLI 275538

51/180

47

C

ommand

Line



-o105 Unlock librarydoor

Unlocks the specified robotic library door.

Returns the job ID and a 1 if the commandsucceeds, or a -1 if the command fails. Whenusing this command, you must also use the-arobotic libraryswitch.

-aroboticlibrary


-fschedule file Schedule the job. If -fschedule filerepresents a scheduled job (not a run now



Highest

High Medium

Low

Lowest





Switches




8/9/2019 BEWS CLI 275538

52/180


-o106 Set mediaoverwriteprotectionperiod

Specifies the media overwrite level andoverwrite options.

Returns a 1 if the command succeeds or a -1 ifthe command fails. When using thiscommand, you must also use the -o1 and -o0switches.

-ol:overwritelevel

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

Overwrite Levels include:

1 = None

2 = None with prompt

3 = Partial

4 = Partial with prompt

5 = Full

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

Overwrite options include:

0 = Use scratch media first

1 = Use recyclable media first

-o111 Erase media Erases the tape in the specified driveaccording to the specified erase type (-e).

Returns the job ID and a 1 if the commandsucceeds, or a -1 if the command fails.

-ddrive name Required. Specifies the drive name you wantto target. If -s is used, -ddrive name will bethe name of the robotic library.

-eerase type Required. Specifies the erase type. Erasetypes are:

1 = quick erase

3 = long erase



Switches




8/9/2019 BEWS CLI 275538

53/180

49

C

ommand

Line

-fschedule file Schedule the job. If -fschedule filerepresents a scheduled job (not a run now


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


Highest

High

Medium

Low

Lowest


-w Wait for job

completion

Instructs the Command Line Applet to wait

for the operation to complete beforereturning.

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

Returns the job ID and a 1 if the commandsucceeds, or a -1 if the command fails.

-ddrive name Required. Specifies the drive name. If -s isused, -ddrive name will be the name of therobotic library.

-sslot numbers Specifies the slot numbers containing themedia to be retensioned.


Switches




8/9/2019 BEWS CLI 275538

54/180



Highest

High

Medium

Low

Lowest




-o113 Label media Labels the tape in the specified drive.Returns the job ID and a 1 if the commandsucceeds, or a -1 if the command fails.


-mmedia name Required. Specifies the media name.

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


Highest

High Medium

Low

Lowest



Switches




O ti Additi l F ti D i ti

8/9/2019 BEWS CLI 275538

55/180

51

C

ommand

Line



-o114 Format media Formats the tape in the specified drive.

Returns the job ID and a 1 if the commandsucceeds, or a -1 if the command fails. When

using this command, you must also use the-ddrive name command.


-sslot numbers Specifies the slot numbers containing the

media to be formatted.


Low

Lowest

Medium

High

Highest

If this switch is absent, the priority is set tomedium.



-o115 Eject media fromdrive

Ejects the tape in the specified drive.

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

-ddrive name

Required. Specifies the drive name.


Switches




Operation Additional Function Description

8/9/2019 BEWS CLI 275538

56/180



Highest

High

Medium

Low

Lowest




-o116 Create a backupfolder

Creates a Backup Folder. Backup Exec allowsyou to create virtual devices called BackupFolders on the hard disk. These BackupFolders are used as destination devices for

backup jobs. When you direct a backup job toa Backup Folder, the data is saved on disk as

backup files. Returns a 1 if the commandsucceeds or a -1 if the command fails.

-r Makes the backup folder being created into aremovable backup-to-disk folder. Otherwise,the folder will be a fixed (non-removable)folder.

-ffolder name Specifies the folder name.

When you create a Backup Folder, BackupExec initially assigns a name and path to it.You can rename a Backup Folder as long asyou use a unique name. Renaming a BackupFolder changes the way it appears in BackupExec, but does not change the location of theBackup Folder on the disk.


Switches





8/9/2019 BEWS CLI 275538

57/180

53

Command

Line

-ddirectory Specifies the location for the folder.

Note Backup jobs submitted to a BackupFolder cannot span disks. If the size of a

backup job exceeds the amount of freespace on the disk where the BackupFolder is located, the job will fail. Makesure that there is sufficient free space on

a disk for a backup job beforesubmitting it. Use the software datacompression option to maximize theamount of data that can be stored on adisk.If the backup job fails because ofinsufficient disk space, the data backedup before the job fails can still berestored.

-o117 Inventory astand-alonedrive

Creates an inventory job on a specifiedstand-alone drive. Displays the job instanceID. Returns a 1 if the command succeeds or a-1 if the command fails.

-ddrive name Required. Specifies the drive name.



job), then the -w option is ignored.


Highest High

Medium

Low

Lowest



Switches





8/9/2019 BEWS CLI 275538

58/180


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


Instructs the Command Line Applet toprompt for a response.

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

-mmedia set Required. Specifies the name of the media set.

-o121 Delete drivepool

Deletes the specified drive pool. Returns a 1 ifthe command succeeds or a -1 if the commandfails.

-dp:drive pool Required. Specifies the name of the drivepool.

-o122 Create mediaserver pool

This operation is only available if the CentralAdmin Server Option (CASO) is installed.Creates a media server pool with the specifiedname. Returns a 1 if the command succeeds ora -1 if the command fails.

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

-pd:pooldescription

Specifies a description for the media serverpool.

-si:server IDs or

-sn:server names

Specifies the media server IDs or names to

add to the media server pool.

-o123 Delete mediaserver pool

This operation is only available if the CentralAdmin Server Option (CASO) is installed.Deletes the media server pool with thespecified name. Returns a 1 if the commandsucceeds or a -1 if the command fails.

Note Use only one of the required switches

for this command.


Switches





8/9/2019 BEWS CLI 275538

59/180

55

Command

Line

-ipool IDs or-nm:pool names

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

-o124 Rename a mediaserver pool or seta new mediapool description

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

Note Use only one of the required switchesfor this command.

-ipool IDor

-onm:old poolname

Required. Specifies the ID of the media server

pool or the name of the media server pool tobe renamed.

-nm:new poolname

Specifies the new name of the media serverpool.

-pd:pooldescription

Specifies a description of the media serverpool.

-o125 Get media serverpools

This operation is only available if the CentralAdmin Server Option (CASO) is insta

bews cli 275538

Documents