This chapter describes the obtool commands in alphabetical order.
Use the addbw
command to add a backup window, which is a time and day range, to an existing list of backup windows.
See Also:
"Backup Window Commands" for related commandsYou must have the modify administrative domain's configuration right to use the addbw
command.
addbw { --times/-t time-range[,time-range]... } day-specifier[,day-specifier]...
Defines a time-of-day range. Refer to "time-range" for a description of the time-range
placeholder.
Defines the day ranges for the backup window. Refer to "day-specifier" for a description of the day-specifier
placeholder.
Example 2-1 Adding Backup Windows
This example creates backup windows so that backups can run from 8 a.m. to 8 p.m. on weekends and any time other than 8 a.m. to 8 p.m. on weekdays.
ob> addbw --times 08:00-20:00 weekend ob> addbw --times 00:00-08:00 mon-fri ob> addbw --times 20:00-24:00 mon-fri ob> lsbw weekend 08:00-24:00 weekday 00:00-08:00,20:00-24:00
Use the adddw
command to add a duplication window, which is a time and day range, to an existing list of duplication windows.
See Also:
"Duplication Window Commands" for related commandsYou must have the modify administrative domain's configuration right to use the adddw
command.
adddw { --times/-t time-range[,time-range]... } day-specifier[,day-specifier]...
Defines a time-of-day range for the duplication window. Refer to "time-range" for a description of the time-range
placeholder.
Defines the day ranges for the duplication window. Refer to "day-specifier" for a description of the day-specifier
placeholder.
Use the addp
command to add a variable name-value pair to a policy.
See Also:
"Policy Commands" for related commands
Appendix 6, "Defaults and Policies" for a complete list of policies and policy classes
You must have the modify administrative domain's configuration right to use the addp
command.
addp policy-name { member-name member-value }...
Specifies the name of a policy or a class of policies.
Specifies the user-assigned name of a policy, usually an environment variable name.
Specifies the user-assigned value of a policy, usually an environment variable value.
Example 2-2 Enabling Verbose Output from the NDMP Data Service
This example uses the addp
command to set the VERBOSE
environment variable for the backupev policy in the ndmp
class.
ob> pwdp / ob> lsp ndmp authenticationtype negotiated [default] backupev (none) [default] backuptype (host type specific) [default] password (not set) [default] port 10000 [default] protocolversion (as proposed by server) [default] restoreev (none) [default] username root [default] ob> addp ndmp/backupev VERBOSE y ob> lsp ndmp/backupev backupev VERBOSE y
Use the backup
command to create a file-system backup request. A file-system backup is distinct from a database backup, which is initiated by Recovery Manager (RMAN).
Backup requests are held locally in obtool until you run the backup
command with the --go
option. Oracle Secure Backup forwards the requests to the scheduler, at which time the requests become jobs and are eligible to run.
A backup made with the backup
command is called an on-demand backup. On-demand backups run just once, either immediately or at a specified time in the future. In contrast, a scheduled backup runs according to a user-specified schedule, which you create with the mksched command.
Each time Oracle Secure Backup performs a backup, it records the name and attributes of each file-system object that it backs up. It writes this data to the Oracle Secure Backup catalog, which is stored on the administrative server. Oracle Secure Backup maintains a discrete backup catalog for each client in the administrative domain.
Whether backups are encrypted and the encryption algorithm and keys used depend upon the current global backup policies described in "Backup Encryption Policies", client backup policies set with the mkhost and chhost commands, and the value of the --encryption
option to this command, if used.
See Also:
"Backup Commands" for commands relating to on-demand backups
"Schedule Commands" for commands relating to scheduled backups
"Browser Commands" for commands that enable you to browse the contents of the backup catalog of any client
"Dataset Commands" to learn how to create and manage dataset files and directories
"Job Commands" to learn how to display and manage backup jobs
"Media Family Commands" to learn how to create and manage media families
You must have the perform file system backups as privileged user right if you specify the --privileged
option. Otherwise, you must have the perform file system backups as self right.
backup [ --level/-l backup-level ] [ --priority/-p schedule-priority ] [ --at/-a date-time ] [ --family/-f media-family-name ] [ --restrict/-r restriction[,restriction]... ] [ --privileged/-g | --unprivileged/-G ] [ --encryption/-e { yes | no | forcedoff | transient } ] [ --algorithm/-L {AES128 | AES192 | AES256 } ] [ --passphrase/-P string ][ --querypassphrase/-Q ] [ --storekey/-s ] [ - disablehardwareencryption /-e ] [ --expires/-x duration] [ --quiet/-q ] { --dataset/-D dataset-name... | --go }
Identifies a backup level. The default level is 0. Refer to "backup-level" for a description of the backup-level
placeholder.
Assigns a schedule priority to a backup. The default priority is 100. Refer to "schedule-priority" for a description of the schedule-priority
placeholder.
Specifies the date and optional time to perform the backup. By default the backup is eligible to run immediately. If you specify a future date, then the backup is eligible to run at the date and time specified rather than immediately. Refer to "date-time" for a description of the date-time
placeholder.
Defines the media family to be used for the backup. If you do not specify a media family, then Oracle Secure Backup defaults to the null
media family. In this case, the volume has no expiration time and its write window remains open forever. By default, VOL
is used for the volume ID prefix, as in the volume ID VOL000002
.
Defines a tape device, host, or tape device/host pair in the administrative domain that identifies one or more acceptable tape devices for the backup. Refer to "restriction" for a description of the restriction
placeholder.
In the absence of a tape device restriction, the backup runs on the first available tape device. You can specify the restriction as a tape device name (as assigned by mkdev or chdev) or as an attachment for a tape device.
Requests that the backup run in privileged mode.
On Linux and UNIX hosts, a privileged backup runs under the root
operating system identity. For example, Oracle Secure Backup user joeblogg
runs under operating system account root
. On Windows systems, the backup runs under the same account as the Oracle Secure Backup service on the Windows client.
Requests that the backup run in unprivileged mode (default).
When you create an Oracle Secure Backup user with the mkuser command, or modify a user with the chuser command, you associate an operating system user with the Oracle Secure Backup user. When an Oracle Secure Backup user makes an unprivileged backup or restore of a host, the host is accessed with the operating system user identity associated with the Oracle Secure Backup user. For example, assume Linux user jblogg
is associated with Oracle Secure Backup user joeblogg
. If you log on to obtool as joeblogg
and initiate an unprivileged backup of a Linux host, then the backup runs under operating system account jblogg
and backs up only those files accessible to jblogg
.
Specifies whether to use encryption for this backup job. Values are:
yes
Use encryption for this backup job. The encryption algorithm and keys used are determined by the current global and client policy settings that apply to each host.
no
Do not use encryption for this backup job. This is the default.
Note that if the global backup policy or client backup policy is set to required
, then those policies supersede this value and encryption is used. If encryption is used, then the encryption algorithm and keys used are determined by the current global and client policy settings that apply to each host.
forcedoff
Do not use encryption for this backup job, regardless of global or client backup policy.
See Also:
Oracle Secure Backup Administrator's Guide for an example situation in which the backup administrator might choose this optiontransient
Encrypt the backups created with this job using a transient passphrase (supplied with the --passphrase
or --querypassphrase
options to backup
), and the encryption algorithm specified by the global encryption policy setting.
This option is intended for use when creating backup files for a restore operation at another location where the Oracle wallet is not available.
See Also:
Oracle Secure Backup Administrator's Guide for more information on transient backupsSpecifies the encryption algorithm to use with this backup. Values include AES128
, AES192
and AES256
. The default is AES192
.
Specifies the transient passphrase for use with the --encryption
transient
option. Value specified is a user-supplied string, in quotes.
Specifies that the operator must be prompted for the transient passphrase for use with the --encryption
transient
option.
Specifies that the transient passphrase for this backup should be added to the appropriate key stores. The default behavior is that transient passphrases are not stored in any key store.
Disables hardware-based encryption. If encryption is specified, then Oracle Secure Backup uses software-based encryption even if the backup occurs on a tape drive capable of hardware-based encryption.
Deletes the backup job if it is not processed within the specified duration after the job first becomes eligible to run. If you specify the --at
option, then the time period begins at the date and time specified by --at
; if you do not specify the --at
option, then the time period begins when you run the backup
command.
Refer to "duration" for a description of the duration
placeholder.
Does not display job ID or status information when a backup job is dispatched to the scheduler. Use this option with the --go
option.
Identifies the dataset file, which is a file that defines the data to be backed up, or the dataset directory. If you specify the name of a dataset directory, then it is equivalent to naming all of the dataset files contained within the directory tree. The --dataset
and --go
options are not mutually exclusive.
By default, file-system backups initiated by obtool do not cross mount points. Refer to "Dataset Statements" to learn about mount point statements that you can use in dataset files.
Sends all backup requests that are queued in the request queue to the Oracle Secure Backup scheduler. Backup requests are held locally in obtool until you run backup
with the --go
option or exit obtool. If you exit obtool without specifying --go
, then all queued backup requests are discarded. obtool warns you before deleting the requests.
If two users log in to obtool as the same Oracle Secure Backup user, and if one user creates backup requests (but not does not specify --go
), then the other user does not see the requests when issuing lsbackup.
When backup requests are forwarded to the scheduler, the scheduler creates a job for each backup request and adds it to the job list. At this time, the jobs are eligible for execution. If the --at
option was specified for a job, then this job is not eligible for execution until the specified time arrives.
Oracle Secure Backup assigns each on-demand backup job an identifier consisting of the username of the logged in user, a slash, and a unique numeric identifier. An example of a job identifier for an on-demand backup is sbt/233
.
Example 2-3 Making a Full Backup
This example illustrates a privileged backup with a priority 10. The data to be backed up is defined by the home.ds
file. Assume that this file contains the following entries, which specify that the /home
directory on brhost2
should be backed up:
include host brhost2 include path /home
The backup is scheduled to run at 10 p.m. on June 14.
ob> backup --level full --at 2008/06/14.22:00 --priority 10 --privileged --dataset home.ds --go Info: backup request 1 (dataset home.ds) submitted; job id is admin/6.
Example 2-4 Restricting Backups to Different Devices
This example creates two on-demand backup requests, one for dataset datadir.ds
and the other for dataset datadir2.ds
, and restricts each to a different tape drive. The backup --go
command forwards the requests to the scheduler. The lsjob command displays information about the jobs.
ob> backup --level 0 --restrict tape1 --dataset datadir.ds ob> backup --level 0 --restrict tape2 --dataset datadir2.ds ob> backup --go Info: backup request 1 (dataset datadir.ds) submitted; job id is admin/8. Info: backup request 2 (dataset datadir2.ds) submitted; job id is admin/9. ob> lsjob --long admin/8 admin/9 admin/8: Type: dataset datadir.ds Level: full Family: (null) Scheduled time: none State: completed successfully at 2008/05/17.16:30 Priority: 100 Privileged op: no Run on host: (administrative server) Attempts: 1 admin/9: Type: dataset datadir2.ds Level: full Family: (null) Scheduled time: none State: completed successfully at 2008/05/17.16:30 Priority: 100 Privileged op: no Run on host: (administrative server) Attempts: 1
Use the borrowdev
command to borrow a tape drive.
You use the borrowdev
command if a backup or restore job is requesting assistance. You can reply to the input request by using the rpyjob command, but this technique can be cumbersome for multiple commands because obtool issues a prompt after each command. The borrowdev
command temporarily overrides the tape device reservation made by the requesting job and enables you to run arbitrary tape library or tape drive commands. You can use the returndev command to release the tape drive and use the catxcr or rpyjob commands to resume the job.
See Also:
"Device Commands" for related commandsYou must have the right to manage devices and change device state to use the borrowdev
command.
borrowdev drive-name...
Specifies the name of the tape drive to borrow.
Example 2-5 Displaying the Transcript for a Hanging Backup
In this example, backup job admin/6
is not proceeding. Running the catxcr command reveals that Oracle Secure Backup cannot find a usable tape for the backup.
End of tape has been reached. Please wait while I rewind and unload the tape. The Volume ID of the next tape to be written is VOL000007. The tape has been unloaded. obtar: couldn't perform auto-swap - can't find usable volume in library (OB device mgr) Enter a command from the following list: load <n> .. load the tape from element <n> into the drive unload <n> .. unload the tape from the drive into element <n> help .. display other commands to modify drive's database go .. to use the tape you selected quit .. to give up and abort this backup or restore :
Example 2-6 Borrowing a Tape Drive
Assume that you press the Enter key to return to the obtool prompt. In this example, you insert a tape into slot 2 of the tape library, borrow the tape drive, load the volume from slot 2 into the tape drive, and then release the tape drive with the returndev command.
ob> lsvol --long Inventory of library lib1: in mte: vacant in 1: volume VOL000006, barcode ADE201, oid 116, full in 2: vacant in 3: vacant in 4: vacant in dte: vacant ob> insertvol unlabeled 2 ob> borrowdev tape1 ob> loadvol 2 ob> returndev tape1
Example 2-7 Resuming a Job After Borrowing a Device
This example runs the catxcr command for the job and then enters go
at the prompt to resume the backup.
ob> catxcr admin/6.1 admin/6.1: 2008/04/11.18:36:44 ______________________________________________________________________ admin/6.1: 2008/04/11.18:36:44 admin/6.1: 2008/04/11.18:36:44 Transcript for job admin/6.1 running on brhost2 . . . admin/6.1: Backup started on Mon Apr 11 2008 at 18:36:44 admin/6.1: Volume label: admin/6.1: Enter a command from the following list: admin/6.1: load <n> .. load the tape from element <n> into the drive admin/6.1: unload <n> .. unload the tape from the drive into element <n> admin/6.1: help .. display other commands to modify drive's database admin/6.1: go .. to use the tape you selected admin/6.1: quit .. to give up and abort this backup or restore admin/6.1: : admin/6.1: : go
Use the canceljob
command to cancel a pending or running job. You can display these jobs by specifying the --pending
or --active
options on the lsjob command.
Canceling a job terminates the job if it is running, then marks its job record as canceled
. Oracle Secure Backup considers canceled jobs as no longer eligible to be run. If you cancel a job that has subordinates, then each of its subordinate jobs is also canceled.
See Also:
"Job Commands" for related commandsIf you are attempting to cancel another user's jobs, then you must have the right to modify any job, regardless of its owner. If you are attempting to cancel your own jobs, then you must have the right to modify any jobs owned by user.
canceljob [ --quiet/-q | --verbose/-v ] job-id...
Suppresses output.
Displays verbose output.
Specifies the job identifier of the job to be canceled. You can display job identifiers with the lsjob command.
Example 2-8 Cancelling a Backup Job
This example displays a pending job and then cancels it.
ob> lsjob --pending Job ID Sched time Contents State ---------------- ----------- ------------------------------ ---------------------- sbt/8 03/21.18:00 dataset fullbackup.ds future work ob> canceljob sbt/8 Info: canceled job sbt/8. ob> lsjob --pending ob>
Use the catds
command to list the contents of a dataset file created with the mkds command.
See Also:
"Dataset Commands" for related commandsYou must have the display administrative domain's configuration right to use the catds
command.
catds dataset-file-name...
Specifies the name of a dataset file. Refer to "dataset-file-name" for a descriptions of the dataset-file-name
placeholder.
Example 2-9 Displaying the Contents of a Dataset
This example displays the contents of the dataset file named basicsummary.ds
, which is a sample dataset file included with Oracle Secure Backup.
ob> catds basicsummary.ds # SAMPLES/basicsummary, pfg, 03/01/02 # review of basic dataset statements # This dataset ties together all of the features introduced # thus far. It describes the root file systems and a couple of # specific directories on the /home file system of each host. # For each directory tree, it excludes any file ending in # ".a" and ".o". include dataset admin/default_rules # get domain defaults from # this file include host sporky # back up these 3 hosts, include host sparky include host spunky include path / # saving these file systems and include path /home/software # directories on each host include path /home/doc include optional pathlist /pl.qr # read additional names from # this pathlist file on each # named host, if it exists exclude name *.a # but in each tree, don't save # files ending exclude name *.o # in these suffixes
See Also:
"Reports Commands" for related commandsUse the catrpt
command to display one or more reports related to media movement. You can use these reports to assist in managing the media life cycle.
In many cases, it is still necessary to rely upon printed reports to manage media as they are moved from one location to another. The catrpt
command provides the following report types:
Pick lists
A list of media that must be moved from its current location to its next location. Useful as a checklist when removing media from a tape library or standalone tape drive.
Distribution lists, or packing lists
A list of media being moved from its current location to its next location. Useful as a printed list to include with media that are being shipped to another location. Also useful to send to an off-site storage vendor when media are scheduled for return from storage.
Inventory lists
A list of media and its present location
Exceptions
A list of media not in the correct location specified by its rotation policy, such as lost volumes, volumes not stored in the correct tape library, and expired volumes still in rotation.
You must have the modify administrative domain's configuration right to use the catrpt
command.
Use the following syntax to display volume pick or distribution reports.
catrpt --type/-t { pick | distribution } job-id...
Specifies the report type, pick or distribution, to be displayed for the specified jobs.
The job ID of the media movement or volume duplication job.
Use the following syntax to display a volume location report.
catrpt --type/-t location [ --location/-L location_name ] [ --intransit/-I ]
Specifies the report type to be displayed for the specified location.
Specifies the location for which you want a location report.
Specifies that only volumes in transit from one location to another be listed. A volume is consider in transit from the time it is removed from a location as part of a media movement job until it is loaded into its next location and appears in an Oracle Secure Backup inventory of that location.
Use the following syntax to display an exception or missing report.
catrpt --type/-t { exception | missing } [ --location/-L location_name ]
Specifies the report type to be displayed for the specified location.
Specifies the location for which you want an exception or missing report.
Use the following syntax to display a volume schedule report.
catrpt { --type/-t schedule } [ --from/-F from_date ] [ --to/-T to_date ] [ --location/-L location_name ]
Specifies the report type to be displayed for the specified location.
Specifies the oldest schedule date to be displayed. If no --to option
is specified, then Oracle Secure Backup displays all schedules from the --from
date to the present.
Specifies the most recent schedule date to be displayed. If no --from
date is specified, then Oracle Secure Backup displays all schedules older than the --to
date.
Specifies the location for which you want a volume schedule report.
Use the catxcr
command to display one or more job transcripts. Oracle Secure Backup maintains a running transcript for each job. The transcript describes the details of the job's operation. Oracle Secure Backup creates this transcript when dispatching the job for the first time and updates it as the job progresses. When a job requires operator assistance, Oracle Secure Backup prompts for assistance by using the transcript.
See Also:
"Job Commands" for related commandsIf you are attempting to list another user's jobs, then you must have the right to list any job, regardless of its owner. If you are attempting to list your own jobs, then you must have the right to list any jobs owned by user.
If you are attempting to respond to another user's jobs, then you must have the right to modify any job, regardless of its owner. If you are attempting to respond to your own jobs, then you must have the right to modify any jobs owned by user.
catxcr [ --level/-l msglevel ] [ --noinput/-N ] [ --msgno/-m ] [ --start/-s msgno | --head/-h nlines | --tail/-t nlines ] [ --follow/-f ] job-id...
Displays only lines with msglevel
or higher message levels. You can specify msglevel
either numerically or by name. The default level is 4 (request), which are the normal messages generated by Oracle Secure Backup.
Each message that Oracle Secure Backup writes to a transcript is tagged with a message number and a message level. The message number indicates the position of the message in the transcript.
Note:
The message number may not correspond to the physical line number because a given message can span multiple physical lines.The message level identifies the content of the message as being in an ordered category in Table 2-1.
Msg Number | Msg Name | Msg Description |
---|---|---|
0 |
debug2 |
debug (extra output) message |
1 |
debug1 |
debug message |
2 |
verbose |
verbose mode output |
3 |
info |
informational message |
4 |
request |
messaged requested by user |
5 |
summary |
operational summary message |
6 |
warning |
warning message |
7 |
error |
error message (operation continues) |
8 |
abort |
error message (operational is canceled) |
9 |
fatal |
error message (program stops) |
Suppresses input requests. By default, when a request for input is recognized, catxcr
pauses and enables you to respond to the prompt. Specifying this option suppresses this action.
Prefixes each line with its message number.
Starts displaying at the line whose message number is msgno
.
Displays the first nlines
of the transcript. If --level
is not specified, then obtool uses --level 4
as a default, which means that nlines
is a count of the default level (or higher). If --level
is specified, then nlines
is a count of lines of the specified level or higher.
Displays the last nlines
of the transcript. If --level
is not specified, then obtool uses --level 4
as a default, which means that nlines
is a count of the default level (or higher). If --level
is specified, then nlines
is a count of lines of the specified level or higher.
Monitors the transcript for growth continually and displays lines as they appear. By default, the catxcr
command displays the requested number of lines and stops. You can exit from --follow
mode by pressing Ctrl-C.
Specifies job identifiers of jobs whose transcripts are to be displayed. If a job-id
refers to a job that has dependent jobs, then obtool displays transcripts of all dependent jobs. When catxcr
displays multiple transcripts, it prefixes each line with its job-id
. Run the lsjob command to display job identifiers.
Example 2-10 Displaying a Job Transcript
This example displays the transcript for a job whose ID is sbt/1.1
.
ob> catxcr sbt/1.1 2008/03/21.10:19:39 ______________________________________________________________________ 2008/03/21.10:19:39 2008/03/21.10:19:39 Transcript for job sbt/1.1 running on osbsvr1 2008/03/21.10:19:39 Volume label: Volume tag: ADE202 Volume ID: RMAN-DEFAULT-000001 Volume sequence: 1 Volume set owner: root Volume set created: Mon Mar 21 10:19:39 2008 Media family: RMAN-DEFAULT Volume set expires: never; content manages reuse
Example 2-11 Displaying the Transcript for a Hanging Backup
In Example 2-5, backup job admin/6
is not proceeding. In this example, running catxcr
reveals that Oracle Secure Backup cannot find a usable tape for the backup. The most common cause of this problem is lack of eligible tapes in the tape library.
You can respond to this situation by pressing the Enter key to return to the obtool prompt or opening an additional window. Use the borrowdev command to gain control of the tape drive. After making a tape available with the unlabelvol or insertvol command, complete the job by running catxcr
and then go
.
End of tape has been reached. Please wait while I rewind and unload the tape. The Volume ID of the next tape to be written is VOL000007. The tape has been unloaded. obtar: couldn't perform auto-swap - can't find usable volume in library (OB device mgr) Enter a command from the following list: load <n> .. load the tape from element <n> into the drive unload <n> .. unload the tape from the drive into element <n> help .. display other commands to modify drive's database go .. to use the tape you selected quit .. to give up and abort this backup or restore :
Use the cd
command to change the directory that you are browsing in the Oracle Secure Backup catalog. Options to the cd
command affect subsequent ls and restore commands.
Browsing the catalog is equivalent to browsing the contents of backup images. The obtool utility displays the contents of the images in a directory structure much like a live file system. You can only browse directories whose contents have been backed up.
See Also:
"Browser Commands" for related commandsThe rights needed to run the cd
command depend on the browse backup catalogs with this access setting for the class.
cd [ --host/-h hostname ] [ --viewmode/-v viewmode ] [ --select/-s data-selector[,data-selector]... ] [ pathname ]
Defines the name of the host computer assigned with the mkhost or renhost commands. You must set the host before you can browse its file system in the Oracle Secure Backup catalog. You can also use the set host
command to set the host.
Specifies the mode in which to view directory contents in the Oracle Secure Backup catalog. The cd
command remains in viewmode
until you change it to a different setting.
Valid values for viewmode
are as follows:
exact
makes visible only those directory entries that match the data selector.
inclusive
makes visible all entries regardless of the current data selector (default).
Specifies the Oracle Secure Backup catalog data that applies to an operation. Refer to "data-selector" for the data-selector
placeholder.
Note:
The data selector values specified bycd
do not affect the lsbu command, which lists all backups unless a data-selector
is specified by lsbu
.Specifies the path name to browse in the Oracle Secure Backup catalog.
Use the cdds
command to change the dataset directory on the administrative server. This command enables you to move up and down a dataset directory tree.
See Also:
"Dataset Commands" for related commandsYou must have the display administrative domain's configuration right to use the cdds
command.
cdds [ dataset-dir-name ]
Specifies the name of a dataset directory into which you want to change. Refer to "dataset-dir-name" for a descriptions of the dataset-dir-name
placeholder.
Use the cdp
command to set the identity of the current policy or policy class. Policies are represented in a directory structure with a slash (/
) as root and the policy classes as subdirectories. You can use cdp
to navigate this structure and pwdp and lsp to display policy information.
See Also:
"Policy Commands" for related commands
Appendix 6, "Defaults and Policies" for a complete list of policies and policy classes
You must have the display administrative domain's configuration right to use the cdp
command.
cdp [ policy-name ]
Specifies the name of a policy or a class of policies. If omitted, then obtool
sets the current policy to a slash (/
).
Example 2-16 Browsing Policy Information
This example uses the pwdp, lsp, and cdp
commands to browse the policies and find the value for the daemon policy webautostart
.
ob> pwdp / ob> lsp daemons daemon and service control policies devices device management policies index index catalog generation and management policies local Oracle Secure Backup configuration data for the local machine logs log and history management policies media general media management policies naming WINS host name resolution server identification ndmp NDMP Data Management Agent (DMA) defaults operations policies for backup, restore and related operations scheduler Oracle Secure Backup backup scheduler policies security security-related policies testing controls for Oracle Secure Backup's test and debug tools ob> cdp daemons ob> lsp auditlogins no [default] obixdmaxupdaters 2 [default] obixdrechecklevel structure [default] obixdupdaternicevalue 0 [default] webautostart yes webpass (set) windowscontrolcertificateservice no [default] ob> cdp webautostart ob> lsp webautostart yes
Use the chclass
command to change the attributes of a user class.
You must have the modify administrative domain's configuration right to use the chclass
command.
See Also:
"Class Commands" for related commands
Appendix 7, "Classes and Rights" for a descriptions of the default Oracle Secure Backup classes and rights
chclass [ --modself/-m { yes | no } ] [ --modconfig/-M { yes | no } ] [ --backupself/-k { yes | no } ] [ --backuppriv/-K { yes | no } ] [ --restself/-r { yes | no } ] [ --restpriv/-R { yes | no } ] [ --listownjobs/-j { yes | no } ] [ --modownjobs/-J { yes | no } ] [ --listanyjob/-y { yes | no } ] [ --modanyjob/-Y { yes | no } ] [ --mailinput/-i { yes | no } ] [ --mailerrors/-e { yes | no } ] [ --mailrekey/-g{ yes | no } ] [ --querydevs/-q { yes | no } ] [ --managedevs/-d { yes | no } ] [ --listconfig/-L { yes | no } ] [ --browse/-b browserights ] [ --orauser/-o { yes | no } ] [ --orarights/-O oraclerights ] classname...
See "mkclass" for descriptions of the options.
The name of the class to be modified. Class names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.
This example lists every user who can run backups with administrator privileges, grants this privilege to user
, and then confirms that the grant was successful.
Use the chdev
command to change the attributes of a configured tape drive or tape library. Use the mkdev command to configure a tape device.
See Also:
"Device Commands" for related commandsYou must have the modify administrative domain's configuration right to use the chdev
command.
Use the following syntax to reconfigure a tape drive.
chdev [ --attach/-a aspec[,aspec]... ] [ --addattach/-A aspec[,aspec]... ] [ --rmattach/-R aspec[,aspec]... ] [ --inservice/-o | --notinservice/-O ] [ --wwn/-W wwn ] [ --library/-l devicename ] [ --dte/-d dte ] [ --ejection/-j etype ] [ --minwriteablevolumes/-m n ] [ --blockingfactor/-f bf ] [ --maxblockingfactor/-F maxbf ] [ --automount/-m { yes | no } ] [ --erate/-e erate ] [ --current/-T se-spec ] [ --uselist/-u se-range ] [ --usage/-U duration ] [ --queryfreq/-q queryfrequency ] [ --serial/-N serial-number ] [ --updateserialnumber/-S ] [ --model/-L model-name ] devicename...
Use the following syntax to reconfigure a tape library.
chdev [ --attach/-a aspec[,aspec]... ] [ --addattach/-A aspec[,aspec]... ][ --class/-x vtl ] [ --rmattach/-R aspec[,aspec]... ] [ --inservice/-o | --notinservice/-O ][ --wwn/-W wwn ] [ --autoclean/-C { yes | no } ][ --cleanemptiest/-E { yes | no } ] [ --cleaninterval/-i { duration | off } ] [ --barcodereader/-B { yes | no | default } ] [ --barcodesrequired/-b { yes | no } ] [ --unloadrequired/-Q { yes | no } ] [ --serial/-N serial-number ] [ --model/-L model-name ] devicename...
The following options enable you to reconfigure a tape drive or tape library. Refer to "mkdev" for descriptions of options not included in this section.
Adds a device attachment for a tape drive or tape library. Refer to "aspec" for a description of the aspec
placeholder.
Specifies library class as VTL.
Removes a device attachment for a tape drive or tape library. Refer to "aspec" for a description of the aspec
placeholder.
Specifies a range of storage elements that the device can use. This option only applies to a tape drive contained in a tape library.
By default, Oracle Secure Backup allows all tapes in a tape library to be accessed by all tape drives in the tape library. For libraries containing multiple tape drives which perform backups concurrently, you might want to partition the use of the tapes.
For example, you might want the tapes in half the storage elements to be available to the first tape drive and the second half to be available to the second tape drive. Alternatively, you might want to set up different use lists for different types of backups on a single tape drive.
Changes to the uselist
value for a tape device are not recognized by jobs that run when you enter the chdev
command. If a job is stalled for lack of usable volumes, for example, you cannot rescue the job by adding storage elements with a chdev
--uselist
command. The chdev
operation succeeds, but the job remains stalled. You must cancel and restart the job for the chdev
changes to take effect.
Refer to "se-range" for a description of the se-range
placeholder.
Specifies the amount of time a tape drive has been used since it was last cleaned. Refer to "duration" for a description of the duration
placeholder.
The mkdev command enables you to request a cleaning cycle for a specific interval. Specify the --usage
option on chdev
to initialize the configured interval to reflect tape drive usage since the last cleaning.
Specifies the means by which tapes are ejected. Values are automatic
, ondemand
, or manual
.
Specifies the threshold for the minimum number of writeable volumes before Oracle Secure Backup initiates early volume rotation.
Specifies the serial number for the tape device.
If you explicitly enter a serial number with the mkdev
command, then Oracle Secure Backup stores this serial number in the device object. If you specify the serial-number
argument as null (''
), then Oracle Secure Backup opens the device, reads the serial number from the device, and stores the number in the device object.
If the checkserialnumbers
policy is enabled, then you must enter a serial number with a chdev
--serial
command whenever tape device hardware is changed, as when a broken tape drive in a tape library is replaced. You must enter the number even if no serial number was entered when the device object was created.
See Also:
"checkserialnumbers"Semantically equivalent to --serial
with a null argument. Oracle Secure Backup opens the tape device, reads the serial number from the device, and stores the serial number in the device object.
Specifies the name of the tape library or tape drive to be reconfigured. Refer to "devicename" for the rules governing tape device names.
Use the following syntax for changing the configuration of a tape drive contained within an ACSLS tape library.
chdev [ --attach/-a aspec ] [ --inservice/-o | --notinservice/-O ] [ --wwn/-W wwn ] [ --library/-l devicename ] [ --lsm/s lsm_id ] [ --panel/p panel_id ] [ --drive/r drive_id ] [ --blockingfactor/-f bf ] [ --maxblockingfactor/-F maxbf ] [ --erate/-e erate ] [ --queryfreq/-q queryfrequency ] devicename...
Use the following semantics for changing the configuration of a tape drive contained within an ACSLS tape library. See "Semantics 1 and 2" for options not identified here.
This option is used only for tape drives contained in ACSLS libraries. It defines the ID of the ACS Library Storage Module where this tape drive resides.
This option is used only for tape drives contained in ACSLS libraries. It defines the ID of the panel where this tape drive resides.
This option is used only for tape drives contained in ACSLS libraries. It defines the ID of the drive where this tape drive resides.
Use the following syntax for reconfiguring an ACSLS tape library.
chdev [ --attach/-a aspec ] [ --inservice/-o | --notinservice/-O ] [ --userid/-n acs-userid ] [ --acsid/-g acs_id ] [ --port/-P port_num ] [ --ejection/-j etype ] [ --minwritablevolumes/-V minvols ] library_devicename...
Use the following syntax for reconfiguring an ACSLS tape library. See "Semantics 1 and 2" for options not identified here.
This option specifies the Oracle Secure Backup media server and ACSLS server for an ACSLS tape library. The format of aspec
is mediaservhostname:acslshost
This option specifies the ACSLS access control user name. This value is optional. If it is specified, then all interactions with an ACSLS server are preceded by this access name.
This option specifies the ACS ID value for the ACSLS tape library to control.
This option specifies the listening port of the ACSLS server software. Typically this value is 0
or not specified. This option must be specified only when your ACSLS server is located behind a firewall.
Use the following semantics to associate a symbolic name with an ACS cartridge access port (CAP) within an ACSLS tape library.
chdev [ --library/-L devicename ] [ --lsm/s lsm_id ] [ --capid/-c cap_id ] capname
Use the following semantics to associate a symbolic name with an ACS cartridge access port (CAP) within an ACSLS tape library.
This option specifies the name of the tape library in which the CAP resides. If it is omitted, then the library variable is used. If the library variable is not found and one is not specified, then an error message is displayed.
This option specifies the hardware location of the CAP within the selected tape library.
This option specifies the ACS Library Storage Module of the CAP within the selected tape library.
The name of the Oracle Secure Backup CAP object to be created.
Example 2-18 Reconfiguring a Tape Drive
This example reconfigures tape drive tape1
in tape library lib1
. The chdev
command specifies the following:
The tape drive is in service.
The error rate is 16 (the default is 8).
The blocking factor is 256, which means that obtool writes blocks of size 128 KB.
Tapes can be automounted.
Note that the command line has been reformatted to fit on the page.
ob> lsdev --long tape1 tape1: Device type: tape Model: [none] Serial number: 06667256 In service: yes Library: lib1 DTE: 1 Automount: yes Error rate: 8 Query frequency: [undetermined] Debug mode: no Blocking factor: (default) Max blocking factor: (default) Current tape: [unknown] Use list: all Drive usage: none Cleaning required: no UUID: 15ec3d48-8b97-102d-94d5-080020a0a249 Attachment 1: Host: brhost3 Raw device: /dev/obt0 ob> chdev --type tape --erate 16 --blockingfactor 256 --maxblockingfactor 256 tape1 ob> lsd --long tape1 tape1: Device type: tape Model: [none] Serial number: 06667256 In service: yes Library: lib1 DTE: 1 Automount: yes Error rate: 16 Query frequency: [undetermined] Debug mode: no Blocking factor: 256 Max blocking factor: 256 Current tape: [unknown] Use list: all Drive usage: none Cleaning required: no UUID: 15ec3d48-8b97-102d-94d5-080020a0a249 Attachment 1: Host: brhost3 Raw device: /dev/obt0
Example 2-19 Reconfiguring a Tape Library
This example reconfigures a tape library called lib1
. The chdev
command specifies the following:
The tape library is in service.
There is no barcode reader.
The interval between automatic cleaning cycles is 30 hours.
obtool should use the fullest cleaning tape for cleaning.
Note that the command line has been reformatted to fit on the page.
ob> lsdev --long --nohierarchy lib1 lib1: Device type: library Model: [none] Serial number: [none] In service: yes Debug mode: no Barcode reader: default (hardware-selected) Barcodes required: no Auto clean: no Clean interval: (not set) Clean using emptiest: no UUID: f088f234-8d46-1027-90e1-000cf1d9be50 Attachment 1: Host: brhost3 Raw device: /dev/lib1 ob> chdev --type library --inservice --barcodereader no --barcodesrequired no --autoclean yes --cleanemptiest no --cleaninterval 30hours lib1 ob> lsdev --long --nohierarchy lib1 lib1: Device type: library Model: [none] Serial number: [none] In service: yes Debug mode: no Barcode reader: no Barcodes required: no Auto clean: yes Clean interval: 30hours Clean using emptiest: yes UUID: f088f234-8d46-1027-90e1-000cf1d9be50 Attachment 1: Host: brhost3 Raw device: /dev/lib1
Change the settings of a volume duplication policy.
See Also:
"Volume Duplication Commands"You must have the modify administrative domain's configuration right to use the chdup
command.
chdup [ --comment/-c commentstring ] [ --inputcomment/-i ] [ --trigger/-e dupevent:duration ] [ --restrict/-r restriction[,restriction]... ] [ --addrestrict/-R restriction [,restriction]... ] [ --rmrestrict/-S restriction[,restriction]... ] [ --migrate/-m { yes | no } ] [ --rule/-u duplicationrule[,duplicationrule]... ] [ --addrule/-U duplicationrule[,duplicationrule]... ] [ --rmrule/-V duplicationrule[,duplicationrule]... ] [ --chrule/-h duplicationrule[,duplicationrule ]... ] policyname
See Also:
"dupevent" for a description of the dupevent
placeholder
"duration" for a description of the duration
placeholder
"restriction" for a description of the restriction
placeholder
A descriptive comment for the volume duplication policy.
Allows input of an optional comment. After you run chdup --inputcomment
, obtool prompts you to enter the comment. End the comment with a period (.
) on a line by itself.
Specifies when a volume becomes eligible for duplication. The duration
placeholder specifies how long after dupevent
the volume becomes eligible for duplication.
Replaces any specified tape device restrictions for this duplication policy with the specified restrictions. If you do not specify a restriction, then this volume duplication policy has no tape device restrictions, and can use any available tape device on any media server at the discretion of the Oracle Secure Backup scheduling system. By default, there are no restrictions defined for a volume duplication policy.
Adds specified tape device restrictions to the tape device restriction for this duplication policy. Existing restrictions are retained.
Removes specified tape device restrictions from the tape device restriction for this duplication policy. If all restrictions are removed, then volume duplication for this policy can be performed using any tape device in the administrative domain.
Specifies volume must be migrated. If this option is set to yes
, then only one duplication rule can be specified for this volume duplication policy.
Specifies the duplication rules for this duplication policy.
Adds the specified duplication rule to the set of rules for this duplication policy.
Removes the specified duplication rule from the set of rules for this duplication policy.
This option changes the attributes associated with an existing rule in a duplication policy. The media-family
field of the duplication rule specified in the --chrule
option is compared against all duplication rules in the specified duplication policy. For any matching rules the number
field of the existing duplication rule is replaced with the number
field from the duplication rule specified in the --chrule
option.
Use the chhost
command to change the attributes of a configured Oracle Secure Backup host. Use the mkhost command to configure a host for the first time.
The chhost
command supports Internet Protocol v4 (IPv4), Internet Protocol v6 (IPv6), and mixed IPv4/IPv6 environments on all platforms that support IPv6.
See Also:
"Host Commands" for related commandsYou must have the modify administrative domain's configuration right to use the chhost
command.
chhost [ --access/-a { ob | ndmp } ] [ --inservice/-o | --notinservice/-O ] [ --encryption/-e { required | allowed } ] [ --algorithm/-l { AES128 | AES192 | AES256 } ] [ --keytype/-t { passphrase | transparent } ] [ --rekeyfrequency/-g duration ] [ --passphrase/-s string ] [ --querypassphrase/-Q ] [ --keystoreputonly/-T ] [ --tcpbufsize/-c bufsize ] [ [ --role/-r role[,role]... ] | [ --addrole/-R role[,role]... ] | [ --rmrole/-E role[,role]... ] ] [ [ --ip/-i ipname[,ipname]... ] | [ --addip/-I ipname[,ipname]... ] | [ --rmip/-P ipname[,ipname]... ] ] [ --ndmpauth/-A authtype ] [ { --ndmppass/-p ndmp-password } | --queryndmppass/-q | --dftndmppass/-D ] [ --ndmpport/-n portnumber ] [ --ndmppver/-v protover ] [ --ndmpuser/-u ndmp-username ] [ --nocomm/-N ] [ --ndmpbackuptype/-B ndmp-backup-type ] [ [ --backupev/-w evariable-name=variable-value ]... { [ --addbackupev/-W evariable-name=variable-value ]... | [ --rmbackupev/-x evariable-name ]... } ] [ [ --restoreev/-y evariable-name=variable-value ]... | { [ --addrestoreev/-Y evariable-name=variable-value ]... [ --rmrestoreev/-z evariable-name ]... } ] hostname...
Refer to "mkhost" for options not included in this section.
Specifies an access method for the host. Options are:
ob
Use this option if the host has Oracle Secure Backup installed (UNIX, Linux, or Windows computer) and uses the Oracle Secure Backup internal communications protocol to communicate.
ndmp
Use this option if the host, such as a filer/Network Attached Storage (NAS) device, does not have Oracle Secure Backup installed and uses the Network Data Management Protocol (NDMP) to communicate.
Specifies a passphrase used in generation of the encryption key.
The practice of supplying a password in clear text on a command line or in a command script is not recommended by Oracle. It is a security vulnerability. The recommended procedure is to have the Oracle Secure Backup user be prompted for the password.
Adds a role to a host. Refer to "role" for a description of the role
placeholder.
Adds a key to the key store without making it the active key.
Specifies TCP/IP (Transmission Control Protocol/Internet Protocol) buffer size. The default value is not
set
, in which case global policy operations/tcpbufsize
applies. The maximum TCP/IP buffer size is 4GB, and the minimum TCP/IP buffer size is 1 KB. If Oracle Secure Backup cannot set TCP/IP buffer size as specified, then it returns a warning. This can happen when the operating system kernel limit is smaller than the specified TCP/IP buffer size.
Increasing TCP/IP buffer size also increases TCP/IP advertised window. So to tune backup over a wide area network (WAN), this parameter must be set to a value bigger than the bandwidth times round-trip time.
Removes a role from a host. Refer to "role" for a description of the role
placeholder.
Adds an IP address to a host computer.
Removes an IP address from a host computer.
Suppresses communication with the host computer. This option is useful when you have a host that is no longer connected to their network, but you have tape backups of the host that you might want to restore in the future.
Adds the specified NDMP backup environment variables.
Removes the specified NDMP backup environmental variables.
Adds the specified NDMP restore environmental variables.
Removes the NDMP restore environmental variables.
Specifies the name of the host computer for which you want to make configuration changes.
This example removes the role of mediaserver
from host sfserver1
.
ob> lshost brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service sfserver1 mediaserver,client (via OB) in service ndmphost1 client (via NDMP) in service osbsvr1 admin,mediaserver,client (via OB) in service ob> chhost --rmrole mediaserver salessvr1 ob> lshost sfserver1 sfserver1 client (via OB) in service
Use the chkbw
command to check for the existence of a backup window. This command determines whether at least one backup window is available during which backups can run.
If any backup windows exist, then the command generates no output. If no backup windows exist, then the command generates the following output:
Note: no backup windows are configured. Scheduled backups will not run.
See Also:
"Backup Window Commands" for related commandsYou must have the display administrative domain's configuration right to use the chkbw
command.
chkbw
Use the chkds
command to check the syntax in a dataset file. The command generates no output when there are no syntax errors; otherwise, it issues an error. Empty files generate a warning.
See Also:
"Dataset Commands" for related commandsYou must have the display administrative domain's configuration right to run the chkds
command.
chkds dataset-file-name...
Specifies the name of a dataset file. Refer to "dataset-file-name" for a descriptions of the dataset-file-name
placeholder.
Example 2-22 Checking a File for Syntax
This example creates a dataset file with bad syntax and then checks it.
ob> mkds --nq --input badsyntax.ds Input the new dataset contents. Terminate with an EOF or a line containing just a dot ("."). icnlude host brhost2 . Error: the following problems were detected in dataset badsyntax.ds: 1: icnlude host brhost2 Error: "icnlude" - unknown keyword ob> chkds badsyntax.ds Error: the following problems were detected in dataset badsyntax.ds: 1: icnlude host brhost2 Error: "icnlude" - unknown keyword
Example 2-23 Checking Files for Syntax
This example creates two dataset files and then checks them.
ob> mkds --nq --input empty.ds Input the new dataset contents. Terminate with an EOF or a line containing just a dot ("."). . ob> mkds --nq --input goodsyntax.ds Input the new dataset contents. Terminate with an EOF or a line containing just a dot ("."). include host brhost2 include path /home . ob> chkds empty.ds goodsyntax.ds Warning: dataset empty.ds is empty
Use the chkdw
command to check for the existence of at least one duplication window.
See Also:
"Duplication Window Commands" for related commandsYou must have the modify administrative domain's configuration right to use the chkdw
command.
chkdw
Modify a location object.
See Also:
"Location Commands" for related commandsYou must have the modify administrative domain's configuration right to use the chloc
command.
chloc [ --comment/-c commentstring | --inputcomment/-i commentstring ] [ --mailto/-m email-target[,email-target] ] [ --addmailto/-a email-target[,email-target] ] [ --rmmailto/-r email-target[,email-target] ] [ --customerid/-I idstring ] [ --notification/-n ntype ] [ --recalltime/-R duration ] locationname...
Specifies a descriptive comment for the location. You can specify either --comment
or --inputcomment
, but not both.
Allows input of an optional comment. After you run chloc --inputcomment
, obtool prompts you to enter the comment. End the comment with a period (.
) on a line by itself. You can specify either --comment
or --inputcomment
, but not both.
Specifies one or more e-mail recipients for the location.
Specifies one or more e-mail recipients to be added to the location.
Specifies one or more e-mail recipients to be removed from the location.
A customer ID string. Only valid for a storage location.
The --notification
ntype
option enables you to specify a type of electronic notification to be sent to the offsite vault vendor when media are moved from or to a storage location. The ntype
value is either none
or imftp
(Iron Mountain FTP file).
The --recalltime
option enables you to specify the time taken to recall a volume from this storage location to the data center. This setting is disabled for an active location and is valid only for offsite storage locations. You can use this setting to determine whether to fail a restore request initiated by Recovery Manager (RMAN) that requires use of tape volumes that cannot be supplied within the specified resource wait time period. This parameter can also be used by the volume cloning feature to determine which volume to recall for a restore operation when multiple copies are available at multiple offsite locations.
The name of the storage location.
Note:
all
is a reserved word and cannot be used as a location name.Use the chmf
command to alter the attributes of a media family. A media family is a named classification of backup volumes.
See Also:
"Media Family Commands" for related commandsYou must have the modify administrative domain's configuration right to use the chmf
command.
Attributes in a media family are applied to a volume in the media family at volume creation time. The media family attributes are part of the volume's attributes. After data is first written to the volume, you cannot change the volume attributes other than by rewriting the volume. If you change the media family attributes, then these changes do not apply to any volumes that have been created in this family.
Oracle Secure Backup includes a default content-managed media family named RMAN-DEFAULT
. You cannot delete or rename this media family, although you can reset any options except for the following:
--writewindow
--retain
--contentmanaged
chmf [ --writewindow/-w duration ] [ --retain/-r duration ] [ [ --vidunique/-u ] | [ --vidfile/-F vid-pathname ] | [ --viddefault/-d | [ --vidfamily/-f media-family-name ] ] [ [ --inputcomment/-i ] | [ --comment/-c comment ] ] [ --contentmanaged/-C ] [ --append/-a ] [ --noappend/-A ] [ --rotationpolicy/-R policyname ] [ --duplicationpolicy/-D policyname ] [ --acsscratchid/-d acsscratch_id ] media-family-name...
Refer to "mkmf" for descriptions of options that are not included in this section.
Allows input of an optional comment for the media family. After you run chmf --inputcomment
, obtool prompts you to enter the comment. End the comment with a period (.
) on a line by itself.
Specifies information to store with the media family. To include white space in comment
, surround the text with quotes.
Specifies the rotation policy for the media family.
To clear the rotation policy, specify an empty string ("") for the policy name.
Specifies the duplication policy for the media family.
To remove a duplication policy, specify an empty string for the policy name.
For ACSLS libraries this option defines the scratch pool ID from which volumes are pulled. For non-ACSLS libraries this option has no effect. When a volume is unlabeled it is placed back into the scratch pool ID that is defined by the media family it belonged to when it was unlabeled.
When a volume is pulled from a scratch pool and initially labeled, it acquires a permanent media family identical to that which is generated when pre-labeling volumes.
Specifies the name of the media family to change.
Example 2-24 Changing Properties of a Media Family
This example creates a time-managed media family called full_bkup
. The write window for volumes in the volume is 7 days. Because the retention period is 28 days, a volume in the media family expires 35 days after Oracle Secure Backup first writes to it. The example then changes the retention period from 7 days to 10 days.
ob> mkmf --vidunique --writewindow 7days --retain 28days full_bkup ob> lsmf --long full_bkup full_bkup: Write window: 7 days Keep volume set: 28 days Appendable: yes Volume ID used: unique to this media family ob> chmf --writewindow 10days full_bkup ob> lsmf --long full_bkup full_bkup: Write window: 10 days Keep volume set: 28 days Appendable: yes Volume ID used: unique to this media family
Change the settings of a rotation policy.
See Also:
"Rotation Policy Commands" for information on related commands
"mkrot" for more information on rotationrule
You must have the modify administrative domain's configuration right to use the chrot
command.
chrot [ --comment/-c commentstring | --inputcomment/-i commentstring ] [ --rule/-u rotationrule[, rotationrule...] ] [ --addrule/-A rotationrule [, rotationrule...] ] [ --rmrule/-R rotationrule [, rotationrule...] ] [ --chrule/-h rotationrule [, rotationrule...] ] [ --position/-p n ] policyname...
Specifies a descriptive comment for the rotation policy. You can specify either --comment
or --inputcomment
, but not both.
Allows input of an optional comment. After you run chrot --inputcomment
, obtool prompts you to enter the comment. End the comment with a period (.
) on a line by itself. You can specify either --comment
or --inputcomment
, but not both.
Specifies the replacement rotation rules for this rotation policy.
Specifying --rule
in a chrot
command replaces the rotation rule at the specified --position
with a new rule, which may have a new location. You can only specify one rule when using --rule
in conjunction with --position
. If you do not specify --position
, then all rotation rules defined for this policy are replaced by the specified rules.
Adds the specified rotation rule to the set of rules for this rotation policy.
Removes the specified rotationrule
from the set of rules for this rotation policy.
When removing an existing rotationrule
from a rotation policy with --rmrule
, only the location is required. If you specify an event
or duration
portion of the rotationrule
, and they do not match those defined for the existing rule for the specified location, then an error message results.
This option changes the attributes associated with an existing rule in a rotation policy. The location
field of the rotation rule specified in the --chrule
option is compared against all rotation rules in the specified rotation policy. For any matching rules the event
and duration
fields of the existing rotation rule are replaced with the event
and duration
fields from the rotation rule specified in the --chrule
option.
the --position
value indicates the specific point at which a rotationrule
is to be added to the existing list of location/duration tuples in the rotation policy. Positions are numbered starting from 1. Rotation rule tuples are inserted immediately before the tuple at the position specified by n
. For example, if n
=1
, then the tuples are inserted before the first tuple in the list. If n
=2
, then the tuples are inserted between the first and second tuples, and so on. If the --position
parameter is not specified, then location/duration tuples are inserted after the existing list.
Specifies the name for a rotation policy, which can be 1-31 characters.
Example 2-25 Changing a Rule in a Rotation Policy
This example uses --rule
with --position
to replace rotation rule 2, and then replace it again, leaving rule 1 intact.
ob> lsrot --long rp1 rp1: Rotation rule 1: * : firstwrite : 2 seconds Rotation rule 2: vault : arrival : 1 day UUID: f7d61560-2d53-102c-8bcf-00163e38b3e7 ob> chrot --rule imvault:arrival:1day --position 2 rp1 ob> lsrot --long rp1 rp1: Rotation rule 1: * : firstwrite : 2 seconds Rotation rule 2: imvault : arrival : 1 day UUID: f7d61560-2d53-102c-8bcf-00163e38b3e7 ob> chrot --rule Media_Recycle_Bin:arrival --position 2 rp1 ob> lsrot --long rp1 rp1: Rotation rule 1: * : firstwrite : 2 seconds Rotation rule 2: Media_Recycle_Bin : arrival : disabled UUID: f7d61560-2d53-102c-8bcf-00163e38b3e7
Use the chsched
command to change an existing backup schedule, volume duplication scan, or vaulting scan schedule.
See Also:
"Schedule Commands" for related commandsYou must have the modify administrative domain's configuration right to use the chsched
command.
Use the following syntax to change an existing backup schedule.
chsched [ --dataset/-D dataset-name[,dataset-name]... ] [ --adddataset/-A dataset-name[,dataset-name]... ] [ --rmdataset/-R dataset-name[,dataset-name]... ] [ --comment/-c comment | --inputcomment/-i ] [ --priority/-p schedule-priority ] [ --enabled/-z ] [ --disabled/-Z ] [ --encryption/-e { yes | no } ] [ --restrict/-r restriction[,restriction]... ] [ --addrestrict/-E restriction[,restriction]... ] [ --rmrestrict/-T restriction[,restriction]... ] [ [ --addtrigger/-a ] | [ --chtrigger/-h trigger-number[,trigger-number]...] | [ --rmtrigger/-m trigger-number[,trigger-number]...] ] [ [ --day/-d day-date ] [ --time/-t time ] [ --level/-l backup-level ] [ --family/-f media-family-name ] [ --expires/-x duration ] ]... schedulename...
Refer to "mksched" for option descriptions not included in this section.
Specifies the dataset to include in the backup job.
Adds a dataset to the current schedule.
Removes a dataset from the current schedule.
Specifies that the backup schedule be enabled. You can use this option to restart a backup schedule that you earlier disabled.
Specifies that the vaulting scan schedule be disabled. You can use this option to suspend a backup schedule without deleting it. This option is useful when you must take a host out of service temporarily.
Specifies encryption flags for the backup schedule or job. Valid values are:
yes
Backups for these scheduled jobs are always encrypted, regardless of settings for the global or host-specific encryption policies.
no
This is the default.
If both global and host-specific encryption policies are set to allowed
, then backups created for these jobs are not encrypted.
If either the global encryption policy or the host-specific encryption policy is set to required
, then that policy overrides this setting and backups are always encrypted. The encryption algorithm and keys are determined by the policies of each client host.
Adds another tape drive to be used by the backup. Refer to "restriction" for a description of the restriction
placeholder.
Removes a restriction from a schedule. Refer to "restriction" for a description of the restriction
placeholder.
Adds a trigger to the schedule. A trigger is a user-defined period in time or sets of times that causes a scheduled backup to run. You must specify the --day
option when adding a trigger. If you specify --day
but do not specify a time, then the time defaults to 00:00.
Edits the specified trigger in the schedule. Specify the --long
option on the lssched command to obtain trigger numbers.
Removes a trigger from the schedule. Specify the --long
option on the lssched command to obtain trigger numbers.
Specifies the name of the schedule.
Use the following syntax to change an existing vaulting scan schedule.
chsched [ --comment/-c comment | --inputcomment/-i ] [ --priority/-p schedule-priority ] [ --enabled/-z ] [ --disabled/-Z ] [ --location/-L locationname[,locationname]... ] [ --addlocation/-O locationname[,locationname]... ] [ --rmlocation/-C locationname[,locationname]... ] [ --restrict/-r vault_restriction[,vault_restriction ] ] [ --addrestrict/-E vault_restriction[,vault_restriction ] ] [ --rmrestrict/-T vault_restriction[,vault_restriction ] ] [ --select/-S select_criterion[,select_criterion] ] [ --addselect/-P select_criterion[,select_criterion] ] [ --rmselect/-U select_criterion[,select_criterion] ] [ [ --addtrigger/-a ] | [ --chtrigger/-h trigger-number[,trigger-number]... ] | [ --rmtrigger/-m trigger-number[,trigger-number]... ] ] [ [ --day/-d day-date ][ --time/-t time ][ --expires/-x duration ] ]... schedulename...
Refer to "mksched" for option descriptions not included in this section.
Specifies that the vaulting scan schedule be enabled. You can use this option to restart a vaulting scan schedule that you earlier disabled.
Specifies that the vaulting scan schedule be disabled. You can use this option to suspend a vaulting scan schedule without deleting it. This option is useful when you must take a host out of service temporarily.
Specifies a replacement location to be applied to the vaulting scan schedule. This option replaces the entire set of locations currently defined for the schedule.
Adds one or more locations to a vaulting scan schedule.
Removes one or more locations from a vaulting scan schedule.
Note:
The--location
, --addlocation
, and --rmlocation
options are deprecated for vaulting scan schedules in this release, but they are supported for backward compatibility. Oracle recommends that you use the --restrict
, --addrestrict
, and --rmrestrict
options to limit vaulting scans to particular locations.Restricts a vaulting scan to one or more locations. The locations can be specified in any of the following forms:
location_name
@cap_name
The location_name
is the location that is scanned during a scan job for volumes eligible to be moved. The cartridge access port (CAP) name can be specified only if the location is an ACSLS library.
location_name
If location_name
is an ACSLS library and no CAP name is specified, then Oracle Secure Backup selects the largest available CAP.
@cap_name
If no location name is specified, then the location of the specified CAP is scanned. This form applies only to ACSLS libraries.
If the ejection type for the library is set to automatic or ondemand, then Oracle Secure Backup exports volumes to the specified CAP during a media movement job.
This option replaces the entire set of locations currently defined for the schedule.
Adds one or more locations to a vaulting scan schedule. The locations can be specified in any of the forms listed for the --restrict
option.
Removes one or more locations from a vaulting scan schedule. The locations can be specified in any of the forms listed for the --restrict
option.
Restricts a vaulting scan to one or more media families. This option replaces the entire set of media families currently defined for the schedule.
Adds one or more media families to the vaulting scan.
Removes one or more media families from the vaulting scan.
Adds a trigger to the schedule. A trigger is a user-defined period in time or sets of times that causes a scheduled backup to run. You must specify the --day
option when adding a trigger. If you specify --day
but do not specify a time, then the time defaults to 00:00.
Edits the specified trigger in the schedule. Specify the --long
option on the lssched command to obtain trigger numbers.
Removes a trigger from the schedule. Specify the --long
option on the lssched command to obtain trigger numbers.
Specifies the name of the schedule.
Use the following syntax to change an existing volume duplication scan schedule.
chsched [ --comment/-c comment | --inputcomment/-i ] [ --priority/-p schedule-priority ] [ --enabled/-z ] [ --disabled/-Z ] [ --location/-L locationname[,locationname]... ] [ --addlocation/-O locationname[,locationname]... ] [ --rmlocation/-C locationname[,locationname]... ] [ [ --addtrigger/-a ] | [ --chtrigger/-h trigger-number[,trigger-number]... ] | [ --rmtrigger/-m trigger-number[,trigger-number]... ] ] [ [ --day/-d day-date ][ --time/-t time ][ --expires/-x duration ] ]... schedulename...
Refer to "mksched" for option descriptions not included in this section.
Specifies that the volume duplication scan schedule be enabled. You can use this option to restart a volume duplication scan schedule that you earlier disabled.
Specifies that the volume duplication scan schedule be disabled. You can use this option to suspend a volume duplication scan schedule without deleting it. This option is useful when you must take a host out of service temporarily.
Specifies one or more replacement locations to be applied to a volume duplication scan schedule. This option replaces the entire set of locations currently defined for the schedule. Only an active location can be specified in a duplication scan schedule.
Adds one or more locations to a volume duplication scan schedule. Only an active location can be specified in a duplication schedule.
Removes one or more locations from a volume duplication scan schedule.
Adds a trigger to the schedule. A trigger is a user-defined period in time or sets of times that causes a scheduled backup to run. You must specify the --day
option when adding a trigger. If you specify --day
but do not specify a time, then the time defaults to 00:00.
Edits the specified trigger in the schedule. Specify the --long
option on the lssched command to obtain trigger numbers.
Removes a trigger from the schedule. Specify the --long
option on the lssched command to obtain trigger numbers.
Specifies the name of the schedule.
Example 2-26 Changing a Backup Schedule
Example 2-26 starts with a full backup scheduled to run every Sunday at 9:00 P.M. The first chsched
command adds a weekday trigger at 4:00 A.M., specifies media family full
, and sets the backup to expire after 30 days. The second chsched
command changes the Sunday trigger to run at noon.
ob> lssched --long OSB-CATALOG-SCHED: Type: backup Dataset: OSB-CATALOG-DS Priority: 50 Encryption: no Comment: catalog backup schedule full_backup: Type: backup Dataset: datadir.ds Priority: 5 Encryption: yes Trigger 1: Day/date: sundays At: 21:00 Backup level: full Media family: (null) ob> chsched --addtrigger --day "mon tue wed thu fri" --family full --expires 30days --time 04:00 full_backup ob> lssched --long OSB-CATALOG-SCHED: Type: backup Dataset: OSB-CATALOG-DS Priority: 50 Encryption: no Comment: catalog backup schedule full_backup: Type: backup Dataset: datadir.ds Priority: 5 Encryption: yes Trigger 1: Day/date: sundays At: 21:00 Backup level: full Media family: (null) Trigger 2: Day/date: weekdays At: 04:00 Backup level: full Media family: full Expires after: 30 days ob> chsched --chtrigger 1 --time 12:00 full_backup ob> lssched --long OSB-CATALOG-SCHED: Type: backup Dataset: OSB-CATALOG-DS Priority: 50 Encryption: no Comment: catalog backup schedule full_backup: Type: backup Dataset: datadir.ds Priority: 5 Encryption: yes Trigger 1: Day/date: sundays At: 12:00 Backup level: full Media family: (null) Trigger 2: Day/date: weekdays At: 04:00 Backup level: full Media family: full Expires after: 30 days
Use the chssel
command to change a database backup storage selector that you previously created with the mkssel command.
See Also:
"Database Backup Storage Selector Commands" for related commandsYou must have the modify administrative domain's configuration right to run the chssel
command.
chssel [ --dbname/-d { * | dbname[,dbname]...} ] [ --adddbname/-D { * | dbname[,dbname]...} ] [ --rmdbname/-E dbname[,dbname]... ] [ --dbic/-i { * | dbid[,dbid]... } ] [ --adddbid/-I { * |dbid[,dbid }... } ] [ --rmdbid/-J { * | dbid[,dbid]... } ] [ --host/-h { * | hostname[,hostname]... } ] [ --addhost/-H { * | hostname[,hostname]... } ] [ --rmhost/-K { * | hostname[,hostname]... } ] [ --content/-c { * | content[,content]... } ] [ --addcontent/-C { * | content[,content]... } ] [ --rmcontent/-F { * |content[,content]... } ] [ --restrict/-r restriction[,restriction]... ] [ --addrestrict/-R restriction[,restriction]... ] [ --rmrestrict/-S restriction[,restriction]... ] [ --copynum/-n { * | 1 | 2 | 3 | 4 } ] [ --family/-f media_family ] [ --waittime/-w duration ] [ --encryption/-e {off|on|forceoff|swencryption}] sselname...
Replaces the current database names for the storage selector with the specified dbname
values.
Adds the specified dbname
values to the databases currently associated with the storage selector.
Removes the specified dbname
values from the databases currently associated with the storage selector.
Replaces the current database ID (DBID) for the storage selector with the specified dbid
value.
Adds the specified dbid
values to the DBIDs currently associated with the storage selector.
Removes the specified DBIDs from the storage selector.
Replaces the current hosts for the storage selector with the specified hostname
values.
Adds the specified hostname
values to the hosts currently associated with the storage selector.
Removes the specified hostname
values from the hosts currently associated with the storage selector.
Replaces the current content types for the storage selector with the specified content types. Refer to "content" for a description of the content
placeholder.
Adds the specified content types to the content types currently associated with the storage selector.
Removes the specified content types from the content types currently associated with the storage selector.
Replaces the current tape device restrictions in the storage selector with the specified restriction
values. Refer to "restriction" for a description of the restriction
placeholder.
Adds the specified restriction
values to the storage selector.
Removes the specified restriction
values from the storage selector.
Specifies the copy number to which this storage selector applies. The copy number must be an integer in the range 1 to 4. An asterisk (*) specifies that the storage selector applies to any copy number.
Replaces the current media family for the storage selector with the specified family. You create media families with the mkmf command.
Replaces the current resource availability time for the storage selector with the specified duration. Refer to "duration" for a description of the duration
placeholder.
Specifies whether backups should be encrypted. In all cases, if the data has been encrypted by RMAN, then Oracle Secure Backup performs no further encryption. Set one of the following options for encryption:
ON: Oracle Secure Backup encrypts the backup data unless it has already been encrypted by RMAN.
OFF: Oracle Secure Backup does not encrypt the backup data unless either the host or global policy is set to required. OFF is equivalent to specifying no value for encryption.
FORCEDOFF: Oracle Secure Backup does not encrypt the database backup, overriding any host-specific encryption settings. The FORCEDOFF setting does not affect RMAN, which can still encrypt the backup data.
SWENCRYPTION: Oracle Secure Backup uses software encryption instead of hardware encryption. This option is provided in case you do not want hardware encryption used in some situations.
Note:
Theencryption
option is only available starting with Oracle Secure Backup 10.3.0.2.0.Specifies one or more names of storage selectors to modify.
Example 2-27 creates a backup storage selector named ssel_full
that specifies that the entire database should be backed up. The example then changes the storage selector to include archived redo logs.
Example 2-27 Adding Content Types to a Database Backup Storage Selector
ob> mkssel --dbid 1557615826 --host brhost2 --content full --family f1 ssel_full ob> lsssel --long ssel_full: Content: full Databases: [all] Database ID: 1557615826 Host: brhost2 Restrictions: [none] Copy number: [any] Media family: f1 Resource wait time: 1 hour UUID: b5774d9e-92d2-1027-bc96-000cf1d9be50 ob> chssel --addcontent archivelog ssel_full ob> lsssel --long ssel_full: Contents: archivelog, full Databases: [all] Database ID: 1557615826 Host: brhost2 Restrictions: [none] Copy number: [any] Media family: f1 Resource wait time: 1 hour UUID: b5774d9e-92d2-1027-bc96-000cf1d9be50
Use the chsum
command to change a job summary schedule.
See Also:
"Summary Commands" for related commandsYou must have the modify administrative domain's configuration right to run the chsum
command.
chsum [ --days/-d produce-days[,produce-days]... ] [ --reporttime/-t time ] [ --mailto/-m email-target[,email-target]... ] [ --addmailto/-a email-target[,email-target]... ] [ --rmmailto/-r email-target[,email-target]... ] [ --host/-h hostname[,hostname]... ] [ --addhost/-H hostname[,hostname]... ] [ --rmhost/-h hostname[,hostname]... ] [ [ --covers/-c duration ] | [ --since/-s "summary-start-day[ ]time" ] ] [ --backup/-B { yes | no } ] [ --restore/-R { yes | no } ] [ --orabackup/-b { yes | no } ] [ --orarestore/-e { yes | no } ] [ --scheduled/-S { yes | no } ] [ --user/-U { yes | no } ] [ --subjobs/-J { yes | no } ] [ --superseded/-D { yes | no } ] [ --duplication/-P { yes | no } ] [ --catalog/-C { yes | no } ] [ --mediamovement/-M { yes | no } ] summary-name...
Refer to "mksum" for options not included in this section.
Adds additional email addresses to the job summary schedule.
Removes email addresses from the job summary schedule.
Adds a host to the list of hosts to which this job summary is limited.
Removes a host from the list of hosts to which this job summary is limited.
Specifies the name of the job summary schedule.
ob> lssum weekly_report Wed at 12:00 ob> chsum --addmailto jim@example.com --days Wed,Fri --reporttime 12:00 weekly_report ob> lssu --long weekly_report: Produce on: Wed Fri at 12:00 Mail to: lance@example.com jim@example.com In the report, include: Backup jobs: yes Restore jobs: yes Scheduled jobs: yes User jobs: yes Subordinate jobs: yes Superseded jobs: no
Use the chuser
command to change the attributes of an Oracle Secure Backup user.
See Also:
"User Commands" for related commandsIf you must modify the attributes of any Oracle Secure Backup user, including yourself, then you must have the modify administrative domain's configuration right. To modify only your own password and given name, then you must have the right to modify own name and password.
chuser [ --class/-c userclass ] [ --password/-p password | --querypassword/-q ] [ --unixname/-U unix-user ] [ --unixgroup/-G unix-group ] [ --adddomain/-d { windows-domain | * },windows-account[,windows-password ] ]... [ --rmdomain/-r { windows-domain | * } ] [ --ndmpuser/-N { yes | no } ]... [ --email/-e emailaddr ] [ --givenname/-g givenname ] [ --preauth/-h preauth-spec[,preauth-spec]... ] [ --addpreauth/-H preauth-spec[,preauth-spec]... ] [ --rmpreauth/-X preauth-spec[,preauth-spec]... ] username...
Refer to "mkuser" for descriptions of chuser
options not included in this section.
Specifies a password for the Oracle Secure Backup user when logging in to an administrative domain. The maximum character length that you can enter is 16 characters. If you do not specify a password, then the password is null.
The minimum password length is determined by the minuserpasswordlen
security policy. Its default value is 0, which means a null password is permitted.
See Also:
"minuserpasswordlen"The practice of supplying a password in clear text on a command line or in a command script is not recommended by Oracle. It is a security vulnerability. The recommended procedure is to have the Oracle Secure Backup user be prompted for the password.
Adds Windows domain information to the user account. If the domain is different from an existing domain in the user object, then --adddomain
adds an entry for the additional domain. If the domain name in --adddomain
is same as an existing domain in the user object, then --adddomain
replaces the existing information. Refer to the --domain
option of the mkuser command for more information.
Removes a Windows domain.
Authorizes the specified Oracle Secure Backup user identity for the specified operating system user on the specified host. Refer to "preauth-spec" for a description of the preauth-spec placeholder.
Specifying the --preauth
option replaces any existing preauthorization data. You can reset the preauthorization for an Oracle Secure Backup user by specifying an empty string, for example, --preauth ""
.
Adds preauthorization objects and preauthorizes Oracle Secure Backup access, but does not replace existing preauthorization data. You can add preauthorizations only if you have the modify administrative domain configuration
right. Typically, only an Oracle Secure Backup user in the admin
class has this right.
Refer to "preauth-spec" for a description of the preauth-spec
placeholder.
If you specify os-username
as a Windows account name, then you must state the Windows domain name explicitly either as wild-card or a specific name. Duplicate preauthorizations are not permitted. Preauthorizations are duplicates if they have the same hostname, userid, and domain.
Removes preauthorized access to the specified Oracle Secure Backup user from the specified host or operating system user. Preauthorization attributes, if specified, are ignored. Refer to "preauth-spec" for a description of the preauth-spec
placeholder.
You can remove preauthorizations only if you have the modify administrative domain configuration
right. Typically, only an Oracle Secure Backup user in the admin
class has this right.
Specifies the name of the Oracle Secure Backup user to be modified.
This example creates Oracle Secure Backup user bkpadmin
, reassigns this user to the oracle
class, and then displays information about this user.
Example 2-28 Changing an Oracle Secure Backup User
ob> mkuser bkpadmin --class admin --password "x45y" --givenname "lance" --unixname bkpadmin --unixgroup "dba" --preauth osbsvr1:bkpadmin+rman+cmdline --ndmpuser no --email bkpadmin@example.com ob> chuser --class oracle bkpadmin ob> lsuser --long bkpadmin bkpadmin: Password: (set) User class: oracle Given name: lance UNIX name: bkpadmin UNIX group: dba Windows domain/acct: [none] NDMP server user: no Email address: bkpadmin@example.com UUID: 5f437cd2-7a49-1027-8e8a-000cf1d9be50 Preauthorized access: Hostname: osbsvr1 Username: bkpadmin Windows domain: [all] RMAN enabled: yes Cmdline enabled: yes
Used to change volume attributes, including the rotation policy applied to the volume and its current location.
See Also:
"Volume Rotation Commands"You must have the modify administrative domain's configuration right to use the chvol
command.
If you specify a volume ID that matches multiple volumes in the Oracle Secure Backup volumes catalog, or if the specified volume belongs to a volume set, then Oracle Secure Backup asks which volume or volumes you want to modify.
The form of the response from Oracle Secure Backup depends on the kind of ambiguity it finds. Suppose you want to extend the expiration time on volume VOL000001
:
obtool> chvol --retain forever -v VOL000001
Your selection matches the following volumes:
Volume ID Barcode Created
1 VOL000001 SF002463 01/11.04:24
2 VOL000001 SF004011 02/05.11:20
3 VOL000001 SF009774 02/23.01:31
Please select the volume(s) that you wish to modify: 1, 2, …, a(ll), n(one), or q(uit) [a]:
In this first example, Oracle Secure Backup identifies three volumes with a volume ID matching VOL000001 and asks you which volume or volumes you want to modify. The default is all volumes.
To extend the expiration time on a different volume VOL000008
:
obtool> chvol --retain forever -v VOL000008
The volume VOL000008 belongs to a volume set with the following members:
Volume ID Barcode Created
VOL000007 SF002463 01/11.04:24
VOL000008 SF004011 01/11.05:32
VOL000009 SF009774 01/11.07:13
Please select the volume(s) that you wish to modify: a(ll), n(one), or q(uit) [q]:
In this second example, Oracle Secure Backup identifies VOL000008 as a member of a volume set and asks you to modify all or none of its volumes. You cannot select individual members of the volume set. The default choice is quit.
chvol { [ --rotationpolicy/-R policyname ] | [ --relocate/-M [ --nomovement/-n ] | [ --force/-f ] --tolocation locationname | [ --missing/-g { yes | no } ] | [ --notintransit/-O ] } [ --duplicationpolicy/-D duplication_policy ] [ --vsopt/-V { ignore | prompt | all } ] [ --expiresat/-x date-time | --retain/-r duration ] vol-spec [vol-spec]...
Changes the rotation policy assigned to the volume to policyname
.
Relocates the volume to the specified location.
A volume can be moved from one location in a rotation policy to another with this option. The specified location must be part of the currently assigned rotation policy for the volume. Use the --rotationpolicy
option to assign a rotation policy to a volume.
If you specify the same location for multiple volumes currently at the same location, then Oracle Secure Backup creates one media movement job for all of the volumes. Volumes specified in multiple chvol
--relocate
commands, however, are not merged into a single media movement job.
Relocates the volume to the specified location without creating a media movement job for the relocation. The specified location must be part of the currently assigned rotation policy for the volume. Use the --rotationpolicy
option to assign a rotation policy to a volume.
Relocates the volume to the specified location without the restriction that the location be part of the currently assigned rotation policy for the volume. If this location does not match the expected location for the volume, then the volume appears on the exception report.
Marks the volume as missing (yes
) so that a media movement job does not attempt to move it, or not missing (no
).
Marks the volume as having completed its journey from vault to robot. Oracle Secure Backup updates the current location of the volume and resets its in-transit flag.
Changes the duplication policy assigned to the volume to policyname
. This option has no effect on volumes previously processed in a duplication scan. Specifying --duplicationpolicy
""
sets the duplication policy to null.
Specifies the action to take if a specified volume belongs to a volume set.
The ignore
option forces Oracle Secure Backup to ignore the volume set membership and change just the selected volume. The prompt
option displays all volumes in the volume set and prompts you to select one or more volumes to change. The all
option applies the change to all members of the volume set.
The default behavior is to ignore the volume set membership and change just the selected volume.
Changes the expiration times of all specified volumes to date-time
, subject to the constraint that no expiration time may be reset to a time earlier than the current expiration time.
See "date-time" for more information on the date-time
placeholder.
Changes the expiration times of all specified volumes by adding duration to the creation time of each volume, subject to the constraint that no expiration time may be reset to a time earlier than the current expiration time.
See "duration" for more information on the duration
placeholder.
Note:
The expiration times generated by the--expiresat/-x
and --retain/-r
options are written to the volumes database. Changing the expiration time of a volume has no effect on the data on the physical tape volume.The volume ID or barcode value of one or more volumes.
See "vol-spec" for more information on the vol-spec
placeholder.
Use the clean
command to clean a tape drive.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the clean
command.
clean [ --drive/-D drivename ] [ --force/-f ] [ --use/-u se-spec ]
Specifies the name of the tape drive to clean. If you do not specify a tape drive name, then the drive variable must be set.
Forces Oracle Secure Backup to clean the tape drive. If there is a tape loaded in the tape drive, then this option unloads the tape, loads the cleaning tape, cleans the tape drive, and then reloads the tape that was originally in the tape drive.
Specifies the number of a storage element containing a cleaning tape. If this option is omitted, then Oracle Secure Backup chooses a cleaning tape based on the setting of the --cleanemptiest
option that you specified on the mkdev command. Refer to "se-spec" for a description of the se-spec
placeholder.
Example 2-29 Cleaning a Tape Drive
This example informs Oracle Secure Backup that you are inserting an unused cleaning tape into element 4 of tape library lib1. The example uses the cleaning tape in element 4 to clean tape drive tape1.
ob> insertvol --library lib1 clean --uses 0 --maxuses 3 4 ob> clean --drive tape1 --force --use 4
Use the closedoor
command to close the import/export door of a tape library. This command only works for libraries that support it.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the closedoor
command.
closedoor [ --library/-L libraryname ]
Specifies the name of the tape library on which you want to close the door. If you do not specify a tape library name, then the library variable must be set.
Use the ctldaemon
command to control the operation of Oracle Secure Backup daemons.
See Also:
"Daemon Commands" for related commandsYou must have the modify administrative domain's configuration right to run the ctldaemon
command.
Use the following syntax to suspend or resume scheduling.
ctldaemon --command/-c { suspend | resume }
Use the following syntax to send a command to one or more daemons.
ctldaemon --command/-c { dump | reinitialize | debugon | debugoff } [ --host/-h hostname[,hostname]... ] [ daemon-id ]...
Enables you to temporarily suspend and later resume the obscheduled daemon (Syntax 1). You can suspend obscheduled for troubleshooting purposes.
Enables you to send a control command to an Oracle Secure Backup daemon (Syntax 2). Table 2-2 lists the --command
values.
Table 2-2 Values for --command
Value | Meaning |
---|---|
|
Directs the daemon to dump internal state information to its log file. |
|
Directs the daemon to reread configuration data. |
|
Directs the daemon to generate extra debugging information to its log file. |
|
Cancels debug mode. This is the default state. |
Specifies the name of a host on which the daemon is running. If this option is omitted, then the local host is assumed.
Identifies an Oracle Secure Backup daemon, either a process id (PID) or service name. Possible service names are observiced
, obscheduled
, obrobotd
, and obixd
.
Example 2-31 Suspending the obscheduled Daemon
This example determines whether the obscheduled
daemon is in a normal state and then suspends it.
ob> lsdaemon obscheduled Process Daemon/ Listen ID Service State port Qualifier 9436 obscheduled normal 42130 ob> ctldaemon --command suspend ob> lsdaemon obscheduled Process Daemon/ Listen ID Service State port Qualifier 9436 obscheduled suspended 42130
Use the discoverdev
command to detect tape devices attached through Network Data Management Protocol (NDMP). The command also detects changes in configuration for NDMP-attached tape devices. Based on this information, discoverdev
automatically updates tape device configuration for the administrative domain.
See Also:
"Device Commands" for related commandsOracle Secure Backup detects and acts on the following kinds of changes:
Tape devices that were not previously configured but have appeared. For each such tape device, Oracle Secure Backup creates a tape device with a temporarily-assigned name and configures a tape device attachment for it.
Tape devices that were previously configured for which an attachment has appeared. Oracle Secure Backup adds an attachment to each existing tape device.
Tape devices that were previously configured for which an attachment has disappeared. Oracle Secure Backup removes the attachment from each tape device.
Oracle Secure Backup detects multiple hosts connected to the same tape device by comparing the serial numbers reported by the operating system. Oracle Secure Backup also determines whether any discovered tape device is accessible by its serial number. If a discovered tape device is accessible by its serial number, then Oracle Secure Backup configures each tape device attachment to reference the serial number instead of any logical name assigned by the operating system.
See Also:
"Device Commands" for related commandsYou must have the modify administrative domain's configuration right to use the discoverdev
command.
discoverdev { --host/-h hostname }... [ --quiet/-q ] [ --noupdate/-U ]
[ --missing/-m ] [ --verbose/-v ]
Identifies the host name on which the discovery is to take place.
Suppresses the display of the discovery tape device status.
Reports changes found during the discovery, but does not make configuration changes.
Reports tape devices that were previously discovered but are no longer found.
Provides verbose output describing the tape devices found.
This example discovers tape devices for NDMP host filer_ethel
.
Example 2-32 Discovering NDMP Devices
ob> lshost filer_ethel mediaserver,client (via NDMP) in service linux_admin admin,mediaserver,client (via OB) in service lucy client (via NDMP) in service nt_client client (via OB) in service w2k client (via OB) in service ob> discoverdev --verbose --host filer_ethel Info: beginning device discovery for filer_ethel. Info: connecting to filer_ethel Info: devices found on filer_ethel: Info: ATL 1500 ... Info: mc3 attrs= [none] Info: WWN: [none] Info: SN: PMC13A0007 Info: Quantum SDLT220... Info: nrst7a attrs= norewind raw Info: WWN: [none] Info: SN: CXB45H1313 Info: Quantum SDLT220... Info: nrst8a attrs= norewind raw Info: WWN: [none] Info: SN: PKB51H0286 filer_ethel_mc3_2 (new library) WWN: [none] new attach-point on filer_ethel, rawname mc3 filer_ethel_nrst7a_2 (new drive) WWN: [none] new attach-point on filer_ethel, rawname nrst7a filer_ethel_nrst8a_2 (new drive) WWN: [none] new attach-point on filer_ethel, rawname nrst8a
Use the dumpdev
command to display tape device errors logged by Oracle Secure Backup.
Error logs reside on the administrative server in the admin/log/device
subdirectory path of the Oracle Secure Backup home.
See Also:
"Device Commands" for related commandsYou must have the right to manage devices and change device state to use the dumpdev
command.
dumpdev [ --since/-s date-time ] [ --clear/-c [ --nq ] [ --nd ] ] { --dumpfile/-f path... | devicename... }
Limits the display to those errors that have occurred since date-time
. Refer to "date-time" for the date-time
placeholder.
Deletes the error log after it has been displayed. You are prompted before each log is deleted.
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Suppresses the display of the error log. This is useful to clear the error log without displaying it.
Specifies a path name of the file to be dumped. This option is useful if you have saved a tape device error log file to a file that dumpdev
would not normally find.
Dumps the error log file associated with devicename
. Refer to "devicename" for the rules governing tape device names.
Example 2-33 Dumping the Error Log for a Tape Drive
This example dumps the error log for a tape drive named 10h_tape1
.
ob> dumpdev 10h_tape1 Oracle Secure Backup hardware error log for "10h_tape1", version 1 EXABYTE EXB-85058SQANXR1, prom/firmware id 07J0, serial number 06667256 Tue Jan 10, 2008 at 16:52:26.354 (Eastern Daylight Time) devtype: 14 obexec: mchamber-pc://./obt0, args to wst__exec: handle=0x0 accessed via host mchamber-pc: Windows_NT 5.1 op=16 (eod), buf=0x00, count=1 (0x1), parm=0x00 cdb: 11 03 00 00 00 00 space, cnt=0 to eod sense data: 70 00 03 FF FF FF FF 15 00 00 00 00 14 00 00 00 00 00 03 00 00 00 02 56 D8 2A 03 00 00 ec=0, sk=media err, asc=14, ascq=0 error is: unrecoverable error flags: (none) returned status: code=unrecoverable error, resid=0 (0x0), checks=0x0 []
Use the dupvol
command to duplicate a volume on demand.
The write window for the original volume is closed when it is duplicated. The write window for the newly created duplicate is also closed unless you choose the volume migration option.
If the duplicated volume was itself a duplicate, then the original volume of the on-demand duplicate is set to the original volume of the duplicated volume.
If an on-demand duplication job is canceled, then no further attempts are made to create the duplicate, and the write window for the original volume is reopened.
See Also:
"Duplication on Demand Commands" for related commandsTwo tape drives are required to perform duplication. You must have the right to manage devices and change device state to use the dupvol
command. The size of the destination volume used for duplication must be greater than or equal to the size of the source volume.
If you specify a volume ID that matches multiple volumes in the Oracle Secure Backup volumes catalog, then Oracle Secure Backup asks which volume or volumes you want to duplicate. You can select one or more of the volumes, all of them, or none of them. The default selection is all volumes.
See Also:
"chvol" for a pair of examples illustrating volume ID matchingdupvol { --family/-f media-family } [ --migrate/-m { yes | no }] [ --priority/-p schedule-priority ] [ --quiet/-q ][ --restrict/-r restriction[,restriction]... ] { --volume/-v vid }[ --tag/-t tag[,tag]... ]
Specifies the media family to be used to create the duplicate volume. Each media family specified must match the retention mode (either time or content managed) of the original volume.
Specifies that the volume must be migrated. If this option is set to yes
, then only one restriction can be specified. The original volume is marked as expired. Only one volume can be created by the process of migration.
Specifies a numeric priority greater than zero assigned by the Oracle Secure Backup user to a scheduled duplication. The lower this value, the higher Oracle Secure Backup considers the priority.
Does not display job ID or status information when a duplication job is dispatched to the scheduler.
Defines a tape device, host, or tape device/host pair in the administrative domain that identifies one or more acceptable tape devices for the duplication. Refer to "restriction" for a description of the restriction
placeholder.
In the absence of a tape device restriction, the duplication runs on the first available tape device. You can specify the restriction as a tape device name (as assigned by mkdev or chdev) or as an attachment for a tape device.
Specifies the volume to be duplicated.
Specifies the volume to be duplicated based on the volume tag (barcode).
Use the edds
command to edit an existing dataset file. You can replace the entire contents of a file in one of these ways:
Using the --input/-i
option on the command line, which enables you to input the file on the command line.
Omitting the --input/-i
option, which opens a default editor window where you can input data and make changes in the editor. You apply the changes when you exit the editor. The default editor is defined by your EDITOR environment variable.
See Also:
"Dataset Commands" for related commandsYou must have the modify administrative domain's configuration right to run the edds
command.
edds [ --nq ] [ --nocheck/-C ] [ --input/-i ] dataset-file-name
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Disables syntactic checking of a dataset file for errors.
Enables you to input or replace the entire contents of a dataset file.
Specifies the name of a dataset file. Refer to "dataset-file-name" for a descriptions of the dataset-file-name
placeholder.
Example 2-34 Checking a File for Syntax
This example opens a dataset file that contains bad syntax, replaces its contents with different syntax, and then checks its syntax.
ob> catds badsyntax.ds icnlude host brhost2 ob> edds --nq --input badsyntax.ds Input the replacement dataset contents. Terminate with an EOF or a line containing just a dot ("."). include host brhost2 include path /home . ob> catds badsyntax.ds include host brhost2 include path /home ob> chkds badsyntax.ds
Use the exit
command to exit obtool. This command is functionally identical to the quit command.
See Also:
"Miscellaneous Commands" for related commandsexit [ --force/-f ]
Exits obtool even if there are pending backup or restore requests. Specifying --force
means that pending backup and restore requests are lost.
Normally, you cannot exit obtool when there are pending requests. You should submit pending requests to the scheduler by specifying --go
on the backup or restore commands.
This command uses the --force
option to exit obtool when a backup job is pending.
ob> backup --dataset fullbackup.ds ob> exit Error: one or more backup requests are pending. Use "quit --force" to quit now, or send the requests to the scheduler with "backup --go". ob> exit --force
Use the exportvol
command to move one or more volumes to the import/export mechanism for removal from the tape library. Typically, you export volumes in bulk. This command is supported only for libraries that have import/export slots.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the exportvol
command.
Use the following syntax to export a volume from a tape library or standalone tape drive.
exportvol [ --library/-L libraryname | --drive/-D drivename ] { vol-range | se-range }
Use the following semantics to export a volume from a tape library or standalone tape drive.
Specifies the name of the tape library from which you want to export volumes. If a tape library is specified, then there are no limitations placed on the storage elements to be exported. If there are an insufficient number of vacant import/export elements to fulfill the request, then obtool reports that the command could not be fully processed.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Specifies the name of a tape drive in the tape library from which you want to export volumes. If a tape drive is specified, then all of the elements must belong to the use list of the tape drive.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Specifies the volumes to be exported. Refer to "vol-range" for a description of the vol-range
placeholder.
Specifies the storage elements containing the volumes to be exported. Refer to "se-range" for a description of the se-range
placeholder.
Use the following syntax to export a volume from an ACS tape library.
exportvol { vol-range | se-range } cap_devicename
Use the following semantics to export a volume from an ACS tape library.
Manual operator intervention is required to remove the volume from the cartridge access port after an export operation is finished. If an amount of time greater than the policy setting maxacsidleejectwaittime
passes without such manual operator intervention, then the eject operation is canceled although the cartridges are still located in the cartridge access port. If you find that not all volumes are moving to the cartridge access port before this time period expires, then increase maxacsejectwaittime
.
Specifies the volumes to be exported. Refer to "vol-range" for a description of the vol-range
placeholder.
Specifies the storage elements containing the volumes to be exported. Refer to "se-range" for a description of the se-range
placeholder.
This option is available only when you are exporting a volume from an ACS tape library. It defines which ACS cartridge access port to export the volume to.
Example 2-36 Exporting a Volume
This example exports volume VOL000003
. Note that the sample output has been reformatted to fit on the page.
ob> lsvol --drive tape2 --long Inventory of library lib2: in mte: vacant * in 1: volume VOL000003, barcode DEV423, oid 111, 47711360 kb remaining * in 2: vacant * in 3: vacant * in 4: vacant in iee1: vacant in iee2: vacant in iee3: vacant in dte: vacant *: in use list ob> exportvol --library lib2 --volume VOL000003 ob> lsvol --drive tape2 --long Inventory of library lib2: in mte: vacant * in 1: vacant * in 2: vacant * in 3: vacant * in 4: vacant in iee1: volume VOL000003, barcode DEV423, oid 111, 47711360 kb remaining, last se 1 in iee2: vacant in iee3: vacant in dte: vacant *: in use list
Use the extractvol
command to notify Oracle Secure Backup that you have manually removed or are removing one or more volumes from a specified tape library. You can specify the source of volumes you are extracting.
Note that you are not required to use the extractvol
command if you issue the inventory command after removing the volumes.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the extractvol
command.
extractvol [ --library/-L libraryname | --drive/-D drivename ] { vol-range | se-range }
Specifies the name of the tape library from which you want to extract volumes.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Specifies the name of a tape drive in the tape library from which you want to extract volumes.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Specifies the volumes to be extracted. Refer to "vol-range" for a description of the vol-range
placeholder. Run the lsvol command to display volume information.
Specifies a range of storage elements from which volumes are to be extracted. Refer to "se-range" for a description of the se-range
placeholder.
Example 2-37 Extracting a Volume
This example notifies Oracle Secure Backup that the volume in storage element 1 of tape library lib1 has been manually removed. Note that the sample lsvol output has been reformatted to fit on the page.
ob> lsvol --library lib1 Inventory of library lib1: in 1: volume VOL000002, barcode ADE201, 47711424 kb remaining in 2: volume VOL000001, barcode ADE203, 48359360 kb remaining in dte: volume RMAN-DEFAULT-000002, barcode ADE202, 47773408 kb remaining, content manages reuse, lastse 3 ob> extractvol --library lib1 1 ob> lsvol --library lib1 Inventory of library lib1: in 1: vacant in 2: volume VOL000001, barcode ADE201, 48359360 kb remaining in dte: volume RMAN-DEFAULT-000002, barcode ADE202, 47773408 kb remaining, content manages reuse, lastse 3
Use the id
command to display the name of the currently logged in Oracle Secure Backup user.
See Also:
"Miscellaneous Commands" for related commandsNo rights are required to run the id
command.
id [ --long/-l ]
Displays the Oracle Secure Backup user and its class. By default id
displays only the class.
Example 2-38 Displaying the Current User
This example displays the current Oracle Secure Backup user, logs out, logs in again as a different Oracle Secure Backup user, and then displays current user information.
ob> id --long user: admin, class: admin ob> lsuser admin admin sbt admin tadmin admin ob> logout % obtool Oracle Secure Backup 10.3 login: sbt ob> id sbt
Use the identifyvol
command to load a specified volume into a tape drive, read its volume label, and return the volume to its original storage element.
This command is useful if an inventory command displays an indefinite volume state such as occupied
, or if you have a valid tape but do not know its contents. If a tape is not new or unlabeled, then you can use identifyvol
to populate the inventory with the volume contents.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the identifyvol
command.
identifyvol [ --drive/-D drivename ] [ --import/-i ] [ --obtaropt/-o obtar-option ]... [ se-range ]
Specifies the name of the tape drive to be used for identifying the volumes. If you do not specify a tape drive name, then the drive variable must be set.
Reads each backup image label on the specified volumes. By default identifyvol
only reads the first label on the volume. You can specify this option to update the volumes catalog in an administrative domain with information about tapes generated in other domains.
identifyvol
--import
does not catalog the contents of the backup images on the volume, but it lists out the backup image labels of all the file sections. Example B-16, "Cataloging a File-System Backup Image" shows how to catalog the contents of a backup image with obtar.
Specifies obtar options that are passed to obtar when the volumes are read. For example -J
enables debug mode and provides more details in backup and restore transcripts. See "obtar Options" for details on obtar options.
Note:
obtool --import
translates internally to obtar --zz
. Thus, if you specify the --import
option, then you cannot also use --obtaropt
to specify options used in the obtar -c
, -x
, or -t
modes.Specifies a range of storage elements containing the volumes to be identified. If se-range
is omitted, then the volume currently loaded in the specified tape drive is identified. Refer to "se-range" for a description of the se-range
placeholder.
This example loads the volumes in storage elements 1 and 3 into tape drive tape1
and identifies them.
Example 2-39 Identifying Volumes
ob> lsvol --library lib1 Inventory of library lib1: in 1: occupied in 3: occupied ob> identifyvol --drive tape1 1,3
Example 2-40 Displaying Backup Image Labels
ob> identifyvol --drive drv1 1,3 ob> ob> identifyvol --import --drive drv1 1,3 Seq Volume Volume Archive Client Backup Archive Create # ID Tag File Sect Host Level Date & Time 1 RMAN-DEFAULT-000001 NNH024 1 1 D localhost 0 2010/07/28 15:40:17 1 RMAN-DEFAULT-000001 NNH024 2 1 D localhost 0 2010/07/28 15:51:04 1 RMAN-DEFAULT-000001 NNH024 3 1 D localhost 0 2010/07/28 15:51:58 1 RMAN-DEFAULT-000001 NNH024 4 1 D localhost 0 2010/07/28 16:15:42 End of volume set. Seq Volume Volume Archive Client Backup Archive Create # ID Tag File Sect Host Level Date & Time 1 my-medfam-000002 000051 1 1 localhost 0 2010/07/28 16:31:31 End of volume set.
Use the importvol
command to move one or more volumes from the import/export mechanism of a tape library to storage elements. This command is supported only for libraries that have import/export slots.
The importvol
command differs from the movevol command in the following ways:
The tape library manager determines the destination storage elements to be used.
Tapes can be identified during the move.
A single command can move multiple tapes.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the importvol
command.
If the library to which the importvol
command is directed has an enabled and functioning barcode reader, then Oracle Secure Backup does not allow specification of the unlabeled
option. Instead, the barcodes on the volumes being imported are read and used to attempt a lookup in the volumes database.
If a matching record is found in the database, then that record is associated with the target storage element. If the barcode is not found in the database, then a scratch record is created and the state of the associated volume is marked unknown
.
importvol [ --library/-L libraryname | --drive/-D drivename ] [ --identify/-i | --import/-m | --unlabeled/-u ] [ --obtaropt/-o obtar-option ]... iee-range
Specifies the name of the tape library into which tapes are to be imported. If a tape library is specified, then all empty storage elements in the tape library are valid destinations. If there are insufficient destinations to fulfill the request, then obtool reports that the command could not be fully processed.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Specifies the name of a tape drive in the tape library into which tapes are to be imported. If a tape drive is specified, then valid destinations are limited to the storage elements in the use list of that tape drive.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Reads the volume ID on each volume. This option is equivalent to running the identifyvol command. This option requires specification of a tape drive.
Reads each backup image label on each volume. You can use this option if you are importing volumes from another administrative domain. This option requires specification of a tape drive.
This option imports information regarding the tape into volumes and archive catalogs. To import backup metadata stored in the tape, use --obtaropt with the -G option.
Marks each imported volume as unlabeled. You cannot specify this option with --identify
or --import
.
The unlabeled
option is not allowed if the library to which the importvol
command is directed has an enabled and functioning barcode reader.
Note:
This option does not actually unlabel the volumes. It is equivalent to aninsertvol
unlabeled
command.Specifies obtar options that are passed to obtar when the volumes are read. For example -J
enables debug mode and provides more details in backup and restore transcripts. See "obtar Options" for details on obtar options. This option is effective only for the --identify
and --import
options.
Specifies a range of import/export elements containing the volumes to be imported. Refer to "iee-range" for acceptable values for iee-range
.
Example 2-41 Importing Volumes
This example imports volumes from import elements iee1, iee2, and iee3 into tape library lib2.
ob> lsvol --long --library lib2 Inventory of library lib2: in mte: vacant in 1: vacant in 2: vacant in 3: vacant in 4: vacant in iee1: volume VOL000003, barcode DEV423, oid 111, 47711360 kb remaining, lastse 1 in iee2: unlabeled, barcode DEV424, oid 114, lastse 1 in iee3: unlabeled, barcode DEV425, oid 115, lastse 2 in dte: vacant ob> importvol --library lib2 iee1-3 ob> lsvol --long --library lib2 Inventory of library lib2: in mte: vacant in 1: volume VOL000003, barcode DEV423, oid 111, 47711360 kb remaining in 2: unlabeled, barcode DEV424, oid 114 in 3: unlabeled, barcode DEV425, oid 115 in 4: vacant in iee1: vacant in iee2: vacant in iee3: vacant in dte: vacant
Use the insertvol
command to notify Oracle Secure Backup that you have manually inserted a volume into the specified destination in the tape library and to specify the properties of the inserted volume. Oracle Secure Backup updates the inventory with the supplied information.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the insertvol
command.
If the library to which the insertvol
command is directed has an enabled and functioning barcode reader, then Oracle Secure Backup does not allow specification of the vol-spec
or unlabeled
options. Instead, the barcodes on the volumes being inserted are read and used to attempt a lookup in the volumes database.
If a matching record is found in the database, then that record is associated with the target storage element. If the barcode is not found in the database, then a scratch record is created and the state of the associated volume is marked unknown
.
Use the following syntax to specify that you have inserted unlabeled or unknown volumes or cleaning tapes.
insertvol [ --library/-L libraryname | --drive/-D drivename ] { unknown | unlabeled | clean --uses/-u n --maxuses/-m n } se-range
Specifies the name of the tape library in which you want to insert one or more volumes.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Specifies the name of a tape drive in the tape library in which you want to insert one or more volumes.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Indicates the volume being inserted is of unknown format.
Indicates that the volume inserted is known to be unlabeled or a new volume.
The unlabeled
option is not allowed if the library to which the insertvol
command is directed has an enabled and functioning barcode reader and the media policy barcodesrequired
is set to yes.
Indicates that the volume being inserted is a cleaning tape. You must specify this option with the --uses
and --maxuses
options.
Specifies the number of times that the cleaning tape has been used.
Specifies the maximum number of times that you can use the cleaning tape. The number of remaining uses for the cleaning tape is the difference between --maxuses
and --uses
.
Specifies a range of storage elements into which the volumes are to be inserted. The inventoried state of the target storage elements must be empty before running the insertvol
command. You can verify that the storage elements are empty by running the lsvol
command.
Refer to "se-range" for a description of the se-range
placeholder.
Use the following syntax to specify that you have inserted known or labeled volumes.
insertvol [ --library/-L libraryname | --drive/-D drivename ] [ vol-spec ] se-spec
Specifies the volume ID or barcode of the inserted volume.
This option is not allowed if the library to which the insertvol
command is directed has an enabled and functioning barcode reader.
Specifies the storage element into which the volume was inserted. The inventoried state of the target storage element must be empty before running the insertvol
command. You can verify that the storage element is empty by running the lsvol
command.
The following sequence of events is required:
If the target storage element is not currently empty, then use extractvol
or movevol
to empty it.
Ensure that the storage element is recognized as empty by the lsvol
command. Run the inventory
command if it is not.
See Also:
Manually insert a volume.
This step is necessary because the insertvol
command requires the barcode to be read from the volume being inserted, which in turn requires that the volume be present before the insertvol
command is run.
Immediately run the insertvol command.
Example 2-42 Notifying Oracle Secure Backup of a Manually Inserted Volume
This example informs Oracle Secure Backup that a cleaning tape is inserted into storage element 2 of tape library lib1
. Note that the sample output is reformatted so that it fits on the page.
ob> lsvol --library lib1 --long Inventory of library lib1: in mte: vacant in 1: volume VOL000001, barcode ADE201, oid 102, 48359360 kb remaining in 2: vacant in 3: volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47773408 kb remaining, content manages reuse in 4: vacant in iee1: vacant in iee2: vacant in iee3: vacant in dte: vacant ob> insertvol --library lib1 clean --uses 0 --maxuses 3 2 ob> lsvol --library lib1 --long Inventory of library lib1: in mte: vacant in 1: volume VOL000001, barcode ADE201, oid 102, 48359360 kb remaining in 2: barcode ADE203, cleaning tape: 0 uses, 3 remaining in 3: volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47773408 kb remaining, content manages reuse in 4: vacant in iee1: vacant in iee2: vacant in iee3: vacant in dte: vacant
Use the inventory
command to initiate a scan of the contents of a tape library.
Oracle Secure Backup does not automatically detect changes to a tape library that result from manual actions such as opening the tape library door to move or remove a tape. Use the inventory
command in such circumstances to make the tape library detect the changes.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to run the inventory
command.
inventory [ --library/-L libraryname | --drive/-D drivename ] [ --force/-f ][ se-range ]
Specifies the name of the tape library for which you want to update the inventory.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Specifies the name of a tape drive in the tape library for which you want to update the inventory.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Forces the tape library to perform a physical inventory of the tape library. Instead of reading from its cache, the tape library updates the inventory by physically scanning all tape library elements.
Limits the inventory update to a range of storage elements. If you do not specify a storage element range, then all storage elements are included in the inventory update.
Note:
If a tape library does not support the Initialize Element Status with Range operation, then Oracle Secure Backup ignores the range option and performs a full Initialization Element Status operation.Every data-transfer element (DTE) and import-export element (IEE) is included in the inventory update, no matter whether a storage-element range is specified or not.
Example 2-43 Taking an Inventory of a Tape Library that Contains a Barcode Reader
This example forces the tape library lib1
to perform an inventory operation. Note that the sample output has been reformatted so that it fits on the page.
ob> inventory --library lib1 --force ob> lsvol --library lib1 Inventory of library lib1: * in 2: volume VOL000001, barcode ADE201, 38919872 kb remaining in iee1: volume VOL000002, barcode ADE203, 38273920 kb remaining, lastse 1 in dte: volume RMAN-DEFAULT-000002, barcode ADE202, 38328224 kb remaining, content manages reuse, lastse 3 *: in use list
Example 2-44 Taking an Inventory of a Tape Library that Does not Contain a Barcode Reader
This example displays the inventory of a tape library that does not contains a barcode reader.
The library lib
does not contain a barcode reader. After performing a forced inventory of the library, some volumes have been manually added to the storage elements 1, 2, and 3. When you use the lsvol
command to display the list of volumes in the library, you obtain the following output.
ob> lsvol -L lib Inventory of library lib: in 4: occupied in 8: occupied in 9: occupied in 10: occupied
When you force the tape library lib
to perform an inventory operation, the newly added tapes are displayed in the storage elements as shown by the following output.
ob> inv --force -L lib ob> lsvol -L lib Inventory of library lib: in 1: occupied in 2: occupied in 3: occupied in 4: occupied in 8: occupied in 9: occupied in 10: occupied
Use the labelvol
command to load selected volumes and write a volume label to each volume.
Caution:
This command erases all existing data on the selected volumes.
In Oracle Secure Backup, a volume label typically contains a volume ID—for example, lev0-0001—and a volume tag, which is a barcode. These two attributes uniquely identify a tape. Oracle Secure Backup usually creates a volume label when it first writes to a tape. You might want to label a volume manually in the following circumstances:
The volume has a barcode but resides in a tape library without a barcode reader. In this case, you must manually inform Oracle Secure Backup of the barcode so that it can properly be written to the volume label.
You want to reserve the volume for use in a particular media family. In this case, prelabeling the volume restricts its use to the media family.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the labelvol
command.
labelvol [ --drive/-D drivename ] [ --barcode/-b barcode ] [ --force/-f ] [ --obtaropt/-o obtar-option ]... [ se-range ]
Specifies the name of the tape drive to be used to label the volume. If you do not specify a tape drive name, then the drive variable must be set.
Specifies a barcode for the volume.
Forces the labeling of a volume. Running the command with this option overrides any conditions that would otherwise prevent the labelvol
command from functioning. This option enables you to overwrite unexpired volumes. Also, you can overwrite an incorrect manual entry for a barcode without the currently required prior step of running an unlabelvol command.
Specifies obtar options. For example -J
enables debug mode and provides more details in backup and restore transcripts. See "obtar Options" for details on obtar options.
Specifies a range of storage elements holding the volumes to be labeled. If this option is omitted, then the volume currently loaded in the specified tape drive is labeled. Refer to "se-range" for a description of the se-range
placeholder.
Use the loadvol
command to move a volume from the indicated storage element to the selected tape drive.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the loadvol
command.
loadvol [ --drive/-D drivename ] [ --mount/-m mode ] [ --force/-f ] [ --req/-r ] { vol-spec | element-spec }
Specifies the name of the tape drive in which you want to load a volume. If you do not specify a tape drive name, then the drive variable must be set.
Indicates the mode that the system can use for a volume physically loaded into a tape drive. When a tape is mounted in a tape drive, the tape is positioned in the tape drive so that it is in the correct configuration to perform the specified action. Valid values for mode
are as follows:
read
This mode mounts the volume for reading only.
write
This mode mounts the volume so that it can append any backups to the end of the volume.
overwrite
This mode mounts a volume on the tape device and positions it at the beginning of the tape so that the existing contents of the volume are overwritten. If you use this option, then you are granting permission to overwrite an unexpired volume.
Forces the loading of a volume. If another volume is in the tape drive, then the volume is automatically unloaded.
Loads the volume only if it is not loaded in the tape drive.
Specifies the volume to be loaded. You specify a volume by its volume ID or its type: unknown
, unlabeled
, or clean
. Refer to "vol-spec" for a description of the vol-spec
placeholder.
Specifies the number of a storage element to be loaded. Refer to "element-spec" for a description of the se-spec
placeholder.
Example 2-46 Loading a Volume in a Tape Drive
This example takes a volume from storage element 1 in tape library lib1
and loads it into tape drive tape1
.
ob> lsvol --library lib1 --long Inventory of library lib1: in mte: vacant in 1: volume VOL000002, barcode ADE201, oid 110, 47670368 kb remaining in 2: volume VOL000001, barcode ADE203, oid 102, 48319392 kb remaining in 3: volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47725600 kb remaining, content manages reuse in 4: vacant in iee1: barcode ADE204, oid 114, 47725344 kb remaining, lastse 4 in iee2: vacant in iee3: vacant in dte: vacant ob> loadvol --drive tape1 1 ob> lsvol --drive tape1 Inventory of library lib1: * in 2: volume VOL000001, barcode ADE203, 48319392 kb remaining * in 3: volume RMAN-DEFAULT-000002, barcode ADE202, 47725600 kb remaining, content manages reuse in iee1: barcode ADE204, 47725344 kb remaining, lastse 4 in dte: volume VOL000002, barcode ADE201, 47670368 kb remaining, lastse 1 *: in use list
Use the logout
command to exit obtool and destroy the login token. When you restart obtool, it prompts you for a username.
See Also:
"Miscellaneous Commands" for related commandslogout
Use the ls
command to list the names and attributes of file-system objects represented in the Oracle Secure Backup catalog.
Listing the contents of the Oracle Secure Backup catalog is equivalent to listing the contents of backup images. The catalog displays the images in a directory structure much like a live file system. You can only list directories whose contents have been backed up.
See Also:
"Browser Commands" for related commandsThe rights needed to run the ls
command depend on the browse backup catalogs with this access setting for the class.
ls [ --long/-l | --short/-s ] [ --label/-L ] [ --oneperline/-1 ] [ --reverse/-r ] [ --directory/-d ] [ --backup/-b [ --position/-p ] ] [ --inode/-i ] [ --nobackupid/-I ] [ --noheader/-H ] [ --notype/-T ] [ --noerrors/-E ] [ --numberformat/-n numberformat ] [ --viewmode/-v viewmode ] [ --ctime/-c | --mtime/-t | --utime/-u ] [ --nosort/-X ] [ --noescape/-B ] [ --max/-M max-entries ] [ --startat/-S starting-entry ] pathname...
Displays Oracle Secure Backup catalog data in long form.
If a backup error occurred on an entry, then the --long
display shows the actual error text. If neither the --long
option nor the --backup
option is specified, then E
is appended to the display name.
Displays Oracle Secure Backup catalog data in short form (default).
Labels the items in the Oracle Secure Backup catalog for ease of reading. See Example 2-48 for an illustration.
Puts each item on a separate line.
Reverses the listing order.
Displays information on the current directory in the Oracle Secure Backup catalog.
Displays the backup information.
If a backup error occurred on an entry, then the --backup
display appends an E
on the individual archive section line. If neither the --long
option nor the --backup
option is specified, then E
is appended to the display name.
Displays the physical location of data on the tape when used with the --backup
option.
Displays inode of contents. Note that this option is only supported for backup images generated by a Network Data Management Protocol (NDMP) data service.
Does not display the backup ID.
Displays information without header output.
Does not use "/" to indicate a directory.
Does not display file-system error messages.
Specifies how to display large numbers. Refer to "numberformat" for a description of the numberformat
placeholder.
Specifies the mode in which to view the Oracle Secure Backup catalog directory contents. Valid values for viewmode
are as follows:
exact
displays only those directory entries that match the data selector.
inclusive
displays all entries, regardless of the current data selector (default).
Displays inode change time if --long
also specified.
Displays file modified time if --long
also specified.
Displays file used time if --long
also specified.
Does not sort names for display.
Does not escape non-displayable characters in filenames. Specify --noescape
if you want file names that include an ampersand character (&
) to display normally.
Specifies the maximum number of entries to display.
Specifies the number where the display should start, with 1
as the first item in the listing.
Specifies the path names in the Oracle Secure Backup catalog.
Example 2-48 Displaying Information About a File
This example lists backup data on brhost2
in short form and then in long form.
ob> set host brhost2 ob> ls home/ ob> cd home ob> ls data/ ob> cd data ob> ls backup/ ob> cd backup ob> ls bin/ c_files/ tree/ ob> cd tree ob> ls file1 lev1a/ lev1b/ ob> ls --long file1 -rwx------ bkpadmin.g527 74 2008/03/02.09:51 file1 (4) ob> ls --long --label --backup --position file1 Name: file1 Backup ID: 4 Mode & protection: -rwx------ Last modified: 2008/03/02.09:51:33 Size: 74 Backup ID: 4 Backup date & time: 2008/03/03.12:13:16 Volume ID: VOL000002 Volume tag: DEV423 File number: 11 File section: 1 Requested level: 0 Client: brhost2 Device: vt1 Program version: 10.3 Volume creation: 2008/03/02.10:02:27 Position: 0000023A0009
Use the lsbackup
command to list each backup request that you created with the backup command. These requests are awaiting delivery to the scheduler.
The lsbackup
command only lists backup requests that have not yet been sent to the scheduler with the --go
option. For example, if you create a backup request, specify --go
, and then run lsbackup
, obtool does not display the request.
See Also:
"Backup Commands" for related commandsYou must have the perform file system backups as privileged user right if you specified the --privileged
option when you created the backup. Otherwise, you must have the perform file system backups as self right.
lsbackup [ --long/-l | --short/-s ] [ --noheader/-H ] [ backup-item ]...
Displays data in long form, that is, describes all of the attributes for each job and labels them. Refer to Example 2-49 for the type of data included. By default this command displays a subset of attributes in tabular form.
Displays data in short form, that is, lists job IDs only.
Suppresses column headers when listing data.
Specifies an identifier assigned by obtool to a backup created with the backup command. The identifier is a small integer number.
Table 2-3 describes the output of the lsbackup
command.
Label | Indicates |
---|---|
Dataset |
User-specified name of the dataset file used in the backup job |
Media family |
User-specified name of the media family used in the backup job |
Backup level |
Level of backup to be performed; setting is |
Priority |
Priority level of the backup job; set a number greater than |
Privileged op |
Setting is |
Eligible to run |
Date and time at which the backup job can begin |
Job expires |
Date and time the backup job request expires |
Restriction |
Tape devices to which the backup job is restricted |
If a date reported by lsbackup
is more than six months earlier or more than two months in the future, then it is reported in a yyyy/mm/dd
format. If a date is less than six months earlier or less than two months in the future, then it is reported in a mm/dd.hh:mm
format.
Example 2-49 Listing a Backup in Long Form
This example displays full details about pending backup jobs. The 1:
at the beginning of the output is the backup item identifier.
ob> lsbackup --long 1: Dataset: brhost2.ds Media family: (null) Backup level: full Priority: 10 Privileged op: yes Eligible to run: 2008/06/14.21:00:00 Job expires: 2008/06/19.21:00:00 Restriction: any device
Use the lsbu
command to list cataloged backups. A catalogued backup is a backup that has completed, either successfully or with errors, and that has been logged in the Oracle Secure Backup catalog.
The lsbu
command lists backup date and time, volume ID, and so forth. The ls command lists the contents of cataloged backups.
See Also:
"Browser Commands" for related commandsYou must have the display administrative domain's configuration right to use the lsbu
command.
lsbu [ --long/-l | --short/-s ] [ --noheader/-H ] [ --reverse/-r ] [ --level/-L backup-level | --maxlevel/-M backup-level ] [ --inclusions/-i [ --dependencies/-d ] ] [ --host/-h hostname ]... [ --path/-p pathname ]... [ --duplicates/-D ] [ data-selector ]...
Displays data in long form. The command displays all attributes of the backups and labels them. By default the command displays a subset of attributes in tabular format.
Displays data in short form. The command displays only backup IDs.
Does not display headers for columns.
Reverses the listing order.
Displays backups based on backup level. Refer to "backup-level" for a description of the backup-level
placeholder.
Specifies the maximum backup level to display. Refer to "backup-level" for a description of the backup-level
placeholder.
Displays the paths that were backed up for the set host.
See Also:
"set" to learn how to set or reset the hostFor each incremental backup listed, display the dependencies on predicate backups.
Displays backups of client hostname
.
Displays backups based on file-system objects.
While listing backups, show backup available on duplicate volumes as well. If this option in not specified, then the command shows only the volume at the active location or nearest storage location.
Specifies the Oracle Secure Backup catalog data that applies to an operation.
Table 2-4 describes the output for the lsbu
command.
Label | Indicates |
---|---|
Backup ID |
Unique identification number for a backup job; assigned by Oracle Secure Backup |
Backup date & time |
Starting date and time for a backup job; assigned by the scheduler |
Volume ID |
Unique volume name with a sequentially numbered suffix; assigned by Oracle Secure Backup |
Volume tag |
Barcode of the volume |
Current location |
Current location of the volume |
File number |
The file number the backup job occupies on a tape containing multiple backups |
File section |
The number of times a tape is changed during a backup job that spans multiple tapes |
Requested level |
Defaults to |
Client |
Name of the backed up client computer |
Device |
Name of the tape drive to which the backup is made |
Program version |
Version of Oracle Secure Backup |
Encryption |
Encryption enabled or disabled (see "--encryption/-e {yes | no | forcedoff | transient}") |
Algorithm |
The encryption algorithm used (see "--algorithm/-L") |
Volume creation |
Date and time at which Oracle Secure Backup wrote backup image file number 1 to a volume. |
If a date reported by lsbu
is more than six months earlier or more than two months in the future, then it is reported in a yyyy/mm/dd
format. If a date is less than six months earlier or less than two months in the future, then it is reported in a mm/dd.hh:mm
format.
Example 2-50 Listing Cataloged Backups
This example lists all cataloged backups for host sales-server
.
ob> lsbu -l -h sales-server Backup ID: 0 Backup date & time: 2009/01/14.11:37:44 Volume ID: VOL000001 Volume tag: 16ab82c4c4b1102a6f5000423a5a98c Current location: vlib1 File number: 2 File section: 1 Requested level: 0 Client: sales-server Device: vt1 Program version: 10.3.0.1.0 Encryption: on Algorithm: aes192 Volume creation: 2009/01/14.11:35:15 Backup ID: 1 Backup date & time: 2009/01/14.11:39:09 Volume ID: VOL000001 Volume tag: 16ab82c4c4b1102a6f5000423a5a98c Current location: vlib1 File number: 3 File section: 1 Requested level: 0 Client: sales-server Device: vt1 Program version: 10.3.0.1.0 Encryption: hardware Algorithm: aes256 Volume creation: 2009/01/14.11:35:15 Backup ID: 2 Backup date & time: 2009/01/14.11:39:27 Volume ID: VOL000001 Volume tag: 16ab82c4c4b1102a6f5000423a5a98c Current location: vlib1 File number: 4 File section: 1 Requested level: 0 Client: sales-server Device: vt1 Program version: 10.3.0.1.0 Encryption: off Volume creation: 2009/01/14.11:35:15
Use the lsbw
command to list backup windows. If no backup window exists, then the command displays the following message:
There are no backup windows.
See Also:
"Backup Window Commands" for related commandsYou must have the display administrative domain's configuration right to use the lsbw
command.
lsbw [ --short/-s ] day-specifier[,day-specifier]...
Displays data in short form. The command displays only the days when the backup window is open. By default the command displays days and times.
Specify a time range in terms of days. Refer to "day-specifier" for a description of the day-specifier
placeholder.
Example 2-51 Listing Backup Windows
This example shows the backup windows created in Example 2-1.
ob> lsbw weekend 08:00-20:00 weekday 00:00-08:00,20:00-24:00
Use the lscheckpoint
command to list the identity and attributes of current checkpoints.
See Also:
"Checkpoint Commands" for related commandsYou must have the right to query and display information about devices to use the lscheckpoint
command.
lscheckpoint [ --short/-s | --long/-l ] [ --host/-h hostname[,hostname]... ]... [ job-id ]...
Displays only the IDs of jobs that have checkpoints.
Displays multiple lines for each entry, describing all user-visible information for each checkpoint.
Constrains the listing to checkpoints for the host specified by hostname
.
Specifies the Oracle Secure Backup-assigned job ID whose checkpoint information you want to display. If this option is absent, then obtool displays all checkpoints, or all checkpoints for hosts named specified with the --host/-h
option.
Table 2-5 describes the output of the lscheckpoint
command.
Label | Indicates |
---|---|
Job ID |
Unique identifier of a scheduled backup or restore job; assigned by Oracle Secure Backup |
Host |
Name of host |
Operation |
Type of operation being performed |
Checkpoint created |
Date and time at which the checkpoint was created |
Restartable |
Ability to restart a backup job; setting is |
Current context ID |
Identification of the currently active checkpoint |
If a date reported by lscheckpoint
is more than six months earlier, then it is reported in a yyyy/mm/dd
format. If a date is less than six months earlier, then it is reported in a mm/dd.hh:mm
format.
Example 2-52 Listing Checkpoint Information
This example displays the job information for job admin/8.1
and then displays the checkpoint information for this job.
ob> lsjob --long admin/8.1 admin/8.1: Type: backup br_filer Level: full Family: (null) Restartable: yes Scheduled time: none State: running since 2008/05/18.17:45 Priority: 100 Privileged op: no Run on host: (administrative server) Attempts: 1 ob> lscheckpoint --long admin/8.1 Job ID: admin/8.1 Host: br_filer Operation: backup Checkpoint created: 05/18.17:48 Restartable: yes Current context ID: 18
Use the lsclass
command to list the names and attributes of a Oracle Secure Backup user class.
See Also:
"Class Commands" for related commands
Appendix 7, "Classes and Rights" for a descriptions of the default Oracle Secure Backup classes and rights
You must have the display administrative domain's configuration right to use the lsclass
command.
lsclass [ { --long/-l [ --abbreviate/-a ] } | --short/-s ] [ --mailrekey/-g { yes | no } ] [ --modself/-m { yes | no } ] [ --modconfig/-M { yes | no } ] [ --backupself/-k { yes | no } ] [ --backuppriv/-K { yes | no } ] [ --restself/-r { yes | no } ] [ --restpriv/-R { yes | no } ] [ --listownjobs/-j { yes | no } ] [ --modownjobs/-J { yes | no } ] [ --listanyjob/-y { yes | no } ] [ --modanyjob/-Y { yes | no } ] [ --mailinput/-i { yes | no } ] [ --mailerrors/-e { yes | no } ] [ --querydevs/-q { yes | no } ] [ --managedevs/-d { yes | no } ] [ --listconfig/-L { yes | no } ] [ --browse/-b browserights ] [ --orauser/-o { yes | no } ] [ --orarights/-O oraclerights ] [ classname ]...
Refer to "mkclass" for details on options not included in this section. For the lsclass
command, these options select which classes are to be listed based on whether a class has (yes
) or lacks (no
) the specified rights.
Displays data in long form. The command displays all classes and privileges.
Displays a short description when used with the --long
option.
Displays data in short form (default). The command displays only the class names.
Table 2-6 describes the output of the lsclass
command.
Label | Indicates |
---|---|
browse |
browse backup catalogs with this access right; values are |
oracle |
access Oracle database backups right; values are |
listconfig |
display administrative domain's configuration right; values are |
modself |
modify own name and password right; values are |
modconfig |
modify administrative domain's configuration right; values are |
backupself |
perform file system backups as self right; values are |
backuppriv |
perform file system backups as privileged user right; values are |
listownjobs |
list any jobs owned by user right; values are |
modownjobs |
modify any jobs owned by user right; values are |
restself |
perform file system restores as self right; values are |
restpriv |
perform file system restores as privileged user right; values are |
mailinput |
receive email requesting operator assistance right; values are |
mailerrors |
receive email describing internal errors right; values are |
querydevs |
query and display information about devices right; values are |
managedevs |
manage devices and change device state right; values are |
listanyjob |
list any job, regardless of its owner right; values are |
modanyjob |
modify any job, regardless of its owner right; values are |
oracleuser |
perform Oracle database backups and restores right; values are |
Example 2-53 Displaying Information About a Class
This example lists the attributes of the reader
class.
ob> lsclass --long --abbreviate reader reader: browse: named oracle: none listconfig: no modself: yes modconfig: no backupself: no backuppriv: no listownjobs: no modownjobs: no restself: no restpriv: no mailinput: no mailerrors: no querydevs: no managedevs: no listanyjob: no modanyjob: no oracleuser: no
Use the lsdaemon
command to list Oracle Secure Backup daemons running on a host.
See Also:
"Daemon Commands" for related commandsYou must have the display administrative domain's configuration right to use the lsdaemon
command.
lsdaemon [ --long/-l | --short/-s ] [ --all/-a ] [ --noheader/-H ] [ --host/-h hostname[,hostname]... ] [ daemon-id ]...
Lists data in long form. The command displays the attributes of each daemon and labels them, for example, Listen port: 43983
. By default lsdaemon displays this data in tabular form.
Lists only the names of the daemons.
Lists the same data as --long
except in a table format, that is, with column headings instead of labels. This option is enabled by default.
Lists data in --all
format but suppresses column names.
Lists daemon data based on the specified host in which the daemons run. If this option is omitted, then the local host is assumed.
Identifies an Oracle Secure Backup daemon, either a process id (PID) or service name. Possible service names are observiced
, obscheduled
, obrobotd
, and obixd
. If this option is omitted, all daemons are displayed.
Table 2-7 shows the output for the lsdaemon command.
Label | Indicates |
---|---|
Process ID |
Number identifying the process in which the daemon is running; assigned by the operating system |
Daemon/Service |
Name of the daemon; assigned by Oracle Secure Backup |
State |
State of the daemon; setting is |
Listen port |
TCP port on which the daemon or service is listening for connections |
Qualifier |
Text string that augments the Daemon/Service name |
Example 2-54 Listing Daemons in Short Form
This example lists the names of all daemons.
ob> lsdaemon --short observiced obixd obscheduled
Example 2-55 Listing Daemons in Long Form
This example lists the daemons in long form.
ob> lsdaemon --long Process ID: 9418 Daemon/Service: observiced State: debug Listen port: 400 Qualifier: (none) Process ID: 12652 Daemon/Service: obixd State: normal Listen port: 43983 Qualifier: brhost2 Process ID: 9436 Daemon/Service: obscheduled State: normal Listen port: 42130 Qualifier: (none)
Use the lsdev
command to list the names and attributes of one or more configured devices.
See Also:
"Device Commands" for related commandsYou must have the display administrative domain's configuration right to use the lsdev
command.
lsdev [ --long/-l | --short/-s ] [ --inservice/-o | --notinservice/-O ] [ --reservations/-v | --mount/-m | --description/-d | --borrowed/-b ] [ --nocomm/-N ] [ --reserved/-r [ --me/-e ] ] [ --nohierarchy/-H ] [ --notype/-T ] [ --geometry/-g ] [ --verbose/-V ] [ --attach/-a aspec ] [ --type/-t { tape | library | cap } ] devicename...
Displays data in long form. The command displays the attributes of each device and labels them. Refer to Example 2-57 for sample output. By default the command displays the device name, type, and status.
Displays data in short form. The command prints the name of each device on a separate line.
Displays a list of devices that are logically available to Oracle Secure Backup.
Displays a list of devices that are not logically available to Oracle Secure Backup.
Display device reservation data, for example, the name of reserving component, and so forth. You can use the resdev command to reserve a device and the unresdev to unreserve a device.
Displays a list of devices with their mount status.
Displays a list of devices with detailed descriptions. For any device missing a description, run the pingdev
devicename
command to create one.
Displays a list of devices with their borrowed status.
Suppresses communication with the device.
Lists only those devices that are currently reserved.
Displays devices that are reserved for the logged-in Oracle Secure Backup user. Use with the --reserved
option.
For a tape library, suppresses the display of the tape drives contained in the tape library. By default, display of a tape library also displays the contained tape drives.
Displays a list of devices without specifying the type (tape drive or tape library).
Displays the geometry and other characteristics of a tape library.
This option causes an Inquiry command to be sent to the tape device. While not a requirement of the SCSI-2 standard, most modern tape drives and libraries support the Unit Serial Number Inquiry Page, by which a device can be programmatically interrogated as to its serial number. In response, the device returns the resulting vendor, product ID, firmware version, and serial number.
Produces verbose output (default). For each device obtool displays the device type, name, and status.
Displays the device with the specified attachment. Refer to "aspec" for a description of the aspec
placeholder.
Displays the specified type of device: tape
, library
, or cap
. The cap
value applies only to ACSLS systems. For ACSLS, the long output of tape
and cap
show the appropriate acs, lsm, panel, ID information, access mode and priority.
Specifies the name of the device for which you want to view attribute data. Refer to "devicename" for the rules governing device names.
Table 2-8 shows the output for the lsdev
command.
Label | Indicates |
---|---|
Device type |
Type of device. Setting is If the device object was created with the |
Model |
Manufacturer model, if available |
Serial number |
Manufacturer serial number, if available |
In service |
Device eligibility for use. Setting is |
Debug mode |
Assists in troubleshooting problems. Setting is |
Barcode reader |
Setting is |
Barcodes required |
Setting is |
Auto clean |
Automatically clean the tape drive heads. Setting is |
Clean interval |
Amount of time between cleaning |
Clean using emptiest |
Use cleaning tape with the most remaining cleanings available. Setting is |
Unload required |
Setting is |
UUID |
Universal Unique Identifier (UUID) for the hardware |
Attachment # |
Starts at |
Host |
Host name of the media server |
Raw device |
Device-specific file name: |
Library |
User-assigned Oracle Secure Backup name for the tape library |
DTE |
Number of the tape drive in the tape library |
Automount |
Automatically mounts the tape device. Setting is |
Error rate |
Maximum number of errors for each tape before backup job fails |
Query frequency |
During a backup, Oracle Secure Backup periodically samples the position of the tape. Query frequency is the distance between samplings of the tape position expressed in 1KB blocks. Possible values include:
|
Blocking factor |
Set to the default optimum value of 128 bytes. This value should not be changed arbitrarily because, if you choose a value higher than what is supported by the operating system of the server, then Oracle Secure Backup terminates with an error. |
Max blocking factor |
Set at optimum value by Oracle Secure Backup. Oracle recommends that you not change these values |
Current tape |
Original storage element of the tape currently in the DTE in addition to other information about the tape |
Use list |
Tapes residing in storage elements assigned for this tape drive to use |
Drive usage |
Amount of time since first use or since last cleaning |
Cleaning required |
Tape drive cleaning is required. Setting is |
Example 2-57 Listing Details for a Library
This example lists detail for a tape library named filer_ethel_mc3
.
ob> lsdev --long filer_ethel_mc3 filer_ethel_mc3: Device type: library Model: ATL In service: yes Debug mode: no Barcode reader: default (hardware-selected) Barcodes required: no Auto clean: no Clean interval: (not set) Clean using emptiest: no Unload required: yes UUID: 8249461c-585c-1027-85c6-000103e0a9fc Attachment 1: Host: filer_ethel Raw device: mc3 filer_ethel_nrst7a: Device type: tape Model: Quantum In service: yes Library: filer_ethel_mc3 DTE: 1 Automount: yes Error rate: 8 Query frequency: [undetermined] Debug mode: no Blocking factor: (default) Max blocking factor: (default) Current tape: 1 Use list: all Drive usage: none Cleaning required: no UUID: 82665aa4-585c-1027-85c6-000103e0a9fc Attachment 1: Host: filer_ethel Raw device: nrst7a filer_ethel_nrst8a: Device type: tape Model: Quantum In service: yes Library: filer_ethel_mc3 DTE: 2 Automount: yes Query frequency: [undetermined] Debug mode: no Blocking factor: (default) Max blocking factor: (default) Current tape: [unknown] Use list: all Drive usage: [not set] Cleaning required: [unknown] UUID: 82667cdc-585c-1027-85c6-000103e0a9fc Attachment 1: Host: filer_ethel Raw device: nrst8a
Use the lsds
command to list dataset file and dataset directory names.
See Also:
"Dataset Commands" for related commandsYou must have the display administrative domain's configuration right to use the lsds
command.
lsds [ --long/l | --short/-s ] [ --recursive/-r ] [ dataset-dir-name ]
Displays data in long form, which means that obtool labels the top-level directory. Refer to Example 2-58 for sample output. This option is the default.
Displays data in short form, which means that obtool does not label the top-level directory.
Recursively displays directories and dataset files under the specified directory.
Specifies the name of a dataset directory assigned with mkds or rends. Refer to "dataset-dir-name" for a descriptions of the dataset-dir-name
placeholder.
Example 2-58 Displaying the Contents of a Dataset Directory
This example changes into the root of the dataset directory tree, displays the path, and then displays the contents of the directory.
ob> cdds / ob> pwdds / (top level dataset directory) ob> lsds Top level dataset directory: mydatasets/ tbrset/ admin_domain.ds basicsummary.ds
Use the lsdup
command to list information about duplication policies.
See Also:
"Volume Duplication Commands"You must have the display administrative domain's configuration right to use the lsdup
command.
lsdup::=
lsdup [ --short/-s | --long/-l ] [ policyname ]...
Displays duplication policy information in short form.
Displays duplication policy information in long form.
Specifies the name of a duplication policy.
Use the lsdw
command to list duplication windows.
See Also:
"Duplication Window Commands" for related commandsYou must have the modify administrative domain's configuration right to use the lsdw
command.
lsdw [ --short/-s ] day-specifier[,day-specifier]...
Displays duplication window information in short form.
Use the lsfs
command to list file systems on an Network Attached Storage (NAS) device accessed through Network Data Management Protocol (NDMP).
You must have the right to query and display information about devices to use the lsfs
command.
lsfs [ --short/-s | --long/-l ] [ --noheader/-H ] [ --host/-h hostname[,hostname]... ] [ --logical/-L | --physical/-P ] [ filesystem-name ]...
Displays file-system data in short form.
Displays file-system data in long form.
Suppresses the display of headings.
Specifies the name of the host on which the file system resides.
Indicates that filesystem-name
is a logical volume name.
Indicates that filesystem-name
is a physical volume name.
Specifies the name of a file system that resides on the host.
Table 2-9 describes the output format of the lsfs
command.
Column | Indicates |
---|---|
File-system type |
File-system type |
File-system status |
File-system status; setting is |
Logical volume |
Operating system-defined disk volume or partition |
Total space |
Capacity of Logical Volume |
Used space |
Amount of disk space used |
Total inodes |
Number of inodes |
Used inodes |
Number of used inodes |
Example 2-59 Listing File Systems on an NDMP Host
Example 2-59 displays the file system on the NDMP-accessed host named br_filer.
ob> lshost br_filer client (via NDMP) in service brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service osbsvr1 admin,mediaserver,client (via OB) in service ob> lsfs --host br_filer --long /vol/vol0: File system type: WAFL File system status: online Total space: 104.5 GB Used space: 71.8 GB Available space: 32.7 GB Total inodes: 11,164,856 Used inodes: 4,846,130 ob> lsfs --host br_filer --short /vol/vol0 ob> lsfs --host br_filer FS Type FS Status Logical Volume Total Size Used Size % Full WAFL online /vol/vol0 104.5 GB 71.8 GB 68.7
Use the lshost
command to display the names and attributes of one or more configured hosts.
See Also:
"Host Commands" for related commandsYou must have the display administrative domain's configuration right to use the lshost
command.
lshost [ --long/-l | --short/-s ] [ --inservice/-o | --notinservice/-O ] [ --noroles/-R ] [ --roles/-r role[,role]... [ hostname ]...
Displays host data in long form, which means that obtool displays all attributes and labels them. By default obtool displays a subset of these attributes in tabular form.
Displays host data in short form, which means that obtool displays only the host names.
Lists hosts that are logically available to Oracle Secure Backup.
Lists hosts that are not logically available to Oracle Secure Backup.
Suppresses the display of role information.
Lists hosts having the specified roles. Refer to"role" for a description of the role
placeholder.
Specifies the name of the host computer for which to list data.
Table 2-10 describes the output of the lshost
command.
Label | Indicates |
---|---|
Access mode |
Setting is
|
IP names |
Indicates the IP address of the host computer |
Algorithm |
Indicates the encryption algorithm used |
Encryption policy |
Indicates whether encryption is required or allowed. If set to |
Rekey frequency |
Indicates how often a key is generated |
Key type |
Indicates how the encryption keys are generated |
In service |
Host is eligible for use; setting is |
Roles |
Type of role; setting is |
Trusted host |
Specifies whether this is a trusted host or not. See Oracle Secure Backup Installation and Configuration Guide for more information on trusted hosts. |
Any network |
Specifies whether Oracle Secure Backup daemons listen for and accept connections from any network interface; setting is |
Certificate key size |
Specifies the size (in bits) of the public key/private key pair used with the identity certificate for this host |
UUID |
Universal Unique Identifier; assigned by Oracle Secure Backup |
NDMP port |
Specifies the TCP port number used for NDMP on NDMP servers (see "port") |
NDMP user name |
Specifies the name used to authenticate Oracle Secure Backup to an NDMP server (see "username") |
NDMP password |
Specifies the password used to authenticate Oracle Secure Backup to an NDMP server (see "password") |
NDMP backup type |
Specifies a default backup type for an NDMP server (see "backuptype") |
NDMP protocol version |
Specifies an NDMP protocol version for an NDMP server (see "protocolversion") |
NDMP auth type |
Specifies the means by which the Oracle Secure Backup NDMP client authenticates itself to an NDMP server (see "authenticationtype") |
Example 2-60 Displaying Host Information
This example displays information in short form about all hosts and then displays information about brhost2
and br_filer
in long form.
ob> lshost brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service br_filer client (via NDMP) in service osbsvr1 admin,mediaserver,client (via OB) in service ob> lshost --long brhost2 br_filer brhost2: Access mode: OB IP names: 192.0.2.1 In service: yes Roles: client Any network: default UUID: 641fca34-fb32-1027-b11e-000cf1d9be50br_filer: Access mode: NDMP IP names: 192.0.2.250 NDMP port: (default) NDMP user name: (default) NDMP password: (set) NDMP backup type: (default) NDMP protocol version: (default) NDMP auth type: (default) In service: yes Roles: client Any network: default UUID: 1f80ef88-fb33-1027-b11e-000cf1d9be50
Use the lsjob
command to obtain the status of the following kinds of scheduled jobs:
Backup
Restore
Duplication
Scan control
Media movement
You can select which jobs to display by date, status, and the degree of detail to display. Each job is assigned an identifier consisting of the username of the logged in Oracle Secure Backup user, a slash, and a unique numeric identifier. An example of a job identifier is admin/15
.
The lsjob
command shows all active and pending jobs, with one line for each job, as shown below:
ob> lsj -A Job-ID Sched time Contents State admin/1 none dataset tbrset/entire_backup completed successfully at 2010/08/17.07:57 admin/1.1 none backup brhost2 completed successfully at 2010/08/17.07:57 admin/2 none restore 1 item to brhost2 completed successfully at 2010/08/17.07:58
See Also:
"Job Commands" for related commandsIf you are attempting to list another user's jobs, then you must have the right to list any job, regardless of its owner. If you are attempting to list your own jobs, then you must have the right to list any jobs owned by user.
lsjob [ --active/-a ][ --complete/-c ][ --pending/-p ] [ --inputrequest/-i ][ --all/-A ] [ { [ --from/-f date-time ] [ --to/-t date-time ] } | [ --today/-T ] ] [ --timescheduled/-e ][ --type/-Y job-type[,job-type]...]... [ --host/-h hostname ][ --dataset/-D dataset-name ] [ --piecename/-E piecename[,piecename]... ] [ --dbname/-d dbname[,dbname]... ][ --dbid/-I dbid[,dbid]... ] [ --system/-y | { --username/-u username } | --me/-m ] [ --superseded/-S ] [ --subjobs/-j | --primary/-P ] [ { --short/-s [ --oneperline/-1 ] } | --long/-l ] [ --noheader/-H ] [ --results/-r ] [ --progress/-o ] [ --requires/-R ] [ --times/-C ] [ --log/-L ] [ --catalog/-G ] job-id...
Use these options to select the jobs to be shown. If you specify no state-based options, then obtool displays only active and pending jobs. Multiple options are additive.
Use these options to filter jobs by status. Refer to Example 2-61 for an illustration.
Shows active jobs, that is, jobs that are currently being processed. By default the lsjob
command displays active and pending jobs.
Shows jobs that completed either successfully or unsuccessfully.
Shows pending jobs, that is, jobs that are not running and are scheduled to be processed in the future. By default the lsjob
command displays active and pending jobs.
Shows jobs currently requesting input. For example, a job might require input if you try to restore a backup from a multivolume volume set while using a standalone tape drive or if a volume required for a restore operation is not available in a tape library.
Shows jobs in all states.
Specifies the job ID of the scheduled backup and restore job whose status you want to obtain.
Use these options to filter jobs according to when their state was updated or when they were scheduled to run. Refer to Example 2-62 for an illustration.
Shows only jobs whose state was updated at date-time
or later. For example, show jobs that went from pending to active in the last day. Refer to "date-time" for the date-time
placeholder.
Shows only jobs whose state was updated at date-time
or before. For example, show jobs that went from pending to active before yesterday. Refer to "date-time" for the date-time
placeholder.
Shows only jobs whose state was updated today.
Uses scheduled time as a selection criteria instead of job modification time. Use either --today
or --from
to select the date-time
range. If you specify neither option, then no constraint is applied to the date-time
range.
Type/hostname/dataset-based job options
Use these options to filter jobs according to job type, host name, or dataset identifier. Refer to Example 2-63 for an illustration.
Shows only job entries of the specified type. By default obtool displays all types. Refer to "job-type" for the job-type
placeholder.
Shows only job entries related to the specified host.
Shows only job entries related to the specified dataset file. Run the lsds command to display dataset file information.
Note:
When the--dataset
and --host
options are both specified, the output of the lsjob
command is null. The reason is that lsjob
run with only --dataset
specified shows no host information, while lsjob
run with only --host
specified shows no dataset information.Use these options to filter jobs according to who initiated them. Refer to Example 2-64 for an illustration.
Shows jobs scheduled by Oracle Secure Backup.
Shows jobs belonging to username
. Run the lsuser command to display all Oracle Secure Backup users.
Shows jobs belonging to the currently logged in Oracle Secure Backup user. Run the id command to display the current Oracle Secure Backup user.
Use these options to filter jobs according to miscellaneous criteria. Refer to Example 2-65 for an illustration.
Shows jobs that were superseded before they were run.
A job is superseded when an identical job was scheduled after the initial job had a chance to run. For example, suppose you schedule an incremental backup scheduled every night at 9 p.m. On Wednesday morning you discover that the Tuesday night backup did not run because no tapes were available in the tape library. The incremental backup scheduled for Wednesday supersedes the backup from the previous night.
Shows subordinate jobs if the selected job has them (default). For example, lsjob --primary
shows sbt/25.1
, sbt/25.2
, and sbt/25.3
rather than just sbt/25
.
Shows only each primary job. For example, lsjob --primary
shows sbt/25
rather than sbt/25.1
, sbt/25.2
, and sbt/25.3
.
Use these options to control the display of job information. Refer to Example 2-66 for an illustration.
Shows only job IDs.
Shows job information in labeled rather than column format.
Does not display column headers.
Shows one job ID for each line when used with the --short
option.
Use these options to filter jobs based on how much content to include. Refer to Example 2-67 for an illustration.
Shows results for completed jobs when used with the --complete
option. For example, the results might look like the following:
saved 3.4 MB to VOL000003 (tag ADE202), file 12 ok: /home
See Also:
"--progress/-o"Shows the progress of active jobs when used with the --active
option. For example, the progress might look like the following:
processed 3.1Mb, 42 files
No progress information is displayed for completed jobs, because the --progress
option applies only to active jobs.
See Also:
"--results/-r"Shows resources required to run each job. For example, jobs that can run on any device display "requires any device."
Shows all relevant times for each job. For example, the job times might look like the following:
introduced 2008/03/21.16:59, earliest exec 03/23.00:00, last update 2008/03/21.16:59, expires never
Shows the log associated with each job. The log shows data such as when the job was created, which host it was dispatched on, when it completed, and so forth.
Shows extended information about catalog recovery backups. Oracle Secure Backup also checks for catalog backup failures and generates an e-mail to the administrator if any are found.
Table 2-11 describes the output of the lsjob
command.
Label | Indicates |
---|---|
Job ID |
Unique Oracle Secure Backup identifier assigned to a scheduled backup or restore job |
Type |
The type of job; setting is |
Level |
Identifies a backup level. The default level is 0. Refer to "backup-level" for more information. |
Family |
Identifies the media family to be used for the job. |
Encryption |
This field displays See Oracle Secure Backup Administrator's Guide for more information on backup encryption. |
Scheduled time |
Time job was scheduled to begin |
Contents |
Dataset that was used or host that was backed up |
State |
State of the job; setting is Note: The |
Priority |
Priority level of the job; |
Privileged op |
Whether job requires administrator privileges |
Run on host |
Host on which the job runs |
Attempts |
Number of times Oracle Secure Backup attempted to run the job |
Example 2-61 Filtering Jobs by State
This example shows jobs in completed state.
ob> lsjob --complete Job ID Sched time Contents State ---------- ----------- --------------------------------- ------------------------------------------ admin/1 none dataset tbrset/entire_backup completed successfully at 2007/06/13.10:11 admin/1.1 none backup brhost2 completed successfully at 2007/06/13.10:11 admin/2 none restore 1 item to brhost2 completed successfully at 2007/06/13.10:11 sbt/1 none database tstvw1 (dbid=1586108579) completed successfully at 2007/06/13.10:15 sbt/1.1 none archivelog backup completed successfully at 2007/06/13.10:15 sbt/2 none database tstvw1 (dbid=1586108579) completed successfully at 2007/06/13.10:16 sbt/2.1 none controlfile autobackup completed successfully at 2007/06/13.10:16 sbt/3 none database tstvw1 (dbid=1586108579) completed successfully at 2007/06/13.10:16 sbt/3.1 none datafile backup completed successfully at 2007/06/13.10:16 sbt/4 none database tstvw1 (dbid=1586108579) completed successfully at 2007/06/13.10:17 sbt/4.1 none restore piece '03ik5p7p_1_1' completed successfully at 2007/06/13.10:17
Example 2-62 Filtering Jobs by Time
This example shows jobs that are active and pending today only.
ob> lsjob --today Job ID Sched time Contents State ---------------- ----------- ------------------------------ ----------------------------------- 5 06/13.04:00 dataset datadir.ds processed; host backup(s) scheduled
Example 2-63 Filtering Jobs by Host
This example shows jobs in all states on host brhost2
.
ob> lsjob --all --short --oneperline --host brhost2 admin/1.1 admin/2
Example 2-64 Filtering Jobs by User
This example shows active and pending jobs for Oracle Secure Backup user sbt
.
ob> lsjob --user sbt Job ID Sched time Contents State ---------------- ----------- ------------------------------ --------------------- admin/13 06/23.00:00 dataset fullbackup.ds future work
Example 2-65 Showing Superseded Jobs
This example shows active and pending jobs that have been superseded.
ob> lsjob --superseded Job ID Sched time Contents State ---------------- ----------- ------------------------------ ---------------------- admin/13 06/23.00:00 dataset fullbackup.ds future work
Example 2-66 Displaying Job Data in Long Format
This example shows active and pending jobs in long format.
ob> lsjob --long 5: Type: datadir.ds Level: full Family: full Encryption: on Scheduled time: 06/13.04:00 State: processed; host backup(s) scheduled Priority: 5 Privileged op: no Run on host: (administrative server) Attempts: 1
Example 2-67 Displaying All Time-Related Data
This example shows all time-related data for active and pending jobs.
ob> lsjob --times Job ID Sched time Contents State ---------------- ----------- ------------------------------ ---------------------- 5 06/13.04:00 dataset datadir.ds processed; host backup(s) scheduled introduced 2007/06/13.13:37, earliest exec 06/13.04:00, last update 2007/06/13.13:37, expires 2007/07/13.04:00
Use the lsmf
command to display information about media families.
See Also:
"Media Family Commands" for related commandsYou must have the display administrative domain's configuration right to use the lsmf
command.
lsmf [ --long/-l | --short/-s ] [ media-family-name ]...
Displays data in long form. This option displays all media family attributes and labels them. By default the lsmf
command displays the name and type of each media family.
Displays data in short form. This option displays only media family names.
Specifies the name of the media family to list. If you do not specify a media-family-name
, then obtool displays all media families.
Table 2-12 shows the output for the lsmf
command.
Label | Indicates |
---|---|
Write window |
Indicates the length of time during which writing to a volume set is permitted |
Keep volume set |
Amount of time (added to the length of time for the Write Window) before Volume Set expires; default equals |
Appendable |
Indicates the volume is appendable; setting is |
Volume ID used |
Volume identifier; setting is either |
Comment |
Optional user-supplied description of this media family |
Example 2-68 Listing Media Family Information
Example 2-68 displays media family data in long format.
ob> lsmf --long RMAN-DEFAULT: Keep volume set: content manages reuse Appendable: yes Volume ID used: unique to this media family Comment: Default media family for RMAN backup jobs content-man-family: Write window: forever Keep volume set: content manages reuse Appendable: yes Volume ID used: unique to this media family full_bkup: Write window: 10 days Keep volume set: 28 days Appendable: yes Volume ID used: unique to this media family time-man-family: Write window: 7 days Keep volume set: 28 days Appendable: yes Volume ID used: unique to this media family
Use the lsloc
command to display information about every location in the administrative domain.
See Also:
"Location Commands" for related commandsYou must have the display administrative domain's configuration right to use the lsmf
command.
lsloc [ --short/-s | --long/-l ] location-name [ location-name ]...
Displays data in short form. This option displays only location names.
Displays data in long form.
Specifies the name of the location to list. If you do not specify a location-name
, then obtool displays all locations.
Use the lsp
command to list defaults and policies.
The policy data is represented as a directory tree with /
as the root. You can use cdp to navigate the tree and lsp
and pwdp to display data.
See Also:
"Policy Commands" for related commands
Appendix 6, "Defaults and Policies" for a complete list of policies and policy classes
You must have the display administrative domain's configuration right to use the lsp
command.
lsp [ --short/-s | --long/-l ] [ --dir/-d ] [ --fullname/-f ] [ --novalue/-V ]
[ --nodefault/-D | --defaultvalue/-v ] [ --type/-t ] [ policy-name ]...
Displays data in short form (default). This option displays the policy name and setting and indicates whether the setting is the default value.
Displays data in long form. This option is identical to --short
except that the output includes a brief description of each policy.
Displays the directory of the specified policy.
Display the full path names of the selected policies.
Suppresses the display of policy values.
Suppresses the display of default values of the selected policies.
Displays the default values of the selected policies.
Displays policies by type.
Specifies the name of the policy to display.
Example 2-69 Listing Log Policies
This example displays the full path name of log policies and suppresses the display of the policy defaults.
ob> pwdp / ob> lsp --nodefault --fullname --long logs /logs/adminlogevents (none) Names of events that are logged in the administrative server activity log. /logs/adminlogfile (none) Pathname of the administrative server activity log. /logs/clientlogevents (none) Names of events that are logged in each client's local log file. /logs/jobretaintime 30 days Duration for which scheduler job database records are retained. /logs/logretaintime 7 days Duration for which Oracle Secure Backup daemon log entries are retained. /logs/transcriptretaintime 7 days Duration for which backup transcripts are retained. /logs/unixclientlogfile (none) Pathname of the local activity log file for all UNIX clients. /logs/windowsclientlogfile (none) Pathname of the local activity log file for all Windows clients.
Example 2-70 Listing Policies by Type
This example displays the policies in the class daemons
.
ob> pwd / ob> lsp --type daemons auditlogins no [default] yes-no obixdmaxupdaters 2 [default] uint min 1 obixdrechecklevel structure [default] enum none structure content obixdupdaternicevalue 0 [default] int webautostart yes yes-no webpass (set) text windowscontrolcertificateservice no [default] yes-no
Use the lspiece
command to display information about Recovery Manager (RMAN) backup pieces. Backup pieces are the physical members of backup sets. One RMAN backup piece corresponds to one Oracle Secure Backup backup image. Oracle Secure Backup stores and reports Oracle Database metadata about the contents of each backup piece.
Because the backup pieces might be available on different duplicate volumes as well, the lspiece
command shows which volumes are at the active location or nearest storage location.
See Also:
"Backup Piece Commands" for related commandsYou must have the right to query and display information about devices to use the lspiece
command.
lspiece [ --long/-l | --short/-s ] [ --noheader/-H ] [ --section/-S ] [ --oid/-o oid-list ]... [ --host/-h hostname[,hostname]... ] [ --dbname/-d dbname[,dbname]... ] [ --dbid/-i dbid[,dbid]... ] [ --content/-c content[,content]... ] [ { --vid/-v vid_list | --void/-V oid_list } ] [ piecename ]...
Displays data in long form.
Displays data in short form.
Does not display header row.
Lists the volume ID and backup sections used by the backup pieces. This information is only shown for the --section
option and is not shown for the --long
option.
Specifies one or more backup piece object identifiers. Refer to "oid-list" for a description of the oid-list
placeholder.
Specifies the name of the host computer to which the listing applies.
Specifies the names of the databases whose backup pieces you want to list.
Specifies the DBIDs of the databases whose backup pieces you want to list.
Specifies the types of backup information contained by the backup piece. Refer to "content" for a description of the content
placeholder.
Specifies that only backup pieces contained on the volumes specified in vid_list or oid_list are displayed, possibly further restricted by other selection criteria options.
Specifies the names of the backup pieces to which the listing applies.
Table 2-13 describes the output of the lspiece
command.
Label | Indicates |
---|---|
Backup piece OID |
The backup piece object identifier |
Database |
The name of the database that was backed up |
Database ID |
The DBID of the database that was backed up |
Content |
The content of the backup (see "content") |
Copy number |
The backup piece copy number |
Created |
The creation date of the backup piece |
Host |
The database host |
Piece name |
The name of the backup piece |
Encryption |
Encryption enabled or disabled (see "--encryption/-e {yes | no | forcedoff | transient}") |
Algorithm |
The encryption algorithm used (see "--algorithm/-L") |
If a date reported by lspiece
is more than six months earlier, then it is reported in a yyyy/mm/dd
format. If a date is less than six months earlier, then it is reported in a mm/dd.hh:mm
format.
The following example shows the output of an lspiece
--long
command:
ob> lspiece -l Backup piece OID: 104 Database: bugfix Database ID: 1586108579 Content: full Copy number: 0 Created: 2009/01/14.16:34 Host: sales-server Piece name: 05k4q4km_1_1 Encryption: on Algorithm: aes128 Backup piece OID: 107 Database: bugfix Database ID: 1586108579 Content: full Copy number: 0 Created: 2009/01/14.16:48 Host: sales-server Piece name: 08k4q5dj_1_1 Encryption: RMAN Backup piece OID: 108 Database: bugfix Database ID: 1586108579 Content: full Copy number: 0 Created: 2009/01/14.16:52 Host: sales-server Piece name: 09k4q5me_1_1 Encryption: forcedoff Backup piece OID: 109 Database: bugfix Database ID: 1586108579 Content: full Copy number: 0 Created: 2009/01/14.16:55 Host: sales-server Piece name: 0ak4q5rm_1_1 Encryption: hardware Algorithm: aes256
Use the lspni
command to list PNI (Preferred Network Interface) definitions.
See Also:
"Preferred Network Interface Commands" for related commandsYou must have the display administrative domain's configuration right to use the lspni
command.
lspni [ server-hostname ]...
Specifies the name of the server whose network interfaces are to be listed. If you do not specify a host name, then obtool displays all hosts that have a PNI created with the mkpni command.
Table 2-14 describes the output for the lspni
command.
Column | Indicates |
---|---|
PNI # |
Sequential number, starting at |
interface |
IP address of the interface |
clients |
Names of clients using the interface |
Use the lsrestore
command to list restore requests. These requests are awaiting delivery to the scheduler.
See Also:
"Restore Commands" for related commandsIf you specified that the restore run in privileged mode, or if you are restoring files to a host accessed through Network Data Management Protocol (NDMP), then you must have the right to perform file system restores as privileged user to use the restore
command. Otherwise, you must have the right to perform file system restores as self.
lsrestore [ --long/-l | --detail/-d | { --short/-s [ --oneperline/-1 ] } ]
[ --position/-x ] [ --noheader/-H ] [ --raw/-R ] [ --catalog/-C ]
[ --listrestorerequests ] [ restore-item ]...
Displays restore request data in long form.
Displays detailed data about the backup to be used in the restore.
Displays restore request data in short form. This item is the default.
Shows one item for each line when used with the --short
option.
Displays the position of the backup on tape when used with the --detail
option.
Displays data without column headings.
Displays only raw restore requests, that is, restore requests that do not make use of the Oracle Secure Backup catalog. By default lsrestore
lists all restore requests.
Displays only restore requests that use the Oracle Secure Backup catalog. If you specify --catalog
, then lsrestore
does not display raw restore requests. By default lsrestore
lists all restore requests.
Lists volumes to be recalled.
Specifies the item number of a restore request. You can display the item numbers for restore requests by running lsrestore
without any options.
Table 2-15 describes the output for the lsrestore
command.
Column | Indicates |
---|---|
Item # |
Sequential number, starting at 1, assigned to the restore job |
Data saved from |
Host and path of data that was backed up |
Restore data to |
Host and path of data to be restored |
Host |
Name of host the data is originally from or to which the host is restoring |
Path |
Operating system location of data on the file system |
Priority |
Priority of restore job |
Created |
Creation date of volume set |
File number |
File number of backup to be restored |
Device |
Name of device to be used for restore operation |
Backup ID |
Backup ID for backup to be restored |
Volume ID |
Volume ID for volume to be used in restore operation |
Volume tag |
Barcode for volume to be used in restore operation |
File section |
Backup section to be restored |
Position |
Position of backup data on tape |
Example 2-72 Listing Restore Requests
Example 2-72 lists all restore requests in long format.
ob> lsrestore --long 1: Data saved from: Host: brhost2 Path: /data/backup Restore data to: Host: brhost3 Path: /tmp Priority: 100 Created: 2008/12/02.12:37:07 File number: 1 Device: tape1 Backup ID: 1 Volume ID: VOL000003 Volume tag: ADE203 File section: 1 Position: 000000000009
Use the lsrot
command to list information about rotation policies.
See Also:
"Rotation Policy Commands"You must have the display administrative domain's configuration right to use the lsrot
command.
lsrot::=
lsrot [ --short/-s | --long/-l ] policyname [ policyname... ]
Displays policy information in short form.
Displays policy information in long form.
Specifies the name of a rotation policy, which must be 1-31 characters.
Use the lsrpt
command to list media management reports.
See Also:
"Reports Commands"You must have the display administrative domain's configuration right to use the lsrpt
command.
lsrpt [ --short/-s | --long/-l ] [ --type/-t reporttype [,reporttype...] ] job-id ...
Specifies short form listing.
Specifies long form listing.
Specifies one or more types of report to be displayed. Valid types are distribution
and pick
.
Specifies the identifiers of jobs whose reports are to be listed.
Use the lssched
command to display information about backup, vaulting scan, and duplication scan schedules.
See Also:
"Schedule Commands" for related commandsYou must have the display administrative domain's configuration right to use the lssched
command.
lssched [ --short/-s | --long/-l ] [ --calendar/-c year/month [ --trigger trigger-number[,trigger-number]... ] ] [ --type/-Y schedule-type[,schedule-type...] ] [ schedulename ]...
Displays schedule data in short form.
Displays schedule data in long form.
Restricts display to schedule information in the given month and year.
Displays backup schedule information by trigger number. A trigger is a user-defined period in time or sets of times that causes a scheduled backup to run.
Specifies the type of schedule to be listed. Valid values are backup
, duplicationscan
, and vaultingscan
. Multiple schedule types can be specified.
Specifies the name of the schedule to display.
Table 2-16 describes the output of the lssched
command.
Column | Indicates |
---|---|
Schedule name |
User-supplied name identifying the schedule |
Type |
The schedule type: |
Dataset |
Dataset files used |
Restrict |
Device restrictions |
Priority |
Priority level of the schedule; set a number greater than |
Encryption |
Identifies encrypted backups. See Oracle Secure Backup Administrator's Guide for more information on backup encryption. |
Comment |
User-supplied comment |
Trigger # |
Instance number of this schedule |
Day/date |
Scheduled date for the job |
At |
Scheduled time for the job |
Backup level |
Level of backup to be performed; setting is |
Media family |
Media family to use |
Expires after |
When this trigger expires |
If a date is more than 6 months earlier or more than 2 months in the future, then it is reported in a yyyy/mm/dd
format. If a date is less than 6 months earlier or less than 2 months in the future, then it is reported in a mm/dd.hh:mm
format.
Example 2-73 Displaying Backup
This example displays information about backup schedules lev2
, level3
, and level3-writewindow
.
ob> lssched --long OSB-CATALOG-SCHED: Type: backup Dataset: OSB-CATALOG-DS Priority: 50 Encryption: no Comment: catalog backup schedule full_backup: Type: backup Dataset: datadir.ds Priority: 5 Encryption: yes Trigger 1: Day/date: thursdays At: 21:00 Backup level: full Media family: (null) Trigger 2: Day/date: weekdays At: 04:00 Backup level: full Media family: full Expires after: 30 days
Use the lssection
command to list backup sections matching the criteria specified on the command line. A backup section is the portion of a backup image that occupies one physical volume. Oracle Secure Backup obtains backup section data from the backup sections catalog.
Because the backup sections might be available on different duplicate volumes as well, the lssection
command shows which volumes are at the active location or nearest storage location.
See Also:
"Section Commands" for related commandsYou must have the right to query and display information about devices to use the lssection
command.
lssection [ --long/-l | --short/-s ] [ --noheader/-H ] [ --incomplete/-i ] [ --oid/-o oid-list ]... [ { { --vid/-v vid-list } | { --void/-V oid-list } } [ --file/-f filenumber-list ]... ]
Displays section data in long form.
Displays only the object ID of each backup section record selected.
Displays data without column headings.
Displays section information even if the related volume data is missing from the backup sections catalog.
Selects backup sections with the object identifiers matching those in oid-list
. Refer to "oid-list" for a description of the oid-list
placeholder.
Selects backup sections contained on the volumes whose IDs are supplied in vid-list
. A vid-list
is one or more vid
values separated by commas. Refer to"vid" for a description of the vid
placeholder.
Selects backup sections contained on the volumes whose volume object identifiers are supplied in the list. The void-list
placeholder represents an oid-list
of volume IDs. Refer to "oid-list" for a description of the oid-list
placeholder.
Selects only those backup sections having the file numbers specified the list. Refer to "filenumber-list" for a description of the filenumber-list
placeholder.
Table 2-17 describes the output of the lssection
command.
Column | Indicates |
---|---|
Backup section OID # |
Catalog identifier for the backup section |
Containing volume |
Volume identifier of the tape media where the backup section resides |
Containing volume OID |
Catalog identifier for the volume |
File |
File number; identifies which numbered backup the section occupies on a tape containing multiple backups |
Section |
For a backup that spans multiple tapes; identifies which tape this is in the sequence |
Backup level |
Level of backup to be performed; setting is |
Client |
Name of Oracle Secure Backup client being backed up |
Size |
Size of the backup section |
Created |
Date and time the backup section was created |
Attributes |
Information about the volume expiration |
Encryption |
This field displays See Oracle Secure Backup Administrator's Guide for more information on backup encryption. |
If a date reported by lssection
is more than six months earlier, then it is reported in a yyyy/mm/dd
format. If a date is less than six months earlier, then it is reported in a mm/dd.hh:mm
format.
Example 2-74 Listing Backup Sections
This example displays the object identifiers of all backup sections in the backup sections catalog. The lssection
command then displays data for section 108 in the default standard format to determine which volume it is on. The command then displays all backup sections on this volume in long format.
ob> lssection --short BSOID 100 105 106 107 108 ob> lssection --oid 108 BSOID Volume File Sect Level Client Created Attributes 108 VOL000002 2 1 0 brhost2 04/19.11:52 never expires ob> lssection --vid VOL000002 --long Backup section OID: 105 Containing volume: VOL000002 Containing volume OID: 111 File: 1 Section: 1 Backup level: 0 Client: brhost2 Size: 62.4 MB Created: 2008/04/19.11:36 Attributes: never expires Backup section OID: 108 Containing volume: VOL000002 Containing volume OID: 111 File: 2 Section: 1 Backup level: 0 Client: brhost2 Size: 65.3 MB Created: 2008/04/19.11:52 Attributes: never expires
Use the lssnap
command to list snapshots on Network Data Management Protocol (NDMP) hosts.
See Also:
"Snapshot Commands" for related commandsYou must have the right to query and display information about devices to use the lssnap
command.
lssnap [ --short/-s | --long/-l ] [ --noheader/-H ] [ --reserve/-r ] [ --host/-h hostname[,hostname]... ] [ --fs/-f filesystem-name[,filesystem-name]... ] [ --numberformat/-n numberformat ] [ snapshot-name ]...
Displays snapshot data in short form. This option is the default.
Displays snapshot data in long form.
Suppresses columns headers when listing data.
Displays the reserved space.
Specifies the NDMP host. If you do not specify a host name, then Oracle Secure Backup uses the value from the host variable.
Specifies the file system of which the snapshot was taken.
Specifies the format in which to display large numbers. Refer to "numberformat" for a description of the numberformat
placeholder.
Specifies the name of the snapshot to list.
Table 2-18 describes the output of the lssnap
command.
Label | Indicates |
---|---|
File system |
File system captured in the snapshot |
Max snapshots |
Maximum number of snapshots permitted on this volume |
Reserved space |
Total reserved space for all snapshots |
% reserved space |
Percentage of reserved space currently used by all snapshots |
Snapshot |
Name of the snapshot |
Of |
Name of the file system |
Taken at |
Date and time of the snapshot |
Used % |
Space consumed by this snapshot as a percentage of reserved disk space being used on the volume. This value is calculated by: snapshot size x 100% / reserved space. |
Total % |
Space consumed by this snapshot as a percentage of total disk space on the volume. This value is calculated by: snapshot size x 100% / total disk space in this volume. |
Busy |
Whether the snapshot is busy; values are |
Dependency |
Whether the snapshot has a dependency on another processing entity (such as snapmirror); values are |
If a date reported by lssnap
is more than six months earlier, then it is reported in a yyyy/mm/dd
format. If a date is less than six months earlier, then it is reported in a mm/dd.hh:mm
format.
Example 2-75 Displaying Snapshots
This example displays snapshots on the NDMP-accessed host br_filer
. In this example, the lucy.0
snapshot has used 3% of the space allocated to snapshots on /vol/vol0
(3% of 44.8 GB) and 1% of the total disk space for the volume /vol/vol0
(1% of 104 GB).
ob> lssnap --long --host br_filer File system /vol/vol0: Max snapshots: 255 Reserved space: 44.8 GB % reserved space: 30 Snapshot: lucy.0 Of: /vol/vol0 Taken at: 2008/03/28.20:52 Used %: 3 Total %: 1 Busy: no Dependency: no Snapshot: myhost_snap1 Of: /vol/vol0 Taken at: 2004/08/21.11:30 Used %: 12 Total %: 7 Busy: no Dependency: no
Use the lsssel
command to display a database backup storage selector.
See Also:
"Database Backup Storage Selector Commands" for related commandsYou must have the display administrative domain's configuration right to use the lsssel
command.
lsssel [ --long/-l | --short/-s ] [ --dbname/-d { * | dbname[,dbname]... } ] [ --dbid/-i { * | dbid[,dbid]... } ] [ --host/-h { * | hostname[,hostname]... } ] [ --content/-c { * | content[,content]... } ] [ --copynum/-n { 1 | 2 | 3 | 4 } ] sselname...
Displays all attributes of all storage selectors.
Displays only the names of the selected storage selectors.
Lists storage selectors applicable to the specified database names.
Lists storage selectors applicable to the specified database ID (DBID).
Lists storage selectors applicable to the specified host names.
Lists storage selectors applicable to the specified content types. Refer to "content" for a description of the content
placeholder.
Lists storage selectors applicable to the specified copy number.
Specifies the names of one or more storage selectors to display. This list is filtered by the other selection criteria (if any).
Table 2-19 describes the output of the lsssel
command.
Label | Indicates |
---|---|
Content |
The content types of backups to which this storage selector applies (see "content") |
Databases |
The names of the databases to which this storage selector applies |
Database ID |
The DBIDs of the databases to which this storage selector applies |
Host |
The database hosts to which this storage selector applies |
Restrictions |
The names of devices to which backups controlled by this storage selector are restricted. |
Copy number |
The copy number to which this storage selector applies |
Media family |
The name of the media family to be used for backups under the control of this storage selector object |
Resource wait time |
How long to wait for the availability of resources required by backups under the control of this storage selector |
UUID |
The universal identifier of the storage selector |
Example 2-76 Displaying a Database Backup Storage Selector
This example creates a storage selector and then displays information about it.
ob> mkssel --dbid 1557615826 --host brhost2 --content full --family f1 ssel_full ob> lsssel --long ssel_full: Content: full Databases: [all] Database ID: 1557615826 Host: brhost2 Restrictions: [none] Copy number: [any] Media family: f1 Resource wait time: 1 hour UUID: b5774d9e-92d2-1027-bc96-000cf1d9be50
Use the lssum
command to display every job summary schedule.
See Also:
"Summary Commands" for related commandsYou must have the display administrative domain's configuration right to use the lssum
command.
lssum [ --long/-l | --short/-s ] [ summary-name ]...
Displays job summary schedule data in long form.
Displays the job summary name. By default lssum
displays the summary name and the date and time at which the report should be generated.
Specifies the name of the job schedule summary to list.
Table 2-20 describes the output of the lssum
command.
Column | Indicates |
---|---|
Produce on |
Date and time to generate the report |
Mail to |
E-mail address to which to send reports |
Limit report to hosts |
Hosts to which the job summary is limited |
Backup jobs |
Inclusion of information about backup jobs; setting is |
Restore jobs |
Inclusion of information about restore jobs; setting is |
Oracle backup jobs |
Inclusion of information about Recovery Manager (RMAN) backup jobs; setting is |
Oracle restore jobs |
Inclusion of information about RMAN restore jobs; setting is |
Scheduled jobs |
Inclusion of information about scheduled jobs; setting is |
User jobs |
Inclusion of information about user jobs; setting is |
Subordinate jobs |
Inclusion of information about subordinate jobs; setting is |
Superseded jobs |
Inclusion of information about superseded jobs; setting is |
If a date reported by lsbackup
is more than two months in the future, then it is reported in a yyyy/mm/dd
format. If a date is less than two months in the future, then it is reported in a mm/dd.hh:mm
format.
Example 2-77 Displaying Job Summary Schedules
This example displays information about the job summary schedule named weekly_report
.
ob> lssum --long weekly_report: Produce on: Wed at 12:00 Mail to: lance@example.com In the report, include: Backup jobs: yes Restore jobs: yes Oracle backup jobs: yes Oracle restore jobs: yes Scheduled jobs: yes User jobs: yes Subordinate jobs: yes Superseded jobs: no
Use the lsuser
command to display the names and attributes of one or more Oracle Secure Backup users.
See Also:
"User Commands" for related commandsIf you must list any Oracle Secure Backup user, then you must have the display administrative domain's configuration right. If you are only interested in listing yourself, then you must have the right to modify own name and password.
lsuser [ --long/-l | --short/-s ] [ --class/-c userclass ] [ --unixname/-U unix-user ] [ --unixgroup/-G unix-group ] [ --domain/-d windows-domain ] [ --ndmpuser/-N ] [ --email/-e emailaddr ] [ --givenname/-g givenname ] [ username... ]
Displays data in long form.
Displays data in short form.
Displays Oracle Secure Backup users belonging to a specific class.
Displays Oracle Secure Backup users and associated classes by UNIX name.
Displays Oracle Secure Backup users and associated classes by UNIX group.
Displays Oracle Secure Backup users and associated classes by the Windows domain name.
Displays Oracle Secure Backup users that have access to Network Data Management Protocol (NDMP) servers.
Displays Oracle Secure Backup users and their associated classes by their email addresses.
Displays Oracle Secure Backup users with the given name givenname
.
Specifies the name of the Oracle Secure Backup user whose information you want to display.
Table 2-21 describes the output of the lsuser
command.
Column | Indicates |
---|---|
Password |
User password; setting is |
User class |
Name of the user class |
Given name |
Oracle Secure Backup name |
UNIX name |
|
UNIX group |
|
Windows domain/acct |
Domain or account name, if applicable |
NDMP server user |
Setting is |
Email address |
E-mail address of the user |
UUID |
Universal Unique Identifier (UUID) for the user |
Hostname |
Another computer for which the user is preauthorized to access |
Username |
User name of the user on another computer for which the user is preauthorized to access |
Windows domain |
Domain information, if applicable, on another computer for which the user is preauthorized to access |
RMAN enabled |
Recovery Manager (RMAN) availability on another computer for which the user is preauthorized to access; setting is |
Cmdline enabled |
Command line availability on another computer for which the user is preauthorized to access; setting is |
Example 2-78 Displaying Oracle Secure Backup User Information
This example displays information about Oracle Secure Backup user bkpadmin
.
ob> lsuser admin admin bkpadmin oracle sbt admin ob> lsuser --long bkpadmin bkpadmin: Password: (set) User class: oracle Given name: lance UNIX name: bkpadmin UNIX group: dba Windows domain/acct: [none] NDMP server user: no Email address: bkpadmin@example.com UUID: 5f437cd2-7a49-1027-8e8a-000cf1d9be50 Preauthorized access: Hostname: osbsvr1 Username: bkpadmin Windows domain: [all] RMAN enabled: yes Cmdline enabled: yes
Use the lsvol
command to list the volumes in a tape library or the volumes catalog.
Duplicate volumes are grouped with their original volume by default. The lsvol
command shows the original volume oid
for each duplicate volume.
Oracle Secure Backup uses the following Small Computer System Interface (SCSI) terms to describe basic components of libraries:
A storage element, identified in the lsvol
output as a number, contains a volume when it is not in use.
An import-export element, identified in the lsvol
output with the prefix iee
, is used to move volumes into and out of the tape library without opening the door (thus requiring a full physical inventory). It is sometimes called a mail slot and is physically present only on certain libraries.
A medium transport element, identified in the lsvol
output as mte
, moves a volume from a storage element to another element, such as a tape drive.
A data transfer element (DTE), identified in the lsvol
output as dte
, is a tape drive.
Each element has a name that you and Oracle Secure Backup use to identify it. For example, the first storage element is usually named se1
and the first tape drive is dte1
. You can omit the se
prefix when referring to storage elements; you can refer to the tape drive in libraries (when libraries contain only one tape drive) as dte
.
See Also:
"Library Commands" for related commandsYou must have the right to query and display information about devices to use the lsvol
command.
Use the following syntax to list the volumes (inventory) in a tape library.
lsvol [ --library/-L libraryname | --drive/-D drivename ] [ --long/-l ]
Specifies the name of the tape library holding the volumes to be listed.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Specifies the name of a tape drive in the tape library holding the volumes to be listed.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Displays volume information in long format. If you specify lsvol --long
with no other options, then the command displays an inventory of the dte
, mte
, and storage elements of the tape library. If you specify --long
for particular volumes, then the command displays the OID, volume ID, barcode, volume sequence, and so forth.
Use the following syntax to list the volumes in the volumes catalog.
lsvol [ --short/-s | --long/-l ] [ --relation/-r ] [ --members/-m ] [ --duplicates/-d ][ --noheader/-H ] [ --contents/-c ] { --all/-a | { [ --vid/-v vid[,vid]... ] [ --barcode/-b tag[,tag]... ] [ --vset/-V vsetid[,vsetid]... ] [ [ --dset/-D dsetid[,dsetid]...] [ --family/-f media-family-name[,media-family-name]... ] [ --location/-C location-name[,location-name]... ] [ --attribute/-A volume-attr[,volume-attr]... ] [ --oid/-o oid[,oid]... ] }... [ --novid/-n | --nobarcode/-N ] }
Displays volume information in short format. The command displays only the volume ID for each volume.
Displays volume information in long format.
Groups volumes according to the other options specified. For example, if you specify the --family
option, then obtool sorts according to volumes belonging to the specified media family.
Displays all volume set members for each volume displayed. This option is the default.
List the duplicates for the volume in addition to the volume itself.
Displays information without header output.
Displays information about the contents of each volume.
Specifying this option displays the size of the backup section, as shown in Example 2-80.
Displays all volumes in the volumes catalog.
Displays the volume having the volume ID vid
. Refer to "vid" for a description of the vid
placeholder.
Displays the volume with the barcode tag
.
Displays volumes that are members of the volume set vsetid
. The vsetid
represents the vid
of the first volume in the volume set. Refer to "vid" for a description of the vid
placeholder.
List all duplicates in the duplicate set. The duplicate set ID is the original volume vid
.
Displays all volumes of the specified media family. The media-family-name
placeholder represents the name of a media family assigned with the mkmf or renmf command.
Limits the display to volumes in one or more specified locations.
Displays all volumes with the attribute volume-attr.
Valid values for this placeholder are:
expired
All expired volumes
unexpired
All unexpired volumes
open
All volumes open for writing
closed
All volumes closed for writing
Displays volumes with the specified oid
. Refer to "oid" for a description of the oid
placeholder.
Displays volumes with no volume ID.
Displays volumes with no barcode.
Table 2-22 describes the output of the lsvol
command.
Column | Indicates |
---|---|
VOID |
Oracle Secure Backup catalog identifier for the volume |
OOID |
The Oracle Secure Backup catalog identifier for the original (parent) of a duplicate volume. It is identical to VOID for a volume that is not a duplicate. |
Barcode |
Barcode label identifier affixed to the tape case |
Volume sequence |
Number of the tape in the volume set |
Media family |
Oracle Secure Backup media family name |
Current location |
The place the tape current resides |
Label host |
The media server that labeled the tape originally |
Size |
The size of the backup section |
Created |
Date the volume was first written to. |
Closes |
Last time the tape can be written to |
Expires |
Date the tape expires and can be overwritten or recycled with doing a force unlabel |
Space remaining |
Storage capacity remaining on tape |
If a date reported by lsvol
is more than six months earlier or more than two months in the future, then it is reported in a yyyy/mm/dd
format. If a date is less than six months earlier or less than two months in the future, then it is reported in a mm/dd.hh:mm
format.
Note:
Oracle Secure Backup assigns each backup ID without regard to the time order of backups. For example, backup ID 25 can represent a Monday backup whereas backup ID 6 represents a backup on the following day.Example 2-79 Displaying the Volumes in a Library
This example displays the volumes in tape library lib1
. Note that the sample output has been reformatted to fit on the page.
ob> lsvol --long --library lib1 Inventory of library lib1: in mte: vacant in 1: volume VOL000002, barcode ADE201, oid 110, 16962752 kb remaining in 2: volume VOL000001, barcode ADE203, oid 102, 17619328 kb remaining in 3: vacant in 4: vacant in iee1: vacant in iee2: vacant in iee3: vacant in dte: volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 17017984 kb remaining, content manages reuse, lastse 3
Example 2-80 Displaying the Contents of a Volume
This example displays the contents of volume OSB-CATALOG-MF-000325
. Note that the sample output has been reformatted to fit on the page.
ob> lsvol --contents --vid OSB-CATALOG-MF-000325 VOID OOID Seq Volume ID Barcode Family Created 231 231 1 OSB-CATALOG-MF-000325 NEDC2491 OSB-CATALOG-MF 10/07.21:03 Attributes BSOID File Sect Level Host Size Created never closes 532 1 1 0 osbsvr3 62.4 MB 10/07.21:03 Attributes
Use the mkclass
command to define an Oracle Secure Backup user class.
Oracle Secure Backup predefines several classes, which are described in Appendix 7, "Classes and Rights".
See Also:
"Class Commands" for related commandsYou must have the modify administrative domain's configuration right to use the mkclass
command.
mkclass [ --modself/-m { yes | no } ] [ --modconfig/-M { yes | no } ] [ --backupself/-k { yes | no } ] [ --backuppriv/-K { yes | no } ] [ --restself/-r { yes | no } ] [ --restpriv/-R { yes | no } ] [ --listownjobs/-j { yes | no } ] [ --modownjobs/-J { yes | no } ] [ --listanyjob/-y { yes | no } ] [ --modanyjob/-Y { yes | no } ] [ --mailinput/-i { yes | no } ] [ --mailerrors/-e { yes | no } ] [ --mailrekey/-g { yes | no } ] [ --querydevs/-q { yes | no } ] [ --managedevs/-d { yes | no } ] [ --listconfig/-L { yes | no } ] [ --browse/-b browserights ] [ --orauser/-o { yes | no } ] [ --orarights/-O oraclerights ] classname...
The default for all mkclass
options that require a yes
or no
value is no
.
Specifies whether e-mails are sent out to the administrative class when a rekey occurs, encounters errors, or has expired keys.
Enables Oracle Secure Backup users to modify their own password and given name.
Enables Oracle Secure Backup users to modify (create, modify, rename, and remove) all objects in an Oracle Secure Backup administrative domain. These modifiable objects include objects representing classes, users, hosts, devices, defaults, and policies.
Enables Oracle Secure Backup users to run backups under their own user identity.
Enables Oracle Secure Backup users to run backups as the root or privileged user.
Enables Oracle Secure Backup users to restore the contents of backup images under the restrictions of the access rights imposed by the user's UNIX name/group or Windows domain/account.
Enables Oracle Secure Backup users to restore the contents of backup images as a privileged user. On Linux and UNIX hosts, a privileged restore operation runs under the root
operating system identity. For example, Oracle Secure Backup user joeblogg runs under operating system account root
. On Windows systems, the restore operations runs under the same account as the Oracle Secure Backup service on the Windows client.
Grants Oracle Secure Backup users the right to view the following:
Status of scheduled, ongoing, and completed jobs that they configured
Transcripts for jobs that they configured
Grants Oracle Secure Backup users the right to modify only jobs that they configured.
Grants Oracle Secure Backup users the right to view the following:
Status of any scheduled, ongoing, and completed jobs
Transcripts for any job
Grants Oracle Secure Backup users the right to make changes to all jobs.
Enables Oracle Secure Backup users to receive email when Oracle Secure Backup needs manual intervention. Occasionally, during backup and restore operations, manual intervention of an operator is required. This situation can occur if a required volume cannot be found or a volume is required to continue a backup. In such cases, Oracle Secure Backup sends e-mail to all Oracle Secure Backup users who belong to classes having this right.
Enables Oracle Secure Backup users to receive email messages describing errors that occur during Oracle Secure Backup activity.
Enables Oracle Secure Backup users to query the state of devices.
Enables Oracle Secure Backup users to control the state of devices with the obtool command.
Enables Oracle Secure Backup users to list objects, for example, hosts, devices, and users, in the administrative domain.
Grants Oracle Secure Backup users browsing rights. Specify one of the following browserights
values, which are listed in order of decreasing privilege:
privileged
means that Oracle Secure Backup users can browse all directories and catalog entries.
notdenied
means that Oracle Secure Backup users can browse any catalog entries for which they are not explicitly denied access. This option differs from permitted
in that it allows access to directories having no stat record stored in the catalog.
permitted
means that Oracle Secure Backup users are bound by normal UNIX permissions checking (default). Specifically, Oracle Secure Backup users can only browse directories if at least one of the following conditions is applicable:
The UNIX user defined in the Oracle Secure Backup identity is listed as the owner of the directory, and the owner has read rights.
The UNIX group defined in the Oracle Secure Backup identity is listed as the group of the directory, and the group has read rights.
Neither of the preceding conditions is met, but the UNIX user defined in the Oracle Secure Backup identity has read rights for the directory.
named
means that Oracle Secure Backup users are bound by normal UNIX rights checking, except that others do not have read rights. Specifically, Oracle Secure Backup users can only browse directories if at least one of the following conditions is applicable:
The UNIX user defined in the Oracle Secure Backup identity is listed as the owner of the directory, and the owner has read rights.
The UNIX group defined in the Oracle Secure Backup identity is listed as the group of the directory, and the group has read rights.
none
means that no Oracle Secure Backup user has any rights to browse any directory or catalog.
Enables Oracle Secure Backup users to perform Oracle Database backup and restore operations (yes
or no
). This right enables Oracle Secure Backup users to perform any SBT operation, regardless of what other rights they have. For example, an Oracle Secure Backup user with this right can perform SBT restore operations even if the perform
restores
as
self
right is set to no
.
Enables Oracle Secure Backup users with the specified rights to access Oracle Database backups. The oraclerights
placeholders can be any of the following values:
class
means that Oracle Secure Backup users can access SBT backups created by any Oracle Secure Backup user in the same class.
all
means that Oracle Secure Backup users can access all SBT backups.
none
means that no Oracle Secure Backup user has any rights to access SBT backups.
owner
means that Oracle Secure Backup users can access only those SBT backups that they themselves have created (default).
Specifies the name of the class to be created. Class names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.
This example creates a class called backup_admin
. The command accepts the default value of no
for --listownjobs
, --modownjobs
, --listanyjob
, --modanyjob
, --managedevs
, --orauser
, and --orarights
. Note that because of space constraints the mkclass
command in the example spans multiple lines.
ob> mkclass --listconfig yes --modself yes --modconfig yes --backupself yes --backuppriv yes --restself yes --restpriv yes --mailinput yes --mailerrors yes --querydevs yes --browse privileged backup_admin ob> lsclass --long backup_admin backup_admin: browse backup catalogs with this access: privileged access Oracle backups: owner display administrative domain's configuration: yes modify own name and password: yes modify administrative domain's configuration: yes perform backups as self: yes perform backups as privileged user: yes list any jobs owned by user: no modify any jobs owned by user: no perform restores as self: yes perform restores as privileged user: yes receive email requesting operator assistance: yes receive email describing internal errors: yes query and display information about devices: yes manage devices and change device state: no list any job, regardless of its owner: no modify any job, regardless of its owner: no user can perform Oracle backups and restores: no
Use the mkdev
command to configure a device for use with Oracle Secure Backup. This command assigns Oracle Secure Backup names and attributes to the devices in your administrative domain.
To be usable by Oracle Secure Backup, each device must have at least one attachment, which describes a data path between a host and the device itself. In the attachment, you identify a host to which the device is connected and a raw device name through which it is accessed.
See Also:
"Device Commands" for related commands
"mkhost" to learn about configuring an administrative domain
You must have the modify administrative domain's configuration right to use the mkdev
command.
You should disable any system software that scans and opens arbitrary Small Computer System Interface (SCSI) targets before configuring an Oracle Secure Backup tape device. If Oracle Secure Backup has to contend with other system software (such as monitoring software) for access to tape libraries and tape drives, then unexpected behavior can result.
Use the following syntax to configure a tape drive.
mkdev --type/-t tape [ --attach/-a aspec[,aspec]... ] [ --inservice/-o | --notinservice/-O ] [ --wwn/-W wwn ] [ --library/-l devicename ] [ --dte/-d dte ] [ --ejection/-j etype ] [ --minwriteablevolumes/-m n ] [ --blockingfactor/-f bf ] [ --maxblockingfactor/-F maxbf ] [ --automount/-m { yes | no } ] [ --erate/-e erate ] [ --current/-T se-spec ] [ --uselist/-u se-range ] [ --usage/-U duration ] [ --queryfreq/-q query_frequency ] [ --serial/-N serial-number ] [ --model/-L model-name ] devicename...
The following options enable you to configure a tape drive.
Specifies the device as a tape drive.
Configures an attachment, which is the physical or logical connection of a device to a host. An attachment is distinct from a device and describes a data path between a host and the device.
Oracle Secure Backup uses attachments to access a device, so a device must have at least one attachment to be usable by Oracle Secure Backup. A Fibre Channel-attached tape drive or tape library often has multiple attachments, one for each host that can directly access it. Refer to "aspec" for a description of the aspec
placeholder.
Specifies that the tape drive is logically available to Oracle Secure Backup.
Specifies that the tape drive is not logically available to Oracle Secure Backup.
Specifies the worldwide name of the device. Refer to "wwn" for an explanation of the wwn
placeholder.
Specifies the name of the tape library in which a tape drive resides.
Specifies the data transfer element (DTE) number of a tape drive within its containing tape library. DTE is the SCSI-2 name for a tape drive in a tape library. DTEs are numbered 1 through n and are used to identify tape drives in a tape library.
You must specify a dte
number if --library
is specified. The dte
option is not available for standalone tape drives.
Specifies the means by which tapes are ejected. Values are automatic
, ondemand
, or manual
.
Specifies the threshold for the minimum number of writeable volumes before Oracle Secure Backup initiates early volume rotation.
Specifies a blocking factor. A blocking factor determines how many 512-byte records to include in each block of data written to tape. By default, Oracle Secure Backup writes 64K blocks to tape, which is a blocking factor of 128.
Specifies a maximum blocking factor. The maximum blocking factor controls the amount of data that Oracle Secure Backup initially reads from a tape whose blocking factor is unknown.
The largest value permitted for the maximum blocking factor, which is the number of 512-byte records for each physical tape block, is 4096. This value represents a maximum tape block size of 2MB. This maximum is subject to device and operating system limitations that can reduce this maximum block size.
Sets the automount mode. The mount mode indicates the way in which Oracle Secure Backup can use a volume physically loaded into a tape drive (see the description of "mountdev").
A value of yes
(default) instructs Oracle Secure Backup to mount tapes for backup and restore operations without operator intervention. If this option is set to no
, then you must manually mount volumes before they are usable.
A setting of no
can be useful if you dedicate a tape drive to performing on-demand restore operations, but not backups. If automount
is set to yes
for this tape drive when a backup is scheduled, and if the tape drive contains an unmounted, eligible tape, then Oracle Secure Backup uses the tape drive for the backup.
Specifies the error rate percentage. The error rate is the number of recovered errors divided by the total blocks written, multiplied by 100. Oracle Secure Backup issues a warning if the error rate reported by the device exceeds the value you specify. The default is 8
.
Oracle Secure Backup issues a warning if it encounters a SCSI error when trying to read or reset the error counters of the tape drive. Some tape drives do not support the SCSI commands necessary to perform these operations. To avoid these warnings, disable error rate checking by specifying none
for the error rate.
Specifies the number of a storage element. This option only applies to a tape drive when the following criteria are met:
The tape drive is in a tape library.
The tape drive is known to be loaded with a tape.
The hardware cannot determine from which storage element the tape drive was loaded.
Refer to "se-spec" for a description of the se-spec
placeholder.
Specifies a range of storage elements that the device can use. This option only applies to a tape drive contained in a tape library.
By default, Oracle Secure Backup allows all tapes in a tape library to be accessed by all tape drives in the tape library. For libraries containing multiple tape drives which perform backups concurrently, you might want to partition the use of the tapes.
For example, you might want the tapes in half the storage elements to be available to the first tape drive and those in the second half to be available to the second tape drive. Alternatively, you might want to set up different use lists for different types of backups on a single tape drive.
Refer to "se-range" for a description of the se-range
placeholder.
Specifies the interval for a cleaning cycle. For example, --usage 1month
requests a cleaning cycle every month. Refer to "duration" for a description of the duration
placeholder.
You can specify the --usage
option on the chdev command to initialize the configured interval to reflect the amount of time that the tape drive has been used since the last cleaning. For example, specify --usage 1week
on the chdev
command to indicate that the most recent cleaning was a week ago.
Specifies the query frequency in terms of kb
, which is the "distance" between samplings of the tape position expressed in 1KB blocks. The maximum allowed query frequency is 1048576 (1MB), which is a query frequency of 1GB. A query frequency of 0
disables position sampling.
During a backup, Oracle Secure Backup periodically samples the position of the tape. obtar saves this position information in the Oracle Secure Backup catalog to speed up restore operations. For some devices, however, this sampling can degrade backup performance. While Oracle Secure Backup has attempted to determine optimal query frequencies for all supported tape drive types, you might find that you must adjust the query frequency.
Specifies the serial number for the tape device.
If a serial number is entered, then Oracle Secure Backup stores that serial number in the device object. If no serial number is entered, then the serial number is read and stored in the device object the first time Oracle Secure Backup opens the tape device.
See Also:
"checkserialnumbers"Specifies the model name for the tape device. The model number is usually discovered during device configuration.
Specifies the name of the tape drive to be configured. If an attachment is specified, then only one devicename
is allowed. Refer to "devicename" for the rules governing device names.
Use the following syntax to configure a tape library.
mkdev --type/-t library [ --class/-x vtl ] [ --attach/-a aspec[,aspec]... ] [ --inservice/-o | --notinservice/-O ] [ --wwn/-W wwn ] [ --autoclean/-C { yes | no } ] [ --cleanemptiest/-E { yes | no } ] [ --cleaninterval/-i { duration | off } ] [ --barcodereader/-B { yes | no | default } ] [ --barcodesrequired/-b { yes | no } ] [ --ejection/-j etype ] [ --minwriteablevolumes/-m n ] [ --unloadrequired/-Q { yes | no } ] [ --serial/-N serial-number ] [ --model/-L model-name ] devicename...
The following options enable you to configure a tape library. See "Semantics 1" for identical options not listed here.
Specifies the device as a tape library.
Specifies a virtual tape library.
Specifies whether automatic tape cleaning should be enabled. A cleaning cycle is initiated either when a tape drive reports that it needs cleaning or when a specified usage time has elapsed.
Oracle Secure Backup checks for cleaning requirements when a cartridge is either loaded into or unloaded from a tape drive. If at that time a cleaning is required, then Oracle Secure Backup performs the following steps:
Loads a cleaning cartridge
Waits for the cleaning cycle to complete
Replaces the cleaning cartridge in its original storage element
Continues with the requested load or unload
Note that you can run the clean command to clean a tape drive manually.
Specifies which cleaning tape to use. This option is useful when a tape library contains multiple cleaning tapes.
The default value of yes
specifies the emptiest cleaning tape, which causes cleaning tapes to round robin as cleanings are required.
The no
value specifies that obtool should use the least used cleaning tape, which uses each cleaning tape until it is exhausted, then uses the next cleaning tape until it is exhausted, and so forth.
Specifies whether there should be a cleaning interval, and if so, the duration
of the interval. The default is off
. The duration is the interval of time a tape drive is used before a cleaning cycle begins. Refer to "duration" for a description of the duration
placeholder.
If automatic tape drive cleaning is enabled, then duration
indicates the interval between cleaning cycles. For tape drives that do not report cleaning requirements, you can specify a cleaning interval, for example, 30days
.
Specifies whether a barcode reader is present. Many devices report whether they have a barcode reader. For these devices you can specify default
. For devices that do not report this information, specify yes
or no
.
Specifies whether Oracle Secure Backup requires tapes in the tape library to have readable barcodes. The default is no
. If you specify yes
, and if a tape in the tape library does not have a readable barcode, then Oracle Secure Backup refuses to use the tape.
Typically, Oracle Secure Backup does not discriminate between tapes with readable barcodes and those without. This policy ensures that Oracle Secure Backup can always solicit a tape needed for restore by using both the barcode and the volume ID.
Specifies whether an unload operation is required before moving a tape from a tape drive to a storage element. Typically, you should leave this option set to default of yes
, which means the value comes from the external device table ob_drives
. If you encounter difficulties, however, particularly timeouts waiting for offline while unloading a tape drive, then set the value to no
.
Specifies the serial number for the tape device.
If a serial number is entered, then Oracle Secure Backup stores that serial number in the device object. If no serial number is entered, then the serial number is read and stored in the device object the first time Oracle Secure Backup opens the tape device.
Specifies the model name for the tape device. The model number is usually discovered during device configuration.
Specifies the name of the tape library to be configured. If an attachment is specified, then only one devicename
is allowed. Refer to "devicename" for the rules governing device names.
Use the following syntax for configuring a tape drive in an ACSLS tape library:
mkdev --type/-t tape [ --attach/-a aspec[,aspec]... ] [ --inservice/-o | --notinservice/-O ] [ --wwn/-W wwn ] [ --library/-l devicename --lsm/s lsm_id --panel/p panel_id --drive/r drive_id] [ --blockingfactor/-f bf ] [ --maxblockingfactor/-F maxbf ] [ --erate/-e erate ] [ --queryfreq/-q queryfrequency ] devicename... devicename...
Use the following semantics for configuring a tape drive in an ACSLS tape library. See "Semantics 1" for identical options not listed here.
This option is used only for tape drives contained in ACSLS libraries. It defines the ID of the ACS Library Storage Module where this tape drive resides.
This option is used only for tape drives contained in ACSLS libraries. It defines the ID of the panel where this tape drive resides.
This option is used only for tape drives contained in ACSLS libraries. It defines the ID of the drive where this tape drive resides.
Use the following syntax is for configuring an ACSLS tape library.
mkdev --type/-t library -class/-x acsls --attach/-a aspec... --acsid/-g acs_id [ --inservice/-o | --notinservice/-O ] [ --userid/-n acs_userid ] [ --port/-P port_num ] [ --ejection/-j etype ] [ --minwritablevolumes/-V minvols ] library_devicename...
Use the following semantics is for configuring an ACSLS tape library. See "Semantics 1" for identical options not listed here.
This option specifies that this tape library is an ACS tape library.
This option specifies the Oracle Secure Backup media server and ACSLS server for an ACSLS tape library. The format of the aspec is mediaservhostname:acslshost
This option specifies the ACS ID value for the ACSLS tape library to control.
This option specifies the ACSLS access control user name. This value is optional. If it is specified, then all interactions with an ACSLS server are preceded by this access name.
This option specifies the listening port of the ACSLS server software. Typically this value is 0
or not specified. This option must be specified only when your ACSLS server is located behind a firewall.
Use the following syntax to associate a symbolic name with an ACS cartridge access port (CAP) within an ACSLS tape library. This command does not create or modify the CAP, which is a physical item on the ACS.
mkdev --type/-t cap [ --library/-L devicename ] [ --capid/-c cap_id ] [ --lsm/-s lsm_id ] capname
Use the following semantics to associate a symbolic name with an ACS cartridge access port (CAP) within an ACSLS tape library.
This option specifies the name of the tape library in which the CAP resides. If it is omitted, then the library variable is used. If the library variable is not found and one is not specified, then an error message is displayed.
This option specifies the hardware location of the CAP within the selected tape library.
This option specifies the ACS Library Storage Module of the CAP within the selected tape library.
The name of the Oracle Secure Backup CAP object to be created.
Example 2-82 Configuring a Tape Drive
This example configures a tape drive.
ob> lsdev library lib1 in service drive 1 tape1 in service library lib2 in service drive 1 tape2 in service ob> mkdev --type tape --inservice --library lib1 --erate 8 --dte 2 --blockingfactor 128 --uselist 1 --usage 4minute --automount yes hptape ob> lsdev library lib1 in service drive 1 tape1 in service drive 2 hptape in service library lib2 in service drive 1 tape2 in service
Use the mkds
command to make a dataset file or dataset directory.
See Also:
"Dataset Commands" for related commandsYou must have the modify administrative domain's configuration right to use the mkds
command.
mkds [ --nq ] [ --dir/-d ] [ --nocheck/-C ] [ --noedit/-E ] [ --input/-i ] dataset-name...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Creates a dataset directory called dataset-name
.
A dataset directory is a directory that contains dataset files. Dataset directories can have a hierarchy of nested subdirectories that is up to 10 levels deep.
Disables syntactic checking of a dataset file for errors.
Prevents a default editor window (as defined by your EDITOR
environment variable) from opening when creating a dataset file.
Lets you to input the contents of a dataset file.
Specifies the name of the dataset directory or dataset file. The mkds
command creates the dataset file or directory relative to the directory indicated by the pwdds command. Refer to "dataset-name" for a description of the dataset-name
placeholder.
Example 2-84 Creating a Dataset
This example creates a dataset directory called mydatasets1
and then creates a dataset file called test.ds
in this directory.
ob> pwdds / (top level dataset directory) ob> mkds --dir mydatasets1 ob> mkds --nq --input mydatasets1/test.ds Input the new dataset contents. Terminate with an EOF or a line containing just a dot ("."). include host brhost2 include path /home . ob> lsds --recursive Top level dataset directory: mydatasets1/ mydatasets1/test.ds
Example 2-85 Creating a Dataset Subdirectory
This example creates a not_used
subdirectory in the mydatasets1
directory.
ob> pwdds /mydatasets1 ob> mkds --dir not_used ob> cdds .. ob> pwdds / (top level dataset directory) ob> lsds --recursive Top level dataset directory: mydatasets1/ mydatasets1/not_used/ mydatasets1/test.ds
Example 2-86 Creating a Dataset for a Windows Host
This example creates a dataset file named c-winhost1.ds
. This file specifies the backup of drive C:\
on a Windows host named winhost1
.
ob> pwdds / (top level dataset directory) ob> mkds --nq --input c-winhost1.ds Input the new dataset contents. Terminate with an EOF or a line containing just a dot ("."). include host winhost1 include path "C:\" { exclude name *.log } . ob> lsds NEWCLIENTS c-winhost1.ds
Create a volume duplication policy.
See Also:
"Volume Duplication Commands"You must have the modify administrative domain's configuration right to use the addbw
command.
mkdup [ --comment/-c commentstring] [ --inputcomment/-i ] [ --trigger/-e dupevent:duration ] [ --restrict/-r restriction[,restriction]...] ] [ --migrate/-m { yes | no } ] { --rule/-u duplicationrule[,duplicationrule...] } policyname...
A descriptive comment, displayed when using lsdup
.
Prompt the backup administrator to enter a descriptive comment. After you run mkdup --inputcomment
, obtool prompts you to enter the comment. End the comment with a period (.
) on a line by itself.
Specifies when a volume becomes eligible for duplication. The duration
placeholder specifies how long after dupevent
the volume becomes eligible for duplication.
Restricts duplication to specific devices within the administrative domain. You can select media server hosts or specific devices on these hosts. You must have the duplicateovernetwork
policy set to yes
to duplicate a volume to a different media server than the one containing the original volume being duplicated. Oracle Secure Backup does not duplicate between devices attached to different media servers by default, because it requires heavy use of network bandwidth.
If you have set duplicateovernetwork
to yes
and do not specify a restriction (default), then this volume duplication policy has no device restrictions, and can use any available device on any media server at the discretion of the Oracle Secure Backup scheduling system.
See Also:
"dupevent" for a description of the dupevent
placeholder
"duration" for a description of the duration
placeholder
"restriction" for a description of the restriction
placeholder
"duplicateovernetwork" for more information on the duplicateovernetwork
policy
Specifies volume to be migrated. If this option is set to yes
, then only one rule can be specified for this volume duplication policy. If you do not specify the --migrate
option, then the volume is not migrated.
Specifies a duplication rule, in the form media-family
:
number
.
Use the mkhost
command to add a host to an administrative domain. The host must run Oracle Secure Backup locally or be accessible to Oracle Secure Backup with Network Data Management Protocol (NDMP).
The mkhost
command supports Internet Protocol v4 (IPv4), Internet Protocol v6 (IPv6), and mixed IPv4/IPv6 environments on all platforms that support IPv6.
See Also:
"Host Commands" for related commandsYou must have the modify administrative domain's configuration right to run the mkhost
command.
If your Windows host is protected by a firewall, then the firewall must be configured to permit Oracle Secure Backup daemons on the host to communicate with the other hosts in your administrative domain. Windows XP Service Pack 2 and Windows Server 2003 contain a built-in Windows firewall which, in the default configuration, blocks inbound traffic on ports used by Oracle Secure Backup. Refer to Oracle Secure Backup Installation and Configuration Guide for more information.
Use the following syntax to add a host that runs Oracle Secure Backup locally to an administrative domain.
mkhost [ --access/-a ob ] [ --inservice/-o | --notinservice/-O ] [ --encryption/-e { required | allowed } ] [ --algorithm/-l { AES128 | AES192 | AES256 } ] [ --keytype/-t { passphrase | transparent } ] [ --rekeyfrequency/-g duration ] [ --passphrase/-s string ] [ --querypassphrase/-Q ] [ --tcpbufsize/-c bufsize ] [ --ndmpauth/-A authtype ] [ --roles/-r role[,role]... ] [ --ip/-i ipname[,ipname]... ] [ --nocomm/-N ] [ --certkeysize/-k cert-key-size ] hostname...
Use these options if the host has Oracle Secure Backup installed and uses the Oracle Secure Backup internal communications protocol to communicate.
Specifies that the host accesses a local installation of Oracle Secure Backup. By default obtool determines dynamically whether the computer is accessed through the Oracle Secure Backup RPC protocol (plus NDMP) or solely through NDMP.
Specifies whether encryption is required or allowed. If set to required
, then all backups from this host are encrypted. If set to allowed
, then encryption is determined by the global encryption policy and encryption settings specific to the backup job. Default is required
.
Specifies encryption algorithm used. Default is AES192
.
Specifies how the encryption keys are generated. Values are:
passphrase
The backup administrator supplies a passphrase, which is then used to generate encryption keys. The keys generated using a passphrase are not stored in the Oracle wallet. If the passphrase is lost, then these backups cannot be restored.
transparent
The encryption keys are generated automatically and stored in the Oracle wallet.
Default is transparent
.
Specifies how often a key is generated. Values are:
off
Never generate a key
Generate keys at the time interval specified. If N
is0
, then Oracle Secure Backup never generates a key. The minimum duration is one day.
systemdefault
Generate keys according to the global rekeyfrequency policy.
perbackup
Generate keys for each backup.
The default is 30days
.
Specifies a passphrase used in generation of the encryption key.
The practice of supplying a password in clear text on a command line or in a command script is not recommended by Oracle. It is a security vulnerability. The recommended procedure is to have the Oracle Secure Backup user be prompted for the password.
Queries for the passphrase used in generation of the encryption key.
Specifies TCP/IP (Transmission Control Protocol/Internet Protocol) buffer size. The default value is not
set
, in which case global policy operations/tcpbufsize
applies. The maximum TCP/IP buffer size is 4GB, and the minimum TCP/IP buffer size is 1 KB. If Oracle Secure Backup cannot set TCP/IP buffer size as specified, then it returns a warning. This can happen when the operating system kernel limit is smaller than the specified TCP/IP buffer size.
Increasing TCP/IP buffer size also increases TCP/IP advertised window. So to tune backup over a wide area network (WAN), this parameter must be set to a value bigger than the bandwidth times round-trip time.
Specifies that the host is logically available to Oracle Secure Backup.
Specifies that the host is not logically available to Oracle Secure Backup.
Assigns one or more roles to the host. Refer to "role" for a description of the role
placeholder.
Indicates the IP address of the host computer. IP addresses are represented as a series of four numbers separated by periods.You can also use host names for IP addresses. In this case, the host name is resolved by the underlying operating system to an IP address.
If you specify ipname
, then Oracle Secure Backup never uses the user-assigned host name to obtain the host IP address; instead, it considers each specified ipname
until it finds one that resolves to a working IP address. If you specified a PNI (Preferred Network Interface) for this host with the mkpni command, then Oracle Secure Backup considers the PNI address first.
Note:
The use of DHCP to assign IP addresses is not supported for hosts that participate in an Oracle Secure Backup administrative domain. You must assign static IP addresses to all hosts. If you cannot use static IP addresses, then ensure that the DHCP server guarantees that a given host is always assigned the same IP address.If you do not specify ipname
, then Oracle Secure Backup tries to resolve the specified hostname
to obtain the IP address.
Suppresses communication with the host computer. You can use this option to add a host to the domain when the host is not yet connected to the network.
Sets the size (in bits) of the public key/private key pair used for the identity certificate of this host. By default Oracle Secure Backup uses the value in the certkeysize security policy. If you specify --certkeysize
, then the specified value overrides the key size in the security policy. The key size set with --certkeysize
applies only to this host and does not affect the key size of any other current or future hosts.
Because larger key sizes require more computation time to generate the key pair than smaller key sizes, the key size setting can affect the processing time of the mkhost
command. While the mkhost
command is running, obtool might display a status message every 5 seconds (see Example 2-88). obtool displays a command prompt when the process has completed.
Use the following syntax to add a host that Oracle Secure Backup accesses with NDMP, such as a filer, to an administrative domain.
mkhost --access/-a ndmp [ --inservice/-o | --notinservice/-O ] [ --encryption/-e { required | allowed } ] [ --algorithm/-l { AES128 | AES192 | AES256 } ] [ --keytype/-t { passphrase | transparent } ] [ --rekeyfrequency/-g duration ] [ --passphrase/-s string ] [ --querypassphrase/-Q ] [ --role/-r role[,role]... ] [ --ip/-i ipname[,ipname]... ] [ --ndmpauth/-A authtype ] [ { --ndmppass/-p ndmp-password } | --queryndmppass/-q | --dftndmppass/-D ] [ --ndmpport/-n portnumber ] [ --ndmppver/-v protover ] [ --ndmpuser/-u ndmp-username ] [ --nocomm/-N ] [ --ndmpbackuptype/-B ndmp-backup-type ] [ --backupev/-w evariable-name=variable-value ]... [ --restoreev/-y evariable-name=variable-value ]... hostname...
Note:
For NDMP hosts, the followingmkhost
command options are only available starting with Oracle Secure Backup 10.3.0.2.0:
encryption
algorithm
keytype
rekeyfrequency
passphrase
querypassphrase
Use these options if the host does not have Oracle Secure Backup installed (for example, a filer or Network Attached Storage (NAS) device) and uses NDMP to communicate.
Specifies that the host uses Network Data Management Protocol (NDMP) to communicate. An NDMP host is a storage appliance from third-party vendors such as NetApp, Mirapoint, or DynaStore. An NDMP host implements the NDMP protocol and employs NDMP daemons (rather than Oracle Secure Backup daemons) to back up and restore file systems.
Specifies encryption algorithm used. Default is AES192
.
Specifies encryption algorithm used. Default is AES192
.
Specifies how often a key is generated. Values are:
off
Never generate a key
N duration
Generate keys at the time interval specified. If N
is0
, then never generate a key. The minimum duration is one day.
systemdefault
Generate keys according to the global rekeyfrequency policy.
perbackup
Generate keys for each backup.
Default is 30days
.
Specifies how the encryption keys are generated. Values are:
passphrase
The backup administrator supplies a passphrase, which is then used to generate encryption keys.
transparent
The encryption keys are generated automatically and stored in the Oracle Wallet.
Specifies that the host is logically available to Oracle Secure Backup.
Specifies that the host is not logically available to Oracle Secure Backup.
Assigns a role to the host. Refer to "role" for a description of the role
placeholder.
Indicates the IP address of the host computer. IP addresses are represented as a series of four numbers separated by periods. The use of DHCP to assign IP addresses is not supported for hosts that participate in an Oracle Secure Backup administrative domain. You must assign static IP addresses to all hosts. If you cannot use static IP addresses, then ensure that the DHCP server guarantees that a given host is always assigned the same IP address.
Note:
You can use host names for IP addresses. In this case, the host name is resolved by the underlying operating system to an IP address.Provides an authorization type. Refer to "authtype" for a description of the authtype
placeholder.
The authorization type is the mode in which Oracle Secure Backup authenticates itself to the NDMP server. Typically, you should use the negotiated
default setting. You can change the setting if necessary; for example, if you have a malfunctioning NDMP server.
Specifies an NDMP password. The password is used to authenticate Oracle Secure Backup to this NDMP server. If you do not specify this option, and if you do not specify --queryndmppass
, then Oracle Secure Backup uses the default NDMP password defined in the ndmp/password policy.
Prompts you for the NDMP password.
Uses the default NDMP password defined in the ndmp/password policy.
Specifies a TCP port number for use with NDMP. Typically, the port 10000 is used. You can specify another port if this server uses a port other than the default.
Specifies a protocol version. Refer to "protover" for a description of the protover
placeholder. The default is null (""
), which means "as proposed by server."
Specifies a user name. The user name is used to authenticate Oracle Secure Backup to this NDMP server. If left blank, then the user name value in the ndmp/username policy is used.
Suppresses communication with the host computer. You can use this option to add a host to the domain when the host is not yet connected to the network.
Specifies a default NDMP backup format. The default is defined by the NDMP data service running on the client. Refer to "ndmp-backup-type" for a description of the ndmp-backup-type
placeholder.
Declares NDMP backup environment variables that are passed to the host's NDMP Data Service for a backup.
Declares NDMP restore environment variables that are passed to the host's NDMP Data Service for a restore.
Specifies name of the host to be added to the administrative domain. Note that you cannot specify multiple hosts if you specify an IP address with the --ip
option.
Host names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.
Example 2-87 Adding a Host Running Oracle Secure Backup Locally
This example adds host sfserver1
, which runs Oracle Secure Backup locally, to the administrative domain.
ob> lshost brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service osbsvr1 admin,mediaserver,client (via OB) in service ob> mkhost --access ob --inservice --roles mediaserver,client --nocomm sfserver1 ob> lshost brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service sfserver1 mediaserver,client (via OB) in service osbsvr1 admin,mediaserver,client (via OB) in service
Example 2-88 Adding a Host with a Large Key Size
This example adds a host with a certificate key size of 4096
. The sample output shows the periodic status message.
ob> mkhost --inservice --role client --certkeysize 4096 osbsvr2 Info: waiting for host to update certification status... Info: waiting for host to update certification status... Info: waiting for host to update certification status... Info: waiting for host to update certification status... ob> lshost osbsvr2 osbsvr2 client (via OB) in service
Example 2-89 Adding an NDMP Host
This example adds a host that Oracle Secure Backup accesses with NDMP. Due to space constraints the sample command has been reformatted to fit on the page.
ob> mkhost --nocomm --access ndmp --ip 192.0.2.151 --inservice --roles client --ndmpauth none --ndmpuser jim --ndmppass mypassword --ndmppver "" ndmphost1 ob> lshost brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service sfserver1 mediaserver,client (via OB) in service ndmphost1 client (via NDMP) in service osbsvr1 admin,mediaserver,client (via OB) in service
Create a location object.
Note:
Themkloc
command can only be used to create a storage location. Oracle Secure Backup automatically creates an active location corresponding to each tape library and tape drive in the administrative domain.See Also:
"Location Commands" for related commandsYou must have the modify administrative domain's configuration right to use the mkloc
command.
mkloc [ --inputcomment/-i | --comment/-c comment ] [ --mailto/-m email-target[,email-target]... ] [ --customerid/-I customerid ] [ --notification/-n ntype ] [ --recalltime/-R duration ] locationname...
Allows input of an optional comment for the location. After you run mkloc --inputcomment
, obtool prompts you to enter the comment. End the comment with a period (.
) on a line by itself.
Specifies a descriptive comment for the location.
A customer ID string. Note: Only valid for storage locations.
The e-mail addresses specified here receive the pick or distribution reports for media movement involving volumes at the specified location. An e-mail system must be operational on the administrative server for this feature to operate. Separate multiple entries with a comma.
The --notification
ntype
option enables you to specify a type of electronic notification to be sent to the offsite vault vendor when media are moved from or to a storage location. The ntype
value is either none
or imftp
(Iron Mountain FTP file).
The --recalltime
option enables you to specify the time taken to recall a volume from this storage location to the data center. This setting is disabled for an active location and is valid only for offsite storage locations. You can use this setting to determine whether to fail a restore request initiated by Recovery Manager (RMAN) that requires use of tape volumes that cannot be supplied within the specified resource wait time period. This parameter can also be used by the volume cloning feature to determine which volume to recall for a restore operation when multiple copies are available at multiple offsite locations.
The name of the storage location.
Note:
all
is a reserved word and cannot be used as a location name.Use the mkmf
command to create a media family, which is a named classification of backup volumes. A media family ensures that volumes created at different times have similar characteristics. For example, you can create a media family for backups with a six-month retention period. If you specify this family on successive backup commands, then all created volumes have a six-month retention period.
A media family has either of the following types of mutually exclusive expiration policies: content-managed (default) or time-managed. In a content-managed policy, volumes expire only when every backup piece recorded on a volume has been marked as deleted. In a time-managed policy, volumes expire when they reach the expiration time, which is calculated as the sum of the --writewindow
time, the --retain
time, and the volume creation time.
See Also:
"Media Family Commands" for related commandsYou must have the modify administrative domain's configuration right to use the mkmf
command.
mkmf [ --writewindow/-w duration ] [ --retain/-r duration ] [ [ --vidunique/-u ] | [ --vidfile/-F vid-pathname ] | [ --viddefault/-d ] | [ --vidfamily/-f media-family-name ] ] [ [ --inputcomment/-i | [ --comment/-c comment ] ] [ --contentmanaged/-C ] [ --append/-a ] [ --noappend/-A ] [ --rotationpolicy/-R policyname ] [ --duplicationpolicy/-D policyname ] [ --acsscratchid/-d acsscratch_id ] media-family-name...
Specifies a write-allowed time period for the media family. Refer to "duration" for a description of the duration
placeholder. The default is disabled
, which means that Oracle Secure Backup does not consider the write window when computing the volume expiration time.
A write window is the period for which a volume set remains open for updates, usually by appending backup images. All volumes in the family are considered part of the same volume set. The write window opens when Oracle Secure Backup writes the first file to the first volume in the set and closes after the specified period elapses. When the write window closes, Oracle Secure Backup disallows further updates to the volume set until one of the following conditions is met:
It expires.
It is relabeled.
It is reused.
It is unlabeled.
It is forcibly overwritten.
Oracle Secure Backup continues using the volume set for backup operations until the write window closes.
Note that if you select forever
or disabled
as a duration
, then you cannot enter a number. For example, you can set the write window as 14days
or specify forever
to make the volume set eligible to be updated indefinitely. All volume sets that are members of the media family remain open for updates for the same time period.
This option has no effect for media families used for automated tape duplication.
Specifies the retention period, which is amount of time to retain the volumes in the volume set. By specifying this option, you indicate that this media family is time-managed rather than content-managed. Refer to "duration" for a description of the duration
placeholder.
The volume expiration time is the date and time on which a volume expires. Oracle Secure Backup computes this time by adding the write window duration (--writewindow
), if it is specified, to the time at which it wrote backup image file number 1 to a volume, and then adding the volume retention time (--retain
).
The retention period prevents you from overwriting any volume included as a member of this media family until the end of the specified time period. If one volume becomes full, and if Oracle Secure Backup continues the backup onto subsequent volumes, then it assigns each volume in the volume set the same retention time.
You can make Recovery Manager (RMAN) backups to time-managed volumes. Thus, volumes with a time-managed expiration policy can contain a mixture of file-system and RMAN backup pieces.
Caution:
If you make RMAN backups to time-managed volumes, then it is possible for a volume to expire and be recycled while the RMAN repository reports the backup pieces as available. In this case, you must use theCROSSCHECK
command in RMAN to resolve the discrepancy.You can change a media family from time-managed to content-managed by specifying --contentmanaged
on the chmf command.
Media families used for automated tape duplication must have the same expiration policy as the associated original volumes. If the original volume has a time-managed expiration policy, then the duplicate volumes must be time-managed as well.
Creates a volume ID unique to this media family. The volume ID begins with the string media-family-name-
000001
and increments the volume sequence number each time it is used. For example, MYVOLUME-000001
would be the volume ID for the first volume in the MYVOLUME
media family, MYVOLUME-000002
would be the ID for the second volume, and so forth.
Specifies the name of the volume sequence file for the media family that you are creating. Specify either a relative filename, in which case the file is created in the administrative directory on the administrative server, or an absolute filename.
Because Oracle Secure Backup does not create this file automatically, you must create it manually. If you select the --vidfile
option, then use a text editor to customize the vid-
prefix. Enter the first volume ID to be assigned to the media family as a single line of text, for example, MYVOLUME-000001
.
Note:
You must create the volume ID file before specifying the--vidfile
option.Specifies the system default, that is, Oracle Secure Backup uses the same volume ID sequencing that it would use if no media family were assigned. The default volume ID begins at VOL000001
and increments each time it is used.
Uses the same volume ID sequencing as is used for the media family identified by media-family-name
.
Allows input of an optional comment for the media family. After you run mkmf --inputcomment
, obtool prompts you to enter the comment. End the comment with a period (.
) on a line by itself.
Specifies information to store with the media family. To include white space in the comment
, surround the text with quotes.
Specifies that volumes in this media family are content-managed rather than time-managed. Volumes that use this expiration policy are intended for RMAN backups: you cannot write a file-system backup to a content-managed volume.
A content-managed volume is eligible to be overwritten when all backup image sections have been marked as deleted. You can delete backup pieces through RMAN or through the rmpiece command in obtool. A volume in a content-managed volume set can expire even though other volumes in the same set are not expired.
You can change a media family from content-managed to time-managed by specifying --retain
on the chmf command.
Media families used for automated tape duplication must have the same expiration policy as the associated original volumes. If the original volume has a content-managed expiration policy, then the duplicate volumes must be content-managed as well.
Specifies that additional backup images can be appended to volumes in the media family (default). This option has no effect for media families used for automated tape duplication.
Although a volume might be unexpired and have tape remaining, Oracle Secure Backup does not write to a volume that is lower than the most recent volume sequence number for the media family. Every backup tries to append to the most recent volume in the media family. If this volume is full, then it writes to a different volume.
Specifies that additional backup images cannot be appended to volumes in the media family. This option ensures that a volume set contains only a single backup image, which is useful if you perform a full backup and then use the tapes to re-create the original file system.
Specifies the rotation policy for the media family.
This option has no effect for media families used for automated tape duplication.
To clear the rotation policy, specify an empty string ("") for the policy name.
Specifies the duplication policy for the media family.
To clear the duplication policy, specify an empty string ("") for the policy name.
For ACSLS libraries this option defines the scratch pool ID from which volumes are pulled. For non-ACSLS libraries this option has no effect. When a volume is unlabeled it is placed back into the scratch pool ID that is defined by the media family it belonged to when it was unlabeled.
Specifies the name of the media family to create. Media family names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 31 characters.
Example 2-90 Creating a Time-Managed Media Family
This example creates a time-managed media family called time-man-family
. Volumes in the volume set are available for update for 7 days. Because the retention period is 28 days, a volume in the media family expires 35 days after Oracle Secure Backup first writes to it.
ob> mkmf --vidunique --writewindow 7days --retain 28days time-man-family
Example 2-91 Creating a Content-Managed Media Family
This example creates a content-managed media family called content-man-family
. Because the write window is forever
, volumes in this family are eligible for update indefinitely. Volumes only expire when RMAN shows the status of all backup pieces on the volumes as DELETED
.
ob> mkmf --vidunique --writewindow forever content-man-family
Use the mkpni
command to define a PNI (Preferred Network Interface) for an existing host. You can specify an unlimited number of PNIs for a host.
The PNI is the network interface that is necessary to transmit data to be backed up or restored. A network can have multiple physical connections between a client and the server performing a backup or restore on behalf of that client. For example, a network can have both Ethernet and Fiber Distributed Data Interface (FDDI) connections between a pair of hosts. PNI enables you to specify, on a client-by-client basis, which of the server's network interfaces is necessary.
The mkpni
command supports Internet Protocol v4 (IPv4), Internet Protocol v6 (IPv6), and mixed IPv4/IPv6 environments on all platforms that support IPv6.
See Also:
"Preferred Network Interface Commands" for related commandsYou must have the modify administrative domain's configuration right to use the mkpni
command.
mkpni --interface/-i server-ipname { --client/-c client-hostname[,client-hostname]... } server-hostname
Specifies the IP address or the DNS host name that the specified clients should use when communicating with the server specified by server-hostname
.
Specifies one or more clients that should use the server-ipname
when communicating with server-hostname
. The client-hostname
specifies the host name or internet address of the client as seen from the server. The host name must be a host name that you created with the mkhost command.
Specifies the name of the server host.
This example defines a PNI that specifies that the client hosts osbsvr1
and brhost3
should use the IP address 192.0.2.1
when communicating with server brhost2
.
ob> mkpni --interface 192.0.2.1 --client osbsvr1,brhost3 brhost2 ob> lspni brhost2: PNI 1: interface: 192.0.2.1 clients: osbsvr1, brhost3
Create a rotation policy.
See Also:
"Rotation Policy Commands"You must have the modify administrative domain's configuration right to use the mkrot
command.
mkrot [ --comment/-c commentstring | --inputcomment/-i commentstring ] --rule/-u rotationrule[,rotationrule]... policyname. ..
A descriptive comment, displayed when using lsrot
. You can specify either --comment
or --inputcomment
, but not both.
Allows input of an optional comment. After you run mkrot --inputcomment
, obtool prompts you to enter the comment. End the comment with a period (.
) on a line by itself. You can specify either --comment
or --inputcomment
, but not both.
Specifies a set of rotation rules to be applied to the rotation policy.
The rotationrule
argument is of the form locationname[:event[:duration]]
, where
locationname
is either the name of an existing location object or a wildcard (*).
If an existing location object is specified as the first locationname
in a rotation rule, then the rotation rule is constrained to that location. If a wildcard (*
) is specified as the first location in a rotation rule, then the rotation rule can apply to any active location. A wildcard is permitted only for the first locationname
in a rotation rule.
A location can appear only once in a rotation policy. An attempt to include a location more than once in the entire set of location/duration tuples for the rotation policy results in an error message and failure of the command.
event
is the volume-specific event that triggers the point at which the duration specified in this tuple begins to count. The event value can be one of the following:
firstwrite
This is the point at which the first write to a volume occurs. This value is valid only for an active location.
lastwrite
This is the point at which the last write to a volume occurs. This value is valid only for an active location.
windowclosed
This is the point at which the write window closes. This value is valid only for an active location.
nonwritable
This is the point at which a volume can no longer be written to, either because the write window has closed or because the volume is full. This value is valid only for an active location.
arrival
This is the point at which the volume arrived at this location. This value is valid only for a storage location.
expiration
This is the point at which the volume expires. This value is valid only for a storage location.
duration
This is the length of time media remain at the location specified in this tuple. It is expressed in standard Oracle Secure Backup time duration syntax.
The duration value must be specified for all locations except a buffer location. The duration value is expressed as an integer n
followed by seconds, minutes, hours, days, weeks, months, or years. Examples of valid values are 14days
, 3weeks
, and 2months
.
If you specify DISABLED
as the duration value, then the volume remains at the associated location forever. The DISABLED
value is allowed only for the final location in a rotation policy.
Specifies the name for a rotation policy, which can be 1-31 characters.
Use the mksched
command to create a backup, vaulting scan, or duplication scan schedule.
A schedule contains 0 or more triggers. A trigger is a user-defined set of days (--day
) and times (--time
) when the scheduled backup, vaulting scan, or duplication scan should run. At the beginning of the day, Oracle Secure Backup inspects the triggers in each enabled schedule.
You can use the chsched command to add, change, or remove triggers in an existing schedule.
See Also:
"Schedule Commands" for related commandsYou must have the modify administrative domain's configuration right to use the mksched
command.
Use the following syntax to create a backup schedule, which describes what, when, and how Oracle Secure Backup should back up. The backup schedule contains the name of each dataset and its associated media family.
For each trigger that fires on a particular day, Oracle Secure Backup creates one backup job for each dataset listed in the schedule. Unlike on-demand (one-time-only) backups created with the backup command, the scheduler creates jobs directly and does not first create a backup request.
mksched [ --type/-Y backup ] [ --dataset/-D dataset-name[,dataset-name]... ] [ --comment/-c comment | --inputcomment/-i ] [ --priority/-p schedule-priority ] [ --restrict/-r restriction[,restriction]... ] [ --enabled/-z ] [ --disabled/-Z ] [ --encryption/-e { yes | no } ] [ [ --day/-d day-date] [ --time/-t time ] [ --level/-l backup-level][ --family/-f media-family-name ] [ --expires/-x duration] ]... schedulename ...
Specifies the type of schedule to create. Valid values are backup
, duplicationscan
, and vaultingscan
.
Specifies the dataset to include in the backup job.
If no datasets are specified in the schedule, then Oracle Secure Backup does not initiate backups based on the schedule. You can add a dataset to an existing schedule by using the chsched command.
Adds a comment to the schedule.
Prompts for a comment. After you run mksched
, obtool prompts you to enter the comment. End the comment with a period (.) on a line by itself.
Assigns a schedule priority to a backup. Refer to "schedule-priority" for a description of the schedule-priority
placeholder.
Restricts the backup to specific devices within an administrative domain. You can select media server hosts or specific devices on these hosts. If you do not specify a restriction (default), then the current schedule has no device restrictions and can use any available device on any media server at the discretion of the Oracle Secure Backup scheduling system. Refer to "restriction" for a description of the restriction
placeholder.
Specifies that the backup schedule be enabled when created. If you do not specify either --enabled/-z
or --disabled/-Z
, then the schedule is enabled when created.
Specifies that the backup schedule be disabled when created. If you specify this option, then you can later enable the backup schedule with a chsched
command.
See Also:
"chsched"Specifies encryption flags for the backup schedule or job. Valid values are:
yes
Backups for these scheduled jobs are always encrypted, regardless of settings for the global or host-specific encryption policies.
no
If the global or host-specific encryption policies are set to allowed
, then backups created for these jobs are not encrypted. This is the default.
If both global and host-specific encryption policies are set to allowed
, then backups created for these jobs are not encrypted.
If either the global encryption policy or the host-specific encryption policy is set to required
, then that policy overrides this setting and backups are always encrypted. The encryption algorithm and keys are determined by the policies of each client host.
Specifies the day on which Oracle Secure Backup triggers the scheduled backup. If you do not specify a day or time, then Oracle Secure Backup does not run backup jobs based on the schedule. If you specify a day but no time, then the time defaults to 00:00. Refer to "day-date" for a description of the day-date
placeholder.
Specifies the time at which Oracle Secure Backup triggers the scheduled backup. You cannot specify a time without a day. Refer to "time" for a description of the time
placeholder.
Identifies a backup level. The default is full
. Refer to "backup-level" for a description of the backup-level
placeholder.
Specifies the name of the media family to which the data of this scheduled backup should be assigned. The default is the null
media family.
Specifies an expiration time period. Refer to "duration" for a description of the duration
placeholder. Specifying this option expires the backup, vaulting scan, or duplication scan if it is not processed by duration
after the trigger time.
Specifies the name of the schedule to create. Schedule names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.
Use the following syntax to create a vaulting scan schedule, which describes the time or times when Oracle Secure Backup scans the volumes catalog to determine which volumes are eligible for vaulting. Vaulting schedules have the --type
option set to vaultingscan
. Vaulting scan control job types are queued for processing by the media manager component of Oracle Secure Backup at the time or times specified in the schedule.
The scan occurs on a location-by-location basis. Scheduled vaulting jobs run in specified vaulting windows and when resources are available.
mksched [ --type/-Y vaultingscan ] [ --comment/-c comment|--inputcomment/-i ] [ --priority/-p schedule-priority ] [ --restrict/-r vault_restriction[,vault_restriction]... ] [ --location/-L location_name[,location_name]... ] [ --enabled/-z ] [ --disabled/-Z ] [ --select/-S select_criterion[,select_criterion]... ] [ [ --day/-d day-date ] [ --time/-t time ][ --expires/-x duration ] ]... schedulename...
Specifies the type of schedule to create. Valid values are backup
, duplicationscan
, and vaultingscan
.
Adds a comment to the schedule.
Prompts for a comment. After you run mksched
, obtool prompts you to enter the comment. End the comment with a period (.) on a line by itself.
Assigns a schedule priority to a vaulting scan. Refer to "schedule-priority" for a description of the schedule-priority
placeholder.
Restricts a vaulting scan to one or more locations. The locations can be specified in any of the following forms:
location_name
@cap_name
The location_name
is the location that is scanned during a scan job for volumes eligible to be moved. The cartridge access port (CAP) name can be specified only if the location is an ACSLS library.
location_name
If location_name
is an ACSLS library and no CAP name is specified, then Oracle Secure Backup selects the largest available CAP.
@cap_name
If no location name is specified, then the location of the specified CAP is scanned. This form applies only to ACSLS libraries.
If the ejection type for the library is set to automatic or ondemand, then Oracle Secure Backup exports volumes to the specified CAP during a media movement job.
Specifies one or more locations to be applied to the vaulting scan schedule. If no location is specified, then the schedule applies to all locations.
Note:
The--location
option is deprecated for vaulting scan schedules in this release, but it is supported for backward compatibility. Oracle recommends that you use the --restrict
option to limit vaulting scans to particular locations.Specifies that the vaulting scan schedule be enabled when created. If you do not specify either --enabled/-z
or --disabled/-Z
, then the schedule is enabled when created by default.
Specifies that the vaulting scan schedule be disabled when created. If you specify this option, then you can later enable the backup schedule with a chsched
command.
See Also:
"chsched"Restricts a vaulting scan to one or more media families.
Specifies the day on which Oracle Secure Backup triggers the scheduled vaulting scan. If you do not specify a day or time, then Oracle Secure Backup does not run vaulting scan jobs based on the schedule. If you specify a day but no time, then the time defaults to 00:00. Refer to "day-date" for a description of the day-date
placeholder.
Specifies the time at which Oracle Secure Backup triggers the scheduled vaulting scan. You cannot specify a time without a day. Refer to "time" for a description of the time
placeholder.
Specifies an expiration time period. Specifying this option expires the vaulting scan if it is not processed by duration
after the trigger time.
See "duration" for more information on the duration
placeholder.
Specifies the name of the schedule to create. Schedule names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.
Use the following syntax to create a duplication schedule, which describes the time or times when Oracle Secure Backup scans the volumes catalog to determine which volumes are eligible for duplication. Duplication schedules have the --type
option set to duplicationscan
. Duplication scan control job types are queued for processing by the media manager component of Oracle Secure Backup at the time or times specified in the schedule.
The scan occurs on a location-by-location basis. Scheduled duplication jobs run in specified duplication windows and when resources are available.
mksched [ --type/-Y duplicationscan ] [ --comment/-c comment | --inputcomment/-i ] [ --priority/-p schedule-priority ] [ --enabled/-z ] [ --disabled/-Z ] [ --location/-L locationname[,locationname]... ] [ [ --day/-d day-date ] [ --time/-t time ] [ --expires/-x duration ] ]... schedulename...
Specifies the type of schedule to create. Valid values are backup
, duplicationscan
, and vaultingscan
.
Adds a comment to the schedule.
Prompts for a comment. After you run mksched
, obtool prompts you to enter the comment. End the comment with a period (.) on a line by itself.
Assigns a schedule priority to a duplication scan. Refer to "schedule-priority" for a description of the schedule-priority
placeholder.
Specifies the day on which Oracle Secure Backup triggers the scheduled duplication scan. If you do not specify a day or time, then Oracle Secure Backup does not run duplication scan jobs based on the schedule. If you specify a day but no time, then the time defaults to 00:00. Refer to "day-date" for a description of the day-date
placeholder.
Specifies the time at which Oracle Secure Backup triggers the scheduled duplication scan. You cannot specify a time without a day. Refer to "time" for a description of the time
placeholder.
Specifies an expiration time period. Refer to "duration" for a description of the duration
placeholder. Specifying this option expires the duplication scan if it is not processed by duration
after the trigger time.
Specifies that the duplication scan schedule be enabled when created. If you do not specify either --enabled/-z
or --disabled/-Z
, then the schedule is enabled when created by default.
Specifies that the duplication scan schedule be disabled when created. If you specify this option, then you can later enable the backup schedule with a chsched
command.
See Also:
"chsched"Specifies one or more locations to be applied to the duplication schedule. Only an active location can be specified in a duplication schedule. If no location is specified, then the schedule applies to all locations.
Specifies the name of the schedule to create. Schedule names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.
Example 2-93 Scheduling a Weekly Backup
This example schedules a backup every Thursday at 9:00 p.m.
ob> lssched --long OSB-CATALOG-SCHED: Type: backup Dataset: OSB-CATALOG-DS Priority: 50 Encryption: no Comment: catalog backup schedule ob> mksched --priority 5 --dataset datadir.ds --day thursday --time 21:00 datadir ob> lssched --long OSB-CATALOG-SCHED: Type: backup Dataset: OSB-CATALOG-DS Priority: 50 Encryption: no Comment: catalog backup schedule datadir: Type: backup Dataset: datadir.ds Priority: 5 Encryption: no Trigger 1: Day/date: thursdays At: 21:00 Backup level: full Media family: (null) ob> lsjob --pending Job ID Sched time Contents State ---------------- ----------- ------------------------------ ---------------------- 3 10/06.21:00 dataset datadir.ds future work
Use the mksnap
command to create a snapshot. A snapshot is a consistent copy of a volume or a file system. Snapshots are supported only for a Network Appliance filer running Data ONTAP 6.4 or later.
See Also:
"Snapshot Commands" for related commandsYou must have the right to manage devices and change device state to use the mksnap
command.
mksnap [ --host/-h hostname ] [ --fs/-f filesystem-name ] [ --nowait/-n ] snapshot-name...
Specifies the name of a Network Data Management Protocol (NDMP) host. If you do not specify a host name, then Oracle Secure Backup uses the value from the host variable.
Specifies the name of an NDMP file system. If you do not specify the --fs
option, then the fs
variable must be set.
Does not wait for the snapshot operation to complete.
Specifies the name to give the snapshot. Snapshot names must conform to the filename rules in effect where the snapshot is created.
Example 2-94 Creating a Snapshot
This example creates a snapshot of the file system /vol/vol0
on the NDMP host named lucy.
ob> mksnap --host lucy --fs /vol/vol0 lucy_snap ob> lssnap --long lucy_snap File system /vol/vol0: Max snapshots: 255 Reserved space: 44.8 GB % reserved space: 30 Snapshot: lucy_snap Of: /vol/vol0 Taken at: 2008/03/28.20:52 Used %: 0 Total %: 0 Busy: no Dependency: no
Use the mkssel
command to create a database backup storage selector. Oracle Secure Backup uses the information encapsulated in storage selectors for a backup job when interacting with Recovery Manager (RMAN). You can modify the storage selector with the chssel command.
See Also:
"Database Backup Storage Selector Commands" for related commands
"Database Backup Storage Selectors and RMAN Media Management Parameters" for an explanation of how storage selectors interact with RMAN media management parameters
Oracle Secure Backup Administrator's Guide for a conceptual explanation of storage selectors
You must have the modify administrative domain's configuration right to use the mkssel
command.
mkssel { --dbname/-d { * | dbname[,dbname]... } | --dbid/-i { * | dbid[,dbid]... } } { --host/-h { * | hostname[,hostname]... } } { --family/-f media-family } [ --content/-c { * | content[,content]... } ] [ --restrict/-r restriction[,restriction]... ] [ --copynum/-n { * | 1 | 2 | 3 | 4 } ] [ --waittime/-w duration ] [ --encryption/-e {off|on|forceoff|swencryption}] sselname
Specifies the names of the databases to which this storage selector object applies. Specifying an asterisk (*
) indicates that the storage selector applies to all database names. You cannot combine the asterisk character (*
) with individual database names.
You must specify either --dbname
, --dbid
, or both. If you specify a database name but not a database ID (DBID), then the DBID defaults to all (*
).
Specifies the DBIDs of the databases to which this storage selector object applies. Specifying an asterisk (*
) indicates that the storage selector applies to all DBIDs. You cannot combine the asterisk character (*
) with individual DBIDs.
You must specify either --dbname
, --dbid
, or both. If you specify a DBID but not a database name, then the database name defaults to all (*
).
Specifies the names of the database hosts to which this storage selector applies. Specifying an asterisk character (*
) indicates that the storage selector applies to all database hosts. You cannot combine the asterisk character (*
) with individual hosts. You must specify at least one host name.
Specifies the name of the media family to be used for backups under the control of this storage selector object. You can specify a media family that uses either a content-managed expiration policy or time-managed expiration policy. You create media families with the mkmf command.
Specifies the backup contents to which this storage selector applies. Refer to "content" for a description of the content
placeholder. Specify an asterisk (*
) to indicate all content types.
Specifies the names of devices to which backups controlled by this storage selector are restricted. By default, Oracle Secure Backup uses device polling to find any available device for use in backup operations. Refer to "restriction" for a description of the restriction
placeholder.
Specifies the copy number to which this storage selector applies. The copy number must be an integer in the range of 1 to 4. Specify an asterisk (*
) to indicate that the storage selector applies to any copy number (default).
Specifies how long to wait for the availability of resources required by backups under the control of this storage selector. The default wait time is 1 hour. Refer to "duration" for a description of the duration
placeholder.
Specifies the name of the database backup storage selector. Storage selector names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.
Specifies whether backups should be encrypted. In all cases, if the data has been encrypted by RMAN, then Oracle Secure Backup performs no further encryption. Set one of the following options for encryption:
ON: Oracle Secure Backup encrypts the backup data unless it has already been encrypted by RMAN.
OFF: Oracle Secure Backup does not encrypt the backup data unless either the host or global policy is set to required. OFF is equivalent to specifying no value for encryption.
FORCEDOFF: Oracle Secure Backup does not encrypt the database backup, overriding any host-specific encryption settings. The FORCEDOFF setting does not affect RMAN, which can still encrypt the backup data.
SWENCRYPTION: Oracle Secure Backup uses software encryption instead of hardware encryption. This option is provided in case you do not want hardware encryption used in some situations.
Note:
Theencryption
option is only available starting with Oracle Secure Backup 10.3.0.2.0.Use the mksum
command to create a job summary schedule. The schedule indicates when and in what circumstances Oracle Secure Backup should generate a backup, restore, or duplication job summary, which is a text file report that indicates whether the job was successful.
See Also:
"Summary Commands" for related commandsYou must have the modify administrative domain's configuration right to use the mksum
command.
mksum [ --days/-d produce-days[,produce-days]... ] [ --reporttime/-t time ] [ --mailto/-m email-target[,email-target]... ] [ --host/-h hostname[,hostname]... ] [ [ --covers/-c duration ] | [ --since/-s "summary-start-day time" ] ] [ --backup/-B { yes | no } ] [ --restore/-R { yes | no } ] [ --orabackup/-b { yes | no } ] [ --orarestore/-e { yes | no } ] [ --scheduled/-S { yes | no } ] [ --user/-U { yes | no } ] [ --subjobs/-J { yes | no } ] [ --superseded/-D { yes | no } ] [ --duplication/-P { yes | no } ] [ --catalog/-C { yes | no } ] [ --mediamovement/-M { yes | no } ] summary-name...
Specifies the days of the week on which to generate a job summary. Refer to "produce-days" for a description of the produce-days
placeholder.
Specifies the time at which to generate a job summary. Refer to "time" for a description of the time
placeholder.
Specifies email addresses of users who receive job summaries. An email system must be operational on the administrative server for this feature to operate. Separate multiple entries with a comma.
Generates reports only for the specified host.
Specifies the time frame covered by the report. Refer to "duration" for a description of the duration
placeholder.
Specifies the starting point of the time period that the report covers. Refer to "summary-start-day" for a description of the summary-start-day
placeholder. Refer to "time" for a description of the time
placeholder.
Specifies whether backup jobs should be included in the report. The default is yes
.
Specifies whether restore jobs should be included in the report. The default is yes
.
Specifies whether Recovery Manager (RMAN) backup jobs should be included in the report. The default is yes
.
Specifies whether RMAN restore jobs should be included in the report. The default is yes
.
Specifies whether all jobs waiting to be processed in the scheduler should be included in the report. A scheduled job is a job that has yet to be run. The default is yes
.
Specifies whether the report should include user-initiated jobs. The default is yes
. If it is set to no
, then the summary only shows scheduled jobs.
Specifies whether the report should include subordinate jobs. The default is yes
.
Specifies whether the report should include all jobs that have identical criteria. The default is no
.
A job is superseded when an identical job was scheduled after the initial job had a chance to run. For example, suppose you schedule an incremental backup scheduled every night at 9 p.m. On Wednesday morning you discover that the Tuesday night backup did not run because no tapes were available in the tape library. The incremental backup scheduled for Wednesday supersedes the backup from the previous night.
Specifies whether volume duplication jobs should be included in the report. The default is yes
.
Specifies that the report should include information about catalog backups, including:
The file number for the catalog backup
Results of the verification step when the backup job was run
Note:
Catalog backups are also listed in summary reports that include information on backup jobs. However, they are mixed in with other backups and not marked specifically as catalog backups. The--catalog
option is intended to help monitor the status of catalog backups independently of other backup jobs.Specifies whether to include media movement jobs in the report. The default is yes
.
Specifies the name of the job summary schedule. Names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 127 characters.
Example 2-96 Scheduling a Job Summary
This example schedules a backup summary named weekly_report
.
ob> mksum --days wed --reporttime 12:00 --mailto lance@example.com weekly_report ob> lssum --long weekly_report: Produce on: Wed at 12:00 Mail to: lance@example.com In the report, include: Backup jobs: yes Restore jobs: yes Scheduled jobs: yes User jobs: yes Subordinate jobs: yes Superseded jobs: no
Example 2-97 Sample Job Summary
This example shows parts of a sample summary. Note that the sample output has been reformatted to fit on the page.
I. Pending jobs. None. II. Ready and running jobs. None. III. Successful jobs. Scheduled or Backup File Volume IDs Job ID *Introduced at Completed at Content Size # (Barcodes) -------------- ---------------- ---------------- --------------------- --------- --- ------- admin/1 *2008/03/24.09:52 2008/03/24.09:52 dataset tbrset/entire_backup admin/1.1 *2008/03/24.09:52 2008/03/24.09:52 host brhost2 3.5 MB 1 VOL000001 (ADE202) admin/2 *2008/03/24.09:52 2008/03/24.09:52 restore to brhost2 IV. Unsuccessful jobs. Scheduled or Job ID *Introduced at Content Status ------------------ ---------------- ------------------------ ------------------------ admin/7 *2008/03/24.16:41 dataset homedir.ds failed - host isn't administrative domain member (OB job mgr) admin/7.1 *2008/03/24.16:41 host brhost4(DELETED) failed - host isn't administrative domain member (OB job mgr)
Use the mkuser
command to define an Oracle Secure Backup user. Each Oracle Secure Backup user account belongs to exactly one class, which defines the rights of the Oracle Secure Backup user.
See Also:
"User Commands" for related commands
You must have the modify administrative domain's configuration right to run the mkuser
command.
When an Oracle Secure Backup user performs a backup or restore operation on a host with the default --unprivileged
option, the host is accessed with an operating system identity.
If a Linux or UNIX host is backed up or restored, then Oracle Secure Backup uses the --unixname
and --unixgroup
values for the operating system identity.
If a Windows host is backed up or restored, then Oracle Secure Backup begins with the first domain triplet in the list—skipping any with a wildcard (*
) for the domain name—and checks whether the domain and username allows access to the host.
Note:
Oracle Secure Backup uses theLookupAccountName
system call to determine whether access is allowed. No attempt at logging on actually occurs during the check, nor is there any attempt to enumerate all the valid Windows domains.If access is allowed, then Oracle Secure Backup uses this logon information to run the job. If access is not allowed, then Oracle Secure Backup proceeds to the next domain triplet in the list. If Oracle Secure Backup does not find a triplet that allows access to the host, then it checks whether a triplet exists with a wildcard (*
) as domain name.
mkuser --class/-c userclass [ --password/-p password | --querypassword/-q ] [ --unixname/-U unix-user ] [ --unixgroup/-G unix-group ] [ --domain/-d { windows-domain | * },windows-account[,windows-password ] ]... [ --ndmpuser/-N { yes | no } ] [ --email/-e emailaddr ] [ --givenname/-g givenname ] [ --preauth/-h preauth-spec[,preauth-spec]... ] username
Specifies the name of the class to which the Oracle Secure Backup user should belong. Table 7-1, "Classes and Rights" describes the predefined classes and rights.
Specifies a password for the Oracle Secure Backup user when logging in to an administrative domain. The maximum character length that you can enter is 16 characters. If you do not specify a password, then the password is null.
The minimum password length is determined by the minuserpasswordlen
security policy. Its default value is 0, which means a null password is permitted.
See Also:
"minuserpasswordlen"The practice of supplying a password in clear text on a command line or in a command script is not recommended by Oracle. It is a security vulnerability. The recommended procedure is to have the Oracle Secure Backup user be prompted for the password.
Specifies that you should be prompted for the password, which is not echoed.
Specifies a user name for a Linux or UNIX host. The default user name is the first defined of guest
, nobody
, none
, and user
.
Specifies a group for a Linux or UNIX host. The default is none
.
Specifies a Windows domain name, user account, and password. If you do not enter the Windows password, then obtool prompts you for it. For windows-domain
, enter an asterisk (*
) if the windows-account
and windows-password
apply to all Windows domains. The --domain
option has no default value.
The Windows user account must have access to the following privileges so that obtar can run:
SeBackupPrivilege
User right: Back up files and directories
SeRestorePrivilege
User Right: Restore files and directories
SeChangeNotifyPrivilege
User right: Bypass traverse checking
You must grant the preceding privileges to the user account when it is created or grant them afterward.
Indicates whether the Oracle Secure Backup user is permitted to log in to an Network Data Management Protocol (NDMP) server. Specify yes
to enable the Oracle Secure Backup user to access an NDMP server and no
if you do not. The default is no
. This login is achieved with an external client program.
Specifies the email address for the Oracle Secure Backup user. When Oracle Secure Backup wants to communicate with this user, such as to deliver a job summary or notify the user of a pending input request, it sends email to this address.
Specifies the given name of the Oracle Secure Backup user if different from the user name, for example, "Jim W. Smith"
for user name jsmith
.
Grants the specified operating system user preauthorized access to the administrative domain as the Oracle Secure Backup user. By default there is no preauthorization.
A preauthorization dictates how an operating system user can be automatically logged in to Oracle Secure Backup. Access is authorized only for the specified operating system user on the specified host. For each host within an Oracle Secure Backup administrative domain, you can declare one or more one-to-one mappings between operating system and Oracle Secure Backup user identities. For example, you can create a preauthorization so that UNIX user bkpadmin
is automatically logged in to obtool as Oracle Secure Backup user admin
.
Refer to "preauth-spec" for a description of the preauth-spec
placeholder. Duplicate preauthorizations are not permitted. Preauthorizations are considered to be duplicates if they have the same hostname, user ID, and domain.
Specifies a name for the Oracle Secure Backup user. User names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 127 characters.
The user name must be unique among all Oracle Secure Backup user names. Formally, it is unrelated to any other name used in your computing environment or the Oracle Secure Backup administrative domain.
Example 2-98 Creating an Oracle Secure Backup User
This example creates an administrative Oracle Secure Backup user named janedoe
. This user runs unprivileged backup and restore operations on Linux and UNIX hosts under the jdoe
operating system account. Because no Windows domains are specified, this user is not permitted to run backup or restore operations on Windows hosts. The jdoe
operating system user is preauthorized to make Recovery Manager (RMAN) backups on host osbsvr1
.
ob> lsuser admin admin sbt admin tadmin admin ob> mkuser janedoe --class admin --password "x45y" --givenname "jane" --unixname jdoe --unixgroup "dba" --preauth osbsvr1:jdoe+rman+cmdline --ndmpuser no --email jane.doe@example.com ob> lsuser admin admin janedoe admin sbt admin tadmin admin
Use the mountdev
command to mount a tape volume that was previously loaded into a tape drive. When a volume is mounted in a tape drive, the Oracle Secure Backup scheduler is notified that the mounted volume is available for use. You can set the mode of use for the volume with the mountdev
options.
You can use this command if the tape drive is not set to automount
, which is the recommended, default setting. In special situations the mountdev
and unmountdev commands provide additional control over your tape drive.
See Also:
"Device Commands" for related commandsYou must have the right to manage devices and change device state to use the mountdev
command.
mountdev { --read/-r | --write/-w | --overwrite/-o }
[ --unmount/-u | --norewind/-R ] devicename ...
Identifies the mount mode as read. In this mode, Oracle Secure Backup mounts the volume for reading only.
Identifies the mount mode as write. In this mode, Oracle Secure Backup mounts the volume so that it can append any backups to the end of the volume.
Identifies the mount mode as overwrite. In this mode, Oracle Secure Backup mounts a volume on the device and positions it at the beginning of the tape so that the existing contents of the volume are overwritten. If you use this option, then you are granting permission to overwrite a volume even though its volume expiration policy might not deem it eligible to be overwritten. Specify this option only in situations that warrant or require overwriting unexpired volumes.
Unmounts the currently mounted tape before running the mount request. If a tape is mounted in the tape drive, and you do not first unmount the tape by specifying --unmount
, then the mountdev
command fails.
Specifies that the tape should not be rewound when Oracle Secure Backup finishes writing to it. This option enables Oracle Secure Backup to remain in position to write the next backup image.
Specifies the device on which you want to mount a volume. Refer to "devicename" for the rules governing device names.
Example 2-99 Manually Mounting a Tape Volume
This example manually unmounts a tape volume from tape drive tape1
, which is automounted, and then manually mounts a tape in write mode. Note that the sample lsdev output has been reformatted to fit on the page.
ob> lsdev --long tape1 tape1: Device type: tape Model: [none] Serial number: [none] In service: yes Library: lib1 DTE: 1 Automount: yes Error rate: 8 Query frequency: 3145679KB (-1073791796 bytes) (from driver) Debug mode: no Blocking factor: (default) Max blocking factor: (default) Current tape: 1 Use list: all Drive usage: 14 seconds Cleaning required: no UUID: b7c3a1a8-74d0-1027-aac5-000cf1d9be50 Attachment 1: Host: brhost3 Raw device: /dev/obt0 ob> mountdev --unmount --write tape1 ob> lsdev --mount tape1 drive tape1 in service write rbtar VOL000003 ADE203
Use the movevol
command to move a volume from one element to another element within a tape library. You can only move one volume at a time.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the movevol
command.
movevol [ --library/-L libraryname | --drive/-D drivename ] { vol-spec | element-spec } element-spec
Specifies the name of the tape library in which you want to move a volume.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Specifies the name of a tape drive in the tape library in which you want to move a volume.
If you do not specify --library
or --drive
, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.
Specifies the volume to be moved. Refer to "vol-spec" for a description of the vol-spec
placeholder.
Specifies the number of a storage element, import/export location, or a tape drive. Refer to "element-spec" for a description of the element-spec
placeholder.
If you specify vol-spec
, then element-spec
represents the location to which the volume should be moved. If you specify element-spec
twice, then the first represents the location from which the volume should be moved and the second represents the location to which the volume should be moved.
This example moves the volume in storage element 3 to the import/export element iee3
. Note that the sample output has been reformatted to fit on the page.
ob> lsvol --library lib1 --long Inventory of library lib1: in mte: vacant in 1: vacant in 2: volume VOL000001, barcode ADE201, oid 102, 48319392 kb remaining in 3: volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47725600 kb remaining, content manages reuse in 4: vacant in iee1: barcode ADE203, oid 114, 47725344 kb remaining, lastse 4 in iee2: volume VOL000002, barcode ADE204, oid 110, 47670368 kb remaining, lastse 1 in iee3: vacant in dte: vacant ob> movevol --library lib1 3 iee3 ob> lsvol --library lib1 --long Inventory of library lib1: in mte: vacant in 1: vacant in 2: volume VOL000001, barcode ADE201, oid 102, 48319392 kb remaining in 3: vacant in 4: vacant in iee1: barcode ADE203, oid 114, 47725344 kb remaining, lastse 4 in iee2: volume VOL000002, barcode ADE204, oid 110, 47670368 kb remaining, lastse 1 in iee3: volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47725600 kb remaining, content manages reuse, lastse 3 in dte: vacant
Use the opendoor
command to open the import/export door of a tape library. This command only works for libraries that support it.
The import/export door is a mechanism that an operator uses to transfer tapes into and out of the tape library. You can then run the importvol command to move volumes to internal slots in the tape library and the exportvol command to move volumes out of the tape library. Because the tape library itself is not opened during this process, a reinventory is not required.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the opendoor
command.
opendoor [ --library/-L libraryname ]
Specifies the name of the tape library on which you want to open the import/export door. If you do not specify a tape library name, then the library variable must be set.
Example 2-101 Opening an Import/Export Door
This example opens the import/export door in tape library lib1
.
ob> lsvol --library lib1 --long Inventory of library lib1: in mte: vacant in 1: vacant in 2: volume VOL000001, barcode ADE201, oid 102, 48319392 kb remaining in 3: vacant in 4: vacant in iee1: barcode ADE203, oid 114, 47725344 kb remaining, lastse 4 in iee2: volume VOL000002, barcode ADE204, oid 110, 47670368 kb remaining, lastse 1 in iee3: volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47725600 kb remaining, content manages reuse, lastse 3 in dte: vacant ob> opendoor --library lib1
Use the pingdev
command to determine whether a device is accessible to Oracle Secure Backup with all configured attachments.
For each attachment defined for the device, Oracle Secure Backup performs the following steps:
Establishes a connection to the device
Queries the device's identity by using the Small Computer System Interface (SCSI) inquiry
command
Closes the connection
For each attachment that is remote from the host running obtool, Oracle Secure Backup establishes a Network Data Management Protocol (NDMP) session with the remote media server to test the attachment.
See Also:
"Device Commands" for related commandsYou must have the right to manage devices and change device state to use the pingdev
command.
pingdev [ --nohierarchy/-H ] [ --quiet/-q | --verbose/-v ] [ --host/-h hostname ]... { --all/-a | devicename ... }
Suppresses access to each tape drive contained in a tape library. By default, obtool pings each tape drive contained in the tape library.
Suppresses output. By default, obtool displays the output shown in Example 2-102.
Displays verbose output as shown in the following sample output:
ob> pingdev --verbose lib1 Info: pinging library lib1. Info: library lib1 accessible. Info: pinging drive tape1. Info: drive 1 tape1 accessible.
By default, obtool displays the output shown in Example 2-102.
Specifies the name of the host computer whose attached devices you are pinging.
Pings all defined devices.
Specifies the name of the device to ping. Refer to "devicename" for the rules governing device names.
Example 2-102 Pinging a Tape Drive with Multiple Attachments
This example pings the tape drive called tape3
. The tape device has attachments to multiple hosts.
ob> pingdev tape3 Info: drive tape3 via host osbsvr1 accessible. Info: drive tape3 via host brhost3 accessible. ob> pingdev --host brhost3 tape3 Info: drive tape3 via host brhost3 accessible.
Use the pinghost
command to determine whether a host in an administrative domain is responsive to requests from Oracle Secure Backup. This operation is useful for ensuring that a host is responsive on all of its configured IP addresses.
See Also:
"Host Commands" for related commandsYou must have the display administrative domain's configuration right to use the pinghost
command.
This command attempts to establish a TCP connection to the host on each of the IP addresses that you have configured for it. For hosts that use the Oracle Secure Backup protocol, the command connects through TCP port 400; for hosts using Network Data Management Protocol (NDMP), it connects through the configured NDMP TCP port, usually 10000. Oracle Secure Backup reports the status of each connection attempt and immediately closes each connection that was established successfully.
pinghost [ --quiet/-q | --verbose/-v ] hostname...
Suppresses output.
Displays output. This option is the default.
Specifies the name of the host computer to ping.
This example queries the hosts in the administrative domain and then pings host brhost2
.
ob> lshost brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service sfserver1 client (via OB) in service ndmphost1 client (via NDMP) in service osbsvr1 admin,mediaserver,client (via OB) in service ob> pinghost brhost2 brhost2 (address 192.0.2.1): Oracle Secure Backup and NDMP services are available
Use the pwd
command to display the name of the directory in the Oracle Secure Backup catalog that you are browsing.
See Also:
"Browser Commands" for related commandsThe rights needed to use the pwd
command depend on the browse backup catalogs with this access setting for the class.
pwd [ --short/-s | --long/-l ] [ --noescape/-B ]
Displays data in short form.
Displays data in long form.
Does not escape non-displayable characters in path name. Specify --noescape
if you want path names that include an ampersand character (&
) to display normally.
Use the pwdds
command to show the name of the current directory in the dataset directory tree.
See Also:
"Dataset Commands" for related commandsYou must have the display administrative domain's configuration right to use the pwdds
command.
pwdds
Example 2-105 Displaying the Current Directory
This example shows the current directory, changes into a different directory, and then shows the current directory again.
ob> pwdds / (top level dataset directory) ob> lsds Top level dataset directory: mydatasets1/ mydatasets/ admin_domain.ds ob> cdds mydatasets ob> pwdds /mydatasets
Use the pwdp
command to display the identity of the current policy.
The policy data is represented as a directory tree with /
as the root. You can use cdp to navigate the tree and lsp and pwdp
to display data.
See Also:
"Policy Commands" for related commands
Appendix 6, "Defaults and Policies" for a complete list of policies and policy classes
You must have the display administrative domain's configuration right to use the pwdp
command.
pwdp
Example 2-106 Displaying the Current Directory in the Policy Tree
This example uses cdp to browse the policies and pwdp
to display the current directory in the policy directory tree.
ob> pwdp / ob> lsp daemons daemon and service control policies devices device management policies index index catalog generation and management policies local Oracle Secure Backup configuration data for the local machine logs log and history management policies media general media management policies naming WINS host name resolution server identification ndmp NDMP Data Management Agent (DMA) defaults operations policies for backup, restore and related operations scheduler Oracle Secure Backup backup scheduler policies security security-related policies testing controls for Oracle Secure Backup's test and debug tools ob> cdp daemons/auditlogins ob> pwdp /daemons/auditlogins ob> lsp auditlogins no [default] ob> cdp ../.. ob> pwdp / ob> lsp daemons daemon and service control policies devices device management policies index index catalog generation and management policies local Oracle Secure Backup configuration data for the local machine logs log and history management policies media general media management policies naming WINS host name resolution server identification ndmp NDMP Data Management Agent (DMA) defaults operations policies for backup, restore and related operations scheduler Oracle Secure Backup backup scheduler policies security security-related policies testing controls for Oracle Secure Backup's test and debug tools
Use the quit
command to exit obtool. This command is identical in functionality to the exit command.
See Also:
"Miscellaneous Commands" for related commandsquit [ --force/-f ]
Exits obtool even if there are pending backup or restore requests. Specifying --force
means that pending backup and restore requests are lost.
Normally, you cannot quit obtool when there are pending requests. You should submit pending requests to the scheduler by specifying --go
on the backup or restore commands.
This example uses the --force
option to quit obtool when a backup job is pending.
ob> backup --dataset fullbackup.ds ob> quit Error: one or more backup requests are pending. Use "quit --force" to quit now, or send the requests to the scheduler with "backup --go". ob> quit --force
Recalls a tape volume from an offsite storage location.
See Also:
"Volume Rotation Commands"You must have the modify administrative domain's configuration right to use the recallvol
command.
If you specify a volume ID that matches multiple volumes in the Oracle Secure Backup volumes catalog, then Oracle Secure Backup asks which volume or volumes you want to recall. You can select one or more of the volumes, all of them, or none of them. The default selection is all volumes.
If you specify a volume ID and the volume belongs to a volume set, then Oracle Secure Backup lists all volumes in the volume set. You can select all or none of them, but you cannot select individual members of the volume set. The default selection is quit
, which means that no volumes are selected.
See Also:
"chvol" for a pair of examples illustrating volume ID matchingrecallvol [ --immediate/-I ] [ --piece/-p piecename | vol-spec ] [ --tolocation/-t locationname ]
Creates a media movement job immediately.
Recall the volume or volumes containing the specified backup piece. The --piece
and vol-spec
options are mutually exclusive.
The volume ID or the barcode value of the volume. The --piece
and vol-spec
options are mutually exclusive.
Specifies the location to which the volumes should be recalled. If the --tolocation
option is not specified for the recallvolume command, then the volume are recalled to the originating location.
Releases recalled volumes, for return to the location dictated by their rotation policies.
See Also:
"Volume Rotation Commands"You must have the modify administrative domain's configuration right to use the releasevolume
command.
If you specify a volume ID that matches multiple volumes in the Oracle Secure Backup volumes catalog, then Oracle Secure Backup asks which volume or volumes you want to release. You can select one or more of the volumes, all of them, or none of them. The default selection is all volumes.
If you specify a volume ID and the volume belongs to a volume set, then Oracle Secure Backup lists all volumes in the volume set. You can select all or none of them, but you cannot select individual members of the volume set. The default selection is quit.
See Also:
"chvol" for a pair of examples illustrating volume ID matching
releasevol
{ --all/-a | vol-spec }
Use the renclass
command to rename an Oracle Secure Backup user class.
See Also:
"Class Commands" for related commands
Appendix 7, "Classes and Rights" for a descriptions of the default Oracle Secure Backup classes and rights
You must have the modify administrative domain's configuration right to use the renclass
command.
renclass [ --nq ] { old-classname new-classname }...
Does not display a confirmation message. Without this option, the command displays a confirmation message. "obtool Interactive Mode" describes the confirmation message.
Renames old-classname
to new-classname
. Class names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.
Use the rendev
command to rename a configured device.
See Also:
"Device Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rendev
command.
rendev [ --nq ] { old-devicename new-devicename }...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of the existing device. Refer to "devicename" for the rules governing device names.
Specifies the name for the device. Refer to "devicename" for the rules governing device names.
Example 2-109 Renaming a Device
This example renames two tape devices.
ob> lsdev library lib1 in service drive 1 tape1 in service library lib2 in service drive 1 tape2 in service ob> rendev tape1 t1 tape2 t2 rename device tape1? (a, n, q, y, ?) [y]: y rename device tape2? (a, n, q, y, ?) [y]: y ob> lsdev library lib1 in service drive 1 t1 in service library lib2 in service drive 1 t2 in service
Use the rends
command to rename a dataset file or dataset directory. For example, the following command renames old_file
to new_file
and moves it from old_dir
to new_dir
:
ob> rends old_dir/old_file new_dir/new_file
The following command creates new_file in the current directory:
ob> rends old_dir/old_file new_file
See Also:
"Dataset Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rends
command.
rends [ --nq ] { old-dataset-name new-dataset-name }...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of the existing dataset file or directory to rename. Refer to "dataset-name" for a descriptions of the dataset-name
placeholder.
Specifies a name for the dataset file or directory. Note that you can use new-dataset-name
to specify a dataset path. Refer to "dataset-name" for a descriptions of the dataset-name
placeholder.
Example 2-110 Renaming a Dataset
This example renames dataset datadir.ds
in the top-level directory to tbrset/ddir.ds
.
ob> lsds Top level dataset directory: tbrset/ datadir.ds ob> rends --nq datadir.ds tbrset/ddir.ds ob> cdds tbrset ob> lsds Dataset directory tbrset: ddir.ds entire_backup tiny_backup
See Also:
"Volume Duplication Commands"You must have the modify administrative domain's configuration right to use the rendup
command.
rendup::=
rendup [ --nq/--noquery ] { oldpolicyname newpolicyname } [ oldpolicyname newpolicyname... ]
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
For each pair of duplication policy names, the policy with the first name in the pair is renamed to the second name in the pair
Use the renhost
command to rename a configured Oracle Secure Backup host.
See Also:
"Host Commands" for related commandsYou must have the modify administrative domain's configuration right to use the renhost
command.
renhost [ --nq ] [ --nocomm/-N ] { old-hostname new-hostname }...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Suppresses communication with the host computer. Use this option to rename a computer that is not connected to the network.
Specifies the name of the existing host to rename.
Specifies the name for the host. Host names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.
Example 2-111 displays configured hosts and then renames ndmphost1 to ndmphost.
ob> lshost brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service sfserver1 client (via OB) in service ndmphost1 client (via NDMP) in service osbsvr1 admin,mediaserver,client (via OB) in service ob> renhost --nq ndmphost1 ndmphost ob> lshost brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service sfserver1 client (via OB) in service ndmphost client (via NDMP) in service osbsvr1 admin,mediaserver,client (via OB) in service
Renames a storage location.
See Also:
"Location Commands" for related commandsYou must have the modify administrative domain's configuration right to use the renloc
command.
renloc::=
renloc [ --nq ] oldlocationname newlocationname [ oldlocationname newlocationname... ]
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
For each pair of location name arguments, the location with the first name in the pair is renamed to the second name in the pair.
Use the renmf
command to rename a media family.
See Also:
"Media Family Commands" for related commandsYou must have the modify administrative domain's configuration right to use the renmf
command.
renmf [ --nq ] { old-media-family-name new-media-family-name }...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of the existing media family. Note that you cannot rename the RMAN-DEFAULT
media family.
Specifies the name for the media family. Media family names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 31 characters.
Example 2-112 Renaming a Media Family
This example renames media family full_bkup
to full_backup
.
ob> lsmf RMAN-DEFAULT content manages reuse content-man-family write forever content manages reuse full_bkup write 7 days content manages reuse time-man-family write 7 days keep 28 days ob> renmf full_bkup full_backup rename media family full_bkup? (a, n, q, y, ?) [y]: y ob> lsmf RMAN-DEFAULT content manages reuse content-man-family write forever content manages reuse full_backup write 7 days content manages reuse time-man-family write 7 days keep 28 days
See Also:
"Rotation Policy Commands"You must have the modify administrative domain's configuration right to use the renrot
command.
renrot::=
renrot [ -nq ] oldpolicyname newpolicyname [ oldpolicyname newpolicyname... ]
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
For each pair of policy names, the policy with the first name in the pair is renamed to the second name in the pair. Oracle Secure Backup rotation policy names must be 1-31 characters.
Use the rensched
command to rename a schedule. Run the lssched command to display schedule names.
See Also:
"Schedule Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rensched
command.
rensched [ --nq ] { old-schedulename new-schedulename }...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of an existing schedule.
Specifies a name for the old-schedulename
schedule. Schedule names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.
Example 2-113 Renaming a Backup Schedule
Example 2-113 renames schedule full_backup
to weekday_sunday_backup
.
ob> lssched full_backup sundays, weekdays fullbackup.ds ob> rensched --nq full_backup weekday_sunday_backup ob> lssched weekday_sunday_backup sundays, weekdays fullbackup.ds
Use the rensnap
command to rename a snapshot.
See Also:
"Snapshot Commands" for related commandsYou must have the right to manage devices and change device state to use the rensnap
command.
rensnap [ --nq ] [ --host/-h hostname ] [ --fs/-f filesystem-name ] { old-snapshot-name new-snapshot-name }...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of the Network Data Management Protocol (NDMP) host computer where you want to rename the snapshot. If you do not specify a host name, then Oracle Secure Backup uses the value from the host variable.
Specifies the name of the file system included in the snapshot. If you do not specify the --fs
option, then the fs
variable must be set.
Specifies the name of an existing snapshot.
Specifies a name for old-snapshot-name
.
Example 2-114 Renaming a Snapshot
This example renames snapshot lucy_snap
to lucy.0
.
ob> lssnap --long lucy_snap File system /vol/vol0: Max snapshots: 255 Reserved space: 44.8 GB % reserved space: 30 Snapshot: lucy_snap Of: /vol/vol0 Taken at: 2008/03/28.20:52 Used %: 0 Total %: 0 Busy: no Dependency: no ob> rensnap --nq --host lucy --fs /vol/vol0 lucy_snap lucy.0 ob> lssnap File system /vol/vol0: Snapshot Of Taken at %Used %Total Snapshot Name /vol/vol0 2008/03/28.21:00 0 0 hourly.0 /vol/vol0 2008/03/28.20:52 0 0 lucy.0 /vol/vol0 2008/03/28.17:00 0 0 hourly.1 /vol/vol0 2008/03/28.13:00 0 0 hourly.2 /vol/vol0 2008/03/28.05:00 0 0 nightly.0 /vol/vol0 2008/03/28.01:00 0 0 hourly.3 /vol/vol0 2008/03/27.21:00 0 0 hourly.4 /vol/vol0 2008/03/27.17:00 0 0 hourly.5 /vol/vol0 2008/03/27.05:00 0 0 nightly.1 /vol/vol0 2007/08/21.11:30 22 7 myhost_snap
Use the renssel
command to rename a database backup storage selector.
See Also:
"Database Backup Storage Selector Commands" for related commandsYou must have the modify administrative domain's configuration right to use the renssel
command.
renssel [ --nq ] { old-sselname new-sselname }...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of the existing database backup storage selector.
Specifies the name of a database backup storage selector.
Example 2-115 Renaming a Database Backup Storage Selector
This example uses the mkssel command to create a storage selector and specifies the content as full. The example uses the chssel command to add archived logs to the content of the selector, then renames the selector from ssel_full
to ssel_full_arch
.
ob> mkssel --dbid 1557615826 --host brhost2 --content full --family f1 ssel_full ob> chssel --addcontent archivelog ssel_full ob> renssel ssel_full ssel_full_arch rename ssel ssel_full? (a, n, q, y, ?) [y]: y ob> lsssel --short ssel_full_arch
Use the rensum
command to rename a job summary schedule.
See Also:
"Summary Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rensum
command.
rensum [ --nq ] { old-summary-name new-summary-name }...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of an existing job summary schedule.
Specifies the name of the job summary schedule. Names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 127 characters.
Use the renuser
command to rename an Oracle Secure Backup user.
See Also:
"User Commands" for related commandsYou must have the modify administrative domain's configuration right to use the renuser
command.
renuser [ --nq ] { old-username new-username }...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the current Oracle Secure Backup user name.
Specifies the name for the Oracle Secure Backup user. User names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 127 characters.
Use the resdev
command to reserve a tape device for your exclusive use. While you hold the reservation, no Oracle Secure Backup component accesses the device.
See Also:
"Device Commands" for related commandsYou must have the right to manage devices and change device state to use the resdev
command.
During normal operations, Oracle Secure Backup temporarily assigns exclusive use of shared resources to its processes and jobs. It assigns this use through a built-in resource reservation system managed by the service daemons on the administrative server.
You might encounter situations in which you want exclusive and explicit use of a device. When such situations arise, you can direct Oracle Secure Backup to reserve a device for your use and, when you are finished, to release that reservation with the unresdev command. While you hold the reservation, no Oracle Secure Backup component can access the device.
The resdev
command fails with an error if you try to reserve a device that is reserved. The command also fails if you attempt to select a tape drive in a tape library but all devices are reserved or no tape drives are configured.
resdev [ --nowarn/-W ] { --in/-i libraryname ... | devicename ... }
Does not warn about devices that are out of service.
Finds and reserves any reservable tape drive in the specified libraries.
Specifies either the name of a tape drive or a tape library to be reserved.
Refer to "devicename" for the rules governing device names.
Example 2-118 Reserving a Device
This example reserves all tape drives in tape library lib1
. In this example, lib1
contains a single tape drive. The example shows the warnings that result from attempting to reserve a reserved tape drive.
ob> lsdev library lib1 in service drive 1 tape1 in service library lib2 in service drive 1 tape2 in service ob> lsdev --reserved ob> resdev --in lib1 Drive tape1 reserved. ob> resdev --in lib1 Error: no drive is available in library lib1. ob> resdev tape1 Error: you already have drive tape1 reserved.
Use the resetp
command to reset the value of a one or more policies to the default value.
The policy data is represented as a directory tree with /
as the root. You can use cdp to navigate the tree and lsp and pwd to display data.
See Also:
"Policy Commands" for related commands
Appendix 6, "Defaults and Policies" for a complete list of policies and policy classes
You must have the modify administrative domain's configuration right to use the resetp
command.
resetp [ --nq ] policy-name...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of a policy or a class of policies.
Example 2-119 Resetting Policies to Their Default Values
This example resets the policies in the logs
class to their defaults.
ob> lsp logs adminlogevents all adminlogfile /tmp/logs/adminevents.log clientlogevents (none) [default] jobretaintime 60 days logretaintime 14 days transcriptretaintime 14 days unixclientlogfile (none) [default] windowsclientlogfile (none) [default] ob> resetp logs Really reset ALL logs policies [no]? y ob>
Use the restore
command to create a file-system restore request. File-system restore operations are distinct from database restore operations, which are initiated by Recovery Manager (RMAN).
You can use the restore
command to perform catalog-based or raw restore operations. In a catalog-based restore, you browse the catalog for the objects to be restored. When you have located their names and selected the instances, you can restore the objects. In a raw restore, you must have independent knowledge of the secondary storage location (volume ID and backup image file number) of a backup. You can either restore all data in the backup or specify an individual file or directory.
A restore request is held locally in obtool until you run the restore
command with the --go
, --gocatalog
, or --goraw
option, at which time Oracle Secure Backup converts all restore requests into jobs and sends them to the Oracle Secure Backup scheduler.
See Also:
"Restore Commands" for related commandsIf you have specified that the restore run in privileged mode, or if you are restoring files to a host accessed through Network Data Management Protocol (NDMP), then you must have the right to perform file system restores as privileged user to use the restore
command. Otherwise, you must have the right to perform file system restores as self.
obtool uses the host variable to determine the name of the host whose backups are being restored. The default value for host
is the name of the host on which obtool is running. You can set the host
variable with the set or cd command.
If you specify a volume ID that matches multiple volumes in the Oracle Secure Backup volumes catalog, then Oracle Secure Backup asks which volume or volumes you want to recall. You can select one or more of the volumes, all of them, or none of them. The default selection is all volumes.
If you specify a volume ID and the volume belongs to a volume set, then Oracle Secure Backup lists all volumes in the volume set. You can select all or none of them, but you cannot select individual members of the volume set. The default selection is quit.
See Also:
"chvol" for a pair of examples illustrating volume ID matchingUse the following syntax to restore data by browsing the Oracle Secure Backup catalog.
restore [ --tohost/-h hostname ] [ --device/-d drivename ] [ --privileged/-g | --unprivileged/-G ] [ --replaceexisting/-e | --keepexisting/-E ] [ --replaceinuse/-u | --keepinuse/-U ] [ --incremental/-i ] [ --noposition/-X ] [ --priority/-p schedule-priority ] [ --select/-s data-selector[,data-selector]... ] [ --passphrase/-P string | --querypassphrase/-Q ] [ --algorithm/-l ] [ --ignoremismatch/-w] [ --obtaropt/-o obtar-option ]... [ --preview/-y [ --recall/-r ] | --go | --gocatalog | --goraw ] { pathname [ --aspath/-a pathname ] }...
Specifies the name of the host computer to which you want to restore data.
Specifies a tape drive used to perform the restore operation. The tape drive name must be a valid device name. Refer to "devicename" for the rules governing device names.
Specifies that the restore operation should run in privileged mode.
On UNIX systems, a privileged restore job runs under the root
user identity. On Windows systems, the job runs under the same account identity as the Oracle Secure Backup service on the Windows client.
Specifies that the restore operation should run in unprivileged mode (default).
An unprivileged restore job runs under the UNIX user or Windows account identity specified in the mkuser command. Access to file-system data is constrained by the rights of the UNIX user or Windows account having this identity.
Overwrites existing files (default).
Does not overwrite existing files.
Replaces in-use files with those from the backup image. Windows deletes each in-use file when the last user closes it. This option is available on Windows only.
Leaves in-use files unchanged (default). This option is available on Windows only.
Directs Network Attached Storage (NAS) data servers to apply incremental restore rules. This option applies only to NAS data servers that implement this feature. This option does not apply to a file-system backup created with obtar.
Normally, restore operations are additive: each file and directory restored from a full or an incremental backup is added to its destination directory. If files have been added to a directory since the most recent Oracle Secure Backup backup, then a restore operation does not remove the newly added files.
When you specify --incremental
, NAS data servers restore each directory to its state during the last incremental backup. Files that were deleted before the last incremental backup are deleted by the NAS data service when restoring this incremental backup.
For example, assume you make an incremental backup of /home
, which contains file1
and file2
. You delete file1
and make another incremental backup of /home
. After a normal restore of /home
, the directory would contain file1
and file2
; after an NDMP incremental restore of /home
, the directory would contain only file2
.
Indicates that Oracle Secure Backup should not use available position data to speed the restore operation. You might use this option if position data is corrupted.
A schedule priority you assign to a restore.
See "schedule-priority" for more information on the schedule-priority
placeholder.
Filters data based on the specified data-selector
.
See "data-selector" for more information on the data-selector
placeholder.
Specifies a passphrase-generated decryption key for the entire backup volume set to be restored.
Queries the operator for a passphrase to use in generating decryption keys for the entire backup volume set to be restored.
Specifies the backup algorithm to use for decryption during restore. Required if --passphrase
is used.
Causes mismatches of the encryption algorithm or passphrase as supplied by the --algorithm
or --passphrase
options to be treated as warnings instead of failures. This option is targeted at the situation where the header on the tape has been corrupted, but you still want to recover as much of the encrypted data as possible.
Mismatched encryption parameters are processed at different times depending on the restore type. For a raw restore the mismatch is caught and handled after the job is created, the tape is loaded, and the header is read off the tape. The job transcript for the raw restore reflects the encryption parameter mismatch. For a catalog-based restore, however, the mismatch is caught immediately and the job is never created.
Specifies obtar options. For example -J
enables debug mode and provides more details in the restore transcript.
See "obtar Options" for more information on obtar options.
Lists the volumes needed for a restore and gets their status as either onsite
or offsite
. An onsite
status means that the volume is in a library or drive. An offsite
status means that the volume is in a storage location and must be recalled.
This option is available only for catalog restore operations. It is not supported for raw restore operations.
Starts recalls for any volumes needed by a restore if the volumes are offsite
.
This option is available only for catalog restore operations. It is not supported for raw restore operations.
Releases all queued restore requests to the Oracle Secure Backup scheduler.
Releases queued restore requests from a backup catalog to the Oracle Secure Backup scheduler.
Releases queued raw restore requests to the Oracle Secure Backup scheduler. A raw restore request does not use backup catalog data.
Specifies the path name obtained by browsing the backup catalog for files that you backed up. If you do not specify --aspath
, then Oracle Secure Backup restores the backup to the same path. If pathname
does not exist on the host to which you are restoring, then Oracle Secure Backup creates it.
For example, assume that you browse the backup catalog for brhost2
and locate the /home
directory, which you want to restore. The restore /home
command restores the backup to the /home
directory on brhost2
.
Specifies an alternative path name where Oracle Secure Backup can restore the files. For example, to restore a backup of /home
to /tmp/home
, specify restore
/home
--aspath /tmp/home
.
Note that if pathname
does not exist on the host to which you are restoring, then Oracle Secure Backup creates it.
Use the following syntax for raw restore operations.
restore --raw/-R [ --tohost/-h hostname ] [ --device/-d drivename ] [ --privileged/-g | --unprivileged/-G ] [ --passphrase/-P string ] [ --querypassphrase/-Q ] [ --algorithm/-l ] { --filenumber/-F filenumber } { --vid/-v vid[,vid ]... } [ --tag/-t tag[,tag]... ] [ --replaceexisting/-e | --keepexisting/-E ] [ --replaceinuse/-u | --keepinuse/-U ] [ --incremental/-i ] [ --priority/-p schedule-priority ] [ --obtaropt/-o obtar-option ]... [ --go | --gocatalog | --goraw ] { --all/-A pathname | {[ --aspath/-a pathname ] [ --position/-x position ] ... }}
This section describes additional options used in Syntax 2. Options that are also used with Syntax 1 are not described in this section.
Specifies a raw restore operation, which is a restore operation that does not use an Oracle Secure Backup catalog. You must specify the identity (volume ID or barcode) of the tape volumes to which the file-system objects were backed up and the backup image file number in which they are stored.
Specifies the file number on the tape where the backup is located. Refer to "filenumber" for a description of the filenumber
placeholder.
Selects backups based on volume ID. Refer to "vid" for a description of the vid
placeholder.
Selects backups based on the volume tag (barcode).
Restores all data in the backup.
Specifies the absolute path name of the file or directory that you backed up. If you do not know the absolute path names for the files when they were backed up, then you can use obtar -tvf
to find them or restore an entire backup image. If you do not specify --aspath
, then Oracle Secure Backup restores the backup to the same path.
Oracle Secure Backup does not support the use of wildcard characters in restore path names. The following wildcard characters are supported for backup include paths: *
, ?
, [
, and ]
. If you have path names to restore that include any of these wildcard characters, then no special escaping is required for the restore
command.
Note that if pathname
does not exist on the host to which you are restoring, then Oracle Secure Backup creates it.
Specifies an alternative path name where Oracle Secure Backup can restore the files. For example, to restore a backup of /private/bkpadmin
to /tmp/private/bkpadmin
, specify the following:
ob> restore /private/bkpadmin --aspath /tmp/private/bkpadmin
Note that if pathname
does not exist on the host to which you are restoring, then Oracle Secure Backup creates it.
Specifies the position of the data on the tape.
Example 2-120 Performing an Oracle Secure Backup Catalog Restore
This example displays the latest backup image of the /home/data
directory stored in the Oracle Secure Backup catalog. The restore
command submits the request to the scheduler with priority 1. Oracle Secure Backup runs the job and restores the data.
ob> set host brhost2 ob> cd /home/data ob> ls bin/ c_files/ tree/ ob> lsbackup latest Backup Backup Volume Volume File Sect Backup Date and Time ID ID Tag # # Level 2008/03/28.11:17:02 2 VOL000003 ADE201 1 1 0 ob> restore --select latest --priority 1 --go /home/data Info: 1 catalog restore request item submitted; job id is admin/16. ob> lsjob admin/16 Job ID Sched time Contents State ---------------- ----------- ------------------------------ --------------------------------------- admin/16 none restore 1 item to brhost2 completed successfully at 2008/03/29.16:34
Example 2-121 Performing a Raw Restore Operation
This example submits a raw restore request to the scheduler. The request specifies that the /home/data
directory should be restored from volume VOL000003
. Oracle Secure Backup runs the job and restores the data.
ob> restore --raw --filenumber 1 --vid VOL000003 /home/data ob> restore --go Info: raw restore request 1 submitted; job id is admin/76. ob> lsjob admin/7 Job ID Sched time Contents State ---------------- ----------- ------------------------------ --------------------------------------- admin/7 none restore 1 item to brhost2 completed successfully at 2008/03/29.17:00
Use the returndev
command to return a tape drive that you borrowed with the borrowdev command.
See Also:
"Device Commands" for related commandsYou must have the right to manage devices and change device state to use the returndev
command.
returndev { drivename... | --all/-a }
Specifies the name of the tape drive to return.
Returns all the tape drives that you currently have borrowed.
Use the reusevol
command to recycle selected volumes. Oracle Secure Backup loads the selected volumes and deletes their backup images.
Each volume has a volume label stored at Beginning of Tape (BOT). The label consists of the volume ID, the barcode tag (if any), and other information about the volume. The reusevol
command is similar to the unlabelvol command, but reusevol
directs Oracle Secure Backup to preserve the existing volume label.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the reusevol
command.
reusevol [ --drive/-D drivename ] [ --force/-f ] [ --obtaropt/-o obtar-option ]... se-range
Specifies the name of the tape drive to be used to relabel the volume. If you do not specify a tape drive name, then the drive variable must be set.
Forces the reuse of a volume. Oracle Secure Backup disregards the expiration date, if any, found in the volume label. If the --force
option is not employed and the volume is not expired, then reusevol
fails.
Specifies obtar options. For example -J
enables debug mode and provides more details in backup and restore transcripts. See "obtar Options" for details on obtar options.
Specifies the range of storage elements holding the volumes to be reused. If omitted, then the volume currently loaded in the tape drive is reused. Refer to "se-range" for a description of the se-range
placeholder.
Example 2-123 Reusing a Volume
This example displays information about the tape located in storage element 2 of tape library lib1
. The volume in this storage element is not empty. The reusevol
command forcibly reuses the volume, thereby deleting its contents and removing its volume ID. The barcode of the volume is retained. Note that the sample output has been reformatted to fit on the page.
ob> lsvol --long --library lib1 Inventory of library lib1: in mte: vacant in 1: barcode ADE202, oid 117, 47447360 kb remaining, content manages reuse in 2: volume VOL000004, barcode ADE204, oid 120, 47420448 kb remaining in 3: barcode ADE201, oid 116, 47462976 kb remaining in 4: volume VOL000001, barcode ADE200, oid 102, 47424064 kb remaining in iee1: barcode ADE203, oid 114, 47725344 kb remaining, lastse 4 in iee2: vacant in iee3: vacant in dte: vacant ob> lsvol --barcode ADE204 --content VOID Seq Volume ID Barcode Family Created Attributes 120 1 VOL000004 ADE204 04/01.09:16 never closes BSOID File Sect Level Host Created Attributes 172 1 1 0 brhost2 04/01.09:16 ob> reusevol --drive tape1 --force 2 ob> lsvol --barcode ADE204 --content VOID Seq Volume ID Barcode Family Created Attributes 122 ADE204
Use the revhost
command to revoke a host identity certificate.
See Also:
Oracle Secure Backup Installation and Configuration Guide for more information on revoking a host identity certificate
"Host Commands" for related commands
You must have the modify administrative domain's configuration right to use the revhost
command.
revhost [ --nq ] hostname...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
The name of the host whose identity certificate is to be revoked.
Use the rmbackup
command to remove a backup request, set of backup requests, or all backup requests that are queued in obtool. A backup request is held locally in obtool until you run the backup command with the --go
option, at which time Oracle Secure Backup makes each backup request into a dataset backup job and forwards it to the scheduler.
See Also:
"Backup Commands" for related commandsYou must have the perform file system backups as privileged user right if you specified the --privileged
option when you requested the backup. Otherwise, you must have the perform file system backups as self right.
rmbackup { --all/-a | backup-item... }
Removes all backup requests in the queue.
Specifies an identifier assigned by obtool to a backup request created with the backup command. The identifier is a small integer number. Run the lsbackup command with the --long
option to display backup identifiers.
Example 2-124 Deleting a Backup Request
This example queries the backup requests awaiting delivery to the scheduler and deletes the backup request with the identifier 2
.
ob> lsbackup --long 1: Dataset: fullbackup.ds Media family: (null) Backup level: full Priority: 100 Privileged op: no Eligible to run: upon "backup --go" Job expires: never Restriction: any device 2: Dataset: partialbackup.ds Media family: (null) Backup level: full Priority: 100 Privileged op: no Eligible to run: upon "backup --go" Job expires: never Restriction: any device ob> rmbackup 2 ob> lsbackup --long 1: Dataset: fullbackup.ds Media family: (null) Backup level: full Priority: 100 Privileged op: no Eligible to run: upon "backup --go" Job expires: never Restriction: any device
Use the rmbw
command to remove a backup window or specific time ranges. The command displays an error if no backup windows within the specified range exist.
See Also:
"Backup Window Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmbw
command.
rmbw [ --times/-t time-range[,time-range]... ] day-specifier[,day-specifier]...
Defines a time-of-day range. Refer to "time-range" for a description of the time-range
placeholder.
Defines the day ranges for the backup window. Refer to "day-specifier" for a description of the day-specifier
placeholder.
Example 2-125 Removing Backup Windows
This example removes the backup windows created by the addbw command in Example 2-1.
ob> rmbw --times 00:00-08:00 mon-friob> rmbw --times 20:00-24:00 mon-friob> rmbw --times 08:00-20:00 weekend
Use the rmcheckpoint
command to remove checkpoint information for the specified jobs. When you issue this command, Oracle Secure Backup immediately removes all administrative-host resident checkpoint data for the specified job. It cleans up filer-resident data at the beginning of the next backup of this filer or within 24 hours, whichever comes first.
If no checkpoints exist, then obtool displays the following error message:
Error: no checkpoints matched the selection criteria.
See Also:
"Checkpoint Commands" for related commandsYou must have the right to manage devices and change device state to use the rmcheckpoint
command.
rmcheckpoint [ --nq ] { { --host/-h hostname[,hostname]... }... | --all/-a | job-id... }
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Deletes all checkpoints describing the client host specified by hostname
.
Deletes all checkpoints within the administrative domain.
Deletes the checkpoint identified by job ID job-id
.
Use the rmclass
command to remove an Oracle Secure Backup user class from an administrative domain.
See Also:
"Class Commands" for related commands
Appendix 7, "Classes and Rights" for a descriptions of the default Oracle Secure Backup classes and rights
You must have the modify administrative domain's configuration right to use the rmclass
command. The class must be empty, that is, have no Oracle Secure Backup users, to be deleted.
rmclass [ --nq ] classname...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of the class to delete.
Use the rmdev
command to remove a device from an administrative domain or to move it from one location to another within the administrative domain. You can run the mkdev command to reconfigure a device for use by Oracle Secure Backup.
See Also:
"Device Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmdev
command.
rmdev [ --nq ] [ --migrate/-m new_devicename ] devicename...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Logically migrates all volumes that have references to the location corresponding to devicename
to the location corresponding to new_devicename
. The --migrate
option can specify only one device name at a time.
Specifies the name of the device to remove or move to a different location. Refer to "devicename" for the rules governing device names.
Example 2-128 Removing a Tape Drive
This example removes a tape drive from a tape library.
ob> lsdev library lib1 in service drive 1 tape1 in service library lib2 in service drive 1 tape2 in service drive 2 tape2a in service ob> rmdev tape2a Warning: removing a device to which a job is restricted will cause the job to become unusable. remove device tape2a? (a, n, q, y, ?) [n]: y ob> lsdev library lib1 in service drive 1 tape1 in service library lib2 in service drive 1 tape2 in service
Use the rmds
command to remove a dataset file or dataset directory.
See Also:
"Dataset Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmds
command.
rmds [ --nq ] dataset-name...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of the dataset directory or dataset file that you created with the mkds or rends command. Refer to "dataset-name" for a description of the dataset-name
placeholder.
Example 2-129 Removing a Dataset
This example removes a dataset directory named mydatasets and a dataset file named full_backup.ds
.
ob> lsds Top level dataset directory: mydatasets/ full_backup.ds ob> rmds --nq mydatasets ob> lsds Top level dataset directory: full_backup.ds ob> rmds --nq full_backup.ds ob> lsds Top level dataset directory: ob>
Removes one or more duplication policies.
See Also:
"Volume Duplication Commands"You must have the modify administrative domain's configuration right to use the rmdup
command.
rmdup [ -nq/--noquery ] { policyname } [ policyname ]...
By default, the backup administrator is prompted before the duplication policy is removed. With --nq
, no confirmation is requested.
The duplication policy with the specified name is removed.
Use the rmdw command to remove a duplication window.
See Also:
"Duplication Window Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmdw
command.
rmdw { --times/-t time-range[,time-range]... } day-specifier[,day-specifier]...
Defines a time-of-day range for the duplication window. Refer to "time-range" for a description of the time-range
placeholder.
Defines the day ranges for the duplication window. Refer to "day-specifier" for a description of the day-specifier
placeholder.
Use the rmhost
command to remove a host from the Oracle Secure Backup administrative domain. When you remove a host, Oracle Secure Backup destroys all information pertinent to the host, including:
Configuration data
Incremental backup state information
Metadata in the backup catalog
Device attachments
PNI (Preferred Network Interface) references
Moreover, when you remove a UNIX or Windows host, Oracle Secure Backup contacts that host and directs it to delete the administrative domain membership information that it maintains locally. You can suppress this communication if the host is no longer accessible.
See Also:
"Host Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmhost
command.
rmhost [ --nq ] [ --nocomm/-N ] hostname...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Suppresses communication with the host computer. Use this option to remove a computer that is not connected to the network. This option does not apply to hosts accessible only through Network Data Management Protocol (NDMP).
Specifies the name of the host to remove.
This example shows that brhost4
is not in service and then removes brhost4
from the administrative domain.
ob> lshost brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service brhost4 client (via OB) not in service sfserver1 client (via OB) in service osbsvr1 admin,mediaserver,client (via OB) in service ob> rmhost --nq --nocomm brhost4 ob> lshost brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service sfserver1 client (via OB) in service osbsvr1 admin,mediaserver,client (via OB) in service
Use the rmjob
command to remove jobs. Removing a job has the effect of canceling it and deleting all record of the existence of the job and its subordinate jobs. You can remove a job only if it is not running. After removing a job, you cannot view its status.
See Also:
"Job Commands" for related commandsIf you are attempting to remove the jobs of another Oracle Secure Backup user, then you must have the right to modify any job, regardless of its owner. If you are attempting to remove your own jobs, then you must have the right to modify any jobs owned by user.
rmjob [ --nq ] [ --keepxcr/-k ] [ --quiet/-q | --verbose/-v ] job-id...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Keeps the job transcript. The default is to delete the transcript of the job.
Removes the job quietly.
Displays verbose output about the job removal.
Specifies the job IDs of the jobs to remove.
This example displays all active and pending jobs and removes them.
ob> lsjob Job ID Sched time Contents State ---------------- ----------- ------------------------------ ---------------------- sbt/13 03/23.00:00 dataset fullbackup.ds future work ob> rmjob --nq sbt/13 Info: removing job sbt/13. ob> lsjob ob>
Use the rmloc
command to remove a location.
See Also:
"Location Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmloc
command.
rmloc [ --nq ] locationname...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the location to remove, using its location name.
Use the rmmf
command to remove a media family.
Removing a media family does not affect the metadata on tapes that were originally written using that media family.
See Also:
"Media Family Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmmf
command.
rmmf [ --nq ] media-family-name...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of the media family you want to remove. Note that you cannot remove the RMAN-DEFAULT
media family.
Example 2-132 Removing Media Families
This example removes the media families named content-man-family
and time-man-family
.
ob> lsmf RMAN-DEFAULT content manages reuse content-man-family write forever content manages reuse full_backup write 7 days content manages reuse time-man-family write 7 days keep 28 days ob> rmmf --nq content-man-family time-man-family ob> lsmf RMAN-DEFAULT content manages reuse full_backup write 7 days content manages reuse
Use the rmp
command to remove a variable name-value pair from a policy.
See Also:
"Policy Commands" for related commands
Appendix 6, "Defaults and Policies" for a complete list of policies and policy classes
You must have the modify administrative domain's configuration right to use the rmp
command.
rmp policy-name member-name...
Specifies the name of a policy or a class of policies.
Specifies a user-assigned name of a policy, usually an environment variable name.
Example 2-133 Enabling Verbose Output from the NDMP Data Service
This example uses the rmp
command to unset the VERBOSE
environment variable for an ndmp/backupev
policy. Example 2-2 shows how to set the variable for the policy.
ob> pwdp / ob> lsp ndmp/backupev backupev VERBOSE y ob> rmp ndmp/backupev VERBOSE ob> lsp ndmp/backupev backupev (none) [default]
Use the rmpiece
command to delete a Recovery Manager (RMAN) backup piece from tape.
See Also:
"Backup Piece Commands" for related commandsYou must have the right to manage devices and change device state to use the rmpiece
command.
rmpiece [ --nq ] [ --oid/-o oid-list ]... [ piecename ]...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies or more backup piece identifiers in the Oracle Secure Backup catalog. Refer to "oid" for a description of the oid
placeholder.
Specifies the names of the backup pieces to which the listing applies. The name of a backup piece is indicated by the Piece name
heading in the lspiece output.
Example 2-134 Removing Backup Pieces
This example displays information about two RMAN backup pieces and then deletes them.
ob> lspiece POID Database Content Copy Created Host Piece name 104 ob full 0 03/18.16:25 osbsvr1 05gfkmq9_1_1 105 ob archivelog 0 03/18.16:32 osbsvr1 06gfkn8h_1_1 ob> rmpiece --oid 104,105 remove backup piece OID 104? (a, n, q, y, ?) [n]: y remove backup piece OID 105? (a, n, q, y, ?) [n]: y ob> lspiece ob>
Use the rmpni
command to remove PNI (Preferred Network Interface) definitions.
The rmpni
command supports Internet Protocol v4 (IPv4), Internet Protocol v6 (IPv6), and mixed IPv4/IPv6 environments on all platforms that support IPv6.
See Also:
"Preferred Network Interface Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmpni
command.
Use the following syntax to remove all PNIs defined for a server.
rmpni server-hostname...
Use the following syntax to remove a client host from all PNI definitions.
rmpni [ --client/-c client-hostname[,client-hostname]... ]...
Use the following syntax to remove all PNIs that use a specific interface on a server.
rmpni [ --interface/-i server-ipname[,server-ipname]... ]...
Use the following syntax to remove a client host from the PNI defined for the specified server.
rmpni [ --client/-c client-hostname[,client-hostname]... ]... server-hostname...
Specifies one or more client hosts from which you want to remove PNIs.
Specifies the IP address or the DNS name of the interface to be removed.
Specifies the name of the server computer.
Example 2-135 Removing All PNI Definitions for a Host
This example uses the syntax shown in Syntax 1 to remove all network interfaces for host brhost3
.
ob> lspni brhost2: PNI 1: interface: 192.0.2.1 clients: osbsvr1, brhost4, sfserver1 brhost3: PNI 1: interface: 192.0.2.200 clients: osbsvr1, brhost4, sfserver1 ob> rmpni brhost3 ob> lspni brhost2: PNI 1: interface: 192.0.2.1 clients: osbsvr1, brhost3, sfserver1
Example 2-136 Removing a Client from All PNI Definitions
This example uses the syntax shown in Syntax 2 to remove the client hosts sfserver1
and osbsvr1
from all network interfaces definitions.
ob> lspni brhost2: PNI 1: interface: 192.0.2.1 clients: osbsvr1, brhost4, sfserver1 brhost3: PNI 1: interface: 192.0.2.200 clients: osbsvr1, brhost4, sfserver1 ob> rmpni --client sfserver1,osbsvr1 ob> lspni brhost2: PNI 1: interface: 192.0.2.1 clients: brhost4 brhost3: PNI 1: interface: 192.0.2.200 clients: brhost4
Example 2-137 Removing All PNI Definitions That Use a Specified Interface
This example uses the syntax shown in Syntax 3 to remove all PNIs that use interface 192.0.2.1
on a server.
ob> lspni brhost2: PNI 1: interface: 192.0.2.1 clients: osbsvr1, brhost4, sfserver1 brhost3: PNI 1: interface: 192.0.2.200 clients: osbsvr1, brhost4, sfserver1 ob> rmpni --interface 192.0.2.1 ob> lspni brhost3: PNI 1: interface: 192.0.2.200 clients: osbsvr1, brhost4, sfserver1
Example 2-138 Removing Clients from a PNI Definition
This example uses the syntax shown in Syntax 4 to remove the clients osbsvr1
and sfserver1
from the PNI definition for server brhost2
.
ob> lspni brhost2: PNI 1: interface: 192.0.2.1 clients: osbsvr1, brhost4, sfserver1 ob> rmpni --client osbsvr1,sfserver1 brhost2 ob> lspni brhost2: PNI 1: interface: 192.0.2.1 clients: brhost4
Use the rmrestore
command to remove a restore request from the queue.
See Also:
"Restore Commands" for related commandsIf you specified that the restore run in privileged mode, or if you are restoring files to a host accessed through Network Data Management Protocol (NDMP), then you must have the right to perform file system restores as privileged user to use the restore
command. Otherwise, you must have the right to perform file system restores as self.
rmrestore { --all /-a | restores-item... }
Removes all restore requests.
Specifies the item number of the restore request to remove. You can display the item numbers for restore requests by running the lsrestore command.
See Also:
"Rotation Policy Commands"You must have the modify administrative domain's configuration right to use the rmdup
command.
rmrot --noquery/-nq policyname [ policyname... ]
By default, the backup administrator is prompted before the policy is removed. With --noquery
, no confirmation is requested.
The name of the policy to remove.
Use the rmsched
command to remove a backup schedule. Run the lssched command to display backup schedules.
See Also:
"Schedule Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmsched
command.
rmsched [ --nq ] schedulename...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of the schedule to remove.
Example 2-140 Removing a Backup Schedule
Example 2-140 removes the backup schedule named incremental
.
ob> lssched full_backup sundays homedir.ds incremental mondays tuesdays wednesdays thursdays homedir.ds ob> rmsched --nq incremental ob> lsschedfull_backup sundays homedir.ds
Use the rmsection
command to inform Oracle Secure Backup that a backup section is deleted. Oracle Secure Backup does not physically remove the section from the volume, but indicates in its backup sections catalog that the section is removed. You can view the status of a section by running the lssection command. Typically, you use rmssection
only when the backup sections catalogs require manual update.
Note:
If you remove a backup section that contains a Recovery Manager (RMAN) backup piece, then Oracle Secure Backup responds to RMAN queries concerning the backup piece by saying that it does not exist.See Also:
"Section Commands" for related commandsYou must have the right to manage devices and change device state to use the rmsection
command.
rmsection [ --nq ] [ --oid/-o oid-list ]...[ --vid/-v vid { --file/-f filenumber-list }... ]
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Selects backup sections with the object identifiers matching those in oid-list
. Refer to "oid-list" for a description of the oid-list
placeholder.
Selects backup sections contained on the volume specified by vid
. Refer to "vid" for a description of the vid
placeholder.
Selects the backup sections with the file numbers specified in the list. Refer to "filenumber-list" for a description of the filenumber-list
placeholder.
Example 2-141 Removing Backup Sections
This example deletes a section that contains an RMAN backup piece. A query of the backup sections catalog shows that the backup section has the attribute deleted
.
ob> lssection --short BSOID 106 107 ob> rmsection --nq --oid 107 ob> lssection --long Backup section OID: 106 Containing volume: VOL000003 Containing volume OID: 110 File: 1 Section: 1 Backup level: 0 Client: brhost2 Created: 2008/04/19.11:36 Attributes: never expires Backup section OID: 107 Containing volume: RMAN-DEFAULT-000002 Containing volume OID: 112 File: 1 Section: 1 Backup level: 0 Client: osbsvr1 Created: 2008/04/19.11:37 Attributes: deleted
Use the rmsnap
command to remove a snapshot.
See Also:
"Snapshot Commands" for related commandsYou must have the right to manage devices and change device state to use the rmsnap
command.
rmsnap [ --host/-h hostname ] [ --fs/-f filesystem-name ] [ --nowait/-n ] snapshot-name...
Specifies the name of the Network Data Management Protocol (NDMP) host that contains the snapshot to remove. If you do not specify a host name, then Oracle Secure Backup uses the value from the host variable.
Specifies the name of the file system included in the snapshot. If you do not specify the --fs
option, then the fs
variable must be set.
Does not wait for the snapshot removal operation to complete.
Specifies the name of the snapshot to remove.
Example 2-142 Removing a Snapshot
This example creates a snapshot called test
and then deletes it.
ob> set fs /vol/vol0 ob> mksnap --host lucy ob> lssnap test File system /vol/vol0: Snapshot Of Taken at %Used %Total Snapshot Name /vol/vol0 2008/03/28.21:11 0 0 test ob> rmsnap test ob> lssnap test Warning: snapshot test not found on host lucy, file system /vol/vol0.
Example 2-143 Removing a Snapshot
This example deletes three snapshots from the host storabcknfs4
.
ob> lssnap -h storabcknfs4 File system /vol/vol1: Snapshot Of Taken at %Used %Total Snapshot Name /vol/vol1 2010/08/18.04:00 0 0 nightly.0 /vol/vol1 2010/08/18.02:47 0 0 snapshot_for_backup.8204 /vol/vol1 2010/08/18.00:00 0 0 hourly.0 /vol/vol1 2010/08/17.20:00 0 0 hourly.1 /vol/vol1 2010/08/17.16:00 0 0 hourly.2 /vol/vol1 2010/08/17.12:00 0 0 hourly.3 /vol/vol1 2010/08/17.04:00 0 0 nightly.1 /vol/vol1 2010/08/16.04:00 0 0 weekly.0 /vol/vol1 2010/08/15.04:00 0 0 nightly.2 /vol/vol1 2010/08/14.04:00 1 0 nightly.3 /vol/vol1 2010/08/13.04:00 0 0 nightly.4 /vol/vol1 2010/08/09.04:00 9 5 weekly.1 ob> rmsnap -h storabcknfs4 -f/vol/vol1 hourly.3 ob> rmsnap -h storabcknfs4 -f/vol/vol1 nightly.4 ob> rmsnap -h storabcknfs4 -f/vol/vol1 nightly.3 ob> lssnap -h storabcknfs4 File system /vol/vol1: Snapshot Of Taken at %Used %Total Snapshot Name /vol/vol1 2010/08/18.04:00 0 0 nightly.0 /vol/vol1 2010/08/18.02:47 0 0 snapshot_for_backup.8204 /vol/vol1 2010/08/18.00:00 0 0 hourly.0 /vol/vol1 2010/08/17.20:00 0 0 hourly.1 /vol/vol1 2010/08/17.16:00 0 0 hourly.2 /vol/vol1 2010/08/17.04:00 0 0 nightly.1 /vol/vol1 2010/08/16.04:00 0 0 weekly.0 /vol/vol1 2010/08/15.04:00 0 0 nightly.2 /vol/vol1 2010/08/09.04:00 9 5 weekly.1
Use the rmssel
command to remove a database backup storage selector.
See Also:
"Database Backup Storage Selector Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmssel
command.
rmssel [ --nq ] sselname...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the names of the database backup storage selectors to remove.
Use the rmsum
command to remove a job summary schedule.
See Also:
"Summary Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmsum
command.
rmsum [ --nq ] summary-name...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of the job summary schedule to remove.
Use the rmuser
command to remove an Oracle Secure Backup user from the administrative domain.
See Also:
"User Commands" for related commandsYou must have the modify administrative domain's configuration right to use the rmuser
command.
rmuser [ --nq ] username...
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Specifies the name of the Oracle Secure Backup user to remove.
Use the rmvol
command to remove volume records from the Oracle Secure Backup catalog permanently. The only way to undo the removal is to import the volume again, so that the Oracle Secure Backup catalog is repopulated.
See Also:
"Volume Rotation Commands" for related commandsYou must have the modify catalog right to use the rmvol
command.
rmvol [ --nq ] [ --force/-f ] { [ --vid/-v vol-spec[,vol-spec]... ] [ --barcode/-b barcode_value[,barcode_value]... ] [ --location/-l location_name[,location_name]... ] }
Does not display a confirmation message. If you do not specify this option, then you are prompted for confirmation before the volume is deleted. You can reply to the confirmation request with one of the following:
a
Remove records for all volume selections.
n
Remove no records.
q
Remove no records and quit the command.
y
Remove the record for this volume.
?
Repeat the prompt.
By default, you can only remove the records of expired volumes. You can specify --force
to override this restriction and remove the records of unexpired volumes as well.
Specifies the volume ID of the volume whose record you want to remove. See "vol-spec" for more information on the vol-spec
placeholder.
Specifies the barcode of the volume whose record you want to remove.
Specifies the location of the volume or volumes whose records you want to remove. Oracle Secure Backup removes the records of all volumes at the specified location.
Note:
You must specify--vid
, --barcode
, or --location
, but you can specify multiple options.If the volumes database contains multiple entries matching a specified vol-spec or barcode, then Oracle Secure Backup displays a list of the matching volumes from which you can choose volumes to remove. The following example shows multiple matches for vol-spec VOL000001
:
ob> rmvol -f -v VOL000001 Your vol-spec, "VOL000001", matched the following volumes: Volume ID Barcode Created 1 VOL000001 def5768a15b710295f7000423a5cbf4 2 VOL000001 3f2e113415b7102a59e000423a5cbf4 06/05.15:28 Please select the volume(s) that you wish to modify (1, 2, ..., a(ll), n(one), q(uit):
Use the rpyjob
command to respond to a job that is prompting for input or assistance. You can display jobs of this type by specifying --inputrequest
on the lsjob command. You can determine what a job is requesting by performing a catxcr command.
See Also:
"Job Commands" for related commandsIf you are attempting to respond to the job prompts of another Oracle Secure Backup user, then you must have the right to modify any job, regardless of its owner. If you are attempting to respond to your own job prompts, then you must have the right to modify any jobs owned by user.
rpyjob --reply/-r text job-id...
Specifies the textual reply to the prompt. To include white space in the value, surround the text with quotes.
Specifies the identifier of the job to which the reply is to be sent.
Example 2-147 Displaying Information About a Job Requesting Assistance
This example uses lsjob to display jobs that are requesting assistance and then runs catxcr to display the transcript for job admin/7.1
.
The transcript shows that the tape library does not contain a usable tape for the backup job. Press the Enter key after running catxcr
to return to the obtool prompt.
ob> lsjob --inputrequest --long admin/7.1: Type: backup brhost2 Level: full Family: (null) Scheduled time: none State: running since 2008/05/09.12:38 Priority: 100 Privileged op: no Run on host: brhost2 Attempts: 1 ob> catxcr --tail 12 admin/7.1 End of tape has been reached. Please wait while I rewind and unload the tape. The Volume ID of the next tape to be written is VOL000005. The tape has been unloaded. obtar: couldn't perform auto-swap - can't find usable volume in library (OB device mgr) Enter a command from the following list: load <n> .. load the tape from element <n> into the drive unload <n> .. unload the tape from the drive into element <n> help .. display other commands to modify drive's database go .. to use the tape you selected quit .. to give up and abort this backup or restore :
Example 2-148 Displaying Information About a Job Requesting Assistance
This example inserts a volume into the tape library and then uses rpyjob
to reply with two commands: load 3
and go
. Specifying --inputrequest
on lsjob
generates a null response, which means that no jobs require input.
ob> insertvol --library lib2 unlabeled 3 ob> rpyjob --reply "load 3" admin/7.1 ob> rpyjob --reply "go" admin/7.1 ob> lsjob --inputrequest ob>
Use the runjob
command to control how a job is processed. The command enables you to start a job in the following ways:
Immediately
In an order different from that of the scheduler
On a specific device or a device from which the job was previously restricted
See Also:
"Job Commands" for related commandsIf you are attempting to control jobs belonging to another Oracle Secure Backup user are processed, then you must have the right to modify any job, regardless of its owner. If you are attempting to control the processing of your own jobs, then you must have the right to modify any jobs owned by user.
runjob { --asap/-a | --now/-n | { --priority/-p schedule-priority } } [ --device/-d device-name ] [ --mediamovement/-m ] [ --quiet/-q | --verbose/-v ] job-id...
Starts the job as soon a possible by raising it to priority 1.
Starts the job now. If Oracle Secure Backup cannot start the job, then it generates an error message.
Resets the job priority to schedule-priority.
The default priority is 100. Refer to "schedule-priority" for a description of the schedule-priority
placeholder.
Runs the job on the device specified by device-name
, ignoring job requirements.
Enables the pending media movement job specified by job-id
.
Runs the job in quiet mode. --quiet
directs obtool to suppress status messages it would normally write to stdout
. Note that Oracle Secure Backup never suppresses error messages.
Displays output when running the job.
Specifies the identification number of the job you want to run. Run the lsjob command to display job IDs.
Example 2-149 Running a Job Now
This example lists a pending job and runs it immediately.
ob> lsjob --pending Job ID Sched time Contents State ---------------- ----------- ------------------------------ ---------------------- sbt/23 03/22.21:00 dataset workdata.ds future work ob> runjob --device tape1 --now sbt/23 ob> lsjob --all sbt/23 Job ID Sched time Contents State ---------------- ----------- ------------------------------ ---------------------- sbt/23 03/22.21:00 dataset workdata.ds completed successfully at 2008/03/22.18:09
Use the set
command to set or reset the value of an obtool variable in the current session.
See Also:
Appendix 4, "obtool Variables" for a complete list of obtool variablesset [ variable-name [ variable-value ] ]
Specifies the name of the variable to set. If you do not specify a variable name, then set
displays the variables that are currently set.
Specifies the value to which variable-name
should be set.
Example 2-150 Setting a Variable
This example sets the errors
variable to long
so that errors include descriptive text and the obtool component name and then resets it to short
.
ob> show errors errors (not set) ob> set errors long ob> show errors errors long ob> set errors short ob> show errors errors short
Use the setbw
command to change the settings of a backup window. This command replaces an existing backup window, as opposed to the addbw command, which adds a backup window.
See Also:
"Backup Window Commands" for related commandsYou must have the modify administrative domain's configuration right to use the setbw
command.
setbw { --times/-t { none | time-range[,time-range]... } } day-specifier[,day-specifier]...
Defines a time-of-day range. Refer to "time-range" for a description of the time-range
placeholder.
Defines the day ranges for the backup window. Refer to "day-specifier" for a description of the day-specifier
placeholder.
Example 2-151 Changing Backup Windows
This example changes the settings of the backup windows created in Example 2-1. These backup windows allow backups from 7 a.m. until 9 p.m. on weekdays and any time during the weekend.
ob> setbw --times 00:00-07:00,21:00-24:00 mon-fri ob> setbw --times 00:00-24:00 weekend ob> lsbw weekend 00:00-24:00 weekday 00:00-07:00,21:00-24:00
Use the setdw
command to set a duplication window, which is a time and day range.
See Also:
"Duplication Window Commands" for related commandsYou must have the modify administrative domain's configuration right to use the setdw
command.
setdw { --times/-t none | time-range[,time-range]... } day-specifier[,day-specifier]...
Defines a time-of-day range for the duplication window. Refer to "time-range" for a description of the time-range
placeholder.
Defines the day ranges for the duplication window. Refer to "day-specifier" for a description of the day-specifier
placeholder.
Use the setp
command to set the value of a policy. Note that you can reset a value with the resetp command.
The policy data is represented as a directory tree with /
as the root. You can use cdp to navigate the tree and lsp and pwdp
to display data.
See Also:
"Policy Commands" for related commands
Appendix 6, "Defaults and Policies" for a complete list of policies and policy classes
You must have the modify administrative domain's configuration right to use the setp
command.
setp policy-name policy-value
Specifies the name of a policy or a class of policies.
Specifies the policy value, which is dependent on the policy type.
Example 2-152 Setting Policy Values
This example sets the Web server password to pandora
, configures the Web server so that it starts automatically, and then sets the Network Data Management Protocol (NDMP) host password to mehitibel
.
ob> pwdp / ob> lsp daemons/webpass webpass (set) ob> setp daemons/webpass pandora ob> lsp --nodefault daemons/webauto webautostart no ob> setp daemons/webauto yes ob> lsp --nodefault ndmp/password password (not set) ob> setp ndmp/password mehitibel
Use the show
command to display the value of one or more variables.
See Also:
Appendix 4, "obtool Variables" for a complete list of obtool variables
show [ variable-name ]...
Specifies the name of the variable whose value you want to display. If you do not specify a variable name, then show
displays all variables that are currently set.
Use the unlabelvol
command to load selected volumes and physically remove the Oracle Secure Backup volume label and backup data from each of them.
Each volume has a volume label stored at Beginning of Tape (BOT). The label consists of the volume ID, the barcode (if any), and other information about the volume. Typically, you use the unlabelvol
command to remove all traces of a backup and its associated volume label from an unexpired tape and from the Oracle Secure Backup catalog.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the unlabelvol
command.
unlabelvol [ --drive/-D drivename ] [ --force/-f ] [ --obtaropt/-o obtar-option ]... [ se-range ]
Specifies the name of the tape drive to be used to unlabel the volume. If you do not specify a tape drive name, then the drive variable must be set.
Forces obtool to ignore the expiration policy for the volume. If the --force
option is not used and the volume is not expired according to its expiration policy, then unlabelvol
fails.
Specifies the range of storage elements holding the volumes to be unlabeled. If this option is omitted, then the volume currently loaded in the tape drive is unlabeled. Refer to "se-range" for a description of the se-range
placeholder.
Example 2-154 Unlabeling a Volume
This example unlabels the volume in storage element 1 of tape library lib1
.
ob> lsvol --library lib1 --long Inventory of library lib1: in mte: vacant in 1: volume VOL000002, barcode ADE201, oid 110, 16962752 kb remaining in 2: vacant in 3: volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 17017984 remaining, content manages reuse in 4: vacant in iee1: vacant in iee2: vacant in iee3: vacant in dte: vacant ob> unlabelvol --force --drive tape1 1 ob> lsvol --library lib1 --long Inventory of library lib1: in mte: vacant in 1: unlabeled in 2: vacant in 3: volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 17017984 remaining, content manages reuse in 4: vacant in iee1: vacant in iee2: vacant in iee3: vacant in dte: vacant
Use the unloadvol
command to unload a volume from a tape drive. The unload operation rewinds the tape before moving it to its storage slot.
See Also:
"Library Commands" for related commandsYou must have the right to manage devices and change device state to use the unloadvol
command.
unloadvol [ --drive/-D drivename ] [ element-spec ]
Specifies the name of the tape drive to be unloaded. If you do not specify a tape drive name, then the drive variable must be set.
Specifies the destination storage element for the volume to be unloaded. Refer to "element-spec" for a description of the element-spec
placeholder.
You can specify vacant
to make Oracle Secure Backup unload the volume to any vacant storage element. If element-spec
is omitted, then the source (if known) of the volume is used. The source element of the volume in the dte
is displayed after the string lastse
when you run lsvol.
Example 2-155 Unloading a Volume from a Tape Drive
This example unloads a volume from tape drive tape1
and inserts it into the source element for the volume. The text lastse 3
in the dte
output indicates that the source for the volume is element 3. Note that the sample output has been formatted to fit on the page.
ob> lsvol --library lib1 --long Inventory of library lib1: in mte: vacant in 1: volume VOL000002, barcode ADE204, oid 110, 47670368 kb remaining in 2: volume VOL000001, barcode ADE201, oid 102, 48319392 kb remaining in 3: vacant in 4: vacant in iee1: barcode ADE203, oid 114, 47725344 kb remaining, lastse 4 in iee2: vacant in iee3: vacant in dte: volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47725600 kb remaining, content manages reuse, lastse 3 ob> unloadvol --drive tape1 ob> lsvol --library lib1 --long Inventory of library lib1: in mte: vacant in 1: volume VOL000002, barcode ADE204, oid 110, 47670368 kb remaining in 2: volume VOL000001, barcode ADE201, oid 102, 48319392 kb remaining in 3: volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47725600 kb remaining, content manages reuse in 4: vacant in iee1: barcode ADE203, oid 114, 47725344 kb remaining, lastse 4 in iee2: vacant in iee3: vacant in dte: vacant
Use the unmountdev
command to unmount tape volumes manually. When a tape is unmounted, the tape is no longer in a mode in which Oracle Secure Backup can read or write to it. You can use the mountdev command to mount an unmounted tape.
The unmountdev
command is particularly useful when the tape drive is not set to automount
, which is the recommended, default configuration setting. In special situations the unmountdev
and mountdev commands provide additional control over your tape drive.
See Also:
"Device Commands" for related commandsYou must have the right to manage devices and change device state to use the unmountdev
command.
unmountdev [ --unload/-u | --norewind/-R ] devicename...
Unloads a volume from the tape drive.
Specifies that the tape should not be rewound when Oracle Secure Backup finishes writing to it.
Specifies the device from which you want to unmount a volume. Refer to "devicename" for the rules governing device names.
Example 2-156 Unmounting a Tape Volume
This example unmounts an automounted tape drive called tape1
.
ob> lsdev --long tape1 tape1: Device type: tape Model: [none] Serial number: [none] In service: yes Library: lib1 DTE: 1 Automount: yes Error rate: 8 Query frequency: 3145679KB (-1073791796 bytes) (from driver) Debug mode: no Blocking factor: (default) Max blocking factor: (default) Current tape: 1 Use list: all Drive usage: 14 seconds Cleaning required: no UUID: b7c3a1a8-74d0-1027-aac5-000cf1d9be50 Attachment 1: Host: brhost3 Raw device: /dev/obt0 ob> unmountdev --norewind tape1 ob> lsdev --mount tape1 drive tape1 in service unmounted
Use the unresdev
command to unreserve a device previously reserved with the resdev command.
See Also:
"Device Commands" for related commandsYou must have the right to manage devices and change device state to run the unmountdev
command.
unresdev { --all/-a | devicename... }
Unreserve all devices reserved by the current Oracle Secure Backup user.
Specifies the name of the device to be unreserved. Refer to "devicename" for the rules governing device names.
Example 2-157 Unreserving a Device
This example unreserves tape drive tape1
.
ob> lsdev --reserved drive 1 tape1 in service ob> unresdev tape1 ob> lsdev --reserved ob>
Use the unrmsection
command to undo the effect of the rmsection command. The command resets the deleted flag in the backup section records, which you can view by running the lssection command.
The unrmsection
command fails if the volume containing the selected backup sections has been recycled or unlabeled after all of the backup sections it contains were deleted.
See Also:
"Section Commands" for related commandsYou must have the right to manage devices and change device state to use the unrmsection
command.
unrmsection [ --nq ] [ --oid/-o oid-list ]...[ --vid/-v vid { --file/-f filenumber-list }... ]
Does not display a confirmation message. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.
Selects backup sections with the object identifiers matching those in oid-list
. Refer to "oid-list" for a description of the oid-list
placeholder.
Selects backup sections contained on the volume specified by vid
.
Selects the backup sections with the file numbers specified in the list. Refer to "filenumber-list" for a description of the filenumber-list
placeholder.
Example 2-158 Undoing the Deletion of Backup Sections
This example undoes the deletion of two backup sections that have an attribute of deleted
.
ob> lssection BSOID Volume File Sect Level Client Created Attributes 100 VOL000001 1 1 0 brhost2 03/24.09:52 never expires 105 RMAN-DEFAULT-000002 1 1 0 osbsvr1 03/24.10:13 deleted 106 VOL000002 1 1 0 brhost2 03/24.10:13 never expires 107 VOL000003 1 1 0 brhost2 03/24.10:13 never expires 108 RMAN-DEFAULT-000002 2 1 0 osbsvr1 03/24.10:14 deleted 109 VOL000003 2 1 0 brhost2 03/24.11:27 never expires 110 VOL000003 3 1 0 brhost2 03/24.11:27 never expires ob> unrmsection --nq --oid 105,108 ob> lssection BSOID Volume File Sect Level Client Created Attributes 100 VOL000001 1 1 0 brhost2 03/24.09:52 never expires 105 RMAN-DEFAULT-000002 1 1 0 osbsvr1 03/24.10:13 content manages reuse 106 VOL000002 1 1 0 brhost2 03/24.10:13 never expires 107 VOL000003 1 1 0 brhost2 03/24.10:13 never expires 108 RMAN-DEFAULT-000002 2 1 0 osbsvr1 03/24.10:14 content manages reuse 109 VOL000003 2 1 0 brhost2 03/24.11:27 never expires 110 VOL000003 3 1 0 brhost2 03/24.11:27 never expires
Use the unset
command to undefine a variable.
See Also:
Appendix 4, "obtool Variables" for a complete list of obtool variables
unset variable-name...
Specifies the name of the variable to undefine.
Use the updatehost
command to instruct Oracle Secure Backup to complete the inclusion of a host in the administrative domain. Typically, you use this command when you initially configured a host when it was offline.
When you run the mkhost or chhost command for a host, Oracle Secure Backup exchanges messages with the host to inform it of its state. If you run mkhost
or chhost
with the --nocomm
option because communication with the host is not possible, then the host contains out-of-date configuration information. When the host becomes available, use an updatehost
command to synchronize the Oracle Secure Backup configuration information between the administrative server and the host.
See Also:
"Host Commands" for related commandsYou must have the modify administrative domain's configuration right to use the updatehost
command.
updatehost [ --force/-f ] [--recertify/-r] hostname...
Forces an update. The updatehost
command normally fails if the internal name (UUID) stored on the subject host disagrees with the internal name for the subject stored on the administrative server. This situation arises if the subject host is reassigned to this administrative domain from another domain. To update the subject host regardless of this situation, use --force
.
Recertifies a client host that was earlier decertified and brings it back into the Oracle Secure Backup adminstrative domain, without destroying the restore catalog data of the client. The host could have been decertified either by using the obcm decertify
command or by the reinstallation of Oracle Secure Backup.
If you remove a client and then add it, the catalog restore data would be destroyed in the process.
Note:
Therecertify
option is only available starting with Oracle Secure Backup 10.3.0.2.0.Specifies the name of the host to update. This command is useful only for hosts accessed with the Oracle Secure Backup protocol. NDMP hosts do not maintain any Oracle Secure Backup state data and are therefore not applicable to this function.
This example updates a host that had been offline when it was added with mkhost.
ob> lshost brhost2 client (via OB) in service brhost3 mediaserver,client (via OB) in service sfserver1 client (via OB) not in service osbsvr1 admin,mediaserver,client (via OB) in service ob> updatehost sfserver1 ob> pinghost sfserver1 sfserver1: Oracle Secure Backup and NDMP services are available
Example 2-161 Recertifying a Host
This example recertifies the host brhost46
, that was previously decertified using the obcm decertify
command, and brings it back into the Oracle Secure Backup administrative domain. The commands are run using the obtool
utility on the administrative server.
ob> updatehost --recertify brhost46 Info: waiting for host to update certification status... Info: waiting for host to update certification status... ob> pinghost brhost46 stadc46: Oracle Secure Backup and NDMP services are available
Use the vault
command to perform a one-time on-demand vaulting scan.
See Also:
"Volume Rotation Commands" for related commandsvault [ --select/-S select_criterion[, select_criterion]... [ --quiet/-q ] [ --at/-a date-time ] [ --priority/-p schedule-priority ] [ --restrict/-r restriction[,restriction]... ] [ --expires/-x duration ] ]...
Restricts a vaulting scan to one or more media families.
Specifies that neither job ID nor status information is displayed when the vaulting scan job is dispatched to the scheduler.
Specifies a date and time to perform the vaulting scan. If a date and time is not specified, then the vaulting scan runs immediately.
See "date-time" for more information on the date-time
placeholder.
Assigns a schedule priority to the vaulting scan.
See "schedule-priority" for more information on the schedule-priority
placeholder.
Specifies locations to be scanned during the vaulting scan. It the location corresponds to an ACSLS library, then this option also specifies the cartridge access point to be used for media ejection. Restrictions can be specified in any of the following forms:
location
location@capname
@capname
Specifies an expiration time period. Specifying this option expires the vaulting scan if it is not processed by duration
after the trigger time.
See "duration" for more information on the duration
placeholder.
Use the vfylibs
command to check the configuration of one or more libraries and drives. You specify which libraries to check, and vfylibs
checks the drive ID of each tape drive in each of the specified libraries against a list of all defined libraries and drive IDs for all tape drives in those libraries.
The drives can be open and in use when you run the vfylibs
command, but vfylibs
fails if an active robot process is associated with the library.
The vfylibs
command is not supported for ACSLS libraries.
For each specified library, vfylibs
performs the following configuration checks:
The device ID (DVCID) for each tape drive in the library is obtained by a Read Element Status command with the DVCID bit set.
Note:
Some libraries, particularly older models, do not support the DVCID bit. The accuracy of thevfylibs
command is reduced when it encounters libraries of this type.The drive object for each tape drive in the library is fetched.
For each attach point specified with this drive object, the drive is opened.
An ID for the drive is constructed using SCSI Inquiry commands.
The constructed ID is compared with the ID returned with the element status for the tape drive.
The vfylibs
command checks for and reports the following configuration errors:
There is no drive object for a library and tape drive number.
The drive object for a library and tape drive is not in service.
The drive object for a library and tape drive has no attach points.
The host for an attach point could not be resolved (host object not found).
The host for an attach point is not in service.
The ID obtained through an attach point does not match the ID reported by the library.
Note:
Ifvfylibs
finds an ID mismatch, then it also searches the IDs of all drives to see if the incorrect ID matches the ID of a tape drive in some other library.See Also:
"Device Commands" for related commandsvfylibs library_name [ [library_name]... | --all/-a ] [ --verbose/-v ]
The name of the library whose configuration you want to check. You can specify multiple library names. Specifying no names at all, which is the same as specifying --all
, requests verification of all libraries in your configuration.
Displays the serial number of the device. If the serial number of an IBM ULTRIUM-DT2 drive is 1110229581, for example, then vfylibs displays:
IBM ULTRIUM-TD2 1110229581
Example 2-162 Checking the Configuration of a Tape Library
In this example, the vfylibs
command runs successfully, and the IDs match:
ob> pingd l2 Info: library l2 accessible. Error: drive l2_t1 is in use by obt on host bkpservr04, process 5487. Error: drive l2_t2 is in use by obt on host bkpservr04, process 5513. ob> vfylib -v l2 collecting dte info... lib l2 ... dte 1: l2_t1 (IBM ULTRIUM-TD2 1110229581) dte 2: l2_t2 (IBM ULTRIUM-TD2 1110229610) verifying dte definitions against drive objects... lib l2 ... dte 1 l2_t1 (IBM ULTRIUM-TD2 1110229581) ... att bkpservr04:/dev/sg3 ... id matches dte 2 l2_t2 (IBM ULTRIUM-TD2 1110229610) ... att bkpservr04:/dev/sg4 ... id matches 0 errors found
Example 2-163 Running vftlibs When a Robot Process Is Active
In this example, the vfylibs
command returns an error because an active robot process is associated with the library:
ob> pingd l2 Error: library l2 is in use by obt on host bkpservr04, process 5487. Error: drive l2_t1 is in use by obt on host bkpservr04, process 5487. Error: drive l2_t2 is in use by obt on host bkpservr04, process 5513. ob> vfylib -v collecting dte info... Error: library l2 is in use by obt on host bkpservr04, process 5487. 0 errors found
Example 2-164 Running vfylibs When IDs Do Not Match
In this example, the vfylibs
command runs successfully but the IDs do not match:
ob> vfylib l1 -v collecting dte info... lib l1 ... dte 1 [not determined] ... getting DVCID: bad id type in DVCID Error: the following requested library name(s) were not found: l1 1 error found