Contents

List of Examples

List of Tables

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

Changes in This Release for Oracle Secure Backup Reference

• Changes in Oracle Secure Backup 12c Release 2 (12.2.0.1)
• Deprecated Features

1 About obtool

• 1.1 obtool Invocation
  • 1.1.1 obtool Login
    • 1.1.1.1 Login and Preauthorization
  • 1.1.2 obtool Interactive Mode
    • 1.1.2.1 obtool Syntax for Interactive Mode
    • 1.1.2.2 Command Execution in Interactive Mode
    • 1.1.2.3 Input Redirection in Interactive Mode
    • 1.1.2.4 Exiting obtool
  • 1.1.3 obtool Noninteractive Mode
    • 1.1.3.1 Escaping Special Characters in obtool Command Line
    • 1.1.3.2 Running Multiple obtool Commands Non-Interactively
    • 1.1.3.3 Redirecting obtool Commands From an Input File
  • 1.1.4 Exiting obtool
  • 1.1.5 Logging Out of obtool
  • 1.1.6 Starting obtool as a Specific User: obtool -u
  • 1.1.7 obtool Domain Authentication
  • 1.1.8 obtool Version Number
  • 1.1.9 obtool Date and Time Information
• 1.2 obtool Online Help
  • 1.2.1 obtool Topics
  • 1.2.2 obtool Command Syntax
  • 1.2.3 obtool Glossary
• 1.3 obtool Command Categories
  • 1.3.1 Backup Commands
  • 1.3.2 Backup Image Commands
  • 1.3.3 Backup Image Instance Management
  • 1.3.4 Backup Piece Commands
  • 1.3.5 Backup Window Commands
  • 1.3.6 Browser Commands
  • 1.3.7 Checkpoint Commands
  • 1.3.8 Class Commands
  • 1.3.9 Daemon Commands
  • 1.3.10 Database Backup Storage Selector Commands
  • 1.3.11 Dataset Commands
  • 1.3.12 Device Commands
  • 1.3.13 Duplication on Demand Commands
  • 1.3.14 Duplication Window Commands
  • 1.3.15 File-System Command
  • 1.3.16 Host Commands
  • 1.3.17 Job Commands
  • 1.3.18 Library Commands
  • 1.3.19 Location Commands
  • 1.3.20 Media Family Commands
  • 1.3.21 Miscellaneous Commands
  • 1.3.22 Policy Commands
  • 1.3.23 Preferred Network Interface Commands
  • 1.3.24 Reports Commands
  • 1.3.25 Restore Commands
  • 1.3.26 Rotation Policy Commands
  • 1.3.27 Schedule Commands
  • 1.3.28 Section Commands
  • 1.3.29 Snapshot Commands
  • 1.3.30 Staging Commands
  • 1.3.31 Summary Commands
  • 1.3.32 User Commands
  • 1.3.33 Volume Rotation Commands
  • 1.3.34 Volume Duplication Commands
• 1.4 obtool Lexical Conventions
  • 1.4.1 Conventions in Syntax Diagrams
  • 1.4.2 Conventions in Code Examples
• 1.5 obtool Exit Codes

2 obtool Commands: addbw to lsvol

• 2.1 addbw
• 2.2 adddw
• 2.3 addp
• 2.4 backup
• 2.5 borrowdev
• 2.6 canceljob
• 2.7 catalog
• 2.8 catds
• 2.9 catrpt
• 2.10 catxcr
• 2.11 cd
• 2.12 cdds
• 2.13 cdp
• 2.14 chclass
• 2.15 chdev
• 2.16 chdup
• 2.17 chhost
• 2.18 chinstance
• 2.19 chkbw
• 2.20 chkds
• 2.21 chkdw
• 2.22 chloc
• 2.23 chmf
• 2.24 chpni
• 2.25 chrot
• 2.26 chsched
• 2.27 chssel
• 2.28 chstage
• 2.29 chsum
• 2.30 chuser
• 2.31 chvol
• 2.32 clean
• 2.33 closedoor
• 2.34 cpinstance
• 2.35 ctldaemon
• 2.36 discoverdev
• 2.37 dumpdev
• 2.38 dupvol
• 2.39 edds
• 2.40 exit
• 2.41 exportvol
• 2.42 extractvol
• 2.43 find
• 2.44 id
• 2.45 identifyvol
• 2.46 importvol
• 2.47 insertvol
• 2.48 inventory
• 2.49 labelvol
• 2.50 loadvol
• 2.51 logout
• 2.52 ls
• 2.53 lsbackup
• 2.54 lsbkup
• 2.55 lsbu
• 2.56 lsbw
• 2.57 lscheckpoint
• 2.58 lsclass
• 2.59 lsdaemon
• 2.60 lsdev
• 2.61 lsds
• 2.62 lsdup
• 2.63 lsdw
• 2.64 lsfs
• 2.65 lshost
• 2.66 lsinstance
• 2.67 lsjob
• 2.68 lsloc
• 2.69 lsmf
• 2.70 lsp
• 2.71 lspiece
• 2.72 lspni
• 2.73 lsrestore
• 2.74 lsrot
• 2.75 lsrpt
• 2.76 lssched
• 2.77 lssection
• 2.78 lssnap
• 2.79 lsssel
• 2.80 lsstage
• 2.81 lssum
• 2.82 lsuser
• 2.83 lsvol

3 obtool Commands: managedev to vfylibs

• 3.1 managedev
• 3.2 mkclass
• 3.3 mkdev
• 3.4 mkds
• 3.5 mkdup
• 3.6 mkhost
• 3.7 mkloc
• 3.8 mkmf
• 3.9 mkpni
• 3.10 mkrot
• 3.11 mksched
• 3.12 mksnap
• 3.13 mkssel
• 3.14 mkstage
• 3.15 mksum
• 3.16 mkuser
• 3.17 mountdev
• 3.18 movevol
• 3.19 opendoor
• 3.20 pingdev
• 3.21 pinghost
• 3.22 pwd
• 3.23 pwdds
• 3.24 pwdp
• 3.25 quit
• 3.26 recallvol
• 3.27 releasevol
• 3.28 renbkup
• 3.29 renclass
• 3.30 rendev
• 3.31 rends
• 3.32 rendup
• 3.33 renhost
• 3.34 renloc
• 3.35 renmf
• 3.36 renrot
• 3.37 rensched
• 3.38 rensnap
• 3.39 renssel
• 3.40 renstage
• 3.41 rensum
• 3.42 renuser
• 3.43 resdev
• 3.44 resetp
• 3.45 restore
• 3.46 returndev
• 3.47 reusevol
• 3.48 revhost
• 3.49 rmbackup
• 3.50 rmbw
• 3.51 rmcheckpoint
• 3.52 rmclass
• 3.53 rmdev
• 3.54 rmds
• 3.55 rmdup
• 3.56 rmdw
• 3.57 rmhost
• 3.58 rminstance
• 3.59 rmjob
• 3.60 rmloc
• 3.61 rmmf
• 3.62 rmp
• 3.63 rmpiece
• 3.64 rmpni
• 3.65 rmrestore
• 3.66 rmrot
• 3.67 rmsched
• 3.68 rmsection
• 3.69 rmsnap
• 3.70 rmssel
• 3.71 rmstage
• 3.72 rmsum
• 3.73 rmuser
• 3.74 rmvol
• 3.75 rpyjob
• 3.76 runjob
• 3.77 set
• 3.78 setbw
• 3.79 setdw
• 3.80 setp
• 3.81 show
• 3.82 stagescan
• 3.83 unlabelvol
• 3.84 unloadvol
• 3.85 unmountdev
• 3.86 unresdev
• 3.87 unrmsection
• 3.88 unset
• 3.89 updatehost
• 3.90 vault
• 3.91 vfylibs

4 obtool Placeholders

• 4.1 aspec
• 4.2 authtype
• 4.3 backup-container
• 4.4 backup-level
• 4.5 concjobs
• 4.6 content
• 4.7 data-selector
• 4.8 dataset-dir-name
• 4.9 dataset-file-name
• 4.10 dataset-name
• 4.11 date-range
• 4.12 date-time
• 4.13 day-date
• 4.14 day-specifier
• 4.15 devicename
• 4.16 dupevent
• 4.17 duplicationrule
• 4.18 duration
• 4.19 element-spec
• 4.20 event
• 4.21 filenumber
• 4.22 filenumber-list
• 4.23 iee-range
• 4.24 iee-spec
• 4.25 job-type
• 4.26 name-format
• 4.27 ndmp-backup-type
• 4.28 numberformat
• 4.29 oid
• 4.30 oid-list
• 4.31 policyname
• 4.32 preauth-spec
• 4.33 produce-days
• 4.34 protover
• 4.35 restriction
• 4.36 role
• 4.37 rotationrule
• 4.38 schedule-priority
• 4.39 se-range
• 4.40 se-spec
• 4.41 size-spec
• 4.42 summary-start-day
• 4.43 time
• 4.44 time-range
• 4.45 vid
• 4.46 vol-range
• 4.47 vol-spec
• 4.48 vol-status
• 4.49 wwn

5 obtool Variables

• 5.1 browsemode
• 5.2 drive
• 5.3 errors
• 5.4 escape
• 5.5 fs
• 5.6 host
• 5.7 level
• 5.8 library
• 5.9 maxlevel
• 5.10 namewidth
• 5.11 numberformat
• 5.12 snapshot
• 5.13 verbose
• 5.14 viewmode
• 5.15 width

6 Dataset Language

• 6.1 Overview of the Dataset Language
• 6.2 Dataset File Examples
  • 6.2.1 Backing Up Multiple Paths on Multiple Hosts
  • 6.2.2 Including Dataset Files Within Dataset Files
  • 6.2.3 Defining the Scope of a Backup
• 6.3 Backward Compatibility
• 6.1 Dataset Statements
  • 6.1.1 after backup
  • 6.1.2 before backup
  • 6.1.3 cross all mountpoints
  • 6.1.4 cross local mountpoints
  • 6.1.5 cross remote mountpoints
  • 6.1.6 exclude dir
  • 6.1.7 exclude file
  • 6.1.8 exclude name
  • 6.1.9 exclude oracle database files
  • 6.1.10 exclude path
  • 6.1.11 include catalog
  • 6.1.12 include dataset
  • 6.1.13 include host
  • 6.1.14 include path
  • 6.1.15 setenv NDMP

7 Defaults and Policies

• 7.1 Backup Compression Policies
  • 7.1.1 option
  • 7.1.2 buffersize
  • 7.1.3 excludeformats
• 7.2 Backup Encryption Policies
  • 7.2.1 algorithm
  • 7.2.2 enablehardwareencryption
  • 7.2.3 encryption
  • 7.2.4 keytype
  • 7.2.5 rekeyfrequency
  • 7.2.6 requireencryptablemedia
• 7.3 Copy Backup Image Instance Policies
  • 7.3.1 defaultjobpriority
  • 7.3.2 encryption
  • 7.3.3 copyoptions
• 7.4 Cloud Storage Device Policies
  • 7.4.1 proxyserver
  • 7.4.2 proxyuser
  • 7.4.3 proxypassword
  • 7.4.4 segmentsize
  • 7.4.5 streamsperjob
  • 7.4.6 transfertimeout
  • 7.4.7 usepersistentcon
• 7.5 Daemon Policies
  • 7.5.1 auditlogins
  • 7.5.2 obhttpdwindowslogon
  • 7.5.3 obhttpdwindowspassword
  • 7.5.4 obixdmaxupdaters
  • 7.5.5 obixdrechecklevel
  • 7.5.6 obixdupdaternicevalue
  • 7.5.7 webautostart
  • 7.5.8 webpass
  • 7.5.9 windowscontrolcertificateservice
• 7.6 Device Policies
  • 7.6.1 checkserialnumbers
  • 7.6.2 deletediskorphans
  • 7.6.3 disableasyncio
  • 7.6.4 discovereddevicestate
  • 7.6.5 errorrate
  • 7.6.6 maxdriveidletime
  • 7.6.7 maxacsejectwaittime
  • 7.6.8 poolfreespacegoal
  • 7.6.9 returntoservicecheck
• 7.7 Duplication Policies
  • 7.7.1 duplicateovernetwork
  • 7.7.2 duplicationjobpriority
  • 7.7.3 duplicationoptions
• 7.8 Index Policies
  • 7.8.1 asciiindexrepository
  • 7.8.2 autoindex
  • 7.8.3 earliestindexcleanuptime
  • 7.8.4 generatendmpindexdata
  • 7.8.5 indexcleanupfrequency
  • 7.8.6 latestindexcleanuptime
  • 7.8.7 maxindexbuffer
  • 7.8.8 positiondatainterval
  • 7.8.9 saveasciiindexfiles
• 7.9 Log Policies
  • 7.9.1 adminlogevents
  • 7.9.2 adminlogfile
  • 7.9.3 clientlogevents
  • 7.9.4 jobretaintime
  • 7.9.5 logretaintime
  • 7.9.6 transcriptlocation
  • 7.9.7 transcriptretaintime
  • 7.9.8 unixclientlogfile
  • 7.9.9 windowsclientlogfile
• 7.10 Media Policies
  • 7.10.1 barcodesrequired
  • 7.10.2 blockingfactor
  • 7.10.3 freedstucktapethreshold
  • 7.10.4 maxblockingfactor
  • 7.10.5 overwriteblanktape
  • 7.10.6 overwriteforeigntape
  • 7.10.7 overwriteunreadabletape
  • 7.10.8 volumeretaintime
  • 7.10.9 writewindowtime
• 7.11 Naming Policies
  • 7.11.1 winsserver
• 7.12 NDMP Policies
  • 7.12.1 authenticationtype
  • 7.12.2 backupev
  • 7.12.3 backuptype
  • 7.12.4 dmahosts
  • 7.12.5 password
  • 7.12.6 port
  • 7.12.7 protocolversion
  • 7.12.8 restoreev
  • 7.12.9 username
• 7.13 Operations Policies
  • 7.13.1 autohistory
  • 7.13.2 autolabel
  • 7.13.3 backupimagerechecklevel
  • 7.13.4 backupoptions
  • 7.13.5 databuffersize
  • 7.13.6 disablerds
  • 7.13.7 fullbackupcheckpointfrequency
  • 7.13.8 incrbackupcheckpointfrequency
  • 7.13.9 overwritecheckfrequency
  • 7.13.10 mailport
  • 7.13.11 mailserver
  • 7.13.12 mailfrom
  • 7.13.13 maxcheckpointrestarts
  • 7.13.14 maxentriesrestoreoperation
  • 7.13.15 progressupdatefrequency
  • 7.13.16 restartablebackups
  • 7.13.17 restoreoptions
  • 7.13.18 rmanpriority
  • 7.13.19 rmanresourcewaittime
  • 7.13.20 rmanrestorestartdelay
  • 7.13.21 tcpbufsize
  • 7.13.22 useloadbalance
  • 7.13.23 windowsskipcdfs
  • 7.13.24 windowsskiplockedfiles
• 7.14 Scheduler Policies
  • 7.14.1 applybackupsfrequency
  • 7.14.2 cachealljobs
  • 7.14.3 defaultstarttime
  • 7.14.4 maxdataretries
  • 7.14.5 pollfrequency
  • 7.14.6 recyclejobthreshhold
  • 7.14.7 retainbackupmetrics
• 7.15 Security Policies
  • 7.15.1 autocertissue
  • 7.15.2 certkeysize
  • 7.15.3 certlifetime
  • 7.15.4 certwarning
  • 7.15.5 encryptdataintransit
  • 7.15.6 loginduration
  • 7.15.7 minuserpasswordlen
  • 7.15.8 passwordgracetime
  • 7.15.9 passwordlifetime
  • 7.15.10 passwordreusetime
  • 7.15.11 securecomms
  • 7.15.12 trustedhosts
  • 7.15.13 untrustedhostjobs
  • 7.15.14 webinactivitytimeout
  • 7.15.15 websessiontimeout
• 7.16 Staging Policies
  • 7.16.1 defaultscanjobpriority
  • 7.16.2 obstagescandebuglevel
• 7.17 Vaulting Policies
  • 7.17.1 autorunmmjobs
  • 7.17.2 autovolumerelease
  • 7.17.3 invretrydelay
  • 7.17.4 maxinvretrytime
  • 7.17.5 minwritablevolumes
  • 7.17.6 offsitecustomerid
  • 7.17.7 reportretaintime

8 Classes and Rights

• 8.1 Class Rights
  • 8.1.1 access file system backups
  • 8.1.2 access Oracle database backups
  • 8.1.3 browse backup catalogs with this access
  • 8.1.4 display administrative domain's configuration
  • 8.1.5 modify administrative domain's configuration
  • 8.1.6 list any backup, regardless of its owner
  • 8.1.7 list any backups owned by user
  • 8.1.8 list any job, regardless of its owner
  • 8.1.9 list any jobs owned by user
  • 8.1.10 manage devices and change device state
  • 8.1.11 modify any backup, regardless of its owner
  • 8.1.12 modify any backups owned by user
  • 8.1.13 modify any job, regardless of its owner
  • 8.1.14 modify any jobs owned by user
  • 8.1.15 modify catalog
  • 8.1.16 modify own name and password
  • 8.1.17 perform file system backups as privileged user
  • 8.1.18 perform file system backups as self
  • 8.1.19 perform Oracle database backups and restores
  • 8.1.20 perform file system restores as privileged user
  • 8.1.21 perform file system restores as self
  • 8.1.22 query and display information about devices
  • 8.1.23 receive email describing internal errors
  • 8.1.24 receive email regarding expired passphrase keys
  • 8.1.25 receive email requesting operator assistance

A Miscellaneous Programs

• A.1 makedev
• A.2 obcleanup
• A.3 obcm
• A.4 uninstallob

B obtar

• B.1 obtar Overview
• B.2 Optimizing Your Use of obtar
  • B.2.1 Using tar with Backup Images Created by obtar
  • B.2.2 Backing Up and Restoring Raw File Systems
    • B.2.2.1 Backing Up Raw Partitions
    • B.2.2.2 Restoring Raw Partitions
  • B.2.3 Changing Criteria for Incremental Backups
  • B.2.4 Backing Up Across Mount Points
• B.1 obtar -c
• B.2 obtar -x
• B.3 obtar -t
• B.4 obtar -zz
• B.5 obtar Options

C RMAN Media Management Parameters

• C.1 Database Backup Storage Selectors and RMAN Media Management Parameters
• C.2 About Setting the Job Priority for RMAN Operations
• C.1 OB_BACKUP_NAME
• C.2 OB_DEVICE
• C.3 OB_ENCRYPTION
• C.4 OB_IGNORE_NUMA
• C.5 OB_MEDIA_FAMILY
• C.6 OB_PRIORITY
• C.7 OB_RESOURCE_WAIT_TIME
• C.8 OB_RESTORE_DEVICE

D Oracle Secure Backup Support for Extended Attributes and Access Control Lists

• D.1 Overview of Extended Attributes and Access Control Lists
• D.2 Supported Platforms
• D.3 Requirements
• D.4 Security Practices
• D.5 Performing Backup and Recovery with Extended Attributes and Access Control Lists on Linux and Unix

E Startup and Shutdown of Oracle Secure Backup Services

Glossary

Index