Using the Command Line

Thischapterdescribeshowto usetheDataProtectionforExchangecommandline interface.Eachcommandincludesasyntax diagramandadescription. See

“Readingsyntax diagrams”onpagexiiiformoreinformation.

Thenext sectionisanoverviewofthecommandlineinterface.Thecommandsare described inthefollowingcategories:

v Query v Backup v Restore

v Changetsmpassword v Set

v Help

TheData ProtectionforExchangecommandlineinterfacecanalsobe usedwhen schedulingautomaticbackupsof Exchangedatabases. SeeAppendixA,“Usingthe TivoliStorageManagerscheduler,”onpage119foradiscussion ofusingtheTivoli StorageManagerscheduler withData ProtectionforExchange.

Overview

The nameoftheDataProtectionforExchangecommandlineinterfaceis tdpexcc.exe.ThisprogramislocatedinthedirectorywhereDataProtectionfor Exchangeisinstalled.

The commandlineparametershavethefollowingcharacteristics:

v positionalparametersdonotincludea leadingslash (/)ordash(-)

v optionalparameterscanappearinanyorderaftertherequiredparameters v optionalparametersbeginwith aforwardslash(/)ora dash(-)

v minimumabbreviationsforkeywordsareindicatedinuppercasetext v somekeywordparametersrequire avalue

v forthosekeywordparametersthatrequirea value,thevalueisseparatedfrom thekeyword withanequal sign(=)

v ifaparameter requiresmore thanonevalue aftertheequalsign, thevaluesare separatedwith commas

v eachparameterisseparatedfromtheothersbyusingspaces

v ifaparameter’svalue includesspaces,thevaluemust beenclosedindouble quotes

v

apositionalparametercanappearonlyoncepercommandinvocation

Issue thetdpexcc ?or tdpexcc helpcommandtodisplay helpfor thecommand lineinterface.

Query Commands

Thereare threebasicquerycommands:onecommandfortheExchangeServer,one commandtoviewData ProtectionforExchangeconfigurationinformation,andone commandfortheTivoliStorageManagerserver.Thequerycommandsallowyou to:

v Querythestatusof thelocalExchangeServer

v QueryalistofData ProtectionforExchangeconfigurationinformation

v QueryalistofExchangebackupsinTivoliStorageManagerstorage andTivoli StorageManager serverconnectioninformation

QUERY EXCHANGE

Use thiscommandtoquerythelocalExchangeServerforgeneralinformation.

Thequeryexchange commandreturnsthefollowinginformation:

v Versionand leveloftheExchangeServer v DomainandServer Names

v Storagegroupsandalldatabase nameswithstatusofeach v ExchangeServer2003RecoveryStorageGroupstatus v

Whetherthestoragegrouphascircularloggingenabled v

VSSInformation(onlyapplicablewhenconfigured forVSSoperations)

Syntax

TDPEXCC Query EXCHange

tdpexc.cfg /CONFIGfile=

configfilename

local Exchange server /EXCSERVer=

server-name

tdpexc.log /LOGFile=

logfilename

60 /LOGPrune= numdays

No



Optional Parameters

/CONFIGfile=configfilename

Usethe/configfileparametertospecifythenameof theData Protection forExchangeconfigurationfilethatcontainsthevaluesfortheData ProtectionforExchangeconfigurationoptions.See“SET”onpage102 for detailsaboutthecontentsofthefile.

Theconfigfilenamevariablecaninclude afullyqualifiedpath.Ifthe configfilenamevariabledoesnotincludea path,theData Protectionfor Exchangeinstallationdirectory isused.

Considerations

v If theconfigfilenamevariableincludesspaces,theentire/configfile parameter entrymustbe placedindouble quotes.For example:

/CONFIGfile="c:\Program Files\file.cfg"

v If the/configfileparameterisnotspecified,thedefaultvalue is tdpexc.cfg.

v Ifthe/configfileparameterisspecifiedbuttheconfigfilenamevariableis notspecified,thedefaultvalueistdpexc.cfg.

/EXCSERVer=server-name

Usethe/excserverparametertospecifythenameoftheExchangeServer toquery.

Theserver-namevariable specifiesthenameoftheExchangeServer to query.

Considerations

v IftheExchangeServer toqueryisa memberofaMicrosoft Cluster Server,thisparametermust bespecifiedandshouldbe settothename oftheExchangevirtual server.

v ThedefaultvalueisthelocalExchangeServer.

/LOGFile=logfilename

Usethe/logfile parametertospecifythenameoftheactivitylogfile generatedbyDataProtectionforExchange.

Thelogfilenamevariable identifiesthenameoftheactivitylogfile.

Ifthespecifiedlogfiledoesnotexist, anew logfileiscreated.Ifthe specifiedlogfileexists,newlogentriesare appendedtothefile.The logfilenamevariable canincludea fully-qualifiedpath.However,ifnopath isspecified,thelogfileiswrittentotheData ProtectionforExchange installationdirectory.

Ifthelogfilenamevariable includesspaces,theentire/logfileparameter entrymust beplacedindoublequotes.Forexample:

/LOGFile="c:\Program Files\mytdpexchange.log"

Ifthe/logfileparameter isnotspecified,logrecordsarewrittentothe defaultlogfile,tdpexc.log.

The/logfile parametercannotbe turnedoff.Youalwaysget logging.

WhenusingmultiplesimultaneousinstancesofDataProtectionfor Exchangetoperform operations,usethe/logfileparametertospecifya differentlogfileforeachinstanceused. Thisdirectsloggingforeach instance toadifferentlogfileandpreventsinterspersedlogfilerecords.

Failure tospecifyadifferentlogfileforeachinstance canresultin unreadable logfiles.

/LOGPrune=numdays|No

Usethe/logpruneparametertodisablelogpruningortoexplicitlyrequest a pruneof thelogforonecommandrun.By default,logpruningis enabled andperformedonceperday.Thenumdaysvariable representsthe number ofdaystosave logentries. Bydefault,60daysoflogentriesare savedinthepruneprocess.YoucanusetheDataProtectionforExchange GUIor thesetcommandtochangethedefaultssothatlogpruningis disabled,orsothatmoreorlessdays oflogentriesaresaved. The commandlineuser mayusethe/logpruneparametertooverride these defaults foronecommandrun. Notethatwhenthevalueof the/logprune variable numdaysisa numberintherange0 to9999,apruneisperformed evenifonehasalreadybeen performedfortheday.

Changes tothevalue ofthetimeformatordateformatparametercanresult inan undesiredpruningoftheDataProtectionforExchangelogfile.Ifyou are runninga commandthatmayprunethelogfileand thevalue ofthe

timeformat ordateformatparameterhaschanged,perform oneofthe followingtopreventundesiredpruningofthelogfile:

v Make acopyoftheexistinglogfile.

v Specify anew logfilewith the/logfile parameterorlogfilesetting.

Examples

Example1: Thetdpexccqueryexchangecommandqueries theExchangeserver.

An exampleoftheoutputwhenthiscommandisperformedonExchangeServer 2003isdisplayedbelow.

IBM Tivoli Storage Manager for Mail:

Data Protection for Microsoft Exchange Server Version 5, Release 3, Level 3.0

(C) Copyright IBM Corporation 1998, 2006. All rights reserved.

ACN5057I The C:\Program Files\Tivoli\TSM\TDPExchange\tdpexc.log log file has been pruned successfully.

Microsoft Exchange Server Information

Server Name: TESEXCH

Domain Name: emmaeus.test.local Exchange Server Version: 6.0.4417.0

Storage Groups with Databases and Status

First Storage Group

Circular Logging - Disabled

Mailbox Store (TESEXCH) Online

Public Folder Store (TESEXCH) Online

Second Storage Group

Circular Logging - Disabled

Mailbox Store SSG 1 Online

stg3

Circular Logging - Disabled

mail3 Online

Example2: ThistdpexccqueryexchangecommandqueriesanExchangeServer 2003.Theoutputexampledisplays thata RecoveryStorageGroupexistsandthat all mailboxdatabasewillberestored toit.

IBM Tivoli Storage Manager for Mail:

Data Protection for Microsoft Exchange Server Version 5, Release 3, Level 3.0

(C) Copyright IBM Corporation 1998, 2006. All rights reserved.

Microsoft Exchange Server Information

Server Name: GUEST5

Domain Name: guest5.quest00.local Exchange Server Version: 6.5.6944.0

Storage Groups with Databases and Status

First Storage Group

Circular Logging - Disabled

Mailbox Store (GUEST5) Online

Public Folder Store (GUEST5) Online

MySecond Storage Group Circular Logging - Disabled

secondmailbox Online

MyThird Storage Group Circular Logging - Disabled

thirdstoragebox Offline

Recovery Storage Group exists - All mailbox databases will be restored here.

Example3: Inthisexample,thetdpexccqueryexchangecommandqueriedan ExchangeServer thatisconfigured forVSSoperations.Thefollowingoutputis displayed:

IBM Tivoli Storage Manager for Mail:

Data Protection for Microsoft Exchange Server Version 5, Release 3, Level 3.0

(C) Copyright IBM Corporation 1998, 2006. All rights reserved.

ACN5057I The C:\Program Files\Tivoli\TSM\TDPExchange\tdpexc.log log file has bee n pruned successfully.

Microsoft Exchange Server Information

Server Name: ONY

Domain Name: optimus.zor.local Exchange Server Version: 6.5.7638.1

Storage Groups with Databases and Status

First Storage Group

Circular Logging - Disabled

forfun store Online

Mailbox Store (ONY) Online

Public Folder Store (ONY) Online

stg3

Circular Logging - Disabled

mail1 Online

mail2 Online

mail3 Online

stg_big

Circular Logging - Disabled

mail1 Online

mail2 Online

mail3 Online

mail4 Online

test

Circular Logging - Disabled

test1 Online

Volume Shadow Copy Service (VSS) Information

Writer Name : Microsoft Exchange Writer Local DSMAgent Node : svc_ba

Remote DSMAgent Node : svc_offload Writer Status : Online Selectable Components : 4

QUERY TDP

Use thiscommandtoquerya listofthecurrentvaluesset intheconfigurationfile forData ProtectionforExchange.

Syntax

TDPEXCC Query TDP

tdpexc.cfg /CONFIGfile=

configfilename

tdpexc.log /LOGFile=

logfilename

60 /LOGPrune= numdays

No



Optional Parameters

/CONFIGfile=configfilename

Usethe/configfileparametertospecifythenameof theData Protection forExchangeconfigurationfilethatcontainsthevaluesfortheData ProtectionforExchangeconfigurationoptions.See“SET”onpage102 for detailsaboutthecontentsofthefile.

Theconfigfilenamevariablecaninclude afullyqualifiedpath.Ifthe configfilenamevariabledoesnotincludea path,theData Protectionfor Exchangeinstallationdirectory isused.

Considerations

v If theconfigfilenamevariableincludesspaces,theentire/configfile parameter entrymustbe placedindouble quotes.For example:

/CONFIGfile="c:\Program Files\file.cfg"

v If the/configfileparameterisnotspecified,thedefaultvalue is tdpexc.cfg.

v

If the/configfileparameterisspecifiedbuttheconfigfilenamevariableis notspecified,thedefaultvalueistdpexc.cfg.

/LOGFile=logfilename

Usethe/logfile parametertospecifythenameoftheactivitylogfile generatedbyDataProtectionforExchange.

Thelogfilenamevariable identifiesthenameoftheactivity logfile.

Ifthespecifiedlogfiledoesnotexist, anewlogfileiscreated.Ifthe specifiedlogfileexists,newlogentriesare appendedto thefile.The logfilenamevariable canincludeafully-qualified path.However,ifnopath isspecified,thelogfileiswrittentotheData ProtectionforExchange installationdirectory.

Ifthelogfilenamevariable includesspaces,theentire/logfileparameter entrymust beplacedindoublequotes.Forexample:

/LOGFile="c:\Program Files\mytdpexchange.log"

Ifthe/logfileparameter isnotspecified,logrecordsare writtentothe defaultlogfile,tdpexc.log.

The/logfile parametercannotbe turnedoff.Youalwaysget logging.

WhenusingmultiplesimultaneousinstancesofDataProtectionfor Exchangetoperform operations,usethe/logfileparametertospecifya differentlogfileforeachinstanceused. Thisdirectsloggingforeach instance toadifferentlogfileandpreventsinterspersedlogfilerecords.

Failure tospecifyadifferentlogfileforeachinstance canresultin unreadable logfiles.

/LOGPrune=numdays|No

Usethe/logpruneparametertodisablelogpruningortoexplicitlyrequest a pruneof thelogforonecommandrun.By default,logpruningis enabled andperformedonceperday.Thenumdaysvariable representsthe number ofdaystosave logentries. Bydefault,60daysoflogentriesare savedinthepruneprocess.YoucanusetheDataProtectionforExchange GUIor thesetcommandtochangethedefaultssothatlogpruningis disabled,orsothatmoreorlessdays oflogentriesaresaved. The commandlineuser mayusethe/logpruneparametertooverride these defaults foronecommandrun. Notethatwhenthevalueof the/logprune variable numdaysisa numberintherange0 to9999,apruneisperformed evenifonehasalreadybeen performedfortheday.

Changes tothevalue ofthetimeformatordateformatparametercanresult inan undesiredpruningoftheDataProtectionforExchangelogfile.Ifyou are runninga commandthatmayprunethelogfileand thevalue ofthe timeformat ordateformatparameterhaschanged,perform oneofthe followingtopreventundesiredpruningofthelogfile:

v Makeacopyoftheexistinglogfile.

v Specifyanew logfilewith the/logfileparameterorlogfilesetting.

Example

The tdpexccquerytdpcommandqueriesthevaluessetintheDataProtectionfor Exchangeconfigurationfile.Anexample oftheoutputina Legacyconfigurationis displayed below.

IBM Tivoli Storage Manager for Mail:

Data Protection for Microsoft Exchange Server Version 5, Release 3, Level 3.0

(C) Copyright IBM Corporation 1998, 2006. All rights reserved.

Data Protection for Exchange Preferences

BACKUPDESTination... TSM BACKUPMETHod... LEGACY BUFFers ... 3 BUFFERSIze ... 1024 DATEformat ... 1 LANGuage ... ENU LOCALDSMAgentnode...

LOGFile ... tdpexc.log LOGPrune ... 60

MOUNTWait ... Yes NUMberformat ... 1 REMOTEDSMAgentnode...

TEMPLOGRESTOREPath...E:\TEMP TIMEformat ... 1

An exampleoftheoutputinaVSSconfigurationisdisplayedbelow.

IBM Tivoli Storage Manager for Mail:

Data Protection for Microsoft Exchange Server Version 5, Release 3, Level 3.0

(C) Copyright IBM Corporation 1998, 2006. All rights reserved.

Data Protection for Exchange Preferences

BACKUPDESTination... TSM BACKUPMETHod... VSS BUFFers ... 3 BUFFERSIze ... 1024 DATEformat ... 1 LANGuage ... ENU LOCALDSMAgentnode... svc_ba LOGFile ... tdpexc.log LOGPrune ... 60

MOUNTWait ... Yes NUMberformat ... 1

REMOTEDSMAgentnode... machine1_ba TEMPLOGRESTOREPath... c:\tdp\tdptemplog TIMEformat ... 1

QUERY TSM

Use thiscommandtoqueryTivoliStorageManagerforinformationaboutthe TivoliStorageManagerAPIandtheTivoliStorageManagerserver.Thiscommand canalso displayalistofbackupsthatarestored ontheTivoliStorageManager serverthatmatchthestoragegroupsentered.Activeandinactiveobjectscanbe displayed.

By default,onlytheactivebackupobjectsaredisplayed.Toincludeinactive backupversions inthelist,usethe/alloptionalparameter.

Syntax

TDPEXCC Query TSM * FULL

sg-name,sg-nameN COPY INCRemental DIFFerential DBCopy db-name

/ACtive

/ALl tdpexc.cfg

/CONFIGfile=

configfilename

local Exchange server /FROMEXCSERVer=

server-name

tdpexc.log /LOGFile=

logfilename

60 /LOGPrune= numdays

No

/SKIPINTEGRITYCHECK /TSMNODe= tsmnodename

dsm.opt /TSMOPTFile=

tsmoptfilename

/TSMPassword= tsmpassword



Positional Parameters

The followingpositionalparametersspecifytheobjecttoquery.Ifnoneofthese positionalparametersarespecified,onlytheTivoliStorageManagerAPIand Tivoli StorageManagerserverinformationisdisplayed:

*|DIR|IS|sg-name

* Queryall backupobjectsforall storagegroups sg-name

Queryall backupobjectsforthespecifiedstorage group.Multiple entriesareseparatedbycommas.

The followingpositionalparametersspecifythetype ofbackuptoquery.Ifthis parameter isnotspecified,allbackuptypeswillbe displayed:

FULL|COPY |INCRemental|DIFFerential|DBCopydb-name

FULL QueryonlyFullbackuptypes COPY QueryonlyCopybackuptypes INCRemental

QueryonlyIncrementalbackuptypes DIFFerential

QueryonlyDifferentialbackuptypes DBCopydb-name

Queryonlydatabasecopybackupsfordatabase db-name.

Optional Parameters

/ACtive

Usethe/active parametertodisplayactivebackupobjectsonly.Thisisthe default.

/ALl Usethe/allparametertodisplaybothactiveand inactivebackupobjects.If the/allparameterisnotspecified,onlyactivebackupobjectsare

displayed.

/CONFIGfile=configfilename

Usethe/configfileparametertospecifythenameof theData Protection forExchangeconfigurationfilethatcontainsthevaluesfortheData ProtectionforExchangeconfigurationoptions.See“SET”onpage102 for detailsaboutthecontentsofthefile.

Theconfigfilenamevariablecaninclude afullyqualifiedpath.Ifthe configfilenamevariabledoesnotincludea path,theData Protectionfor Exchangeinstallationdirectory isused.

Considerations

v If theconfigfilenamevariableincludesspaces,theentire/configfile parameter entrymustbe placedindouble quotes.For example:

/CONFIGfile="c:\Program Files\file.cfg"

v If the/configfileparameterisnotspecified,thedefaultvalue is tdpexc.cfg.

v If the/configfileparameterisspecifiedbuttheconfigfilenamevariableis notspecified,thedefaultvalueistdpexc.cfg.

/FROMEXCSERVer=server-name

Usethe/fromexcserverparametertospecifythenameof theExchange Server wheretheoriginalbackupwasperformed.

ThedefaultisthelocalExchangeServer.However,youmustspecifythe nameiftheExchangeServerisnotthedefaultor isa memberofanMSCS.

/LOGFile=logfilename

Usethe/logfile parametertospecifythenameoftheactivitylogfile generatedbyDataProtectionforExchange.

Thelogfilenamevariable identifiesthenameoftheactivity logfile.

Ifthespecifiedlogfiledoesnotexist, anewlogfileiscreated.Ifthe specifiedlogfileexists,newlogentriesare appendedto thefile.The logfilenamevariable canincludeafully-qualified path.However,ifnopath isspecified,thelogfileiswrittentotheData ProtectionforExchange installationdirectory.

Ifthelogfilenamevariable includesspaces,theentire/logfileparameter entrymust beplacedindoublequotes.Forexample:

/LOGFile="c:\Program Files\mytdpexchange.log"

Ifthe/logfileparameter isnotspecified,logrecordsarewrittentothe defaultlogfile,tdpexc.log.

The/logfile parametercannotbe turnedoff.Youalwaysget logging.

WhenusingmultiplesimultaneousinstancesofDataProtectionfor Exchangetoperform operations,usethe/logfileparametertospecifya differentlogfileforeachinstanceused. Thisdirectsloggingforeach instance toadifferentlogfileandpreventsinterspersedlogfilerecords.

Failure tospecifyadifferentlogfileforeachinstance canresultin unreadable logfiles.

/LOGPrune=numdays|No

Usethe/logpruneparametertodisablelogpruningortoexplicitlyrequest a pruneof thelogforonecommandrun.By default,logpruningis enabled andperformedonceperday.Thenumdaysvariable representsthe number ofdaystosave logentries. Bydefault,60daysoflogentriesare savedinthepruneprocess.YoucanusetheDataProtectionforExchange GUIor thesetcommandtochangethedefaultssothatlogpruningis disabled,orsothatmoreorlessdays oflogentriesaresaved. The commandlineuser mayusethe/logpruneparametertooverride these defaults foronecommandrun. Notethatwhenthevalueof the/logprune variable numdaysisa numberintherange0 to9999,apruneisperformed evenifonehasalreadybeen performedfortheday.

Changes tothevalue ofthetimeformatordateformatparametercanresult inan undesiredpruningoftheDataProtectionforExchangelogfile.Ifyou are runninga commandthatmayprunethelogfileand thevalue ofthe timeformat ordateformatparameterhaschanged,perform oneofthe followingtopreventundesiredpruningofthelogfile:

v Makeacopyoftheexistinglogfile.

v Specifyanew logfilewith the/logfileparameterorlogfilesetting.

/TSMNODe=tsmnodename

Thetsmnodename variablereferstotheTivoliStorageManagernodename Data ProtectionforExchangeusestologontotheTivoliStorageManager

Thetsmnodename variablereferstotheTivoliStorageManagernodename Data ProtectionforExchangeusestologontotheTivoliStorageManager

In document Tivoli Storage Manager (Page 75-131)