Thisoptionisvalidforallclients.ThisoptionisalsovalidwiththeJavaGUIand with thecommand-lineinterface.TheTivoliStorageManagerclientAPIdoesnot support thisoption.
Preferences File
Placethisoption inthedsm.opt file.
Syntax
No SpecifiesthatTivoliStorageManagercanusethe″noqueryrestore″ method.
Thisisthedefault.
Yes Specifiesthattheclientusesonlythe″standardrestore″ method.The″no queryrestore″ methodisnotallowed.
Examples
Diskbuffsize
Authorized User
Thediskbuffsizeoption specifiesthemaximumdiskI/Obuffersize(inkilobytes) thattheclientcanusewhenreadingfiles.
Note:Thediskbuffsizeoption replacesthelargecommbuffersoption.
Optimalbackup, archivemigration clientperformancecanusuallybeachievedif thevalue forthisoptionisequaltoorsmallerthantheamountoffileread ahead providedbytheclientfilesystem.Alargerbufferwillrequire morememoryand might notimproveperformance.
Recommendation: Usethedefaultsetting,unlessotherwisedirectedbyIBM support personnel.
Preferences File
Placethisoption inthedsm.sys file.
Syntax
DISKBuffsize
size
Parameters
size Specifiesthemaximumdisk I/Obuffersize (inkilobytes)thattheclientwill usewhenreadingfiles.Therangeofvaluesis16through 1023;thedefaultis 32.
Examples
Optionsfile:
diskbuffsize 64 Commandline:
Does not apply.
Diskcachelocation
Authorized User
The diskcachelocationoptionspecifies thelocationwherethediskcachedatabase willbecreated iftheoptionmemoryefficientbackup=diskcachemethodissetduring an incrementalbackup.Youcanspecifythediskcachelocationoptioninyour dsm.sys filewithina serverstanzaorwith theinclude.fsoption.See“Include options” onpage186 formoreinformation.Ifthediskcachelocationoption
appears intheoptionfile,itsvalue willbeusedforallfilesystemsnotrepresented byaninclude.fsoptioncontainingthediskcachelocationoption.
The diskcacheisatemporaryfilewhichisdeletedaftertheincremental command isrun.Use thisoptiontoselectoneofthefollowing:
1. Alocationthathasmorefreediskspaceif,whenyouareusing
memoryefficientbackup=diskcachemethod,yougetthemessagethatthedisk cachefilecannotbe createdbecauseyoudo nothaveenoughdiskspace.
2. Alocationonadifferentphysicalvolumetoreducecontention forthedisk accessmechanism,and thereforeimproveperformance.
Attention: Forperformance reasons,donotusearemotedrivefor diskcachelocation.
The diskcachefilecreatedbysubsequentdiskcacheincrementalbackupsshould require considerablylessdiskspace.Theactualamount ofdiskspacerequiredfor thediskcachefilecreatedbysubsequentdiskcacheincrementalbackupsdepends onthenumberof filesanddirectoriesincludedinthebackupandonthelengthof thelongestfileordirectorynamewhichisbackedup.Thediskcachefilecreated bytheinitialdiskcacheincrementalbackupcanrequireupto5 gigabytesofdisk spaceforeachmillionfilesordirectoriesbeingbacked up.
Preferences File
Placethisoption inthedsm.sys filewithina serverstanza.
Syntax
DISKCACHELocation
path
Parameters
path Specifiesthelocationwherethediskcachedatabasewillbe createdif memoryefficientbackupissettodiskcachemethod.Thedefaultlocationisto createthedisk cachefileintherootofthefilespacebeingprocessed.
Examples
Optionsfile:
diskcachelocation /home
diskcachelocation /Volumes/hfs2 Commandline:
Does not apply.
Domain
Thedomainoptionspecifies thevolumesthatyouwanttoinclude forincremental backupinyour clientdomain.
Use thedomainoptioninyour dsm.sysfileortheclientuseroptionsfile(dsm.opt) todefineyourdefaultclient domain.Theservercanalsodefinethisoption.Tivoli StorageManagerusesyour defaultclientdomaininthefollowingsituationsto determinewhichvolumestoprocessduring anincrementalbackup:
v Whenyourunanincremental backupusingtheincrementalcommandandyou donotspecifywhichvolumestoprocess.
v Whenyour administratordefinesa scheduletorunanincrementalbackupfor you,butdoesnotspecifywhichvolumestoprocess.
v WhenyouselecttheBackupDomainactionfromtheTivoliStorageManager GUI.
Ifyoudonotusethedomainoptiontospecifyvolumesinyourclientoptionsfile, TivoliStorageManagerusestheall-localparameterasthedefault.
Whenyouusethedomainoption withtheincrementalcommand, TivoliStorage Manager addsvolumesthatyouspecifytothevolumesdefinedinyourclient optionsfile.Forexample,ifyouenterthefollowinginyour clientoptionsfile:
domain /
and thefollowingonthecommandline:
dsmc incremental -domain=/Volumes/puma
TivoliStorageManagerperformsanincremental backupof thestartupdiskand /Volumes/puma,thepumavolume.
Ifyouusebotha filespecificationandthedomainoptionwiththeincremental command, TivoliStorageManagerignoresthedomainoptionand processesonly those volumesthatyouspecifyinthefilespecification.For example,if youenter:
dsmc incremental /Volumes/jaguar -domain=/Volumes/puma
TivoliStorageManagerperformsanincremental backupforthe/Volumes/jaguar volume only.
Youcanalsoexclude volumesbyspecifyingthedash(-)operatorbefore the volumes. Forexample,inthefollowingoptionTivoliStorageManagerwillprocess all localvolumesexceptforthejaguarvolume:
domain ALL-LOCAL -/Volumes/jaguar
Note:Youcannotusethe(-)operatorinfrontofa domainkeywordsuchas ALL-LOCAL.
Preferences File
Placethisoption inthedsm.sys fileortheclientuseroptionsfile(dsm.opt).You canset thisoptionontheBackupcategory,DomainforBackupsection ofthe Preferenceseditor.
Syntax
all-local DOMain
domain
-domain
Parameters
all-local
Backsupall localvolumes.Thisisthedefault.
domain
Defines thevolumestoinclude inyourdefaultclientdomain.
Avolume namemust beenclosedinquotesifitincludesanyspaces.
-domain
Defines thevolumestoexcludeinyour defaultclientdomain.
Examples
Optionsfile:
domain all-local
domain all-local -/Volumes/volume2
domain all-local -/Volumes/volume2 ’-/Volumes/Macintosh HD’
Commandline:
-domain="/ /Volumes/volume2"
-domain="all-local -/Volumes/volume2"
Editor
Theeditoroption turnsthecommand-lineinterface (CLI)editorandretrieve capability onoroff.
Becausecertain terminalsettingsresultinnon-standardinput,theeditormight not workasdefinedinthisdocument.Inthiscase,youcandisable theeditorby settingtheeditoroptiontonoinyourdsm.sys fileorclientuser optionsfile (dsm.opt).
Preferences File
Placethisoption inthedsm.sys fileortheclientuseroptionsfile(dsm.opt).
Syntax
Yes EDitor
No
Parameters
Yes TurnsontheCLIeditorand commandretrievecapability.Thisisthedefault.
No TurnsofftheCLIeditorand commandretrievecapability.
Examples
Optionsfile:
editor yes Commandline:
-editor=yes
Thisoptionisvalidonlyontheinitialcommandline.Itisnotvalidininteractive mode.
Enablearchiveretentionprotection
The enablearchiveretentionprotectionoption allowstheclienttoconnecttoaTivoli StorageManagerdataretentionservertoensurethatarchive objectswillnotbe deletedfromtheserveruntilpolicy-based retentionrequirementsforthatobject havebeen satisfied.Thisoptionisignoredif theclient connectstoaserverthatis notretentionprotectionenabled. Iftheoption is’no’(thedefault)andan attempt ismadetoconnecttoa dataretentionserver,theconnectionwillbe refused.
The dataretentionserverisspeciallyconfiguredforthattask,sonormalbackupor restoreprocessingisrejectedbytheserver.Whentheclientisconnectedtoa data retentionserver,thefollowingcommandswillnotbeavailable.Ifyouattemptto usethesecommands,amessagewillbedisplayed indicatingthattheyarenot validwith thisserver.
v incremental
v backup(all subcommands) v selective
v restore(allsubcommandsexceptrestorebackupset-location=file or -location=tape)
Note: restorebackupset-location=file or-location=tapedo notconnecttoany server(exceptthevirtual one)andthuswillnotbe blockedunderany circumstances.
v restartrestore v deletebackup v deletegroup v expire
v Allqueriesexcept:
– queryaccess – queryarchive – queryfilespace – queryinclexcl
– querymanagementclass – querynode
– queryoptions – queryschedule – querysession – querysysteminfo – querytracestatus
Preferences File
Thisoptionisvalidonlyinthedsm.sys filewithina serverstanzaandisnotvalid in aclientoptionset fromtheserver.Itisnotvalidonanycommandline.
Syntax
No ENABLEARCHIVERETENTIONProtection
Yes
Parameters
No Thedataretentionserverconnectionisrefused.Thisisthedefault.
Yes Theclientconnectstoa dataretentionserver.
Encryptiontype
Theencryptiontypeoptionallows youtouseAES128-bitdataencryption,
providing astrongerformof dataencryptionthanDES56-bitdataencryption.The encryptiontype onlyaffectsbackupandarchive operations.Thedatathatyou include isstoredinencryptedform,andencryptiondoesnotaffecttheamount of datasentor received.Duringrestoreandretrieveoperations,theencrypteddata willbedecrypted withtheproperencryptionalgorithm,regardlessof thesetting forthis option.
Note: Filesthatare backedupusingAES128-bitencryptioncannotberestored withanolderlevelclient.However,ifyoueverneedtoreinstallandusean olderclient,files backedupbytheTivoliStorageManagerVersion5.3client, using56-bitDESencryption,canbe restoredwithanolderclient.
Preferences File
Placethisoption inthedsm.sys file.Youcanalsoset thisoptiononthe Authorization tabof thePreferenceseditor.Theservercanoverridethis.
Syntax
AES128 ENCRYPTIONType
DES56
Parameters
AES128
AES128-bitdataencryption.AES128-bitdataencryptionprovidesastronger formofdataencryptionthanDES56-bit dataencryption.Thisisthedefault.
DES56
DES56-bit dataencryption.
Examples
Optionsfile:
encryptiontype aes128 Commandline:
Does not apply.
Encryptkey
The TivoliStorageManager clientsupportstheoptiontoencryptfilesbeingbacked upor archivedtotheTivoliStorageManagerserver.Thisoptionisenabledwith theinclude.encryptoption.Allfilesmatchingthepatternontheinclude.encrypt specification willbe encryptedbefore thedataissenttotheserver.Therearethree optionsformanagingthekeyusedtoencryptthefiles (prompt,save,and
generate).All threeoptionscanbeusedwitheithertheBackup-Archiveclient or theTivoliStorageManagerAPI.
Attention: Whenusingthepromptoption,yourencryptionkeyisnotsavedin theWindows RegistryortheTivoliStorageManager passwordfileonUNIX.If youforgetthekey,yourdatawillbeunrecoverable.
Supported Clients
Thisoptionisvalidforallclients.
Preferences File
Placethisoption intheclient systemoptionsfile(dsm.sys).Youcansetthisoption ontheAuthorization category,EncryptionKey Passwordsectionof the
Preferenceseditor.
TheencryptionkeypasswordissavedintheTivoliStorageManagerclient’s passwordfile.Apromptisissued foraninitial encryptionkeypassword,and after theinitialprompt,thesavedencryptionkeypasswordinthepassword fileisusedforthebackupsand archivesoffilesmatchingtheinclude.encrypt specification.Thiskeycanbe upto63bytesinlength.Thekeyisretrieved fromthepasswordfileonrestoreand retrieveoperations.
Thisisthedefault.
Restrictions:
v Thisoptioncanonlybeusedwhenpasswordaccessgenerateisalsospecified.
v Therootuser oraTivoliStorageManagerauthorized usermust specifythe initialencryptionkeypassword.
v
Thedefaultforencryptkeyissave,andthedefaultforpasswordaccess is prompt.However, ifyouspecifyencryptkey=save,youmust alsospecify passwordaccessgenerate,when youspecifyincludeencrypt.
prompt
Themanagement oftheencryptionkeypasswordisprovidedbytheuser.The user ispromptedfortheencryptionkeypasswordwhentheTivoliStorage Manager clientbeginsabackuporarchive.Apromptfor thesamekeyis issued whenrestoringorretrievingtheencryptedfile.Thiskeycanbeupto63 bytesinlength.
Restriction:Thisoption canonlybe usedbytherootuser oraTivoliStorage Manager authorizeduser.
generate
An encryptionkeypasswordisdynamicallygeneratedwhentheTivoliStorage Manager clientbeginsabackuporarchive.Thisgeneratedkeypasswordis usedforthebackupsoffilesmatching theinclude.encryptspecification.The generatedkeypassword,inan encryptedform,iskept ontheTivoliStorage Manager server.ThekeypasswordisreturnedtotheTivoliStorageManager clientto enablethefiletobe decryptedonrestoreandretrieveoperations.
Examples
Optionsfile:
encryptkey prompt Commandline:
Does not apply.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Errorlogmax
Authorized User
The errorlogmaxoptionspecifiesthemaximumsize oftheerrorlog,inmegabytes.
Ifyouchangefromerrorlogmaxtoerrorlogretention,all existinglogentriesare retainedandthelogisprunedusingthenewerrorlogretention criteria.
Ifyouchangefromerrorlogretentiontoerrorlogmax,all recordsintheexistinglog are copiedtotheprunedlogdsmerlog.pru,theexistinglogisemptied,and logging begins underthenew logwrapping criteria.
Ifyouchangethevalueoftheerrorlogmaxoption,theexistinglogisextended or shortened toaccommodatethenewsize.Ifthevalueisreduced,theoldestentries are deletedtoreducethefiletothenewsize.
Restriction:Youcannotspecifya non-zeroerrorlogmaxvalueand enable errorlogretention.
Preferences File
Placethisoption inthedsm.sys file.Youcansetthis optionontheGeneral category,SelectErrorLogbuttonofthePreferenceseditor.
Syntax
ERRORLOGMAX
size
Parameters
size
Specifiesthemaximumsize,inmegabytes,forthelogfile.The rangeofvalues is0 to2047;thedefaultis0,whichdisableslogfilewrappingand allowsthe logfiletogrowindefinitely.
Examples
Optionsfile:
errorlogmax 2000 Commandline:
-errorlogmax=2000
Thisoptionisvalidonlyontheinitialcommandline.Itisnotvalidininteractive mode.
Errorlogname
Authorized User
Thisoptionspecifies thefullyqualified pathandfilenameof thefilewhereerror messages arewritten.
Preferences File
Placethisoption inthedsm.sys file.Youcansetthisoption ontheGeneral category,SelectErrorLogbuttonofthePreferenceseditor.
Syntax
ERRORLOGName
filespec
Parameters
filespec
Thefullyqualified pathandfilenamein whichtostore errorloginformation.
Ifanypartofthepathyouspecifydoesnotexist,TivoliStorageManager attemptstocreateit.
Thedefaultfilenameisdsmerror.loganditisplacedoneofthefollowing locations:
~/Library/Logs/tivoli/tsm/
/Library/Logs/tivoli/tsm/
Examples
Optionsfile:
Commandline:
-errorlogname=/Users/user1/tsmerror.log
Thisoptionisvalidonlyontheinitialcommandline.Itisnotvalidininteractive mode.
Errorlogretention
Authorized User
The errorlogretentionoptionspecifies howmanydaystomaintainerrorlogentries before pruning,andwhethertosavetheprunedentries.Theerrorlogispruned when thefirst erroriswritten tothelogafter aTivoliStorageManagersession is started.Iftheonlysession yourunistheclientscheduler,and yourunit
twenty-fourhoursa day,theerrorlogmightnotbe prunedaccording toyour expectations. Stopthesession andstart itagaintoallowtheschedulertoprunethe errorlog.
Ifyouchangefromerrorlogretentiontoerrorlogmax,all recordsintheexistinglog are copiedtotheprunedlogdsmerlog.pru,theexistinglogisemptied,and logging begins underthenew logwrapping criteria.
Ifyouchangefromerrorlogmaxtoerrorlogretention,all existinglogentriesare retainedandthelogisprunedusingthenewerrorlogretention criteria.
Restriction:Youcannotspecifyerrorlogretention andanon-zeroerrorlogmax value.
Preferences File
Placethisoption inthedsm.sys file.Youcansetthis optionontheGeneral category,SelectErrorLogbuttonofthePreferenceseditor.
Syntax
N D
ERRORLOGRetention
days S
Parameters
Nordays
Specifieshow longtowaitbefore pruningtheerrorlog.
N Donotprunetheerrorlog.Thispermitstheerrorlogtogrowindefinitely.
Thisisthedefault.
days
Thenumber ofdaystokeeplogfileentriesbeforepruningthelog.The rangeofvaluesiszerothrough9999.
DorS
Specifieswhethertosave theprunedentries. Entera spaceor commato separate thisparameterfromthepreviousone.
D Discard theerrorlogentrieswhenyouprunethelog.Thisisthedefault.
S Savetheerrorlogentrieswhenyouprunethelog.
Theprunedentriesarecopiedfromtheerrorlogtothedsmerlog.prufile locatedinthesamedirectoryastheerrorlog.
Examples
Optionsfile:
errorlogretention 400 S
Commandline:
-errorlogr=400,S
Thisoptionisvalidonlyontheinitialcommandline.Itisnotvalidininteractive mode.