Go to main content
1/21
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 1 (12.1.0.3)
Changes in Oracle Secure Backup 12c Release 1 (12.1)
New Features
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
Summary Commands
1.3.31
User Commands
1.3.32
Volume Rotation Commands
1.3.33
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
chsum
2.29
chuser
2.30
chvol
2.31
clean
2.32
closedoor
2.33
cpinstance
2.34
ctldaemon
2.35
discoverdev
2.36
dumpdev
2.37
dupvol
2.38
edds
2.39
exit
2.40
exportvol
2.41
extractvol
2.42
find
2.43
id
2.44
identifyvol
2.45
importvol
2.46
insertvol
2.47
inventory
2.48
labelvol
2.49
loadvol
2.50
logout
2.51
ls
2.52
lsbackup
2.53
lsbkup
2.54
lsbu
2.55
lsbw
2.56
lscheckpoint
2.57
lsclass
2.58
lsdaemon
2.59
lsdev
2.60
lsds
2.61
lsdup
2.62
lsdw
2.63
lsfs
2.64
lshost
2.65
lsinstance
2.66
lsjob
2.67
lsloc
2.68
lsmf
2.69
lsp
2.70
lspiece
2.71
lspni
2.72
lsrestore
2.73
lsrot
2.74
lsrpt
2.75
lssched
2.76
lssection
2.77
lssnap
2.78
lsssel
2.79
lssum
2.80
lsuser
2.81
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
mksum
3.15
mkuser
3.16
mountdev
3.17
movevol
3.18
opendoor
3.19
pingdev
3.20
pinghost
3.21
pwd
3.22
pwdds
3.23
pwdp
3.24
quit
3.25
recallvol
3.26
releasevol
3.27
renbkup
3.28
renclass
3.29
rendev
3.30
rends
3.31
rendup
3.32
renhost
3.33
renloc
3.34
renmf
3.35
renrot
3.36
rensched
3.37
rensnap
3.38
renssel
3.39
rensum
3.40
renuser
3.41
resdev
3.42
resetp
3.43
restore
3.44
returndev
3.45
reusevol
3.46
revhost
3.47
rmbackup
3.48
rmbw
3.49
rmcheckpoint
3.50
rmclass
3.51
rmdev
3.52
rmds
3.53
rmdup
3.54
rmdw
3.55
rmhost
3.56
rminstance
3.57
rmjob
3.58
rmloc
3.59
rmmf
3.60
rmp
3.61
rmpiece
3.62
rmpni
3.63
rmrestore
3.64
rmrot
3.65
rmsched
3.66
rmsection
3.67
rmsnap
3.68
rmssel
3.69
rmsum
3.70
rmuser
3.71
rmvol
3.72
rpyjob
3.73
runjob
3.74
set
3.75
setbw
3.76
setdw
3.77
setp
3.78
show
3.79
unlabelvol
3.80
unloadvol
3.81
unmountdev
3.82
unresdev
3.83
unrmsection
3.84
unset
3.85
updatehost
3.86
vault
3.87
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 Encryption Policies
7.1.1
algorithm
7.1.2
enablehardwareencryption
7.1.3
encryption
7.1.4
keytype
7.1.5
rekeyfrequency
7.1.6
requireencryptablemedia
7.2
Copy Backup Image Instance Policies
7.2.1
defaultjobpriority
7.2.2
encryption
7.2.3
copyoptions
7.3
Daemon Policies
7.3.1
auditlogins
7.3.2
obhttpdwindowslogon
7.3.3
obhttpdwindowspassword
7.3.4
obixdmaxupdaters
7.3.5
obixdrechecklevel
7.3.6
obixdupdaternicevalue
7.3.7
webautostart
7.3.8
webpass
7.3.9
windowscontrolcertificateservice
7.4
Device Policies
7.4.1
checkserialnumbers
7.4.2
deletediskorphans
7.4.3
disableasyncio
7.4.4
discovereddevicestate
7.4.5
errorrate
7.4.6
maxdriveidletime
7.4.7
maxacsejectwaittime
7.4.8
poolfreespacegoal
7.4.9
returntoservicecheck
7.5
Duplication Policies
7.5.1
duplicateovernetwork
7.5.2
duplicationjobpriority
7.5.3
duplicationoptions
7.6
Index Policies
7.6.1
asciiindexrepository
7.6.2
autoindex
7.6.3
earliestindexcleanuptime
7.6.4
generatendmpindexdata
7.6.5
indexcleanupfrequency
7.6.6
latestindexcleanuptime
7.6.7
maxindexbuffer
7.6.8
positiondatainterval
7.6.9
saveasciiindexfiles
7.7
Log Policies
7.7.1
adminlogevents
7.7.2
adminlogfile
7.7.3
clientlogevents
7.7.4
jobretaintime
7.7.5
logretaintime
7.7.6
transcriptlocation
7.7.7
transcriptretaintime
7.7.8
unixclientlogfile
7.7.9
windowsclientlogfile
7.8
Media Policies
7.8.1
barcodesrequired
7.8.2
blockingfactor
7.8.3
freedstucktapethreshold
7.8.4
maxblockingfactor
7.8.5
overwriteblanktape
7.8.6
overwriteforeigntape
7.8.7
overwriteunreadabletape
7.8.8
volumeretaintime
7.8.9
writewindowtime
7.9
Naming Policies
7.9.1
winsserver
7.10
NDMP Policies
7.10.1
authenticationtype
7.10.2
backupev
7.10.3
backuptype
7.10.4
dmahosts
7.10.5
password
7.10.6
port
7.10.7
protocolversion
7.10.8
restoreev
7.10.9
username
7.11
Operations Policies
7.11.1
autohistory
7.11.2
autolabel
7.11.3
backupimagerechecklevel
7.11.4
backupoptions
7.11.5
databuffersize
7.11.6
disablerds
7.11.7
fullbackupcheckpointfrequency
7.11.8
incrbackupcheckpointfrequency
7.11.9
overwritecheckfrequency
7.11.10
mailport
7.11.11
mailserver
7.11.12
mailfrom
7.11.13
maxcheckpointrestarts
7.11.14
maxentriesrestoreoperation
7.11.15
progressupdatefrequency
7.11.16
restartablebackups
7.11.17
restoreoptions
7.11.18
rmanpriority
7.11.19
rmanresourcewaittime
7.11.20
rmanrestorestartdelay
7.11.21
tcpbufsize
7.11.22
useloadbalance
7.11.23
windowsskipcdfs
7.11.24
windowsskiplockedfiles
7.12
Scheduler Policies
7.12.1
applybackupsfrequency
7.12.2
cachealljobs
7.12.3
defaultstarttime
7.12.4
maxdataretries
7.12.5
pollfrequency
7.12.6
recyclejobthreshhold
7.12.7
retainbackupmetrics
7.13
Security Policies
7.13.1
autocertissue
7.13.2
certkeysize
7.13.3
certlifetime
7.13.4
certwarning
7.13.5
encryptdataintransit
7.13.6
loginduration
7.13.7
minuserpasswordlen
7.13.8
passwordgracetime
7.13.9
passwordlifetime
7.13.10
passwordreusetime
7.13.11
securecomms
7.13.12
trustedhosts
7.13.13
untrustedhostjobs
7.13.14
webinactivitytimeout
7.13.15
websessiontimeout
7.14
Vaulting Policies
7.14.1
autorunmmjobs
7.14.2
autovolumerelease
7.14.3
invretrydelay
7.14.4
maxinvretrytime
7.14.5
minwritablevolumes
7.14.6
offsitecustomerid
7.14.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
Scripting on this page enhances content navigation, but does not change the content in any way.