2 obtool Commands: addbw to lsvol

This chapter describes the obtool commands in alphabetical order. "obtool Command Categories" organizes the obtool commands into various categories.

addbw

Purpose

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 commands

Prerequisites

You must have the modify administrative domain's configuration right to use the addbw command.

Syntax

addbw::=

addbw { --times/-t time-range[,time-range]... }
day-specifier[,day-specifier]...

Semantics

--times/-t time-range

Defines a time-of-day range. Refer to "time-range" for a description of the time-range placeholder.

day-specifier

Defines the day ranges for the backup window. Refer to "day-specifier" for a description of the day-specifier placeholder.

Example

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

adddw

Purpose

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 commands

Prerequisites

You must have the modify administrative domain's configuration right to use the adddw command.

Syntax

adddw::=

adddw { --times/-t time-range[,time-range]... } day-specifier[,day-specifier]...

Semantics

--times/-t time-range

Defines a time-of-day range for the duplication window. Refer to "time-range" for a description of the time-range placeholder.

day-specifier

Defines the day ranges for the duplication window. Refer to "day-specifier" for a description of the day-specifier placeholder.

Example

Example 2-2 Adding Duplication Windows

This example shows that a daily duplication window exists, that runs between 10 a.m. to 8 p.m. The adddw command creates two other duplication windows, one that extends the window on weekends to 9 p.m, and another that is created for a specific date and time.

ob> lsdw
daily 10:00-20:00
ob> adddw -t 20:00:00-21:00:00 weekend
ob> lsdw
weekend 10:00-21:00
weekday 10:00-20:00
ob> adddw -t 1530-16:30:30 09/30
ob> lsdw
09/30 15:30-16:30:30
weekend 10:00-21:00
weekday 10:00-20:00

addp

Purpose

Use the addp command to add a variable name-value pair to a policy.

See Also:

Prerequisites

You must have the modify administrative domain's configuration right to use the addp command.

Syntax

addp::=

addp policy-name { member-name member-value }...

Semantics

policy-name

Specifies the name of a policy or a class of policies.

member-name

Specifies the user-assigned name of a policy, usually an environment variable name.

member-value

Specifies the user-assigned value of a policy, usually an environment variable value.

Example

Example 2-3 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

backup

Purpose

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 whether the encryption algorithm and keys are used depends 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, if specified.

Client side software encryption is automatically forced on when backup data is written to Oracle Cloud Infrastructure. Encryption is not forced on when Oracle Secure Backup catalog backup data is written to Oracle Cloud Infrastructure.

Whether backups are compressed and whether the compression option is used, depends upon the current global backup policies described in Backup Compression Policies, client backup policies set with the mkhost and chhost commands, and the value of the --compression option, if specified.

See Also:

Prerequisites

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.

To use the --user option, you must have the following rights: Perform file system backups as privileged user, Modify any backup, regardless of its owner, and Modify any job, regardless of its owner.

Usage Notes

If a disk pool runs out of space when a backup operation is in progress, the pool manager daemon tries to free space by deleting expired backup image instances. If the space freed is also not sufficient, then the backup job is paused. The administrator may need to increase the size of the disk pool. The administrator can also choose to cancel the backup job while it is paused.

Syntax

backup::=

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] [--storekey/-s]
              [--encryption/-e encryption] [--algorithm/-L enc-algorithm]
              [ {--passphrase/-P passphrase} | --querypassphrase/-Q ]
              [--disablehwencryption/-d] [--expires/-x duration]
              [--dataset/-D dataset-name...] [--disablestoredcatalog/-C]
              [--name/-n name-format] [--quiet/-q] [--waitfor/-W duration]
              [--user/-u user-name] 
              [ --compression/-K {off | low | medium | basic | high} ]
              [--go]

Semantics

--level/-l backup-level

Identifies a backup level. The default level is 0. Refer to "backup-level" for a description of the backup-level placeholder.

--priority/-p schedule-priority

Assigns a schedule priority to a backup. The default priority is 100. Refer to "schedule-priority" for a description of the schedule-priority placeholder.

--at/-a date-time

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.

--family/-f media-family-name

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.

--restrict/-r restriction

Defines a tape device, disk pool, host, tape device/host pair, or cloud storage device in the administrative domain that identifies one or more acceptable devices for the backup. Refer to "restriction" for a description of the restriction placeholder.

In the absence of a device restriction, the backup runs on the first available tape device. You can specify the restriction as a device name (as assigned by mkdev or chdev) or as an attachment.

If the backup target is a cloud storage device, then the device must be specified because Oracle Secure Backup never backs up to a cloud storage device by default.

--privileged/-g

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.

--unprivileged/-G

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.

--encryption/-e {yes | no | forcedoff | transient}

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.

  • transient

    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 backups

--algorithm/-L

Specifies the encryption algorithm to use with this backup. Values include AES128, AES192 and AES256. The default is AES192.

--passphrase/-p string

Specifies the transient passphrase for use with the --encryption transient option. Value specified is a user-supplied string, in quotes.

--querypassphrase/-Q

Specifies that the operator must be prompted for the transient passphrase for use with the --encryption transient option.

--storekey/-s

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.

--disablehwencryption /-d

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.

--disablestoredcatalog/-C

Specifies that the backup image instance created by this backup will not have an attached catalog. Use this option only for backups stored on tape volume.

--expires/-x duration

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.

--quiet/-q

Does not display job ID or status information when a backup job is dispatched to the scheduler. Use this option with the --go option.

--name /-n name-format

Specifies the name assigned to the backup image created by this backup job. You can explicitly specify a name, specify one or more name format variables, or use a combination of name format variable and static values that you specify.

See "name-format" for a description of the name-format placeholder.

Each backup image name must be unique within the Oracle Secure Backup catalog. If you do not specify a date in the name, then a six-digit date in the —yymmdd format is automatically appended to the backup image name. If you do not include a time in the name, a six-digit time in the -hhmmss format is automatically appended to the backup image name. If you do not add a date or time in the name, then both values in the -yymmdd-hhmmss format are automatically appended to the backup image name.

--waitfor/-W duration

Specifies the amount of time that Oracle Secure Backup waits for the backup job to complete. After the specified time duration is exceeded, Oracle Secure Backup exits from obtool.

See "duration" for a description of the duration placeholder.

--dataset/-D dataset-name

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. However, you can use mount point statements in your dataset files to cross mount points.

Another way to cross remote mount points is to use the setp command and set the operations policy backupoptions as described in Example 3-109.

--user/-u username

Specifies the name of the Oracle Secure Backup user who owns the created backup job.

--compression/-K {off | low | medium | basic | high}
Specifies a compression option for the on-demand backup job that overrides any global and client-level compression options already set.
The possible values are as follows:
off
Software compression is not used for the backup regardless of global and client level policy
low
Compresses data as best as possible without compromising too much on CPU usage and speed. Choose this option if you want the data compressed, but you do not want backup speed or CPU load to be overly affected.
medium
Provides a balance between compression ratio and speed.
basic
This option is generally better in terms of compression ratio than the medium option. It is slower than the low and medium options, but faster than the high option.
high
Compresses data as much as possible, making extensive use of CPU. This option is best suited for backups over slower networks where the limiting factor is network speed.

The default value is that no compression option is set.

If compression is not specified as part of the backup command, then the client host setting for compression is used. If the client host compression setting is not set, then the domain-level policy is used. If the domain-level policy is also not set, then no software compression is performed for this job.

Note:

  • There is no one best compression level. The best level to use depends on your specific environment and compression requirements, as well as network traffic characteristics (workload), backup speed, and the content of the data set being compressed.

  • Oracle Secure Backup compression options are not applicable to database backups performed using RMAN.

    For database backups, similar compression options can be specified as part of RMAN commands.
  • Oracle Secure Backup compression options are not applicable to NDMP hosts (--access ndmp).

  • If Oracle Secure Backup finds hardware capable of doing hardware compression, then it disables any software compression option that may be set, with appropriate warning messages as part of the job.

--go

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.

Examples

Example 2-4 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 2013/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-5 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 2012/03/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 2013/03/17.16:30
    Priority:               100
    Privileged op:          no
    Run on host:            (administrative server)
    Attempts:               1

Example 2-6 Backing Up to a Disk Pool

This example creates a file-system backup that is immediately forwarded to the scheduler. Because a priority was not specified, the default value of 100 is used. The data to be backed up is stored in the dataset my_datasets/bk_fs_sun.ds. The --restrict option indicates that the backup is restricted to use the disk pool dp2 or dp3.

ob> backup --dataset my_datasets/bk_fs_sun.ds --restrict dp2,dp3 --go
Info: backup request 1 (dataset my_datasets/bk_fs_sun.ds) submitted; job id is admin/7.

ob> lsjob --long admin/7
admin/7:
    Type:                   dataset my_datasets/bk_fs_sun.ds
    Level:                  full
    Family:                 (null)
    Encryption:             off
    Scheduled time:         none
    State:                  completed successfully at 2013/04/23.03:54
    Priority:               100
    Privileged op:          no
    Run on host:            (administrative server)
    Attempts:               1

Example 2-7 Backing Up to a Cloud Storage Device

ob> backup --dataset my_datasets/bk_fs_sun.ds –encryption on --restrict clodev --go
Info: backup request 1 (dataset tbrset/entire_backup) submitted; job id is admin/9.

ob> lsjob --long admin/9
admin/9:
    Type:                   dataset my_datasets/bk_fs_sun.ds
    Level:                  full
    Backup name format:     (system default)
    Family:                 (null)
    Encryption:             on
    Disable h/w encryption: no
    Store catalog on media: yes
    Scheduled time:         none
    State:                  completed successfully at 2017/10/31.11:36
    Priority:               100
    Privileged op:          no
    Run on host:            (administrative server)
    Attempts:               1
ob>

Example 2-8 Transferring Backup Ownership to Another User

This example creates an on-demand file-system backup and transfers the ownership to the Oracle Secure Backup user bkup_usr1. The data to be backed up is stored in the dataset my_datasets/bk_fs_week.

ob> backup -D my_datasets/bk_fs_week -u bkup_usr1 –go
Info: backup request 1 (dataset my_datasets/bk_fs_week) submitted; job id is bkup_usr1/3.

borrowdev

Purpose

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 commands

Prerequisites

You must have the right to manage devices and change device state to use the borrowdev command.

Syntax

borrowdev::=

borrowdev drive-name...

Semantics

drive-name

Specifies the name of the tape drive to borrow.

Examples

Example 2-9 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-10 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-11 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: 2013/04/11.18:36:44 ______________________________________________________________________
admin/6.1: 2013/04/11.18:36:44
admin/6.1: 2013/04/11.18:36:44         Transcript for job admin/6.1 running on brhost2
.
.
.
admin/6.1: Backup started on Mon Apr 11 2013 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

canceljob

Purpose

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 commands

Prerequisites

If 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.

Syntax

canceljob::=

canceljob [ --quiet/-q | --verbose/-v ] job-id...

Semantics

--quiet/-q

Suppresses output.

--verbose/-v

Displays verbose output.

job-id

Specifies the job identifier of the job to be canceled. You can display job identifiers with the lsjob command.

Example

Example 2-12 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>

catalog

Purpose

Imports stored backup catalog data from the specified backup container in the administrative domain into the backup catalog.

Use the catalog command in the following scenarios:

  • During disaster recovery

    If the Oracle Secure Backup catalog is damaged and no backup copy of the catalog is available, then you can use the catalog command to recreate the catalog.

  • When a disk pool is replicated to a different storage system

    You can import the backup image instances in the replicated copy into a backup catalog that belongs to a different administrative domain.

  • Importing a volume set

    You can import backup catalog data while importing a volume set in a new administrative domain.

Prerequisites

The volume set that is being cataloged must be a part of the Oracle Secure Backup volumes database. Use the identifyvol command or importvol command with the --identity option to include the volume set in the volumes database.

Usage Notes

When you run the catalog command, Oracle Secure Backup creates a catalog import job. Oracle Secure Backup scans the contents of the volume set, disk pool device, or cloud storage device and identifies the backup image instances that are not currently stored in the backup catalog. When the catalog import job is processed, the backup catalog is updated with the instances identified during the scan. If the catalog operation detects a backup image from a client that does not exist in the current administrative domain, it creates a dummy host with the same name and the UUID as that backup image. This host is solely maintains relevant logs and cannot be used for backup and restore operations.

When cataloging a disk pool or cloud storage device, use the --device option before specifying the name of the device. If you don't use this option, then the catalog command automatically assumes the backup container is a tape volume and displays an error.

After a catalog import job completes, use the catxcr command to display the transcript associated with this catalog import job.

Syntax

catalog::=

catalog
[--firstfullimage/-f] [--quiet/-q | --verbose/-V] [--forcecatimport/-F] 
[--debug/-e...] [--fastcatalogonly/-Y] [--foreground/-g]
[--priority/-p schedule-priority] [--waitfor/-W duration]
{[--vid/-v vid] | [--barcode/-b tag] | [--void/-o void] |
[--backupsectionoid/-B oid]}
{[--device/-d devicename] | [--drive/-D drivename]}

Semantics

--firstfullimage/-f

Specifies that the catalog import job on tape will begin from the backup image instance that begins with the first backup section. All existing archive sections will be skipped and all subsequent backup image instances are imported.

--quiet/-q

Specifies that details of the import operation must not be displayed. Only a simplified version of the volume label and archive label is displayed.

--verbose/-V

Specifies that additional details about the catalog import operation such as backup catalog data, volume labels, and archive labels must be displayed. If this option is omitted, a simplified version of the volume labels and archive labels is displayed.

If neither the --quiet nor the --verbose option is specified, then Oracle Secure Backup displays basic information about the catalog import job.

--forcecatimport/-F

Enables you to import backup catalog data, even if some volumes in a volume set are not present in the volumes database. Oracle Secure Backup imports catalog data from the existing volumes into the backup catalog.

This option is useful when one or more volumes in a volume set is missing. It also recatalogs existing backups in the backup catalog using information from the backup container.

However, if the catalog spans multiple tape volumes and any of these volumes containing catalog data is missing, the information will not be imported.

--debug/-e

Specifies that additional debugging information must be written to the log files. This information is useful in debugging errors that may be caused during the catalog import job. Specifying this option multiple times increases the amount of debug information written to the log files.

--fastcatalogonly/-Y

Specifies that only backup image instances that have the associated backup catalog data must be imported.

--foreground/-g

Specifies that the catalog operation will be performed directly, without creating a prior catalog import job. Use this option only for tape volumes.

--priority/-p schedule-priority

Specifies the priority associated with this catalog import job.

--waitfor/-W duration

Specifies the amount of time that Oracle Secure Backup waits for the catalog job to complete. After this specified duration is exceeded, Oracle Secure Backup either displays a new obtool command prompt or exits from obtool if the catalog command was invoked directly from a system command prompt.

See "duration" for a description of the duration placeholder.

--vid/-v vid

Specifies the unique volume ID of the tape volume or volume set whose data must be imported into the backup catalog. Oracle Secure Backup imports catalog data starting with the first volume in the volume set. Typically, this involves loading a previous tape volume. If the --firstfullimage option is specified, then the cataloging process begins with the backup image instance that begins on this volume. Use the lsvol command to obtain the volume ID of tape volumes.

See "vid" for a description of the vid placeholder.

--barcode/-b tag

Specifies the barcode of the tape volume whose data must be imported into the backup catalog. Use the lsvol command to obtain the barcode of volumes.

--void/-o void

Specifies the catalog identifier of the volume whose data must be imported into the backup catalog. Use the lsvol command to obtain the volume ID, lsbu command to display the backup ID, and lspiece command to display the piece OID for this volume.

--backupsectionoid/-B

Specifies the backup section ID of the backup section that must be imported into the backup catalog. Use the lssection command to determine the backup section ID (BSOID) of backup sections.

--device/-d devicename

Specifies the name of the disk pool whose catalog data must be imported into the backup catalog.

--drive/-D drivename

Specifies the name of the tape volume whose data is being imported into the backup catalog. If no drive is specified, any available tae drive may be used for the catalog operation.

Examples

The catalog command creates a catalog import job. When the catalog import job completes, you can use the catxcr command to display the transcript associated with this job.

In Example 2-13, the lsvol command lists the volumes in tape drive vt1. The catalog command then imports and catalogs the volume with the volume ID VOL000001. Cataloging this volume will begin from the backup image instance with the first available backup section.

The catxcr command displays the transcript of the catalog job with the job ID admin/20.

Example 2-13 Cataloging a Volume

ob> lsvol --drive vt1
Inventory of library vlib1:
  * in    1:             volume RMAN-DEFAULT-000001, barcode 8ebd80f28e4a1039fd900163e359724, 42134336 kb remaining, content manages reuse
    in    dte:           volume VOL000001, barcode 3066e1068e4a10395a300163e359724, 41805312 kb remaining, lastse 2 
  *: in use list
ob> catalog -V --vid VOL000001 --firstfullimage --priority 100
Info: catalog import request 1 submitted; job id is admin/20.
ob> catxcr admin/20
2013/04/25.02:44:31 ______________________________________________________________________
2013/04/25.02:44:31
2013/04/25.02:44:31         Transcript for job admin/20 running on brhost1
2013/04/25.02:44:31
Volume label:
    Volume tag:             3066e1068e4a10395a300163e359724
    Volume UUID:            35af92b6-8e4a-1030-b7a1-00163e359724
    Volume ID:              VOL000001
    Volume sequence:        1
    Volume set owner:       root
    Volume set created:     Mon Apr 22 23:47:04 2013
 
Archive label:
    File number:            1
    File section:           1
    Owner:                  root
    Client host:            brhost2
    Backup level:           0
    S/w compression:        no
    Archive created:        Mon Apr 22 23:47:04 2013
    Archive owner:          admin (UUID 2c29a0ce-8e4a-1030-aa47-00163e359724)
    Owner class:            admin (UUID 2c17868c-8e4a-1030-aa47-00163e359724)
    Encryption:             off
    Catalog data:           yes
    Backup image UUID:      35948336-8e4a-1030-b7a1-00163e359724
    Backup instance UUID:   3594834a-8e4a-1030-b7a1-00163e359724
.
.
.
Importing catalog by reading attached data.Reached end of volume set

Example 2-14 Cataloging a Disk Pool

This example catalogs the disk pool dp1.

ob> lsdev --long dp1
dp1:
    Device type:            disk pool
    In service:             yes
    Debug mode:             no
    Capacity:               (not set)
    Consumption:            0
    Free space goal:        (system default)
    Concurrent jobs:        (unlimited)
    Blocking factor:        (default)
    Max blocking factor:    (default)
    UUID:                   53860d36-2a27-1032-a210-00163e527899
    Attachment 1:
        Host:               brhost3
        Directory:          /net/slc02qdv/scratch/test/osb_ds/temp
ob> catalog --verbose --priority 100 --device dp1
Info: catalog import request 1 submitted; job id is admin/23

catds

Purpose

Use the catds command to list the contents of a dataset file created with the mkds command.

See Also:

"Dataset Commands" for related commands

Prerequisites

You must have the display administrative domain's configuration right to use the catds command.

Syntax

catds::=

catds dataset-file-name...

Semantics

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

Example 2-15 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
#  this 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

catrpt

See Also:

"Reports Commands" for related commands

Purpose

Use 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.

Prerequisites

You must have the modify administrative domain's configuration right to use the catrpt command.

Syntax 1

Use the following syntax to display volume pick or distribution reports.

catrpt::=

catrpt --type/-t { pick | distribution } job-id...

Semantics 1

--type /-t

Specifies the report type, pick or distribution, to be displayed for the specified jobs.

job-id

The job ID of the media movement or volume duplication job.

Syntax 2

Use the following syntax to display a volume location report.

catrpt::=

catrpt --type/-t location [ --location/-L location_name ] [ --intransit/-I ]

Semantics 2

--type/-t location

Specifies the report type to be displayed for the specified location.

--location location_name

Specifies the location for which you want a location report.

--intransit/-I

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.

Syntax 3

Syntax 3

Use the following syntax to display an exception or missing report.

catrpt::=

catrpt --type/-t { exception | missing } [ --location/-L location_name ]

Semantics 3

--type/-t

Specifies the report type to be displayed for the specified location.

--location location_name

Specifies the location for which you want an exception or missing report.

Syntax 4

Use the following syntax to display a volume schedule report.

catrpt::=

catrpt 
{ --type/-t schedule } [ --from/-F from_date ] [ --to/-T to_date ]
[ --location/-L location_name ]

Semantics 4

--type /-t schedule

Specifies the report type to be displayed for the specified location.

--from

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.

--to

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.

--location

Specifies the location for which you want a volume schedule report.

Example

Example 2-16 Listing Media Movement Reports

This example uses the catrpt command to display a pick list of the media movement job created in Example 2-46.

ob> catrpt --type pick 2
                 Oracle Secure Backup Pick List Report
                       Location - vlib1
 
  Volume ID          Barcode            Move Date       Next Loc        
------------------------------------------------------------------------
VOL000001          e53b658a2d2710390a700163e527899 2013/11/12   lib1

catxcr

Purpose

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 commands

Prerequisites

If 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.

Syntax

catxcr::=

catxcr [ --level/-l msglevel ] [ --noinput/-N ] [ --msgno/-m ]
[ --start/-s msgno | --head/-h nlines | --tail/-t nlines ]
[ --follow/-f ] job-id...

Semantics

--level /-l msglevel

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. To request and view lower level messages, you must request that they be generated when the job is initiated, by using the --debug option of the catalog command.

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.

Table 2-1 Message Levels

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)

--noinput/-N

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.

--msgno/-m

Prefixes each line with its message number.

--start/-S msgno

Starts displaying at the line whose message number is msgno.

--head/-h nlines

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.

--tail nlines

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.

--follow/-f

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.

job-id

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.

Examples

Example 2-17 Displaying a Job Transcript

This example displays the transcript for a job whose ID is sbt/1.1.

ob> catxcr sbt/1.1
2013/03/21.10:19:39 ______________________________________________________________________
2013/03/21.10:19:39
2013/03/21.10:19:39         Transcript for job sbt/1.1 running on osbsvr1
2013/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 2013
    Media family:       RMAN-DEFAULT
    Volume set expires: never; content manages reuse

Example 2-18 Displaying the Transcript for a Hanging Backup

In Example 2-9, 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
:

Example 2-19 Displaying a Job Continuously

This example continually displays the transcript for job sbt/1.1. The example disables input requests and displays all message levels.

ob> catxcr --noinput --follow --level 0 sbt/1.1

Example 2-20 Displaying Warnings for a Job

This example displays all errors and warnings for jobs admin/1.1 and admin/2.

ob> catxcr --level warning admin/1.1 admin/2

cd

Purpose

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 and backup image instances. 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 commands

Prerequisites

The rights needed to run the cd command depend on the browse backup catalogs with this access setting for the class.

Syntax

cd::=

cd [ --host/-h hostname ] [ --viewmode/-v viewmode ]
[ --select/-s data-selector[,data-selector]... ] 
[ pathname ]

Semantics

--host/-h hostname

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.

--viewmode/-v viewmode

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 and are present in the current path.

  • inclusive makes visible all entries regardless of the current data selector (default).

  • specific makes visible all entries that match the specified data selector.

--select/-s data-selector

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 by cd do not affect the lsbu command, which lists all backups unless a data-selector is specified by lsbu.

pathname

Specifies the path name to browse in the Oracle Secure Backup catalog.

Example

Example 2-21 Changing Directories

This example sets the host to brhost2, changes into the root directory of the Oracle Secure Backup catalog, and displays its contents.

ob> cd --host brhost2
ob> cd /
ob> ls
/home

cdds

Purpose

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 commands

Prerequisites

You must have the display administrative domain's configuration right to use the cdds command.

Syntax

cdds::=

cdds [ dataset-dir-name ]

Semantics

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.

Example

Example 2-22 Making a Dataset Directory

This example lists the contents of the top-level directory, changes into the mydatasets subdirectory, and then shows the name of the current directory.

ob> lsds
Top level dataset directory:
mydatasets/
ob> cdds /mydatasets
ob> pwdds
/mydatasets

cdp

Purpose

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:

Prerequisites

You must have the display administrative domain's configuration right to use the cdp command.

Syntax

cdp::=

cdp [ policy-name ]

Semantics

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

Example 2-23 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

chauth

Purpose

Use the chauth command to reconfigure an existing authentication object for use with Oracle Secure Backup. An authentication object specifies credentials used to perform backups to Oracle Cloud, both Oracle Cloud Infrastructure and Oracle Cloud Infrastructure Classic.

Prerequisites

You must have the modify administrative domain's configuration right to run the chauth command.

Syntax 1

Use the following syntax to reconfigure an existing authentication object for use with Oracle Cloud Infrastructure.

chauth::=

chauth 
[--comment/-c comment] [--inputcomment/-i]
[--fingerprint/-f  key-finger-print] [--keyfile/-k key-file-path]
[--tenancyocid/-o tenancy-ocid] [--userocid/-u user-ocid]
[--url/-r url]
authobj-name

Semantics

--comment/-c comment

Specifies comment text to describe the authentication object.

--inputcomment/-i

Causes chauth to prompt to enter comment text.

--fingerprint/-f key-finger-print

Specifies the fingerprint for the public key. A public key and private key are required to authenticate with Oracle Cloud Infrastructure. Because the fingerprint is associated with a public key file, it must be updated when the public key file is changed.

--keyfile/-k key-file-path

Specifies the path to the RSA private key file. This file muct be in the PEM format.

--tenancyocid/-o tenancy-ocid

Specifies the tenancy OCID of the Oracle Cloud Infrastructure account.

--userocid/-u user-ocid

Specifies the user OCID of the cloud storage user.

--url/-r url

Specifies the region-specific URL of Oracle Cloud Infrastructure account.

authobj-name

Specifies the name of the authentication object that contains the credentials used to authenticate with Oracle Cloud Infrastructure.

Syntax 2

Use the following syntax to reconfigure an authentication object for use with Oracle Cloud Infrastructure Classic.

Semantics 2

chauth::=

chauth     
[--comment/-c comment] [--inputcomment/-i]
{--username/-n cloud-user} {--queryp/-q}
[--url/-r url]
authobj-name

The following options enable you to configure an authentication object for Oracle Cloud Infrastructure Classic

--comment/-c comment

Specifies comment text to describe the authentication object.

--inputcomment/-i

Causes chauth to prompt to enter comment text.

--username/-n cloud-user

Specifies the user name of the storage user for Oracle Cloud Infrastructure Classic.

--queryp/-q

Causes chauth to prompt for the password for the Oracle Cloud Infrastructure Classic account. Use this option to update the password when the cloud password expires or is changed by the administrator.

--url/-r url

The endpoint URL provided by Oracle Cloud, which must include your identity domain name. The endpoint URL is usually the following, where example is the name of the identity domain: example.storage.oraclecloud.com.

authobj-name

Specifies the name of the authentication object.

Examples

Example 2-24 Changing the OCI Public Key Fingerprint of an Authentication Object

This example changes the Oracle Cloud Infrastructure public key fingerprint used by an authentication object.

ob> lsauth -l auth_02
auth_02:
    Type:                   oci
    Tenancy ocid:           ocid1.tenancy.oc1..aaacghaavjhmkf6c1z2olihuob3nwen8iqx73v6fs3vpdb3v21w7r4wjc2ka
    User ocid:              ocid1.user.oc1..aaacghaaqm771pieyhvpaq69t7tunisjkn7x7stcnksj7jnqc73am7wm7lva
    Key fingerprint:        c5:09:dd:f5:d6:88:2c:63:b1:19:b6:39:09:9c:90:fb
    Identity domain:        testdomain
    URL:                    https://console.us-phoenix-1.oraclecloud.com
    UUID:                   ddf03c9a-ca09-1036-90bb-fa163e381872
ob> chauth -f 69:7f:3b:fc:50:3a:72:83:ff:e5:a6:88:30:b7:ee:a4 auth_02          
ob> lsauth -l auth_02
auth_02:
    Type:                   oci
    Tenancy ocid:           ocid1.tenancy.oc1..aaacghaavjhmkf6c1z2olihuob3nwen8iqx73v6fs3vpdb3v21w7r4wjc2ka
    User ocid:              ocid1.user.oc1..aaacghaaqm771pieyhvpaq69t7tunisjkn7x7stcnksj7jnqc73am7wm7lva
    Key fingerprint:        69:7f:3b:fc:50:3a:72:83:ff:e5:a6:88:30:b7:ee:a4
    Identity domain:        testdomain
    URL:                    https://console.us-phoenix-1.oraclecloud.com
    UUID:                   ddf03c9a-ca09-1036-90bb-fa163e381872
ob>

chclass

Purpose

Use the chclass command to change the attributes of a user class.

Prerequisites

You must have the modify administrative domain's configuration right to use the chclass command.

See Also:

Syntax

chclass::=

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 } ] [ --browse/-b browserights ]
[ --querydevs/-q {yes | no}]       [ --managedevs/-d {yes | no} ]
[ --listownbackups/-s {yes | no} ] [ --modownbackups/-S {yes | no} ]
[ --listanybackup/-u {yes | no} ]  [ --modanybackup/-U {yes | no} ]
[ --orauser/-o {yes | no} ]        [ --orarights/-O oraclerights ]
[ --fsrights/F fsrights ]          [ --listconfig/-L {yes | no} ]
[ --modcatalog/-c {yes | no} ]
classname...

Semantics

See "mkclass" for descriptions of the options.

classname

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.

Example

Example 2-25 Changing Classes

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.

ob> lsclass --backuppriv yes
admin
operator
ob> chclass --backuppriv yes user
ob> lsclass --backuppriv yes
admin
operator
user

chdev

Purpose

Use the chdev command to change the attributes of a configured tape drive, tape library, disk pool, or cloud storage device. Use the mkdev command to initially configure a tape device, disk pool, or cloud storage device.

See Also:

"Device Commands" for related commands

Prerequisites

You must have the modify administrative domain's configuration right to use the chdev command.

Usage Notes

While using chdev with ACSLS libraries or tape drives contained in an ACSLS library, certain device attributes that affect library operations cannot be modified when obacslibd is running. Such attributes can be modified only when obacslibd is stopped.

See Also:

More information about attributes that cannot be modified when obacslibd is running is available at:

  • "Semantics 4" for tape drives contained within an ACSLS library

  • "Semantics 5" for ACSLS tape libraries

  • "Semantics 6" for ACS cartridge access port (CAP) within an ACSLS library

Syntax 1

Use the following syntax to reconfigure a tape drive.

chdev::=

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 ]  
[ --minwritablevolumes/-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 ]  [--positioninterval/-q positioninterval]
[ --serial/-N serial-number ] [ --model/-L model-name ]
[ --updateserialnumber/-S ]              
[ --enablechecksum/-K {yes | no | systemdefault}]
devicename...

Syntax 2

Use the following syntax to reconfigure a tape library.

chdev::=

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 | default } ] 
[ --unloadrequired/-Q { yes | no } ]
[ --serial/-N serial-number ] [ --model/-L model-name ]
[ --updateserialnumber/-S]
[ --ejection/-j etype] [--minwritablevolumes/-V minvols]
devicename...

Semantics 1 and 2

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.

--addattach/-A aspec

Adds a device attachment for a tape drive or tape library. Refer to "aspec" for a description of the aspec placeholder.

--class/-x vtl

Specifies library class as VTL.

--rmattach/-R aspec

Removes a device attachment for a tape drive or tape library. Refer to "aspec" for a description of the aspec placeholder.

--uselist/-u se-range

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.

--usage/-U duration

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.

--ejection/-j etype

Specifies the means by which tapes are ejected. Values are automatic, ondemand, or manual.

--minwritablevolumes/-m n

Specifies the threshold for the minimum number of writeable volumes before Oracle Secure Backup initiates early volume rotation.

--serial/-N serial-number

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"

--updateserialnumber/-S

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.

--enablechecksum/-K {yes | no | systemdefault}

Specifies whether a checksum must be computed and stored while writing backup image instances to this device. The checksum is stored as part of the backup metadata and can be subsequently used to validate backup image instances.

Set one of the following values for enablechecksum:

  • yes: Checksum is computed and stored as part of the backup metadata.

  • no: Checksum is not computed or stored for backup data. Use this option when the device can use hardware-based techniques to verify the integrity of data written.

  • systemdefault: The device policy that is set for this type of device determines if the checksum must be computed and stored along with the backup data. This is the default setting.

    For example, you configure a tape drive with enablechecksum set to systemdefault. The device policy enabletapechecksum is set to yes. In this case, checksums are computed and stored for all backups created on this tape device.

Changes to the checksum computation behavior are applicable only to backups created after this setting is modified.

devicename

Specifies the name of the tape library or tape drive to be reconfigured. Refer to "devicename" for the rules governing tape device names.

Syntax 3

Use the following syntax to reconfigure a disk pool.

chdev
[--attach/-a aspec[,aspec]...]
[--addattach/-A aspec[,aspec]...]
[--rmattach/-R aspec[,aspec]...]
[--inservice/-o | --notinservice/-O]
[--capacity/-y size-spec] [--concurrentjobs/-J concjobs]
[--blockingfactor/-f bf] [--maxblockingfactor/-F maxbf]
[--freespacegoal/-G freespacegoal]
[--staging/-h {yes | no}]
[--stagerule/-H stage-rule-name [,stage-rule-name]…] 
[--addstagerule stage-rule-name [,stage-rule-name]…] 
[--mvstagerule [after-stage-rule-name:]
                {start-stage-rule-name} [-end-stage-rule-name]]
[--rmstagerule stage-rule-name ,[stage-rule-name]...]
[--enablechecksum {yes | no | systemdefault}]  
devicename...

Semantics 3

Refer to "mkdev" for descriptions of options that are not included in this section.

--attach/-a aspec

Redefines the host and file-system directory that store backup image instances for the disk pool. All previous definitions of the disk pool are discarded. However, the backup image instances stored in the file-system directory are not affected.

--addattach/-A aspec

Adds a device attachment for a disk pool.

See "aspec" for a description of the aspec placeholder.

--rmattach/-R aspec

Removes a device attachment for a disk pool. See "aspec" for a description of the aspec placeholder.

--staging/-h {yes | no}
Enables or disables staging. (Note that a cloud storage device cannot have staging enabled.)
--addstagerule stage-rule-name [,stage-rule-name]…
Adds stage rule names to the device stage rule list. Provide the list of names as a comma-delimited sequence. The names are added to the end of the list. You can move the names anywhere in the list by issuing another chdev command with the --mvstagerule option.

This option cannot be used if the --stagerule option or the --mvstagerule option is specified.

--mvstagerule [after-stage-rule-name:]{start-stage-rule-name} [-end-stage-rule-name]
Moves one or more stage rules in the device stage rule list. If after-stage-rule-name followed by a colon character is specified, then a rule, or rules, are moved to after after-stage-rule-name in the list of stage rules, otherwise; the rules are moved to the beginning of the list.

The specified rules can be either a single rule on the list, or a range of rules specified by start-stage-rule-name-end-stage-rule-name.

This option cannot be used if the --stagerule option, the --addstagerule option, or the --rmstagerule option is specified.

--rmstagerule stage-rule-name ,[stage-rule-name]...
Removes one or more stage rules from the device stage rule list.

This option cannot be used if the --stagerule option, the --addstagerule option, or the --mvstagerule option is specified.

--enablechecksum {yes | no | systemdefault}

Specifies whether the checksum must be computed and stored while writing backup data to this disk pool. Storing the checksum enables you to validate backups at a later date.

Set one of the following values for enablechecksum:

  • yes: Checksum is computed and stored as part of the backup metadata.

  • no: Checksum is not computed or stored for backup data. Use this option when the device can use hardware-based techniques to verify the integrity of data written.

  • systemdefault: The device policies that are set for this type of device determines if the checksum must be computed and stored along with the backup data.

    For example, you modify a disk pool configuration and set enablechecksum to systemdefault. The device policy enablediskchecksum is set to yes. After the configuration is modified, a checksum is computed and stored for all backup images instances written to this disk pool.

Changes to the checksum computation behavior are applicable only to backup image instances created after this setting is modified.

Syntax 4

Use the following syntax for changing the configuration of a tape drive contained within an ACSLS tape library.

chdev::=

chdev [ --attach/-a aspec ] [ --inservice/-o | --notinservice/-O ] 
[ --addattach/-A aspec[,aspec]... ] [ --rmattach/-R aspec[,aspec]... ]
[ --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 ]  [--positioninterval/-q positioninterval]
[--enablechecksum {yes | no | systemdefault}]
devicename...

Semantics 4

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.

When obacslibd is running, you cannot modify the following attributes of a tape drive that is contained within an ACSLS library:

  • --lsm/s lsm_id

  • --panel/p panel_id

  • --drive/r drive_id

--addattach/-A aspec

Adds a device attachment for tape drives contained in ACSLS libraries. Refer to "aspec" for a description of the aspec placeholder.

--rmattach/-R

Removes a device attachment for tape drives contained in ACSLS libraries. Refer to "aspec" for a description of the aspec placeholder.

--lsm/-s lsm_id

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.

--panel-p panel_id

This option is used only for tape drives contained in ACSLS libraries. It defines the ID of the panel where this tape drive resides.

--drive -r drive_id

This option is used only for tape drives contained in ACSLS libraries. It defines the ID of the drive where this tape drive resides.

--enablechecksum {yes | no | systemdefault}

Specifies whether the checksum must be computed and stored while writing backup data to this device. Storing the checksum enables you to validate backups at a later date.

Set one of the following values for enablechecksum:

  • yes: Checksum is computed and stored as part of the backup metadata.

  • no: Checksum is not computed or stored for backup data. Use this option when the device can use hardware-based techniques to verify the integrity of data written.

  • systemdefault: The value set for the enabletapechecksum device policy determines whether a checksum must be computed and stored along with the backup data.

Changes to the checksum computation behavior are applicable only to backups created after this setting is modified.

Syntax 5

Use the following syntax to reconfigure an ACSLS tape library.

chdev::=

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...

Semantics 5

Use the following syntax for reconfiguring an ACSLS tape library. See "Semantics 1 and 2" for options not identified here.

When obacslibd is running, you cannot modify the following attributes of an ACSLS tape library:

  • --attach/-a aspec

  • --userid/-n acs-userid

  • --acsid/-g acs_id

  • --port/-P port_num

--attach/-a aspec...

This option specifies the Oracle Secure Backup media server and ACSLS server for an ACSLS tape library. The format of aspec is mediaservhostname:acslshost

--userid/-n acs_userid

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.

--acsid/-g acs_id

This option specifies the ACS ID value for the ACSLS tape library to control.

--port/-P port_num

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.

Syntax 6

Use the following syntax to associate a symbolic name with an ACS cartridge access port (CAP) within an ACSLS tape library.

chdev::=

chdev [ --library/-L devicename ] 
[ --lsm/s lsm_id ] [ --capid/-c cap_id ]
capname 

Semantics 6

Use the following semantics to associate a symbolic name with an ACS cartridge access port (CAP) within an ACSLS tape library.

When obacslibd is running, you cannot modify the following attributes of an ACS CAP within an ACSLS tape library:

  • --lsm/s lsm_id

  • --capid/-c cap_id

--library/-L devicename

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.

--capid/-c cap_id

This option specifies the hardware location of the CAP within the selected tape library.

--lsm /-s lsm_id

This option specifies the ACS Library Storage Module of the CAP within the selected tape library.

capname

The name of the Oracle Secure Backup CAP object to be created.

Syntax 7

Use the following syntax to reconfigure a cloud storage device.

chdev::=

chdev --type/-t cloudstorage 
[--mediasserver media server,media server,...]
[--addmediaserver mediaserver,mediaserver,...]
[--rmmediaserver mediaserver,mediaserver,...]     
[--inservice/-o | --notinservice/-O] 
[--segmentsize segment-size]
[--capacity/-y size-spec] 
[--username cloud-user] 
[--querypassphrase]
[--streamspersjob streams-per-job] 
[--concurrentjobs/-J concjobs]
[--blockingfactor/-f bf] 
[--maxblockingfactor/-F maxbf]
[--freespacegoal/-G freespacegoal] 
[--authobj/-z auth-obj] [--url cloud-url] [--force]
[--enablechecksum {yes | no | systemdefault}]
devicename...

Semantics 7

Use the following semantics to reconfigure a cloud storage device.

Refer to "mkdev" for descriptions of options that are not included in this section.

--mediaserver mediaserver[,mediaserver]
Name of the attached media server. If multiple media servers are specified, then Oracle Secure Backup verifies that the container is reachable via all specified media servers.

When a media server is specified, all data is sent from the client to the media server. The media server then buffers and uploads the data to the cloud. Running too many jobs on the same media server may affect performance.

The media server must have a cloud wallet. See Oracle Secure Backup Installation and Configuration Guide for information about creating a cloud wallet and importing it into media servers.

--addmediaserver mediaserver[,mediaserver]
Adds one or more media servers
--rmmediaserver mediaserver[,mediaserver]
Removes one or more media servers
--inservice/-o | --notinservice/-O
The inservice option sets the status of the cloud storage device so that it is logically available to Oracle Secure Backup. The notinsevice option sets the status of the cloud storage device so that it is not logically available to Oracle Secure Backup.
--capacity/-y size-spec
Specifies the amount of space that the cloud storage device can occupy in the configured cloud account identity domain. The size-spec placeholder specifies the size of the cloud storage device. Enter a numeric value followed by unit. The unit for cloud storage device device size can be one of the following: KB, MB, GB, TB, PB or EB. Enter zero to indicate that there is no limit on the size of the cloud storage device. In this case, the size of the cloud storage device is limited only by the quota purchased for the cloud account identity domain or quoata set for the corresponding container configured in cloud storage device.

If the size of backup image instances on the cloud storage device exceeds the specified capacity, then Oracle Secure Backup does not schedule any further jobs for this cloud storage device until the space consumption drops below the capacity.

If you use the chdev command to change the size of a cloud storage device, then the value you specify cannot be lower than the space currently occupied by the cloud storage device, or the command will fail.

--username cloud user
User name of the cloud account
--container container name
Name of the container in cloud storage. A container is a storage compartment that provides a way to organize the data stored in Oracle Cloud Infrastructure.
--segmentsize segment size

Oracle Secure Backup stores each backup image by splitting it into multiple segments and storing each segment as a single object in a cloud storage container. The segment size defines the size of object.

--streamsperjob num
Oracle Secure Backup can make multiple connections to Oracle Cloud Infrastructure for faster uploads of data. The streamsperjob value defines the number of connections that Oracle Secure Backup can make per job.
--concurrentjobs num
Specifies the maximum number of jobs that can run concurrently for this device. This includes backup, restore, and device management-related jobs. See concjobs for more information.
--blockingfactor/-f bf
Specifies a blocking factor. A blocking factor determines how many 512-byte records to include in each block of data written to the device. By default, Oracle Secure Backup writes 64K blocks, which is a blocking factor of 128.
--maxblockingfactor/-F maxbf
Specifies a maximum blocking factor. The maximum blocking factor controls the amount of data that Oracle Secure Backup initially reads from the device whose blocking factor is unknown.
--freespacegoal/-G freespacegoal
Specifies the percentage of cloud storage device capacity that the device manager must maintain by proactively deleting expired backup image instances.
--authobj/-z auth-obj

Specifies the authentication object that contains the credentials required to authenticate this cloud storage device Oracle Cloud Infrastructure Object Storage or Oracle Cloud Infrastructure Object Storage Classic. Authentication objects are created using the mkauth command.

The specified authentication object must be of the same type as the device being modified. When used with Oracle Cloud Infrastructure Object Storage Classic, the authentication object settings take precedence over credentials specified using the Oracle Cloud storage account's identify domain, URL, and user name.

--url url to cloud
The URL for the Oracle Cloud storage account. It is defined as identity domain.storage.oraclecloud.com
--identitydomain identify domain name
The identity domain name that is associated with the user's cloud storage service.
--enablechecksum {yes | no | systemdefault}

Specifies whether the checksum must be computed and stored while writing backup data to this device. Storing the checksum enables you to validate backups at a later date.

Set one of the following values for enablechecksum:

  • yes: Checksum is computed and stored as part of the backup metadata.

  • no: Checksum is not computed or stored for backup data. Use this option when the device can use hardware-based techniques to verify the integrity of data written.

  • systemdefault: The device policies that are set for this type of device determines if the checksum must be computed and stored along with the backup data.

    For example, you modify a cloud storage device configuration and set enablechecksum to systemdefault. The device policy enablecloudchecksum is set to yes. After the configuration is modified, a checksum is computed and stored for all backup image instances written to this Cloud storage device.

Changes to the checksum computation behavior are applicable only to backup image instances created after this setting is modified.

devicename
Name of the cloud storage device being reconfigured

Examples

Example 2-26 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 
    Enable checksum:        (system default)
    Model:                  [none]
    Serial number:          06667256
    In service:             yes
    Library:                lib1
    DTE:                    1
    Automount:              yes
    Error rate:             8
    Position interval:      [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
    Position interval:      [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-27 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

Example 2-28 Reconfiguring a Disk Pool

This example reconfigures a disk pool called dp1 and creates an attachment to the file-system directory /scratch/osb_test/virtual_devices/dp3 on the host brhost3. The capacity of the disk pool is modified to 50GB and the free space goal is 70%.

ob> chdev --attach brhost3:/mydirectory/my_tests/virtual_devices/dp3 --capacity 50GB --freespacegoal 70 dp1
ob> lsdev -l dp1
dp1:
    Device type:            disk pool
    Enable checksum:        (system default)
    In service:             yes
    Debug mode:             no
    Capacity:               50.0 GB
    Free space goal:        70%
    Concurrent jobs:        (unlimited)
    Blocking factor:        (default)
    Max blocking factor:    (default)
    UUID:                   7cbb3ef0-8e57-1030-bb79-00163e359724
    Attachment 1:
        Host:               brhost3
        Directory:          /mydirectory/my_tests/virtual_devices/dp3

Example 2-29 Reconfiguring a Cloud Storage Device

This example changes the blocking factor, max blocking factor, streams per job, and segment size of a cloud storage device named myCloud1.

ob> chdev --segmentsize 20MB -f 2048 -F 2048 --streamsperjob 10 myCloud1
ob> lsdev -l myCloud1
jsmithCloud1:
    Device type: cloud storage
    Enable checksum: (system default)
    In service: yes
    Debug mode: no
    Capacity: (not set)
    Consumption: 191.5 MB
    Reclaimable space: 191.5 MB
    Free space goal: (system default)
    Concurrent jobs: 5
    Blocking factor: 2048
    Max blocking factor: 2048
    UUID: 186b10d8-a3fa-4f35-9171-80c7c4139297
    Attachment 1:
        Host: MYHOST
    Staging: no
    URL: example.storage.oraclecloud.com
    Username: jsmith@example.com
    Container: myCloud1
    Storage class: object
    Identity domain: example
    Segment size: 20.0 MB
    Streams per job: 10
    Number of objects: 23
    Bytes used: 191.7 MB
ob>

Example 2-30 Modifying a Disk Pool Configuration and Enabling Checksum Computation

Currently, checksums are not computed and stored for backup images instances that are written to the disk pool my_dp. This example modifies the configuration of the disk pool my_dp and enables checksum computation. From this point onwards, a checksum is computed and stored for all backup image instances written to my_dp.

ob> chdev --enablechecksum yes my_dp
ob> 

chdup

Purpose

Change the settings of a volume duplication policy.

Prerequisites

You must have the modify administrative domain's configuration right to use the chdup command.

Syntax

chdup::=

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

Semantics

--comment/-c commentstring

A descriptive comment for the volume duplication policy.

--inputcomment/-i

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.

--trigger/-e dupevent:duration

Specifies when a volume becomes eligible for duplication. The duration placeholder specifies how long after dupevent the volume becomes eligible for duplication.

--restrict/-r restriction...

Replaces any specified backup container restrictions for this duplication policy with the specified restrictions. If you do not specify a restriction, then this volume duplication policy has no restrictions, and can use any available backup container 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.

--addrestrict/-R restriction...

Adds specified tape device restrictions to the tape device restriction for this duplication policy. Existing restrictions are retained.

--rmrestrict/-S restriction...

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.

--migrate/-m

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.

--rule/-u duplicationrule

Specifies the duplication rules for this duplication policy.

--addrule/-U duplicationrule

Adds the specified duplication rule to the set of rules for this duplication policy.

--rmrule/-V duplicationrule

Removes the specified duplication rule from the set of rules for this duplication policy.

--chrule/-h duplicationrule

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.

Example

Example 2-31 Modifying a Duplication Policy

This example changes the trigger, restriction, and rule settings or the duplication policy voldup1, created in Example 3-14.

ob> lsdup
voldup1
ob> chdup --trigger lastwrite:forever --rmrestrict @brhost3 --chrule
RMAN-DEFAULT:3 voldup1
ob> lsdup --long voldup1
voldup1:
     Migrate:                no
     Trigger:                lastwrite : forever
     Rule 1:                 RMAN-DEFAULT : 3
     UUID:                   db4bfd64-18af-1031-b040-00163e527899

chhost

Purpose

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.

You cannot modify a host created by the catalog command using chhost.

See Also:

"Host Commands" for related commands

Prerequisites

You must have the modify administrative domain's configuration right to use the chhost command.

Syntax

chhost::=

chhost 
[ --access/-a { ob | ndmp } ] 
[ --inservice/-o | --notinservice/-O ]
[ --disablerds/-d { yes | no | systemdefault}
[ --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 ]... } ]
[ --compression/-K {off | low | medium | basic | high | “”} ]
hostname...

Semantics

Refer to "mkhost"for options not included in this section.

--access/-a

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.

--passphrase/-s

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.

--addrole/-R role

Adds a role to a host. Refer to "role" for a description of the role placeholder.

--keystoreputonly/-T

Adds a key to the key store without making it the active key.

--tcpbufsize/-c bufsize

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.

--rmrole/-E role

Removes a role from a host. Refer to "role" for a description of the role placeholder.

--ip/-i ipname[,ipname]...

Indicates the IP address of the host computer. 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.

Oracle Secure Backup supports Internet Protocol v4 (IPv4), Internet Protocol v6 (IPv6), and mixed IPv4/IPv6 environments on all platforms that support IPv6.

--addip/-I ipname

Adds an IP address to a host computer.

Oracle Secure Backup supports Internet Protocol v4 (IPv4), Internet Protocol v6 (IPv6), and mixed IPv4/IPv6 environments on all platforms that support IPv6.

--rmip/-P ipname

Removes an IP address from a host computer.

Oracle Secure Backup supports Internet Protocol v4 (IPv4), Internet Protocol v6 (IPv6), and mixed IPv4/IPv6 environments on all platforms that support IPv6.

--nocomm/-N

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.

Note:

The nocomm/-N option is not supported for NDMP hosts.

--addbackupenv/-W evariable-name=variable-value

Adds the specified NDMP backup environment variables.

--rmbackupenv/-x evariable-name

Removes the specified NDMP backup environmental variables.

--addrestoreenv/-Y evariable-name=variable-value

Adds the specified NDMP restore environmental variables.

--rmrestoreenv/-z evariable-name

Removes the NDMP restore environmental variables.

--disablerds/-d { yes | no | systemdefault }

Specifies whether Reliable Datagram Socket (RDS) over Infiniband is used for data transfer between clients and the media server. The valid values are:

  • yes

    Oracle Secure Backup does not use RDS for over Infiniband for data transfer between the host and media server.

  • no

    Oracle Secure Backup uses RDS over Infiniband for data transfer between the host and media server.

  • systemdefault

    This is the default setting. Oracle Secure Backup uses the setting made at the administrative domain level to decide if RDS must be used for data transfer. You use the operations policy disablerds to specify RDS usage at the administrative level. Therefore, if the disablerds operations policy is set to no, and the value of --disablerds for the host is set to systemdefault, the host uses RDS for data transfer.

The --disablerds setting at the host level overrides the setting that you made at the administrative domain level by using the disblerds operations policy. Therefore, if you set the operations policy disablerds to no, and, for a particular host, you set the --disablerds option of the chhost command to yes, RDS is not used for data transfer host.

--compression/-K {off | low | medium | basic | high | “”}
Specifies the compression option to use.
The possible values are as follows:
off
Software compression is not considered for backups in this host regardless of any global policy, if set.
low
Compresses data as best as possible without compromising too much on CPU usage and speed. Choose this option if you want the data compressed, but you do not want backup speed or CPU load to be overly affected.
medium
Provides a balance between compression ratio and speed.
basic
This option is generally better in terms of compression ratio than the medium option. It is slower than the low and medium options, but faster than the high option.
high
Compresses data as much as possible, using extensive CPU. This option is best suited for backups over slower networks where the limiting factor is network speed.
“” (empty quotation marks)
Resets any previously set value to the default setting of compression not set.

The default value is that no compression option is set.

hostname

Specifies the name of the host computer for which you want to make configuration changes.

Example

Example 2-32 Changing a Host

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

chinstance

Purpose

The chinstance command changes the characteristics of a backup image instance.

Prerequisites

You must have the modify any backup, regardless of its owner or modify any backups owned by user class right to use the chinstance command.

Usage Notes

You can modify the expiration date and retention period only for backup image instances that are stored on disk pools.

Syntax

chinstance::=

chinstance 
[--expiresat/-x date-time | --retain/-r duration ]
{ [--uuid/-u backup-instance-uuid]... | backup-instance-name... }

Semantics

--expiresat/-x date-time

Specifies the modified expiration time for the backup image instance. See "date-time" for information about the format used to specify the expiration time.

--retain/-r duration

Specifies the modified duration for which this backup image instance must be valid. See "duration" for information about the format used to specify the retention period.

--uuid/-u backup-instance-uuid]... | backup-instance-name...

Specifies the modified UUID or name for the backup image instance.

Examples

This example modifies the backup image instance brhost2-20130423-110518.1 and sets its expiration time to 2013/12/31.

ob> chinstance --expiresat 2013/12/31 brhost2-20130423-110518.1
ob> lsinstance -l brhost2-20130423-110518.1
Instance name:    brhost2-20130423-110518.1
    Type:                   file system
    Client:                 brhost2
    Backup level:           0
    Container:              dp1
    Encryption:             off
    Created:                2013/04/23.04:22
    Expires:                2013/12/31.01:00    Created by job:         admin/13.1
    UUID:                   bbada6c0-8e70-1030-b10a-00163e359724

chkbw

Purpose

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 commands

Prerequisites

You must have the display administrative domain's configuration right to use the chkbw command.

Syntax

chkbw::=

chkbw

Example

Example 2-33 Checking for the Existence of Backup Windows

This example checks whether backup windows exist. In this example, no windows are configured.

ob> chkbw
Note: no backup windows are configured.  Scheduled backups will not run.

chkds

Purpose

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 commands

Prerequisites

You must have the display administrative domain's configuration right to run the chkds command.

Syntax

chkds::=

chkds dataset-file-name...

Semantics

dataset-file-name

Specifies the name of a dataset file. Refer to "dataset-file-name" for a descriptions of the dataset-file-name placeholder.

Examples

Example 2-34 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-35 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

chkdw

Purpose

Use the chkdw command to check for the existence of at least one duplication window.

See Also:

"Duplication Window Commands" for related commands

Prerequisites

You must have the modify administrative domain's configuration right to use the chkdw command.

Syntax

chkdw::=

chkdw

chloc

Purpose

Modify a location object.

See Also:

"Location Commands" for related commands

Prerequisites

You must have the modify administrative domain's configuration right to use the chloc command.

Syntax

chloc::=

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...

Semantics

--comment/-c commentstring

Specifies a descriptive comment for the location. You can specify either --comment or --inputcomment, but not both.

--inputcomment/-i

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.

--mailto/-m email-target[,email-target]

Specifies one or more e-mail recipients for the location.

--addmailto/-a email-target[,email-target]

Specifies one or more e-mail recipients to be added to the location.

--rmmailto/-r email-target[,email-target]]

Specifies one or more e-mail recipients to be removed from the location.

--customerid/-I idstring

A customer ID string. Only valid for a storage location.

--notification/-n ntype

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).

--recalltime/-R duration

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.

locationname

The name of the storage location.

Note:

all is a reserved word and cannot be used as a location name.

Example

Example 2-36 Modifying a Location Object

This example modifies the comment, addmailto, and customerid settings for the location object testloc created in Example 3-18.

ob> lsloc --long testloc
testloc:
    Recalltime:             1 year
    Mail to:                john.doe@oracle.com
    UUID:                   3331c846-18c0-1031-b040-00163e527899
ob> chloc --comment "This is a test storage location" --addmailto jane.doe@example.com --customerid cust1 testloc
ob> lsloc --long testloc
testloc:
    Comment:                This is a test storage location
    Customer ID:            cust1
    Recalltime:             1 year
    Mail to:                john.doe@oracle.com jane.doe@example.com
    UUID:                   3331c846-18c0-1031-b040-00163e527899

chmf

Purpose

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 commands

Prerequisites

You must have the modify administrative domain's configuration right to use the chmf command.

Usage Notes

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

For disk pools, the only media family attribute that is applicable is the expiration time.

Syntax

chmf::=

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...

Semantics

Refer to "mkmf"for descriptions of options that are not included in this section.

--inputcomment/-i

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.

--comment/-c comment

Specifies information to store with the media family. To include white space in comment, surround the text with quotes.

--rotationpolicy/-R

Specifies the rotation policy for the media family.

To clear the rotation policy, specify an empty string ("") for the policy name.

--duplicationpolicy/-D

Specifies the duplication policy for the media family.

To remove a duplication policy, specify an empty string for the policy name.

--acsscratchid/-d acsscratch_id

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.

media-family-name

Specifies the name of the media family to change.

Example

Example 2-37 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

chpni

Purpose

Use the chpni command to modify the configuration of a Preferred Network Interface (PNI) that was set for a host. The mkpni command enables you to configure a PNI for the first time. You can set multiple PNIs for a particular host.

Prerequisites

You must have the modify administrative domain's configuration right to use the chpni command.

Usage Notes

When you use the chpni command, in addition to the IP address of the host, you must specify one of the following options: --client/-c, --addclient/-a, or --rmclient/-r.

Syntax

chpni::=

chpni [{--interface/-i ipname
 [--client/-c client-hostname [,client-hostname] ...] 
 [--addclient/-a client-hostname [,client-hostname] ...]
 [--rmclient/-r client-hostname [,client-hostname] ...] } ]
{[--network/-n network/prefix [,ipaddr]]...
 [--addnetwork/–N network/prefix, [ipaddr]]...
 [--rmnetwork/–R network/prefix, [ipaddr]]...
 [--useonly/–o ipaddr] 
 [--adduseonly/–A ipaddr] 
 [--rmuseonly/-O ipaddr]}
hostname

Semantics

--interface/-i ipname

Specifies the IP address or the DNS host name that the specified clients must use when communicating with the server specified by hostname.

Oracle Secure Backup supports Internet Protocol v4 (IPv4), Internet Protocol v6 (IPv6), and mixed IPv4/IPv6 environments on all platforms that support IPv6.

--client/-c client-hostname [,client-hostname] ...

Specifies one or more clients that should use the ipname when communicating with hostname. The 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 mkpni command.

--addclient/-a client-hostname [,client-hostname] ...

Adds a client to the list of PNIs configured for the host.

--rmclient/-r client-hostname [,client-hostname]...

Removes a client from the list of PNIs configured for the host.

--network/–n network/prefix,ipaddr

Updates the existing outbound PNI for hostname to the one specified by network/prefix.

--addnetwork/–N network/prefix,ipaddr

Adds the specified network as an outbound PNI for hostname. The network is specified using network/prefix. ipaddr is optional and specifies the address to which the connection must bind.

--rmnetwork/–N network/prefix,ipaddr

Removes the specified network and interface as outbound PNI for the host hostname.

--useonly/-o ipaddr

Updates the existing outbound PNI for hostname to the address specified in ipaddr.

--adduseonly/-A ipaddr

Configures the IP address specified by ipaddr as the only interface that must be used for all outbound connections from the host hostname.

--rmuseonly/-O ipaddr

Removes the specified ipaddr as the only interface that must be used for all outbound connections from hostname.

hostname

Specifies the name of the host.

Example

Example 2-38 Adding a PNI for a Host

This example adds a PNI that specifies that the host brhost3 must use the IP address 192.0.2.1 when communicating with the server brhost2. In this example, a PNI already exists for brhost2, and that PNI contains an entry for client brhost1.

ob> chpni --interface 192.0.2.1 --addclient brhost3 brhost2
ob> lspni
brhost2:
  PNI1:
     interface:         192.0.2.1
     clients:           brhost1, brhost3

Example 2-39 Adding a PNI for Outbound Connections for a Host

This example adds a PNI that specifies that the IP address 192.168.1.0 must be used for all outbound connections from the host brhost2.

ob> chpni --network 192.168.1.0/24 brhost2
ob> lspni
brhost2:
    ONI 1:
        network: 192.168.1.0/24

chrot

Purpose

Change the settings of a rotation policy.

See Also:

Prerequisites

You must have the modify administrative domain's configuration right to use the chrot command.

Syntax

chrot::=

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...

Semantics

--comment/-c commentstring

Specifies a descriptive comment for the rotation policy. You can specify either --comment or --inputcomment, but not both.

--inputcomment/-i

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.

--rule/-u rotationrule

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.

--addrule/-A rotationrule

Adds the specified rotation rule to the set of rules for this rotation policy.

--rmrule/-R rotationrule

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.

--chrule/-h

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.

--position/-p n

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.

policyname

Specifies the name for a rotation policy, which can be 1-31 characters.

Example

Example 2-40 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

chsched

Purpose

Use the chsched command to change an existing backup schedule, volume duplication scan, vaulting scan, or stage scan schedule.

See Also:

"Schedule Commands" for related commands

Prerequisites

You must have the modify administrative domain's configuration right to use the chsched command.

Syntax 1

Use the following syntax to change an existing backup schedule.

chsched::=

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 ] ]...
[ --compression/-K  {off | low | medium | basic | high | “”}]
schedulename...

Semantics 1

Refer to "mksched"for option descriptions not included in this section.

--dataset/-D dataset-name

Specifies the dataset to include in the backup job.

--adddataset/-A dataset-name

Adds a dataset to the current schedule.

--rmdataset/-R dataset-name

Removes a dataset from the current schedule.

--enabled/-z

Specifies that the backup schedule be enabled. You can use this option to restart a backup schedule that you earlier disabled.

--disabled/-Z

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.

--encryption/-e

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.

--addrestrict/-E restriction

Adds another tape drive to be used by the backup. Refer to "restriction" for a description of the restriction placeholder.

--rmrestrict/-T restriction

Removes a restriction from a schedule. Refer to "restriction" for a description of the restriction placeholder.

--addtrigger/-a

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.

--chtrigger/-h trigger-number

Edits the specified trigger in the schedule. Specify the --long option on the lssched command to obtain trigger numbers.

--rmtrigger/-m trigger-number

Removes a trigger from the schedule. Specify the --long option on the lssched command to obtain trigger numbers.

--compression/-K {off | low | medium | basic | high | “” }
Specifies a compression option for the backup schedule job that overrides any global and client-level compression options already set.
The possible values are as follows:
off
Software compression is not used for the backup regardless of global and client level policy
low
Compresses data as best as possible without compromising too much on CPU usage and speed. Choose this option if you want the data compressed, but you do not want backup speed or CPU load to be overly affected.
medium
Provides a balance between compression ratio and speed.
basic
This option is generally better in terms of compression ratio than the medium option. It is slower than the low and medium options, but faster than the high option.
high
Compresses data as much as possible, using extensive CPU. This option is best suited for backups over slower networks where the limiting factor is network speed.
“” (empty quotation marks)
Resets any previously set value to the default setting of compression not set.

The default value is that no compression option is set.

If compression is not specified as part of the mksched command, then the client host setting for compression is used. If the client host compression setting is not set, then the domain-level policy is used. If the domain-level policy is also not set, then no software compression is performed for this job.

schedulename

Specifies the name of the schedule.

Syntax 2

Use the following syntax to change an existing vaulting scan schedule.

chsched::=

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...

Semantics 2

Refer to "mksched"for option descriptions not included in this section.

--enabled/-z

Specifies that the vaulting scan schedule be enabled. You can use this option to restart a vaulting scan schedule that you earlier disabled.

--disabled/-Z

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.

--location/-L locationname[,locationname]…

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.

--addlocation/-O locationname[,locationname]…

Adds one or more locations to a vaulting scan schedule.

--rmlocation/-C locationname[,locationname]…

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.

--restrict/-r vault_restriction[,vault_restriction]...

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.

--addrestrict/-E vault_restriction[,vault_restriction]...

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.

--rmrestrict/-T vault_restriction[,vault_restriction]...

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.

--select/-S select_criterion[,select_criterion]...

Restricts a vaulting scan to one or more media families. This option replaces the entire set of media families currently defined for the schedule.

--addselect/-P select_criterion[,select_criterion]...

Adds one or more media families to the vaulting scan.

--rmselect/-U select_criterion[,select_criterion]...

Removes one or more media families from the vaulting scan.

--addtrigger/-a

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.

--chtrigger/-h trigger-number

Edits the specified trigger in the schedule. Specify the --long option on the lssched command to obtain trigger numbers.

--rmtrigger/-m trigger-number

Removes a trigger from the schedule. Specify the --long option on the lssched command to obtain trigger numbers.

schedulename

Specifies the name of the schedule.

Syntax 3

Use the following syntax to change an existing volume duplication scan schedule.

chsched::=

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...

Semantics 3

Refer to "mksched"for option descriptions not included in this section.

--enabled/-z

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.

--disabled/-Z

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.

--location/-L locationname

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.

--addlocation/-O locationname

Adds one or more locations to a volume duplication scan schedule. Only an active location can be specified in a duplication schedule.

--rmlocation/-C locationname

Removes one or more locations from a volume duplication scan schedule.

--addtrigger/-a

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.

--chtrigger/-h trigger-number

Edits the specified trigger in the schedule. Specify the --long option on the lssched command to obtain trigger numbers.

--rmtrigger/-m trigger-number

Removes a trigger from the schedule. Specify the --long option on the lssched command to obtain trigger numbers.

schedulename

Specifies the name of the schedule.

Syntax 4

Use the following syntax to change an existing stage scan schedule.

If you remove a stage scan schedule that is referenced in a stage rule, than an error is generated and the stage scan schedule is not deleted.

chsched::=

chsched 
[ --comment/-c comment | --inputcomment/-i ]
[ --priority/-p schedule-priority ]
[ --enabled/-z | --disabled/-Z ]
[ [ --addtrigger/-a ] |
  [ --chtrigger/-h trigger-number[,trigger-number]... ] |
  [ --rmtrigger/-m trigger-number[,trigger-number]... ] ]
  [ [ --day/-d day-date ][ --time/-t time ] 
schedulename...

Semantics 4

Refer to "mksched"for option descriptions not included in this section.

--enabled/-z

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.

--disabled/-Z

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.

--addtrigger/-a

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.

--chtrigger/-h trigger-number

Edits the specified trigger in the schedule. Specify the --long option on the lssched command to obtain trigger numbers.

--rmtrigger/-m trigger-number

Removes a trigger from the schedule. Specify the --long option on the lssched command to obtain trigger numbers.

schedulename

Specifies the name of the schedule.

Example

Example 2-41 Changing a Backup Schedule

Example 2-41 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 

chssel

Purpose

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 commands

Prerequisites

You must have the modify administrative domain's configuration right to run the chssel command.

Syntax

Syntax

chssel::=

chssel  
[ --dbname/-d { * | dbname[,dbname]...} ]
[ --adddbname/-D { * | dbname[,dbname]...} ]
[ --rmdbname/-E dbname[,dbname]... ]
[ --dbid/-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 ]
[ --encryption/-e {off|on|forcedoff|swencryption}]
[ --waittime/-w duration ] [--name/-N name-format]
[--priority/-p default | <schedule-priority>] job priority
sselname...

Semantics

--dbname/-d dbname

Replaces the current database names for the storage selector with the specified dbname values.

--adddbname/-D dbname

Adds the specified dbname values to the databases currently associated with the storage selector.

--rmdbname/-E dbname

Removes the specified dbname values from the databases currently associated with the storage selector.

--dbid/-i dbid

Replaces the current database ID (DBID) for the storage selector with the specified dbid value.

--adddbid/-I dbid

Adds the specified dbid values to the DBIDs currently associated with the storage selector.

--rmdbid/-J dbid

Removes the specified DBIDs from the storage selector.

--host/-h hostname

Replaces the current hosts for the storage selector with the specified hostname values.

--addhost/-H hostname

Adds the specified hostname values to the hosts currently associated with the storage selector.

--rmhost/-K hostname

Removes the specified hostname values from the hosts currently associated with the storage selector.

--content/-c content

Replaces the current content types for the storage selector with the specified content types. Refer to "content" for a description of the content placeholder.

--addcontent/-C content

Adds the specified content types to the content types currently associated with the storage selector.

--rmcontent/-F content

Removes the specified content types from the content types currently associated with the storage selector.

--restrict/-r restriction

Replaces the current backup container restrictions in the storage selector with the specified restriction values. Refer to "restriction" for a description of the restriction placeholder.

--addrestrict/-R restriction

Adds the specified restriction values to the storage selector.

--rmrestrict/-S restriction

Removes the specified restriction values from the storage selector.

--copynumber/-n * | 1 | 2 | 3 | 4

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.

--family/-f media-family

Replaces the current media family for the storage selector with the specified family. You create media families with the mkmf command.

--waittime/-w duration

Replaces the current resource availability time for the storage selector with the specified duration. Refer to "duration" for a description of the duration placeholder.

--name/-N name-format

Specifies the name assigned to the backup image created by this backup job. You can explicitly specify a name, specify one or more name format variables, or use a combination of name format variable and static values that you specify.

See "name-format" for a description of the name-format placeholder.

--encryption/-e {off | on | forcedoff | swencryption}

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:

The encryption option is only available starting with Oracle Secure Backup 10.3.0.2.0.

–priority/-p job priority
Specifies a positive integer value that sets the priority for an RMAN backup or RMAN restore job. You can set the job priority value between 1 and 2147483647, with 1 being the highest priority. The default schedule-priority value is 100.
sselname

Specifies one or more names of storage selectors to modify.

Example

Example 2-42 Adding Content Types to a Database Backup Storage Selector

Example 2-42 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.

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

chstage

Purpose

Use the chstage command to make changes to an existing stage rule.

Prerequisites

  • You must have admin class rights to change a stage rule.

Syntax

chstage::=

chstage [--comment/-c comment]
        [--schedule/-T schedulename]
        [--matchfamily/-f {* | media-family-name[,media-family-name]…}]
        [--addmatchfamily/-F {media-family-name[,media-family-name]…}]
        [--rmmatchfamily/-g {media-family-name[,media-family-name]…}]
        [--dbname/-d { * | dbname[,dbname]...}] |
        [--adddbname/-D dbname[,dbname]...]
        [--rmdbname/-E { dbname[,dbname]...}]
        [--dbid/-i { * | dbid[,dbid]...}]
        [--adddbid/-I {dbid[,dbid]...}]
        [--rmdbid/-J {dbid[,dbid]...}]
        [--fshost/-h { * | fshostname [,fshostname]...}]
        [--addfshost/-H {fshostname [,fshostname]...}]
        [--rmfshost/-K {fshostname[,fshostname]...}]
        [--mincopysize/-s size-spec]
        [--mincopyage/-a duration]
        {--targetfamily/-t target-media-family-name}
        [--restrict/-r restriction[,restriction]...]
        [--addrestrict/-R restriction[,restriction]...]
        [--rmrestrict/-S restriction[,restriction]...]
        [--encryption/-e {yes | no | forcedoff }]
        [--algorithm/-L enc-algorithm]
        [[--priority {schedule-priority | default}]] 
        [--migrate/-m {yes | no}]
       stage-rule-name

Semantics

Refer to the mkstage for option descriptions not included in this section.

--dbname/-d dbname

Specifies one or more database names. A backup that has any of the specified database names matches this rule.

--addmatchfamily/-F media-family-name
Adds one or more media families.
--rmmatchfamily/-g media-family-name
Removes one or more media families.
--adddbname/-D dbname
Adds one or more database names.
--rmdbname/-E { dbname
Removes one or more database names.
--adddbid/-I dbid
Adds one or more database identifiers.
--rmdbid/-J dbid
Removes one or more database identifiers.
--addfshost/-H fshostname
Adds one or more Oracle Secure Backup client host names that are used to match only backup image instances for file-system backups.
--rmfshost/-K fshostname
Removes one or more Oracle Secure Backup client host names that are used to match only backup image instances for file-system backups.
--addrestrict/-R restriction
Adds one or more device restrictions.
--rmrestrict/-S restriction
Removes one or more device restrictions.

Example

chstage --targetfamily mftarget --restrict vt1 OSB-DEFAULT-STAGE-RULE

This example adds the media family mftarget and the device vt1 to the Oracle Secure Backup default stage rule.

chsum

Purpose

Use the chsum command to change a job summary schedule.

See Also:

"Summary Commands" for related commands

Prerequisites

You must have the modify administrative domain's configuration right to run the chsum command.

Syntax

chsum::=

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/-K 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}]
             [--scheduleuled/-S {yes | no}] [--user/-U {yes | no}]
             [--subjobs/-J {yes | no}] [--superseded/-D {yes | no}]
             [--duplication/-P {yes | no}] [--mediamovement/-M {yes | no}]
             [--catimport/-I {yes | no}] [--catalog/-C {yes | no}]
             [--copyinstance/-p {yes | no}] [--copyfromstage/-E {yes | no}]
             summary-name...

Semantics

Refer to "mksum" for options not included in this section.

--addmailto/-a email-target[,email-target]

Adds additional email addresses to the job summary schedule.

--rmmailto/-r email-target[,email-target]

Removes email addresses from the job summary schedule.

--addhost/-H

Adds a host to the list of hosts to which this job summary is limited.

--rmhost/-K

Removes a host from the list of hosts to which this job summary is limited.

summary-name

Specifies the name of the job summary schedule.

Example

Example 2-43 Changing a Job Summary Schedule

This example edits the job summary schedule weekly_report and adds the email ID jim@example.com. It also changes the days of the week on which the job summary is generated to Wednesday and Friday and the time of the report to 12:00.

ob> lssum
weekly_report            Wed at 12:00
ob> chsum --addmailto jim@example.com --days Wed,Fri --reporttime 12:00 
weekly_report
ob> lssum --long
weekly_report:
    Produce on:              Wed at 12:00
    Mail to:                 lance@example.com jim@example.com
    In the report, include:
        Backup jobs:             no
        Restore jobs:            no
        Oracle backup jobs:      no
        Oracle restore jobs:     no
        Duplication jobs:        no
        Scheduled jobs:          yes
        User jobs:               yes
        Subordinate jobs:        yes
        Superseded jobs:         no
        Catalog backup jobs:     yes
        Media movement jobs:     no
        Catalog import jobs:     no
        Copy instance jobs:      yes
        Copy from stage jobs:    yes
ob>

chuser

Purpose

Use the chuser command to change the attributes of an Oracle Secure Backup user.

See Also:

"User Commands" for related commands

Prerequisites

If 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.

Syntax

chuser::=

chuser [ --class/-c userclass ]
[ --password/-p password | --querypassword/-q ]
[ --pwdlifetime ] [ --pwdgracetime ] [ --pwdreusetime ] [ --changepassword ]
[ --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...

Semantics

Refer to "mkuser"for descriptions of chuser options not included in this section.

--password/-p password

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 8 characters.

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.

--pwdlifetime

Specifies the lifetime of a user password, in number of days.

--pwdgracetime

Specifies the grace time of the password during which the user can continue using the current password even after it has expired.

--pwdreusetime

Specifies the time period after which a user password that was previously used can be reused.

--changepassword

Specifies that the user must change the current password during the next Oracle Secure Backup login.

Note:

To modify Oracle Secure Backup users, you must be a member of a class that has this right enabled. See Oracle Secure Backup Administrator's Guide for details.

--adddomain/-d {windows-domain | *},windows-account,windows-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. Example 3-37 describes how to create a user for the Windows domain.

--rmdomain/-r {windows-domain | *}

Removes a Windows domain.

--preauth/-h preauth-spec

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 "".

--addpreauth/-H preauth-spec

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.

--rmpreauth/-X preauth-spec

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.

username

Specifies the name of the Oracle Secure Backup user to be modified.

Example

Example 2-44 Changing an Oracle Secure Backup User

This example creates Oracle Secure Backup user bkpadmin, reassigns this user to the oracle class, and then displays information about this 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

Example 2-45 Changing Password Settings for an Oracle Secure Backup User

This example modifies the password settings for the administrative Oracle Secure Backup user dave01, created inExample 3-36. The password change required setting for the user is set to yes and the password grace time is set to disabled. The example also demonstrates the user being prompted to change the current password during the next login.

ob> chuser --changepassword yes --pwdgracetime disabled dave01
ob> lsuser --long dave01
dave01:
    Password:                   (set)
    Password last changed:      2012/10/30.02:33
    Password change required:   yes
    Password lifetime:          80 days
    Password grace time:        disabled
    Password reuse time:        120 days
    User class:                 admin
    Given name:                 dave
    UNIX name:                  [none]
    UNIX group:                 [none]
    Windows domain/acct:        [none]
    NDMP server user:           no
    Email address:              [none]
    UUID:                       7395a468-04dd-1030-93a4-00163e527899
    Preauthorized access:
        Hostname:           brhost3
        Username:           rman
        Windows domain:     [all]
        RMAN enabled:       no
        Cmdline enabled:    yes
ob> logout
[johndoe@slc02qdv reliaty]$ obtool
Oracle Secure Backup 12.1.0.1
login: dave01
Password: 
The password has expired; it must be changed
New password: 
New password (again):

chvol

Purpose

Used to change volume attributes, including the rotation policy applied to the volume and its current location.

Prerequisites

You must have the modify administrative domain's configuration right to use the chvol command.

Usage Notes

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.

Syntax

chvol::=

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 ]
[ --status vol-status ]
vol-spec [vol-spec]...

Semantics

--rotationpolicy/-R policyname

Changes the rotation policy assigned to the volume to policyname.

--relocate/-M --tolocation/-t locationname

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.

--relocate/-M --nomovement/-J --tolocation/-t locationname

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.

--relocate/-M --force/-f --tolocation/-t locationname

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.

--missing/-g {yes | no}

Marks the volume as missing (yes) so that a media movement job does not attempt to move it, or not missing (no).

--notintransit/-O

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.

--duplicationpolicy/-R policyname

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.

--vsopt/-V [ignore | prompt | all]

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.

--expiresat/-x date-time

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. The expiration date must be applied to all volumes within the volume set.

See "date-time" for more information on the date-time placeholder.

--retain/-r duration

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 will only affect the expiration times of archives that are written to the tape after the expiration time is changed. If a catalog import is done of the tape, the database entry for the volume will contain the expiration time for the last archive that was successfully cataloged.  Because the chvolcommand only allows increasing the expiration time, the expiration time for the volume will always be equal to or greater than the expiration time of the very first archive on the tape.

--status vol-status

Changes the availability status of the volume for Oracle Secure Backup backup and restore operations.

See "vol-status" for more information on the status options available for volumes.

vol-spec...

The volume ID or barcode value of one or more volumes.

See "vol-spec" for more information on the vol-spec placeholder.

Example

Example 2-46 Changing Volume Attributes

This example adds the rotation policy rotpol to the volume VOL000001. The chvol command also changes the location of this volume from the library vlib1 to lib1.

ob> lsvol --library vlib1
Inventory of library vlib1:
    in    1:             volume RMAN-DEFAULT-000001, barcode 4c0d6eac2d28103b69500163e527899, 151528320 kb remaining, content manages reuse
    in    dte:           volume VOL000001, barcode e53b658a2d2710390a700163e527899, 153256704 kb remaining, lastse 2

ob> chvol --rotationpolicy rotpol --relocate --tolocation lib1 --vsopt prompt --volume VOL000001
Your vol-spec, matched the following volume:
 
   Volume ID   Barcode                           Created
   VOL000001   e53b658a2d2710390a700163e527899   11/11.01:52
 
Do you wish to modify this volume (y{es}, n(o), q(uit))? [y]: y
ob>

clean

Purpose

Use the clean command to clean a tape drive.

See Also:

"Library Commands" for related commands

Prerequisites

You must have the right to manage devices and change device state to use the clean command.

Syntax

clean::=

clean [ --drive/-D drivename ] [ --force/-f ] [ --use/-u se-spec ]

Semantics

--drive/-D drivename

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.

--force/-f

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.

--use/-u se-spec

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

Example 2-47 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

closedoor

Purpose

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 commands

Prerequisites

You must have the right to manage devices and change device state to use the closedoor command.

Syntax

closedoor::=

closedoor [ --library/-L libraryname ]

Semantics

--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.

Example

Example 2-48 Closing a Library Door

This example closes the door of tape library lib1.

ob> closedoor --library lib1

cpinstance

Purpose

The cpinstance command creates a copy of a backup image instance from an existing backup image. Oracle Secure Backup creates a copy instance job that is scheduled for subsequent execution. This process is similar to how backup or restore jobs are created and scheduled.

Prerequisites

You must have the modify any backup, regardless of its owner or modify any backups owned by user class right to use the cpinstance command.

Usage Notes

If multiple copies of a backup image instance exist, then Oracle Secure Backup chooses the best one to use in the copy instance operation. Copying of multiple backup images is not supported when the backup image instances are located on different backup containers. All backup image instances must be located on the same disk pool or tape volume.

You can use the cpinstance command to create a new tape volume that contains backup image instances originating from several different volumes. This enables you to archive selected backups thereby creating a single volume on a larger-capacity tape media from a volume set consisting of multiple smaller-capacity tapes. This provides a much finer control over the individual backup image instances.

The blocking factor of the source backup image instance is the blocking factor used to write the instance to the destination device.

Copying Backup Image Instances and Backup Encryption

If the source backup image instance is not encrypted, then the backup image instance copy is also not encrypted. However, if the backup image instance is copied to a tape device that supports hardware encryption and you specify that the backup image instance copy must use hardware encryption, then the copy will be hardware encrypted.

If the source backup image instance is software encrypted, then the original encryption properties are used for the backup image instance copy. You cannot use hardware encryption for a source that has been software encrypted.

For tape devices, if the source backup image instance is hardware encrypted, then the copy uses hardware encrypted if it is written to tape devices that support hardware encryption. If the device does not support hardware encryption, then the backup image instance copy is not encrypted. Oracle Secure Backup uses the source encryption key for all backup image instances that are created from that source. This is applicable for both transient and transparent encryption. If the source backup image instance is encrypted with a passphrase (transient encryption), then you must provide the associated passphrase when prompted by the copy instance job.

Copying Backup Image Instances to a Cloud Storage Device

  • The source backup image instance must be software encrypted in order to copy it to a cloud storage device.

  • A backup image instance located on a cloud object container can be copied or migrated to a cloud archive container by using the --cloudcopy option.

Copying Backup Image Instances and Checksum Validation

When creating a copy of a backup image instance, Oracle Secure Backup can compute and store a checksum along with the backup data. This checksum is subsequently used to validate the backup image instance. Whether a checksum is computed depends on the device policy or device configuration.

When a backup image instance that does not contain a checksum is copied to a device with checksum computation enabled, Oracle Secure Backup computes a checksum and stores it on the target device.

When a backup image instance is copied to a target device with checksum validation disabled, a checksum is computed on the media server of the source device if the backup image instance contains a valid checksum on the source device. However, the computed checksum is not stored with the copied instance because checksum computation is disabled for the target device. The obtool output indicates where the checksum was computed. The output can be "Input instance: checksum verified successfully" or "Output instance: checksum verified successfully".

See Oracle Secure Backup Administrator’s Guide for details about checksum computation.

Syntax

cpinstance::=

cpinstance 
[--priority/-p schedule-priority] [--at/-a date-time]
[--family/-f media-family-name] [--quiet/-q]
[--waitfor/-W duration]
[--restrict/-r restriction[,restriction]...]
[--encryption/-e encryption] [--algorithm/-L enc-algorithm]
[--storekey/-s] [--migrate/-m] [--cloudcopy/-c]
{ [--uuid/-u backup-image-uuid]... | backup-image-name... }

Semantics

--priority/-p schedule-priority

Specifies the priority to be assigned to the copy instance job.

--at/-a date-time

Specifies the time at which the copy instance job must be run. Refer to "date-time" for information about the date-time placeholder.

--family/-f media-family-name

Specifies the name of the media family that must be associated with the new backup image instance.

If the source backup image instance resides on a content-managed tape volume, then the media family specified by the --family option must also be content-managed.

--quiet/-q

Specifies that status messages about the copy instance job must not be displayed. No message is displayed when the copy instance job is sent to the scheduler.

--waitfor/-W duration

Specifies the amount of time that Oracle Secure Backup waits for the copy instance job to complete. After the specified duration is exceeded, Oracle Secure Backup exits from obtool.

See "duration" for information about the duration placeholder.

--restrict/-r restriction

Restricts the copy instance job to the specified tape devices or disk pools. Refer to "restriction" for a description of the restriction placeholder.

--encryption/-e encryption

Specifies whether to use encryption when creating the new backup image instance. Possible values to set are:

  • yes

    Use encryption for this copy instance job. The encryption algorithm and keys used are determined by the current global and client policy settings that apply to each host.

  • no

    Fo not use encryption for this copy instance job. This the default. 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

  • transient

    Encrypt backups created with this copy instance 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.

See "Copying Backup Image Instances and Backup Encryption".

--algorithm/-L enc-algorithm

Specifies the encryption algorithm used to create the new instance. Set one of the following values for the encryption algorithm: AES128, AES192, or AES256.

--migrate/-m

Deletes the source backup image instance associated with the specified backup image after the new backup image instance has been created. If more than one backup image instances exist, the cpinstance command fails. This option is not applicable when the source image instance resides on a tape volume.

--cloudcopy/-c

This option is required when you copy or migrate an instance from an Oracle Cloud object storage container to an Oracle Cloud archive storage container.

When instances are copied or migrated between different types of Oracle Cloud containers, checksum validation is not performed because the data movement occurs within the cloud. However, data validation is performed by data integrity techniques present in Oracle Cloud infrastructure.

--storekey/-s

Specifies that the transient passphrase used to encrypt this backup image instance must be added to the appropriate key stores. The default behavior is that transient passphrases are not stored in any key store.

--uuid/-u backup-image-uuid]... | backup-image-name...

Specifies either the UUID or the name of the backup image that must be copied to a different backup container.

Examples

This example creates a copy instance job that copies the backup image instance associated with the backup image fs_bk. The job is scheduled to run at the time specified by the --at option and the backup image instance is created on the disk pool dp1. The backup image instance copy is encrypted.

ob> cpinstance --at 2013/04/24.20:30:00 --restrict dp2 --encryption yes fs_bk
Info: copy instance for fs_bk.1 submitted; job id is admin/17.

ctldaemon

Purpose

Use the ctldaemon command to control the operation of Oracle Secure Backup daemons.

See Also:

"Daemon Commands" for related commands

Prerequisites

You must have the modify administrative domain's configuration right to run the ctldaemon command.

Syntax 1

Use the following syntax to suspend or resume scheduling.

ctldaemon::=

ctldaemon --command/-c { suspend | resume }

Syntax 2

Use the following syntax to send a command to one or more daemons.

ctldaemon::=

ctldaemon --command/-c { dump | reinitialize | debugon | debugoff } 
[ --host/-h hostname[,hostname]... ] [ daemon-id ]...

Semantics

--command/-c

Enables you to temporarily suspend and later resume the obscheduled daemon (Syntax 1). You can suspend obscheduled for troubleshooting purposes.

--command/-c

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

dump

Directs the daemon to dump internal state information to its log file.

reinitialize

Directs the daemon to reread configuration data.

debugon

Directs the daemon to generate extra debugging information to its log file.

debugoff

Cancels debug mode. This is the default state.

--host/-h hostname

Specifies the name of a host on which the daemon is running. If this option is omitted, then the local host is assumed.

daemon-id

Identifies an Oracle Secure Backup daemon, either a process id (PID) or service name. Possible service names are observiced, obscheduled, obrobotd, and obixd.

Example

Example 2-49 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

discoverdev

Purpose

Use the discoverdev command to detect and configure tape devices that are attached to media servers in the administrative domain. You can discover and configure all tape devices in the administrative domain or tape devices attached to specific media servers. The media servers can be attached through Network Data Management Protocol (NDMP) or have the Oracle Secure Backup software installed.

This command also updates existing tape device configuration in case a tape device has already been discovered by more han one media server. Based on this information, discoverdev automatically updates tape device configuration for the administrative domain.

See Also:

"Device Commands" for related commands

Note:

The discoverdev command is not available on the HP-UX platform.

Oracle Secure Backup detects the following kinds of changes during device discovery:

  • Tape devices that were not previously configured but have appeared

    For each such tape device, Oracle Secure Backup can 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 from another media server.

    Oracle Secure Backup adds an attachment to each existing tape device configuration.

  • Tape devices that were previously configured for which an attachment has disappeared.

    Oracle Secure Backup displays information about the device with a missing attachment.

Note:

The discoverdev command does not discover and configure ACSLS libraries and devices. You must use the mkdev command to configure ACSLS libraries.

Prerequisites

You must have the modify administrative domain's configuration right to use the discoverdev command.

While working on Linux 64-bit platforms, you must be familiar with the rules of the kernel's device manager in order to configure persistent tape devices that use the SCSI Generic driver.

Usage Notes

You can run the discoverdev command from the administrative server or any media server.

The discoverdev command creates a device object containing the attachment information for each device that it discovers and configures. The state of the discovered device depends on the value of the discovereddevicestate policy. If this policy is set to in service, then the created device object is available for use by Oracle Secure Backup after the initial configuration.When the device being configured is a tape drive, discoverdev configures the DTE number automatically for this device.

Oracle Secure Backup assigns default names to tape devices that are configured using discoverdev. You can rename these devices using the rendev command.

Device Discovery and SCSI Persistent Binding

By default, Oracle Secure Backup discovers and configures tape devices that are located in the /dev directory. On Linux 64-bit platforms, if you use persistent binding to set up SCSI tape devices, then the device files may not be available in the default directory. In such cases, use the OB_DEVICE_SEARCH_PATH environment variable to specify the location of the persistent devices so that Oracle Secure Backup can discover and configure these devices. This environment variable must be provided in the /etc/init.d/observiced or /etc/rc.d/init.d/functions script with the value of the directory containing tape persistent device links, such as OB_DEVICE_SEARCH_PATH=/date/tape/by-id. The observiced service must be restarted after this variable is set. The OB_DEVICE_SEARCH_PATH cannot be used in RMAN commands or in obtool commands.

If you are using <OSB_INSTALL_DIR>/etc/observiced directly at command line, then you must set the OB_DEVICE_SEARCH_PATH environment variable in that particular command shell.

Multiple Hosts Connected to the Same Tape Device

Oracle Secure Backup detects multiple hosts connected to the same tape device by comparing the serial numbers reported by the operating system. If a discovered tape device is accessible by its serial number, then Oracle Secure Backup updates the existing tape device with the newly configured attachment from each host.

Media Servers with Existing Tape Device Configurations

If you run the discoverdev command with the --configure option for a media server that contains configured tape devices, then Oracle Secure Backup does not reconfigure these devices.

Syntax

discoverdev::=

discoverdev { --host/-h hostname }... | --accesstype/-a {all | ndmp | ob}}
[ --configure/-c [--interactive/-i]] [--verbose/-v]
[ --quiet/-q ] [ --missing/-m ]

Semantics

--host hostname

Identifies the host name on which the discovery is to take place. The host specified must be a media server. Use a comma-delimited list to specify multiple hosts.

--accesstype/-a {all | ndmp | ob}

Specifies the type of hosts for which discovery must be performed. Set one of the following values for accesstype:

  • all: Devices attached to all media servers in the administrative domain are discovered.

  • ndmp: Only devices attached to media servers that are accessed using NDMP are discovered.

  • ob: Only devices attached to media servers accessed using Oracle Secure Backup are discovered.

--configure/-c

Lists information about the devices that are attached to the media server and then creates device objects for each device automatically. If you omit this option, Oracle Secure Backup only displays the details about attached tape devices but does not configure them.

You cannot use this option with the --missing/-m option.

--interactive/-i

Configures discovered tape devices interactively. After each tape device is discovered, a prompt is displayed asking if you want to create a corresponding device object for this tape device. The tape device is configured only after user confirmation.

--quiet/-q

Suppresses the display of the discovery tape device status.

--missing/-m

Reports tape devices that were previously configured but are no longer found by the discoverdev command. If the attachment for a previously configured tape device is missing, Oracle Secure Backup does not remove the tape device configuration.

You cannot use this option with the --configure/-c option.

--verbose/-v

Provides verbose output describing the tape devices discovered.

Example

Example 2-50 Discovering Devices Attached to an Oracle Secure Backup Host

This example discovers devices that are attached to the host storabck18. It lists information about the devices including the device name, device type, serial number, and attachment.

ob> discoverdev -h storabck18 -c -v
2997a776-14c7-1031-a7be-e26800005003:
    Host: storabck18
    Device type: Library
    Model: STK SL150
    Serial number: 464970G+1333SY1401
    Device name: storabck18_lib_1
    Existing device: No
    Attachment new:
        Host: storabck18
        Raw device: /dev/scsi/changer/c2t500104F000D14F89d1
29ba7ec2-14c7-1031-a7be-e26800005003:
    Host: storabck18
    Device type: Tape
    Model: HP Ultrium 5-SCSI
    Serial number: HU1328WGF6
    Device name: storabck18_tape_1
    Existing device: No
    Attachment new:
        Host: storabck18
        Raw device: /dev/scsi/sequential/c2t500104F000D14F89d0
29ba8a34-14c7-1031-a7be-e26800005003:
    Host: storabck18
    Device type: Tape
    Model: HP Ultrium 5-SCSI
    Serial number: HU1327WEYJ
    Device name: storabck18_tape_2
    Existing device: No
    Attachment new:
        Host: storabck18
        Raw device: /dev/scsi/sequential/c2t500104F000D14F8Cd0

dumpdev

Purpose

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 commands

Prerequisites

You must have the right to manage devices and change device state to use the dumpdev command.

Syntax

dumpdev::=

dumpdev [ --since/-s date-time ] [ --clear/-c [ --nq ] [ --nd ] ]
{ --dumpfile/-f path... | devicename... }

Semantics

--since/-s date-time

Limits the display to those errors that have occurred since date-time. Refer to "date-time" for the date-time placeholder.

--clear/-c

Deletes the error log after it has been displayed. You are prompted before each log is deleted.

--nq

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.

--nd

Suppresses the display of the error log. This is useful to clear the error log without displaying it.

--dumpfile/-f path

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.

devicename

Dumps the error log file associated with devicename. Refer to "devicename" for the rules governing tape device names.

Example

Example 2-51 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, 2013 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 []

dupvol

Purpose

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 commands

Prerequisites

Two 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.

Usage Notes

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 matching

Syntax

dupvol::=

dupvol 
  { --family/-f media-family }
  [ --migrate/-m { yes | no }] [ --priority/-p schedule-priority ]
  [ --quiet/-q ][ --restrict/-r restriction[,restriction]... ]
  [--waitfor/-W duration]
  { --volume/-v vid }[ --tag/-t tag[,tag]... ]

Semantics

--family/-f media-family

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.

--migrate/-m

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.

--priority/-p schedule-priority

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.

--quiet/-q

Does not display job ID or status information when a duplication job is dispatched to the scheduler.

--restrict/-r restriction

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.

–waitfor/-W duration
Specifies the amount of time that Oracle Secure Backup waits for the volume duplication to complete. After the specified time duration is exceeded, Oracle Secure Backup exits from obtool.

See duration for more information on the duration placeholder.

--volume/-v vid

Specifies the volume to be duplicated.

--tag/-t tag

Specifies the volume to be duplicated based on the volume tag (barcode).

Example

Example 2-52 Duplicating a Volume

This example displays how VOL000001 is duplicated using the OSB-CATALOG-MF media family. This volume will not be migrated and is restricted to the tape device vt1.

ob> dupvol --family OSB-CATALOG-MF --migrate no --priority 100 --restrict vt1 --volume VOL000001
Info: volume duplication request 1 (volume VOL000001) submitted; job id is admin/4.

edds

Purpose

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 commands

Prerequisites

You must have the modify administrative domain's configuration right to run the edds command.

Syntax

edds::=

edds [ --nq ] [ --nocheck/-C ] [ --input/-i ] dataset-file-name

Semantics

--nq

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.

--nocheck/-C

Disables syntactic checking of a dataset file for errors.

--input/-i

Enables you to input or replace the entire contents of a dataset file.

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

Example 2-53 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

exit

Purpose

Use the exit command to exit obtool. This command is functionally identical to the quit command.

See Also:

"Miscellaneous Commands" for related commands

Syntax

quit::=

exit [ --force/-f ]

Semantics

--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.

Example

Example 2-54 Exiting obtool

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

exportvol

Purpose

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 commands

Prerequisites

You must have the right to manage devices and change device state to use the exportvol command.

Syntax 1

Use the following syntax to export a volume from a tape library or standalone tape drive.

exportvol::=

exportvol [ --library/-L libraryname | --drive/-D drivename ]
{ vol-range | se-range }

Semantics 1

Use the following semantics to export a volume from a tape library or standalone tape drive.

--library/-L libraryname

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.

--drive/-D drivename

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.

vol-range

Specifies the volumes to be exported. Refer to "vol-range" for a description of the vol-range placeholder.

se-range

Specifies the storage elements containing the volumes to be exported. Refer to "se-range" for a description of the se-range placeholder.

Syntax 2

Use the following syntax to export a volume from an ACS tape library.

exportvol::=

exportvol { vol-range | se-range } cap_devicename

Semantics 2

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.

vol-range

Specifies the volumes to be exported. Refer to "vol-range" for a description of the vol-range placeholder.

se-range

Specifies the storage elements containing the volumes to be exported. Refer to "se-range" for a description of the se-range placeholder.

cap_devicename

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

Example 2-55 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

extractvol

Purpose

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 commands

Prerequisites

You must have the right to manage devices and change device state to use the extractvol command.

Syntax

extractvol::=

extractvol [ --library/-L libraryname | --drive/-D drivename ]
{ vol-range | se-range }

Semantics

--library/-L libraryname

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.

--drive/-D drivename

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.

vol-range

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.

se-range

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

Example 2-56 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

find

Purpose

Use the find command to search for selected files and directories while browsing the Backup Catalog.

Prerequisites

The rights needed to run the find command depend on the browse backup catalogs with this access setting for the class.

Syntax

find::=

find [--long/-l | --count/-n] 
[--host/-h hostname [,hostname]...]
[--ignorecase/-i]
[--max/-m max-entries ] 
[--select/-s data-selector ]
[--type/-t {file | dir}]
[--container/-c backup-container]
[--ctype/-y {tape | disk} ]
[--path/-p frompath] [--startat/-S]
[--viewmode/-v viewmode]
name-to-search

Semantics

--long/-l

Displays additional information, like the volume id, backup id, and file number, for each entry in the output.

--count/-n
Returns a count of the number of files found in the backup catalog given the search criteria.
--host/-h hostname

Specifies the host on which the catalog search is performed. Multiple hosts can be specified through a comma-separated list.

--ignorecase/-i

Specifies that the search made on the entire catalog ignores the case, lowercase or uppercase, of the entries. This condition is applied on the name to be searched option.

--max/-m max-entries

Specifies that entries in the search output are restricted to the maximum entries selected with this option. If the output contains fewer entries than the specified limit, then all entries are displayed. If the output contains more entries than the specified limit, the result is trimmed. By default, the output lists all entries.

--select/-s data selector

Specifies the Oracle Secure Backup catalog data that applies to an operation. Refer to "data-selector" for the data-selector placeholder.

--type/-t {file | dir}

Displays the type of output specified in this option. Use file to list only file entries. Use dir to list only directories. By default, both files and directories are listed.

--container/-c backup-container

Searches for files contained on the specified container, tape volume or disk pool, with the container-spec. container-spec is the name of a disk pool or a volume ID. See "backup-container" for more information on containers.

--ctype/-y {tape | disk}

Searches for files that are stored on the specified backup container. Use tape to display backup image instances stored on tape devices and disk to display backup image instances stored on disk pools. By default, find searches for files stored on all backup containers.

--path/-p

Specifies the path from where the search begins. The result displayed is relative to the provided path. Oracle Secure Backup wildcard pattern matching is not supported while specifying the path.

--viewmode/-v viewmode

Specifies the mode in which to view directory contents in the Oracle Secure Backup catalog. The find 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 and are present in the current path.

  • inclusive makes visible all entries regardless of the current data selector (default).

  • specific specific makes visible all entries that match the specified data selector.

name-to-search

Specifies the name of the file or directory to be searched in the catalog. Oracle Secure Backup wildcard pattern matching is supported.

Examples

Example 2-57 Finding Backup Entries on a Host

This example uses the find command to list entries in the /scratch directory on brhost2. The path for the backup entries is provided for the specified host. Oracle Secure Backup wildcard pattern matching is used as the * indicates that backup entries within all folders within the /scratch directory must be listed. The specified data selector all lists all backup entries from the given path.

ob> find -h brhost2 -p /scratch * -s all -l
VOL000001,brhost2: /scratch/osb_test/osb_ds
VOL000001,brhost2: /scratch/osb_test
VOL000001,brhost2: /scratch/osb_test
VOL000001,brhost2: /scratch/osb_test/osb_ds
VOL000001,brhost2: /scratch/osb_test
VOL000001,brhost2: /scratch/osb_test/osb_ds/tmp
VOL000001,brhost2: /scratch/osb_test
VOL000001,brhost2: /scratch/osb_test
VOL000001,brhost2: /scratch/osb_test/osb_ds
VOL000001,brhost2: /scratch/osb_test
VOL000001,brhost2: /scratch/osb_test
Host:           brhost2
Name:           /scratch/osb_test/osb_ds
Last Modified:  2012/12/07.01:59
Size:              0     
User/Group:     johndoe.dba
Container:      VOL000001
Backup ID:      11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1
File No:        12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2
Section No:     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1

Example 2-58 Finding a Type of Entry on a Host

This example uses the find command to list only directory backup entries on brhost2. The example uses Oracle Secure Backup wildcard pattern matching to list all backed up directories under the /scratch directory.

ob> find -h brhost2 -t dir -p /scratch *
VOL000001,brhost2: /scratch/osb_test
VOL000001,brhost2: /scratch/osb_test/osb_ds

Example 2-59 Finding Backups Using the Hostname

This example uses the find command to list backups on the host obsvr1.

ob> find --host osbsvr1 backup
new-obsvr1-mf-000001,obsvr1: /usr/local/oracle/backup

id

Purpose

Use the id command to display the name of the currently logged in Oracle Secure Backup user.

See Also:

"Miscellaneous Commands" for related commands

Prerequisites

No rights are required to run the id command.

Syntax

id::=

id [ --long/-l ] 

Semantics

--long/-l

Displays the Oracle Secure Backup user and its class. By default id displays only the class.

Example

Example 2-60 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 12.2.0.1.0
login: sbt
ob> id
sbt

identifyvol

Purpose

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 invalid 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 commands

Prerequisites

You must have the right to manage devices and change device state to use the identifyvol command.

Syntax

identifyvol::=

identifyvol [ --drive/-D drivename ] [ --import/-i ] 
[ --obtaropt/-o obtar-option ]... [ se-range ]

Semantics

--drive/-D drivename

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.

--import/-i

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 image instances on the volume, but it lists out the backup image instance labels of all the file sections.

For quicker importing of volume information and cataloging of backup catalog data, use the catalog command.

Example B-16 shows how you can catalog the contents of a backup image instance using obtar.

When the identifyvol --import command is issued on an RMAN volume, the output shows a D after the file section number to indicate that it is an RMAN backup. The following is an example of how this type of output looks:
ob> identifyvol --drive faldbvmp02_tape_1 --import 1

Seq  Volume           Volume      Archive    Client    Backup   Archive
Create
 #     ID              Tag       File Sect    Host      Level     Date & Time
  1 RMAN-DEFAULT-000076 FAL008         1    1 D faldbvmp01     0  2018/02/19
21:06:21
  1 RMAN-DEFAULT-000076 FAL008         2    1 D faldbvmp01     0  2018/02/19
21:13:05
--obtaropt/-o obtar-option

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.

se-range

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.

Example

This example loads the volumes in storage elements 1 and 3 into tape drive tape1 and identifies them.

Example 2-61 Identifying Volumes

ob> lsvol --library lib1
Inventory of library lib1:
    in    1:             occupied
    in    3:             occupied
ob> identifyvol --drive tape1 1,3

Example 2-62 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.

importvol

Purpose

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 commands

Prerequisites

You must have the right to manage devices and change device state to use the importvol command.

Usage Notes

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.

Syntax

importvol::=

importvol [ --library/-L libraryname | --drive/-D drivename ]
[ --identify/-i | --import/-m | --unlabeled/-u ] 
[ clean --uses/-U n --maxuses/-M n]
[ --obtaropt/-o obtar-option ]... 
iee-range

Semantics

--library/-L libraryname

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.

--drive/-D drivename

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.

--identify/-i

Reads the volume ID on each volume. This option is equivalent to running the identifyvol command. This option requires specification of a tape drive.

--import/-m

Reads each backup image label on each volume. You can use this option to import volume information and archive section information from a different administrative domain. This option requires specification of a tape drive.

This option imports information regarding the tape into volumes and archive catalogs for the specified tape drive.

To import volume information more efficiently and to catalog the backup catalog data for the entire domain, use the catalog command.

To import backup metadata stored in the tape, you can also use --obtaropt with the -G option.

--unlabeled/-u

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 an insertvol unlabeled command.

clean

Imports the specified tapes and marks them as cleaning tapes. The iee elements specified in iee-range are assumed to have cleaning tapes in them. All the cleaning tapes are assigned the same uses and maxuses values. This option must be used with the --uses and --maxuses options.

--uses/-U n

See insertvol.

--maxuses/-M n

See insertvol.

--obtaropt/-o obtar-option

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.

iee-range

Specifies a range of import/export elements containing the volumes to be imported. Refer to "iee-range" for acceptable values for iee-range.

Examples

Example 2-63 Importing Volumes

This example uses the importvol command to update the volumes from import elements iee1, iee2, and iee3 in the tape library lib2. Here, the tape library and import elements belong to the same Oracle Secure Backup domain.

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, content manages reuse
    in    iee2:          unlabeled, barcode DEV424, oid 114
    in    iee3:          unlabeled, barcode DEV425, oid 115
    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

insertvol

Purpose

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 commands

Prerequisites

You must have the right to manage devices and change device state to use the insertvol command.

Usage Notes

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.

Syntax 1

Use the following syntax to specify that you have inserted unlabeled or unknown volumes or cleaning tapes.

insertvol::=

insertvol [ --library/-L libraryname | --drive/-D drivename ]
{ unknown | unlabeled | clean --uses/-u n --maxuses/-m n }
se-range

Semantics 1

--library/-L libraryname

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.

--drive/-D drivename

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.

unknown

Indicates the volume being inserted is of unknown format.

unlabeled

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.

clean

Indicates that the volume being inserted is a cleaning tape. You must specify this option with the --uses and --maxuses options.

--uses/-u n

Specifies the number of times that the cleaning tape has been used.

--maxuses/-m m

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.

se-range

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.

Syntax 2

Use the following syntax to specify that you have inserted known or labeled volumes.

insertvol::=

insertvol [ --library/-L libraryname | --drive/-D drivename ]
[ vol-spec ] se-spec

Semantics 2

vol-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.

See Also:

"vol-spec" for a description of the vol-spec placeholder

se-spec

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.

See Also:

"se-spec" for a description of the se-spec placeholder

The following sequence of events is required:

  1. If the target storage element is not currently empty, then use extractvol or movevol to empty it.

  2. Ensure that the storage element is recognized as empty by the lsvol command. Run the inventory command if it is not.

    See Also:

  3. 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.

  4. Immediately run the insertvol command.

Example

Example 2-64 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

inventory

Purpose

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 commands

Prerequisites

You must have the right to manage devices and change device state to run the inventory command.

Syntax

inventory::=

inventory [ --library/-L libraryname | --drive/-D drivename ]
[ --force/-f ][ se-range ]

Semantics

--library/-L libraryname

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.

--drive/-D drivename

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.

--force/-f

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.

se-range

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.

See Also:

"se-range" for more information on the se-range placeholder

Example

Example 2-65 Taking an Inventory of a Tape Library

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-66 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

labelvol

Purpose

Use the labelvol command to load selected volumes and write a volume label to each volume.

WARNING:

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 commands

Usage Notes

You can also use the labelvol to create a pool of tapes that belong to a single media family. To do this, you must use the —obtaropt option with -Xfa:<mediafamily> as shown in Example 2-67 below.

Prerequisites

You must have the right to manage devices and change device state to use the labelvol command.

Syntax

labelvol::=

labelvol [ --drive/-D drivename ] [ --barcode/-b barcode ] 
[ --force/-f ] [ --obtaropt/-o obtar-option ]... [ se-range ]

Semantics

--drive/-D drivename

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.

--barcode/-b barcode

Specifies a barcode for the volume.

--force/-f

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.

--obtaropt/-o obtar-option

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.

se-range

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.

Example

Example 2-67 Manually Labeling a Volume

This example reserves the tape in storage element 4 in tape library lib1 for use by media family mf_incr.

ob> insertvol unlabeled --library lib1 4
ob> labelvol --drive tape1 --obtaropt -Xfam:mf_incr 4

loadvol

Purpose

Use the loadvol command to move a volume from the indicated storage element to the selected tape drive.

See Also:

"Library Commands" for related commands

Prerequisites

You must have the right to manage devices and change device state to use the loadvol command.

Syntax

loadvol::=

loadvol [ --drive/-D drivename ] [ --mount/-m mode ]
[ --force/-f ] [ --req/-r ] { vol-spec | element-spec }

Semantics

--drive/-D drivename

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.

--mount/-m mode

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.

--force/-f

Forces the loading of a volume. If another volume is in the tape drive, then the volume is automatically unloaded.

--req/-r

Loads the volume only if it is not loaded in the tape drive.

vol-spec

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.

element-spec

Specifies the number of a storage element to be loaded. Refer to "element-spec" for a description of the se-spec placeholder.

Example

Example 2-68 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

logout

Purpose

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 commands

Syntax

logout::=

logout

Example

Example 2-69 Displaying the Current User

This example logs out, logs in again as user admin, and then displays current user information.

ob> logout
% obtool
Oracle Secure Backup 12.2.0.1.0
login: admin
ob> id
admin

ls

Purpose

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 and backup image instances. 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 commands

Prerequisites

The rights needed to run the ls command depend on the browse backup catalogs with this access setting for the class.

Syntax

ls::=

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 ] [ --host/-h hostname ]
[ --select/-s data-selector[,data-selector]... ] [--recursive/-R ]
pathname...

Semantics

--long/-l

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.

--short/-s

Displays Oracle Secure Backup catalog data in short form (default).

--label/-L

Labels the items in the Oracle Secure Backup catalog for ease of reading. See Example 2-70 for an illustration.

--hostname/-h

Displays entries only belonging to the specified host.

--oneperline/-1

Puts each item on a separate line.

--recursive/-R

Displays all entries that are backed up from a particular path. It lists all entries that are a part of a given directory and data selector.

--reverse/-r

Reverses the listing order.

--directory/-d

Displays information on the current directory in the Oracle Secure Backup catalog.

--backup/-b

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.

--position/-p

Displays the physical location of data on the tape when used with the --backup option.

--inode/-i

Displays inode of contents. Note that this option is only supported for backup image instances generated by a Network Data Management Protocol (NDMP) data service.

--nobackupid/-I

Does not display the backup ID.

--noheader/-H

Displays information without header output.

--notype/-T

Does not use "/" to indicate a directory.

--noerrors/-E

Does not display file-system error messages.

--numberformat/-n numberformat

Specifies how to display large numbers. Refer to "numberformat" for a description of the numberformat placeholder.

--viewmode viewmode

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 and are present in the current path.

  • inclusive displays all entries, regardless of the current data selector (default).

  • specific displays all entries that match the data selector.

--ctime/-c

Displays inode change time if --long also specified.

--mtime/-t

Displays file modified time if --long also specified.

--utime/-u

Displays file used time if --long also specified.

--nosort/-X

Does not sort names for display.

--noescape/-B

Does not escape non-displayable characters in filenames. Specify --noescape if you want file names that include an ampersand character (&) to display normally.

--max/-M max-entries

Specifies the maximum number of entries to display.

--startat/-S starting-entry

Specifies the number where the display should start, with 1 as the first item in the listing.

--select/-s data-selector
Specifies the Oracle Secure Backup catalog data that applies to an operation. Refer to data-selector for the data-selector placeholder.
pathname

Specifies the path names in the Oracle Secure Backup catalog.

Example

Example 2-70 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      2012/03/02.09:51 file1              (4)
ob> ls --long --label --backup --position file1
Name:               file1
    Backup ID:          4
        Mode & protection:  -rwx------
        Last modified:      2012/03/02.09:51:33
        Size:                 74
    Backup ID:          4
        Backup date & time: 2012/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:    12.1.0.1.0
        Volume creation:    2012/03/02.10:02:27
        Position:           0000023A0009

lsauth

Purpose

Use the lsauth command to list the names and attributes of authentication objects. With no option or argument specified, lsauth lists only the names of authentication objects.

Prerequisites

Syntax

Use the following syntax to list authentication objects.

Semantics

lsauth::=

lsauth [--short/-s | --long/-l]
[--type/-t {oci | oci-classic}]
[authobj-name] 
--short/-s | --long/-l

Optionally selects either a short or long listing format. Short listing format shows authentication object names. Long listing format shows authentication object attributes and names.

--type/-t
Optionally specifies the type of authentication objects to display. Use oci to display all Oracle Cloud Infrastructure authentication objects and oci-classic to display all Oracle Cloud Infrastructure Classic authentication objects.
authobj-name

Optionally specifies authentication object names to list.

Examples

Example 2-71 Listing All Authentication Object Names

This example lists the names of all existing authentication objects.

ob> lsauth
auth_oci_ch          
auth_oci_den          

Example 2-72 Listing a Single Authentication Object

This example lists the details of a specific authentication object.

ob> lsauth auth_classic
auth_classic          

Example 2-73 Listing the Attributes of All Authentication Objects

This example lists all authentication objects and their associated attributes.

ob> lsauth -l 
auth_oci_ch:
    Type:                   oci
    Tenancy ocid:           ocid1.tenancy.oc1..aaaaaaaavjhvwf2c2z2ozzyuob7njen5imx57i6ts3vcsb3v54w7q4whc6ka
    User ocid:              ocid1.user.oc1..aaaaaaaaqm7l5pijshvpaq67t7tnixsjkn7z7sapqusj7jqacl7pm7wm6lva
    Key fingerprint:        c5:09:dd:f5:d6:88:2c:63:b1:19:b6:39:09:9c:90:fb
    Identity domain:        testdomain
    URL:                    https://console.us-phoenix-1.oraclecloud.com
    UUID:                   69ae9858-c9fb-1036-90bb-fa163e381872
auth_oci_den:
    Type:                   oci
    Tenancy ocid:           ocid1.tenancy.oc1..aaacghaavjhmkf6c1z2olihuob3nwen8iqx73v6fs3vpdb3v21w7r4wjc2ka
    User ocid:              ocid1.user.oc1..aaacghaaqm771pieyhvpaq69t7tunisjkn7x7stcnksj7jnqc73am7wm7lva
    Key fingerprint:        69:7f:3b:fc:50:3a:72:83:ff:e5:a6:88:30:b7:ee:a4
    Identity domain:        testdomain
    URL:                    https://console.us-phoenix-1.oraclecloud.com
    UUID:                   ddf03c9a-ca09-1036-90bb-fa163e381872

lsbackup

Purpose

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 commands

Prerequisites

You 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.

Syntax

lsbackup::=

lsbackup [ --long/-l | --short/-s ] [ --noheader/-H ] [ backup-item ]...

Semantics

--long /-l

Displays data in long form, that is, describes all of the attributes for each job and labels them. Refer to Example 2-74 for the type of data included. By default this command displays a subset of attributes in tabular form.

--short /-s

Displays data in short form, that is, lists job IDs only.

--noheader/-H

Suppresses column headers when listing data.

backup-item

Specifies an identifier assigned by obtool to a backup created with the backup command. The identifier is a small integer number.

Output

Table 2-3 describes the output of the lsbackup command.

Table 2-3 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 full, 1 to 10, incremental, or offsite

Priority

Priority level of the backup job; set a number greater than 0; 1 is the highest priority

Privileged op

Setting is yes or no

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

S/w compression

Compression option to be used in the backup job

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

Example 2-74 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: 2017/01/14.21:00:00
     Job expires: 2017/01/19.21:00:00
     Restriction: any device
     Encryption: off
     Hardware encryption: if present
     Store catalog on tape: yes
     S/w compression: high

lsbkup

Purpose

Displays information about backup images created by a backup job. After a backup job completes, Oracle Secure Backup creates a backup image and a backup image instance. Backup images store metadata about a backup such as type of backup, creation date and time, job ID, and host on which the backup was created.

Prerequisites

You must have the list any backup, regardless of its owner or list any backups owned by user class right to use the lsbkup command.

Usage Notes

  • The backup images instances associated with each backup can be displayed by using the --instances option of the lsbkup command.

  • If the --contents and the --container options are both specified, then for each file-system backup image instance listed, all backup paths are displayed. This is true even if the backup image instance spans more than one volume, and even if the data for a later backup path is on another volume in the volume set.

Syntax

lsbkup::=

lsbkup 
[--long/-l | --short/-s] [--noheader/-H]
[--type/-Y {database | filesystem}]
[--ctype/-y {tape | disk | cloudstorage}]
[ {[--from/-f date-time] [--to/-t date-time]} | [--today/-T] ]
[--dbname/-n dbname[,dbname]...] [--dbid/-d dbid[,dbid]...]
[--piecename/-p piecename[,piecename]...]
[--instances/-i | --contents/-C] [--duplicates/-D]
[--host/-h hostname]...
[ [--barcode/-b tag]... | [--container/-c backup-container]... |
[--uuid/-u backup-image-uuid]... | backup-image-name... ]

Semantics

--long/-l

Displays all the attributes related to each backup image, with multiple lines of information for each backup image.

--short/-s

Displays only the names of the backup images.

--noheader/-H

Omits displaying headers in the command output.

--type/-Y {database | filesystem}

Displays backup images of the specified type only. Use database to display Oracle Database backups and filesystem to display information about file-system backups. By default, backup images associated with both types of backups are displayed.

--ctype/-y {tape | disk | cloudstorage}

Displays backup images that are stored on the specified backup container. Use tape to display backup images stored on tape devices and disk to display backup images stored on disk pools. Use cloudstorage to display backup images stored on cloud storage devices. By default, backup images stored on all backup containers are displayed.

--from/-f date-time

Displays backup images created since the specified date or time. See "date-time" for information about specifying the date and time.

--to/-t <date-time>

Displays backup images created before the specified date or time. See "date-time" for information about specifying the date and time.

--today/-T

Displays backup images created today.

--dbname/-n dbname

Displays backup images for the database specified by dbname. Use a comma-separated list to specify multiple database names.

--dbid/-d dbid

Displays backup image instances for the database whose database identifier (DBID) is specified by dbid. Use a comma-separated list to specify multiple DBIDs.

--piecename/-p piecename

Displays backup image instances whose backup piece names match the ones specified by piecename. Use a comma-separated list to specify multiple backup piece names.

--instances/-i

Displays all the backup image instances associated with a backup image.

--contents/-C

Displays the contents of backup images. For file-system backups, Oracle Secure Backup displays the directory path that is backed up. For Oracle Database backups created using RMAN, Oracle Secure Backup displays the name of the database, the backup piece name, and the type of backup.

--duplicates/-D

Displays duplicate volumes for backup image instances stored on tape. Duplicate volume containers are denoted by a "+" in the display. This option is applicable only if the --instances option is specified, as containers are associated only with backup image instances.

--host/-h hostname

Displays backup images for the specified host.

--barcode/-b tag

Displays only backup images contained in the volume that has the specified barcode.

--container/-c backup-container

Displays backup images contained in the specified container (tape volume, disk pool or cloud storage device). See "backup-container".

Note:

You can use only one of the following options simultaneously in an lsbkup command:

  • --barcode, --container, --uuid, and backup-spec

  • --contents and --instances

--uuid/-u backup-image-uuid

Displays backup images with the specified UUID. Oracle Secure Backup assigns a unique UUID to each backup image.

backup-image-name

Specifies the name of the backup image whose details must be displayed.

Examples

Example 2-75 Specifying Backup Image Instances for a Specified Host

This example displays backup images for the host brhost2. It also displays details about the backup images instances associated with each backup image.

ob> lsbkup --host brhost2 --instances
      Backup Image Name        Client          Type      Created            Size
brhost2-20110926-115943        brhost2          FS  2011/09/26.04:59     62.4 MB
    Seq       Created          Expires      Encryption  Container(s)
      1  2011/09/26.04:59                   off         VOL00001 
brhost2-20110926-120953        brhost2          FS  2011/09/26.05:09     62.4 MB
    Seq       Created          Expires      Encryption  Container(s)
      1  2011/09/26.05:09                   off         VOL00002 
      1  2011/09/26.06:09 2011/09/26.16:10  off         STK.pool

Example 2-76 Displaying Backup Image Details in Long Format

This example displays, in long format, the details about the backup image brhost2-20110926-123218. The Size shown in this particular example output is the size of the backup after compression.

ob> lsbk -l brhost2-20170422-133707
Backup image name:    brhost2-20170422-133707
    Type:                   file system
    Client:                 brhost2
    Backup level:           0
    Size:                   26.2 MB
    Uncompress size:        62.5 MB
    Backup owner:           admin
    Owner class:            admin
    Backup date and time:   2017/04/22.06:37
    Created by job:         admin/1.1
    UUID:                   631810e4-09c9-1035-a969-00163e43c05f

Example 2-77 Displaying the Contents of Backup Images

This example displays the contents of each backup image. For file-system backups, the name of the directory path backed up is displayed. For Oracle Database backups created using RMAN, the name of the database, the backup piece name, and the type of backup is displayed.

ob> lsbkup --contents
      Backup Image Name        Client          Type      Created            Size
brhost2-20110926-123218        brhost2          FS  2011/09/26.05:32     62.4 MB
    Container              File Sect      Level
    VOL000001                 1    1          0
        /oracle/work/data/backup
brhost1-20110926-123432        brhost1          DB  2011/09/26.05:34    832.0 KB
    Container              File Sect  Database  Content      Piece Name
    RMAN-DEFAULT-000001       1    1  dbu       archivelog   01mng6eq_1_1
brhost1-20110926-123500        brhost1          DB  2011/09/26.05:35      7.8 MB
    Container              File Sect  Database  Content      Piece Name
    RMAN-DEFAULT-000001       2    1  dbu       autobackup   c-20883-20110926-00
brhost1-20110926-123525        brhost1          DB  2011/09/26.05:35     82.5 MB
    Container              File Sect  Database  Content      Piece Name
    RMAN-DEFAULT-000001       3    1  dbu       full         03mng6gn_1_1

Example 2-78 Displaying Backup Images for a Database

This example displays the backup images that are stored in Oracle Cloud for the database with DBID 1523209233.

ob> lsbkup --ctype cloudstorage --dbid 1523209233 --long
Backup image name:    brhost2-20190218-143007
    Type:                   Oracle database
    Client:                 brhost2
    Backup piece name:      0btq67sn_1_1
    Database:               orcl
    Content:                full
    Size:                   4.0 MB
    Backup owner:           shaisbt
    Owner class:            oracle
    Backup date and time:   2019/02/18.09:30
    Created by job:         shaisbt/1.1
    UUID:                   a562e928-15b7-1037-808c-96d7c2e53741
Backup image name:    brhost2-20190218-143101
    Type:                   Oracle database
    Client:                 brhost2
    Backup piece name:      c-1523209233-20190218-00
    Database:               orcl
    Content:                autobackup
    Size:                   13.0 MB
    Backup owner:           shaisbt
    Owner class:            oracle
    Backup date and time:   2019/02/18.09:31
    Created by job:         shaisbt/2.1
    UUID:                   c5bcb8f2-15b7-1037-a9f2-a9b966e502f6

lsbu

Purpose

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 commands

Prerequisites

You must have the display administrative domain's configuration right to use the lsbu command.

Syntax

lsbu::=

lsbu [--long/-l | --short/-s] [--noheader/-H] [--reverse/-r]
[--level/-L backup-level | --maxlevel/-M backup-level]
[--inclusions/-i [--dependencies/-d] ]
[--host/-h hostname[,hostname]...] [--duplicates/-D]
[--backup/-b backup-image-name] [--buuid/u backup-image-uuid]
[--instance/-I backup-instance-name | --iuuid/U backup-instance-uuid]
[--path/-p pathname] [data-selector]...

Semantics

--long/-l

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.

--short/-s

Displays data in short form. The command displays only backup IDs.

--noheader/-H

Does not display headers for columns.

--reverse/-r

Reverses the listing order.

--level/-L backup-level

Displays backups based on backup level. Refer to "backup-level" for a description of the backup-level placeholder.

--maxlevel/-M backup-level

Specifies the maximum backup level to display. Refer to "backup-level" for a description of the backup-level placeholder.

-inclusions/-i

Displays the paths that were backed up for the set host.

See Also:

"set" to learn how to set or reset the host

--dependencies/-d

For each incremental backup listed, display the dependencies on predicate backups.

--host/-h hostname

Displays backups of client hostname.

--duplicates/-D

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.

--backup/-b backup-image-name
Displays backups for the specified backup image name.
--buuid/u backup-image-uuid
Displays backups for the specified backup image UUID.
--instance/-I backup-instance-name
Displays backups for the specified backup image instance name.
--iuuid/U backup-instance-uuid
Displays backups for the specified backup image instance UUID.
--path/-p pathname

Displays backups based on file-system objects.

data-selector

Specifies the Oracle Secure Backup catalog data that applies to an operation.

See Also:

"data-selector" for more information on the data-selector placeholder

Output

Table 2-4 describes the output for the lsbu command.

Table 2-4 Output of 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 0 if no previous backup job exists for this directory; assigned by the Oracle Secure Backup user when the backup job is scheduled

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

Algorithm

The encryption algorithm used

Volume creation

Date and time at which Oracle Secure Backup wrote backup image file number 1 to a volume.

Archive Creation The date and time of archive creation
Instance name The name of the backup instance

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.

Examples

Example 2-79 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: 2013/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:    12.1.0.1.0
   Encryption:         on
   Algorithm:          aes192
   Volume creation:    2009/01/14.11:35:15
Backup ID:          1
   Backup date & time: 2013/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:    12.1.0.1.0
   Encryption:         hardware
   Algorithm:          aes256
   Volume creation:    2013/01/14.11:35:15
Backup ID:          2
   Backup date & time: 2013/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:    12.1.0.1.0
   Encryption:         off
   Volume creation:    2013/01/14.11:35:15 

Example 2-80 Listing Cataloged Backups for a Specific Instance

ob> lsbu -l 3
Backup ID:          3
    Backup date & time: 2017/08/28.09:38:31
    File number:        1
    File section:       1
    Requested level:    0
    Client:             brhost2
    Device:             tape1
    Program version:    12.2.0.1.0
    Archive creation:   2017/08/28.09:38:31
    Instance name:      brhost2-20170828-163831.3
    Encryption:         off

lsbw

Purpose

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 commands

Prerequisites

You must have the display administrative domain's configuration right to use the lsbw command.

Syntax

lsbw::=

lsbw [ --short/-s ] day-specifier[,day-specifier]...   

Semantics

--short/-s

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.

day-specifier

Specify a time range in terms of days. Refer to "day-specifier" for a description of the day-specifier placeholder.

Example

Example 2-81 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

lscheckpoint

Purpose

Use the lscheckpoint command to list the identity and attributes of current checkpoints.

See Also:

"Checkpoint Commands" for related commands

Prerequisites

You must have the right to query and display information about devices to use the lscheckpoint command.

Syntax

lscheckpoint::=

lscheckpoint [ --short/-s | --long/-l ] [ --host/-h hostname[,hostname]... ]...
[ job-id ]...

Semantics

--short/-s

Displays only the IDs of jobs that have checkpoints.

--long/-l

Displays multiple lines for each entry, describing all user-visible information for each checkpoint.

--host/-h hostname

Constrains the listing to checkpoints for the host specified by hostname.

job-id

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.

Output

Table 2-5 describes the output of the lscheckpoint command.

Table 2-5 lscheckpoint Output

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 yes or no

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

Example 2-82 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 2013/45/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: 04/18.17:48
    Restartable:        yes
    Current context ID: 18

lsclass

Purpose

Use the lsclass command to list the names and attributes of a Oracle Secure Backup user class.

See Also:

Prerequisites

You must have the display administrative domain's configuration right to use the lsclass command.

Syntax

lsclass::=

lsclass [ { --long/-l [ --abbreviate/-a ] } | --short/-s ]
 [--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}]      [--browse/-b <browserights>]
               [--querydevs/-q {yes | no}]      [--managedevs/-d {yes | no}]
               [--listownbackups/-s {yes | no}] [--modownbackups/-S {yes | no}]
               [--listanybackup/-u {yes | no}]  [--modanybackup/-U {yes | no}]
               [--orauser/-o {yes | no}]        [--orarights/-O oraclerights]
               [--fsrights/-F fsrights]        [--listconfig/-L {yes | no}]
               [--modcatalog/-c {yes | no}]
               [classname]...

Semantics

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.

--long/-l

Displays data in long form. The command displays all classes and privileges.

--abbreviate/-a

Displays a short description when used with the --long option.

--short/-s

Displays data in short form (default). The command displays only the class names.

--fsrights/-F fsrights

Enables Oracle Secure Backup users with the specified rights to access Oracle file system backups.

Output

Table 2-6 describes the output of the lsclass command.

Table 2-6 lsclass Output

Label Indicates

browse

browse backup catalogs with this access right; values are privileged, notdenied, permitted, named, none

oracle

access Oracle database backups right; values are owner, class, all, or none

file system

access file system backups right; values are owner, class, all, or none

listconfig

display administrative domain's configuration right; values are yes or no

modself

modify own name and password right; values are yes or no

modconfig

modify administrative domain's configuration right; values are yes or no

backupself

perform file system backups as self right; values are yes or no

backuppriv

perform file system backups as privileged user right; values are yes or no

listownjobs

list any jobs owned by user right; values are yes or no

modownjobs

modify any jobs owned by user right; values are yes or no

restself

perform file system restores as self right; values are yes or no

restpriv

perform file system restores as privileged user right; values are yes or no

mailinput

receive email requesting operator assistance right; values are yes or no

mailerrors

receive email describing internal errors right; values are yes or no

querydevs

query and display information about devices right; values are yes or no

managedevs

manage devices and change device state right; values are yes or no

listanyjob

list any job, regardless of its owner right; values are yes or no

modanyjob

modify any job, regardless of its owner right; values are yes or no

oracleuser

perform Oracle database backups and restores right; values are yes or no

Example

Example 2-83 Displaying Information About a Class

This example lists the attributes of the reader class.

ob> lsclass --long --abbreviate reader
reader:
reader:
    browse:         named
    oracle:         none
    file system:    none
    listconfig:     no
    modself:        yes
    modconfig:      no
    modcatalog:     no
    backupself:     no
    backuppriv:     no
    listownjobs:    no
    modownjobs:     no
    restself:       no
    restpriv:       no
    mailinput:      no
    mailerrors:     no
    mailrekey:      no
    querydevs:      no
    managedevs:     no
    listanyjob:     no
    modanyjob:      no
    oracleuser:     no
    listownbackups: no
    modownbackups:  no
    listanybackup:  no
    modanybackup:   no

lsdaemon

Purpose

Use the lsdaemon command to list Oracle Secure Backup daemons running on a host.

See Also:

"Daemon Commands" for related commands

Prerequisites

You must have the display administrative domain's configuration right to use the lsdaemon command.

Syntax

lsdaemon::=

lsdaemon [ --long/-l | --short/-s ] [ --all/-a ] [ --noheader/-H ]
[ --host/-h hostname[,hostname]... ] [ daemon-id ]...

Semantics

--long/-l

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.

--short/-s

Lists only the names of the daemons.

--all/-a

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.

--noheader/-H

Lists data in --all format but suppresses column names.

--host/-h hostname

Lists daemon data based on the specified host in which the daemons run. If this option is omitted, then the local host is assumed.

daemon-id

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.

Output

Table 2-7 shows the output for the lsdaemon command.

Table 2-7 lsdaemon Output

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 debug or normal

Listen port

TCP port on which the daemon or service is listening for connections

Qualifier

Text string that augments the Daemon/Service name

Examples

Example 2-84 Listing Daemons in Short Form

This example lists the names of all daemons.

ob> lsdaemon --short
observiced
obixd
obscheduled

Example 2-85 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)

Example 2-86 Listing Daemons in Default Form

This example lists daemon information in the default table format.

ob> lsdaemon
Process  Daemon/                        Listen
     ID  Service      State               port  Qualifier
   9418  observiced   debug                400
  12652  obixd        normal             43983  brhost2
   9436  obscheduled  normal             42130

lsdev

Purpose

Use the lsdev command to list the names and attributes of one or more configured devices.

See Also:

"Device Commands" for related commands

Prerequisites

You must have the display administrative domain's configuration right to use the lsdev command.

Syntax

lsdev::=

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 ] [--consumption/-c]
[ --attach/-a aspec ] [ --type/-t { cloudstorage| tape | library | cap | disk } ]
devicename...

Semantics

--long/-l

Displays data in long form. The command displays the attributes of each device and labels them. Refer to Example 2-87 for sample output. By default the command displays the device name, type, and status.

--short/-s

Displays data in short form. The command prints the name of each device on a separate line.

--inservice/-o

Displays a list of devices that are logically available to Oracle Secure Backup.

--notinservice/-O

Displays a list of devices that are not logically available to Oracle Secure Backup.

--reservations/-v

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.

--mount/-m

Displays a list of devices with their mount status.

--description/-d

Displays a list of devices with detailed descriptions. For any device missing a description, run the pingdev devicename command to create one.

--borrowed/-b

Displays a list of devices with their borrowed status.

--nocomm/-N

Suppresses communication with the device.

--reserved/-r

Lists only those devices that are currently reserved.

--me/-e

Displays devices that are reserved for the logged-in Oracle Secure Backup user. Use with the --reserved option.

--nohierarchy/-H

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.

--notype/-T

Displays a list of devices without specifying the type (tape drive or tape library).

--geometry/-g

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.

--verbose/-V

Produces verbose output (default). For each device obtool displays the device type, name, and status.

--attach/-a aspec

Displays the device with the specified attachment. Refer to "aspec" for a description of the aspec placeholder.

--consumption/-c

Displays the amount of space currently used by each disk pool. Oracle Secure Backup also displays a percentage value that represents the percentage of disk pool capacity that has been used.

--type/-t cloudstorage | tape | library | cap | disk

Displays the specified type of device: cloudstorage, tape, library, cap or disk. 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.

devicename

Specifies the name of the device for which you want to view attribute data. Refer to "devicename" for the rules governing device names.

Output

Table 2-8 describes the output for the lsdev command.

Table 2-8 lsdev Output

Label Indicates

Device type

Type of device. Setting is cloudstorage, tape drive, library, or disk.

If the device object was created with the mkdev --class vtl option, then the device type listed by lsdev includes (VTL).

Model

Manufacturer model, if available

Serial number

Manufacturer serial number, if available

In service

Device eligibility for use. Setting is yes or no.

Debug mode

Assists in troubleshooting problems. Setting is yes or no.

Barcode reader

Setting is yes, no, or default

Barcodes required

Setting is yes, no, or default. If it is set to yes, then tapes must be barcoded to run a backup job

Auto clean

Automatically clean the tape drive heads. Setting is yes or no. Configured separately

Clean interval

Amount of time between cleaning

Clean using emptiest

Use cleaning tape with the most remaining cleanings available. Setting is yes or no.

Unload required

Setting is yes or no.

UUID

Universal Unique Identifier (UUID) for the hardware

Attachment #

Starts at 1 and increments for multiple tape drives or libraries

Host

Host name of the media server

Raw device

Device-specific file name: /dev/rbl# for a tape library and /dev/rbt# for a tape drive

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 yes or no.

Error rate

Maximum number of errors for each tape before backup job fails

Position interval

During a backup, Oracle Secure Backup periodically samples the position of the tape. Position interval is the distance between samplings of the tape position expressed in 1KB blocks. Possible values include:

  • [undetermined]

    The device was not asked what the current position interval is, because the --description option was not specified.

  • [positioning unsupported]

    The tape drive does not support positioning.

  • [positioning disabled in operations policy]

    An Oracle Secure Backup user has disabled position querying in the operations policy.

  • interval (from index policy)

    An Oracle Secure Backup user has specified the indicated position interval in the index policy.

  • interval (from object)

    The tape drive has a particular position interval specified in the device object.

  • interval (from driver)

    The device driver has decided on the indicated position interval.

Blocking factor

The default value is 128. 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 yes or no

Consumption

Amount of space used by the disk pool or cloud storage device. The value in brackets indicates the percentage of disk pool capacity that has been utilized.

Reclaimable space

Amount of space in the disk pool or cloud storage device that can be freed by deleting expired backup image instances.

Capacity

Total capacity of the disk pool or cloud storage device.

Free space

Percentage of disk pool capacity that the disk pool manager must maintain by proactively deleting expired backup image instances.

Concurrent jobs

Maximum number of jobs that can run concurrently for this disk pool or cloud storage device. This includes backup, restore, and copy instance jobs.

Staging Whether staging is enabled.
Stage rules A list of stage rules.
User name

Name of the Oracle Cloud user account. This user account belongs to the defined identity domain.

Container The name of the Oracle Secure Backup Oracle Cloud container
Storage class The cloud storage class, either object or archive.
Segmentsize The size specified for segments in the container. (Oracle Secure backup splits each backup image into multiple segments.)
Streamsperjob

The number of threads created for parallel uploads of backup data.

Number of objects The number of objects in the cloud container. (Oracle Secure Backup stores each segment as a single object in a cloud container.)
Bytes used The actual number of bytes consumed in the cloud container. This value includes additional metadata, and possibly uncatalogued backup data, not reported by consumption.
Proxy

The proxy server URL, if the connection to Oracle Cloud is through a proxy server.

Proxy user The proxy server user name.

Examples

Example 2-87 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
    Position interval:      [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
    Position interval:      [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

Example 2-88 Displaying Space Consumption Details for a Disk Pool

This example displays the amount of space occupied by backup image instances in the disk pool dp1. Under Consumption, the percentage value in brackets represents the percentage of total space on the disk pool that is used.

ob> lsdev -l dp1

dp1:
    Device type:            disk pool
    Enable checksum:        no
    In service:             no
    Debug mode:             no
    Capacity:               10.0 MB
    Consumption:            576.0 KB (5%)
    Reclaimable space:      576.0 KB (5%)
    Free space goal:        (system default)
    Concurrent jobs:        1
    Blocking factor:        (default)
    Max blocking factor:    (default)
    UUID:                   f712590d-97b4-4a33-86a5-8c6ba5f25655
    Attachment 1:
        Host:               MY-LAP
        Directory:          c:/diskpool2
    Staging:                no
    Stage rules:            aaaaa, bbbbb, ccccc, ddddd

Example 2-89 Listing Details for a Cloud Storage Device

This example lists details for a cloud storage device named clo.

ob>  lsdev -l clo
clo:
    Device type: cloud storage
    Enable checksum: yes
    In service: yes
    Debug mode: no
    Capacity: 400.0 GB
    Consumption: 55.5 GB (13%)
    Reclaimable space: 62.4 MB (0%)
    Free space goal: (system default)
    Concurrent jobs: 4
    Blocking factor: (default)
    Max blocking factor: (default)
    UUID: cd83d04e-7977-1035-83a5-fa163e178731
    Attachment 1:
        Host: brhost3
    Staging: no
    URL: example.storage.oraclecloud.com
    Username: jsmith@example.com
    Container: ndisk
    Storage class: object
    Identity domain: example
    Segment size: (system default)
    Streams per job: (system default)
    Number of objects: 8478
    Bytes used: 55.9 GB

lsds

Purpose

Use the lsds command to list dataset file and dataset directory names.

See Also:

"Dataset Commands" for related commands

Prerequisites

You must have the display administrative domain's configuration right to use the lsds command.

Syntax

lsds::=

lsds [ --long/l | --short/-s ] [ --recursive/-r ] [ dataset-dir-name ]

Semantics

--long/-l

Displays data in long form, which means that obtool labels the top-level directory. Refer to Example 2-90 for sample output. This option is the default.

--short/-s

Displays data in short form, which means that obtool does not label the top-level directory.

--recursive/-r

Recursively displays directories and dataset files under the specified directory.

dataset-dir-name

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

Example 2-90 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

lsdup

Purpose

Use the lsdup command to list information about duplication policies.

Prerequisites

You must have the display administrative domain's configuration right to use the lsdup command.

Syntax

lsdup::=

lsdup [ --short/-s | --long/-l ] [ policyname ]...

Semantics

--short/-s

Displays duplication policy information in short form.

--long/-l

Displays duplication policy information in long form.

policyname

Specifies the name of a duplication policy.

Example

Example 2-91 Listing Information About Duplication Policies

This example lists the details of the duplication policy voldup1 created in Example 3-14.

ob> lsdup
voldup1    
ob> lsdup --long voldup1
voldup1:	
    Migrate:                no
    Trigger:                firstwrite : forever
    Restriction 1:          @brhost3
    Rule 1:                 RMAN-DEFAULT : 2
    UUID:                   db4bfd64-18af-1031-b040-00163e527899

lsdw

Purpose

Use the lsdw command to list duplication windows.

See Also:

"Duplication Window Commands" for related commands

Prerequisites

You must have the modify administrative domain's configuration right to use the lsdw command.

Syntax

lsdw::=

lsdw [ --short/-s ] day-specifier[,day-specifier]...

Semantics

--short/-s

Displays duplication window information in short form.

lsfs

Purpose

Use the lsfs command to list file systems on an Network Attached Storage (NAS) device accessed through Network Data Management Protocol (NDMP).

Prerequisites

You must have the right to query and display information about devices to use the lsfs command.

Syntax

lsfs::=

lsfs [ --short/-s | --long/-l ] [ --noheader/-H ]
[ --host/-h hostname[,hostname]... ]
[ --logical/-L | --physical/-P ] [ filesystem-name ]...

Semantics

--short/-s

Displays file-system data in short form.

--long/-l

Displays file-system data in long form.

--noheader/-H

Suppresses the display of headings.

--host/-h hostname

Specifies the name of the host on which the file system resides.

--logical/-L

Indicates that filesystem-name is a logical volume name.

--physical/-P

Indicates that filesystem-name is a physical volume name.

filesystem-name

Specifies the name of a file system that resides on the host.

Output

Table 2-9 describes the output format of the lsfs command.

Table 2-9 lsfs Output

Column Indicates

File-system type

File-system type

File-system status

File-system status; setting is online or offline

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

Example 2-92 Listing File Systems on an NDMP Host

Example 2-92 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

lshost

Purpose

Use the lshost command to display the names and attributes of one or more configured hosts.

See Also:

"Host Commands" for related commands

Prerequisites

You must have the display administrative domain's configuration right to use the lshost command.

Syntax

lshost::=

lshost [ --long/-l | --short/-s ] [ --inservice/-o | --notinservice/-O ]
 [ --unauthenticated/-U ] [ --noroles/-R ] [ --roles/-r role[,role]... 
[ {--admin/-A | hostname} ]...

Semantics

--long/-l

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.

--short/-s

Displays host data in short form, which means that obtool displays only the host names.

--inservice/-o

Lists hosts that are logically available to Oracle Secure Backup.

--notinservice/-O

Lists hosts that are not logically available to Oracle Secure Backup.

--unauthenticated/-U
Lists hosts that are not authenticated by the administrative host.

Note that you cannot use the --unauthenticated parameter in conjunction with the --inservice and --notinservice parameters.

--noroles/-R

Suppresses the display of role information.

--roles/-r role

Lists hosts having the specified roles. Refer to"role" for a description of the role placeholder.

--admin/-A |hostname

Specifies the name of the host computer for which to list data.

Output

Table 2-10 describes the output of the lshost command.

Table 2-10 lshost Output

Label Indicates

Access mode

Setting is OB or NDMP. You can use NDMP as the access mode for Oracle Secure Backup clients and media servers. For the administrative server, you can use only OB as the access mode

OB indicates the host has Oracle Secure Backup installed (on UNIX, Linux, or Windows computer) and uses Oracle Secure Backup internal communications protocol to communicate.

NDMP indicates the host does not have Oracle Secure Backup installed (for example, a filer/Network Attached Storage (NAS) device) and uses the Network Data Management Protocol (NDMP) to communicate.

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 required, then all backups from this host are encrypted. If set to allowed, then encryption is determined by the global encryption policy and backup job-specific encryption settings. Default is required.

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 yes or no

Roles

Type of role; setting is client, admin, or media server

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 default, yes or no

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")

S/w compression

Specifies the compression option to be used for all file system backups in this Oracle Secure Backup client, where it is not set at the job level

Example

Example 2-93 Displaying Host Information

This example displays information in short form about all hosts and then displays information about brhost2 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> lsh -l brhost2
brhost2:
    Access mode:             OB
    IP names:                126.1.1.2
    Disable RDS:             not set (system default)
    TCP/IP buffer size:      not set (global policy)
    S/w compression:         (not set)
    Algorithm:               aes192
    Encryption policy:       allowed
    Rekey frequency:         1 month (system default)
    Key type:                transparent
    In service:              yes
    Roles:                   client
    Trusted host:            no
    Certificate key size:    3072
    UUID:                    c8d15fd2-2ee3-1035-a955-00163e43c05f

lsinstance

Purpose

Use the lsinstance command to display information about backup image instances.

Prerequisites

You must have the list any backup, regardless of its owner or list any backups owned by user class right to use the lsinstance command.

Syntax

lsinstance::=

lsinstance 
[--long/-l | --short/-s] [--noheader/-H] [--sections/-S]
[--type/-Y {database | filesystem}]
[--ctype/-y {tape | disk | cloudstorage}]
[ {[--from/-f date-time] [--to/-t date-time]} | [--today/-T] ]
[--dbname/-n dbname[,dbname]...] [--dbid/-d dbid[,dbid]...]
[--piecename/-p piecename[,piecename]...]
[--duplicates/-D] [--expired/-e] [--host/-h hostname]...
[ [--barcode/-b tag]... | [--container/-c backup-container]... |
[--uuid/-u backup-instance-uuid]... | backup-instance-name... ]

Semantics

Refer to "cpinstance" for descriptions of options that are not included in this section.

--long/-l

Specifies that all the attributes pertaining to each backup image instance must be displayed.

--short/-s

Displays only the names of backup image instances.

--noheader/-H

Omits displaying the headers in the command output.

--sections/-S

Displays the backup sections that are used to store the data corresponding to the backup image instance.

--type/-Y {database | filesystem}

Limits the display of backup image instances to the specified type. Use database for backup image instances that are created for Oracle Database jobs. Use filesystem for backup image instances created for file-system backups.

--ctype/-y {tape | disk | cloudstorage}

Displays backup image instances that are stored on the specified type of backup container. Use tape to display backup image instances stored on tape. Use disk to display details about backup image instances stored on disk pools. Use cloudstorage to display backup image instances stored on cloud storage devices.

--from/-f date-time

Displays backup image instances that were created since the specified date or time. Refer to "date-time" for a description of the date-time placeholder.

--today/-T
d

Displays backup image instances that were created today.

--dbname/-n dbname

Displays backup image instances for the database specified by dbname. Use a comma-separated list to specify multiple database names.

--dbid/-d dbid

Displays backup image instances for the database whose database identifier (DBID) is specified by dbid. Use a comma-separated list to specify multiple DBIDs.

--piecename/-p piecename

Displays backup image instances whose backup piece name matches with that specified by piecename. Use a comma-separated list to specify multiple backup piece names.

--duplicates/-D

Displays duplicate volumes for backup image instances tat are stored on tape. Duplicate volume containers are denoted by a "+" in the command output.

--expired/-e

Displays all the expired backup image instances.

--host/-h hostname

Displays backup image instances for the specified host.

--barcode/-b

Displays only backup image instances stored on a volume that has the specified barcode.

Note:

You can use one of the following options in an lsinstance command: --barcode, --container, --uuid, and instance-spec.

Examples

Example 2-94 Listing Duplicate Volumes for Backup Image Instances

This example displays the duplicate volumes for backup image instances. The details for each instance include the creation time and the backup container on which the backup image instance is stored.

ob> lsinstance --duplicates
        Instance Name                 Created       Container(s)
brhost2-20121116-145737.1         2012/11/16.06:57  VOL000001
brhost2-20121116-145901.1         2012/11/16.06:59  mf1-000001,mf1-dup-000001+,
                                                    mf1-000002,mf1-dup-000002+,

Example 2-95 Displaying Backup Image Instance Details in Long Format

The following example displays the details of the backup image instance brhost2-20120503-163309.1 using the long format.

ob> lsinstance --long brhost2-20120503-163309.1
Instance name:    brhost2-20120503-163309.1
    Type:                   file system
    Client:                 brhost2
    Backup level:           0
    Container:              pool
    Encryption:             off
    Created:                2012/05/03.09:33
    Expires:                2012/05/03.09:34
    Created by job:         admin/2.1
    UUID:                   4b194612-77a6-102f-b437-00163e3e5439

Example 2-96 Displaying Backup Sections for a Backup Image Instance

The following example displays the backup sections associated with the backup image instance brhost2-20130329-123910.1.

ob> lsinstance --sections --long brhost2-20130329-123910.1
Instance name:    brhost2-20130329-123910.1
    Type:                   file system
    Client:                 brhost2
    Backup level:           0
    Container:              spantape-2-000001 (3bf4b0347ad6103bcac00163e309d9f)
                            spantape-2-000002 (3c4f18127ad61038ebd00163e309d9f)
                            spantape-2-000003 (3ca975967ad6103ae8b00163e309d9f)
    Encryption:             off
    Created:                2013/03/29.05:39
    Created by job:         admin/9.1
    UUID:                   4147ca4e-7ad6-1030-b076-00163e309d9f
    Backup Section OID:     107
        File:                   1
        Section:                1
        Size:                   1.1 MB
        UUID:                   4147ca62-7ad6-1030-b076-00163e309d9f
    Backup Section OID:     108
        File:                   1
        Section:                2
        Size:                   1.1 MB
        UUID:                   476e32aa-7ad6-1030-b076-00163e309d9f
    Backup Section OID:     109
        File:                   1
        Section:                3
        Size:                   6.0 MB
        UUID:                   4a728762-7ad6-1030-b076-00163e309d9f

Example 2-97 Displaying Staging Information in Long Format

This example shows the Stage state and Stage rule fields which are displayed if the instance is created by a copyfromstage job that copied the instance to another disk pool device that had staging enabled, and that device then used staging again to copy the instance to another device.

ob> lsinstance --long
Instance name:              brhost2-20151015-170355.1
    Type:                   file system
    Client:                 brhost2
    Backup level:           0
    Container:              pool1
    Encryption:             off
    Created:                2015/10/15.10:03
    Expires:                2015/10/15.10:03
    Stage state:            stage-complete
    Stage rule:             mystagingrule
    Created by job:         admin/3.1
UUID:                   5177a230-55c7-1033-a532-00163e566d4e
ob>

The Stage rule field displays the name of the stage rule that resulted in the instance being created. This field is displayed only if the instance was created because of a copyfromstage job.

The Stage state line is displayed for instances in a disk pool device that are either in the state stage-in-progress, or stage-complete. This line is not shown for instances in the state, not-staged.

Example 2-98 Displaying Backup Image Instances for a Specified Database

This example displays the backup image instances that are stored in Oracle Cloud for the database named orcl.

ob> lsinstance --ctype cloudstorage --dbname orcl --long
Instance name:    brhost2-20190218-143007.1
    Type:                   Oracle database
    Client:                 brhost2
    Backup piece name:      0btq67sn_1_1
    Container:              db_backups
    Media family:           db107mf
    Encryption:             on
    Algorithm:              aes192
    Created:                2019/02/18.09:30
    Created by job:         admin/1.1
    UUID:                   a562e946-15b7-1037-808c-96d7c2e53741
Instance name:    brhost2-20181075-143101.1
    Type:                   Oracle database
    Client:                 brhost2
    Backup piece name:      c-1523209233-20190218-00
    Container:              db_backups
    Media family:           db107mf
    Encryption:             on
    Algorithm:              aes192
    Created:                2019/02/18.09:31
    Created by job:         admin/2.1
    UUID:                   c5bcb910-15b7-1037-a9f2-a9b966e502f6 

Example 2-99 Displaying Specific Backup Pieces from Cloud Storage

This example displays the backup pieces that are specified using the --piecename parameter and that are stored in Oracle Cloud.

ob> lsinstance --ctype cloudstorage --piecename 0btq67sn_1_1 --piecename c-1523209233-20190218-00 --long
Instance name:    brhost2-20190218-143007.1
    Type:                   Oracle database
    Client:                 brhost2
    Backup piece name:      0btq67sn_1_1
    Container:              db_backups
    Media family:           db107mf
    Encryption:             on
    Algorithm:              aes192
    Created:                2019/02/18.09:30
    Created by job:         admin/1.1
    UUID:                   a562e946-15b7-1037-808c-96d7c2e53741
Instance name:    brhost2-20190218-143101.1
    Type:                   Oracle database
    Client:                 brhost2
    Backup piece name:      c-1523209233-20190218-00
    Container:              db_backups
    Media family:           db107mf
    Encryption:             on
    Algorithm:              aes192
    Created:                2019/02/18.09:31
    Created by job:         admin/2.1
    UUID:                   c5bcb910-15b7-1037-a9f2-a9b966e502f6

lsjob

Purpose

Use the lsjob command to obtain the status of the following kinds of scheduled jobs:

  • Backup

  • Restore

  • Duplication

  • Scan control

  • Media movement

  • Copy instance

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 commands

Prerequisites

If 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.

Syntax

lsjob::=

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...

Semantics

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.

State-based job options

Use these options to filter jobs by status. Refer to Example 2-100 for an illustration.

--active/-a

Shows active jobs, that is, jobs that are currently being processed. By default the lsjob command displays active and pending jobs.

--complete/-c

Shows jobs that completed either successfully or unsuccessfully.

--pending/-p

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.

--inputrequest/-i

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.

--all/-A

Shows jobs in all states.

job-id

Specifies the job ID of the scheduled backup and restore job whose status you want to obtain.

Time-based job options

Use these options to filter jobs according to when their state was updated or when they were scheduled to run. Refer to Example 2-101 for an illustration.

--from/-f date-time

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.

--to/-t date-time

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.

--today/-T

Shows only jobs whose state was updated today.

--timescheduled/-e

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-102 for an illustration.

--type/-Y job-type[,job-type]...

Shows only job entries of the specified type. By default obtool displays all types. Refer to "job-type" for the job-type placeholder.

--host/-h hostname

Shows only job entries related to the specified host.

--dataset/-D dataset

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.

Username-based job options

Use these options to filter jobs according to who initiated them. Refer to Example 2-103 for an illustration.

--system/-y

Shows jobs scheduled by Oracle Secure Backup.

--username/-u username

Shows jobs belonging to username. Run the lsuser command to display all Oracle Secure Backup users.

--me/-m

Shows jobs belonging to the currently logged in Oracle Secure Backup user. Run the id command to display the current Oracle Secure Backup user.

Miscellaneous job options

Use these options to filter jobs according to miscellaneous criteria.

--superseded/-S

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.

--subjobs/-j

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.

--primary/-P

Shows only each primary job. For example, lsjob --primary shows sbt/25 rather than sbt/25.1, sbt/25.2, and sbt/25.3.

Format control job options

Use these options to control the display of job information. Refer to Example 2-104 for an illustration.

--short/-s

Shows only job IDs.

--long/-l

Shows job information in labeled rather than column format.

--noheader/-H

Does not display column headers.

--oneperline/-1

Shows one job ID for each line when used with the --short option.

Content level job options

Use these options to filter jobs based on how much content to include. Refer to Example 2-105 for an illustration.

--results/-r

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
--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.

--requires/-R

Shows resources required to run each job. For example, jobs that can run on any device display "requires any device."

--times/-C

Shows all relevant times for each job. For example, the job times might look like the following:

introduced 2013/03/21.16:59, earliest exec 03/23.00:00, last update
2013/03/21.16:59, expires never
--log/-L

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.

--catalog/-G

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.

Output

Table 2-11 describes the output of the lsjob command.

Table 2-11 lsjob Output

Label Indicates

Job ID

Unique Oracle Secure Backup identifier assigned to a scheduled backup or restore job

Type

The type of job. See "job-type" for more information.

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

on for backups encrypted by Oracle Secure Backup

transient for backups encrypted by Oracle Secure Backup with a user-supplied one-time passphase

forcedoff for an on-demand backup that was not encrypted, overriding the host-required encryption setting

off for backups that are not encrypted

hardware for backups encrypted by an encryption-capable tape drive

transient_hardware for transient backups encrypted by an encryption-capable tape drive

RMAN for backups encrypted by Recovery Manager (RMAN)

This field displays awaiting job completion for an RMAN backup job that has not completed. Only when the RMAN backup finishes does this field report the encryption state of the backup.

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 processed, pending, completed successfully, failed, or waiting for input since date-timestamp.

Note: The waiting for input since date-timestamp state means the job was running but is now blocked waiting for user input that can be supplied using rpyjob.

Priority

Priority level of the job; 1 is the highest priority

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

S/w compression Status

Displays the S/w compression option considered for this job based on the compression setting

Examples

Example 2-100 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 2013/02/13.10:11
admin/1.1  none        backup brhost2                    completed successfully at 2013/02/13.10:11
admin/2    none        restore 1 item to brhost2         completed successfully at 2013/02/13.10:11
sbt/1      none        database tstvw1 (dbid=1586108579) completed successfully at 2013/02/13.10:15
sbt/1.1    none        archivelog backup                 completed successfully at 2013/02/13.10:15
sbt/2      none        database tstvw1 (dbid=1586108579) completed successfully at 2013/02/13.10:16
sbt/2.1    none        controlfile autobackup            completed successfully at 2013/02/13.10:16
sbt/3      none        database tstvw1 (dbid=1586108579) completed successfully at 2013/02/13.10:16 
sbt/3.1    none        datafile backup                   completed successfully at 2013/02/13.10:16
sbt/4      none        database tstvw1 (dbid=1586108579) completed successfully at 2013/02/13.10:17
sbt/4.1    none        restore piece '03ik5p7p_1_1'      completed successfully at 2013/02/13.10:17

Example 2-101 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-102 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-103 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-104 Displaying Job Data in Long Format

This example shows active and pending jobs in long format. The Created by user property shows “privileged” indicating that this is an on-demand job that included the --user option.

ob> lsjob --long
5:
    Type:                   datadir.ds
    Level:                  full
    Family:                 full
    Encryption:             on
    Created by user:        privileged
    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-105 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 2013/02/13.13:37, earliest exec 06/13.04:00, last update 
    2013/02/13.13:37, expires 2013/03/13.04:00

Example 2-106 Displaying Subjob Data in Long Format

This example shows all major fields displayed as part of a subjob in long format.

ob> lsjob --long admin/4.1
admin/4.1:
    Type:                     backup brhost2
    Level:                    full
    Backup name format:       (system default)
    Family:                   (null)
    Encryption:               off
    Disable h/w encryption:   no
    Store catalog on media:   yes
    S/w compression:          low
    Scheduled time:           none
    State:                    completed successfully at 2017/06/09.00:10
    Priority:                 100
    Privileged op:            no
    Run on host:              brhost3
    Attempts:                 1

lsloc

Purpose

Use the lsloc command to display information about every location in the administrative domain.

See Also:

"Location Commands" for related commands

Prerequisites

You must have the display administrative domain's configuration right to use the lsmf command.

Syntax

lsloc::=

lsloc [ --short/-s | --long/-l ] location-name [ location-name ]...

Semantics

--short/-s

Displays data in short form. This option displays only location names.

--long/-l

Displays data in long form.

location-name

Specifies the name of the location to list. If you do not specify a location-name, then obtool displays all locations.

lsmf

Purpose

Use the lsmf command to display information about media families.

See Also:

"Media Family Commands" for related commands

Prerequisites

You must have the display administrative domain's configuration right to use the lsmf command.

Syntax

lsmf::=

lsmf [ --long/-l | --short/-s ] [ media-family-name ]...

Semantics

--long/-l

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.

--short/-s

Displays data in short form. This option displays only media family names.

media-family-name

Specifies the name of the media family to list. If you do not specify a media-family-name, then obtool displays all media families.

Output

Table 2-12 shows the output for the lsmf command.

Table 2-12 lsmf Output

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 never

Appendable

Indicates the volume is appendable; setting is yes or no

Volume ID used

Volume identifier; setting is either system default, unique to this media family, same as for media fam < >, or from file < >

Comment

Optional user-supplied description of this media family

Example

Example 2-107 Listing Media Family Information

Example 2-107 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

lsp

Purpose

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:

Prerequisites

You must have the display administrative domain's configuration right to use the lsp command.

Syntax

lsp::=

lsp [ --short/-s | --long/-l ] [ --dir/-d ] [ --fullname/-f ] [ --novalue/-V ]
[ --nodefault/-D | --defaultvalue/-v ] [ --type/-t ] [ policy-name ]...

Semantics

--short/-s

Displays data in short form (default). This option displays the policy name and setting and indicates whether the setting is the default value.

--long/-l

Displays data in long form. This option is identical to --short except that the output includes a brief description of each policy.

--dir/-d

Displays the directory of the specified policy.

--fullname/-f

Display the full path names of the selected policies.

--novalue/-V

Suppresses the display of policy values.

--nodefault/-D

Suppresses the display of default values of the selected policies.

--defaultvalue/-v

Displays the default values of the selected policies.

--type/-t

Displays policies by type.

policy-name

Specifies the name of the policy to display.

Examples

Example 2-108 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-109 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

Example 2-110 Listing a Security Password Policy

This example sets the global password reuse time security policy to 180 days and lists the policy information.

ob> setp security/passwordreusetime 180days
ob> lsp --nodefault security/passwordreusetime
passwordreusetime                180 days

lspiece

Purpose

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 commands

Prerequisites

You must have the right to query and display information about devices to use the lspiece command.

Syntax

lspiece::=

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 ]...

Semantics

--long/-l

Displays data in long form.

--short/-s

Displays data in short form.

--noheader/-H

Does not display header row.

--section/-S

Lists the volume ID and backup sections used by the backup pieces. The volume ID is included with the --long output when you specify the --section option.

--oid/-o oid-list

Specifies one or more backup piece object identifiers. Refer to "oid-list" for a description of the oid-list placeholder.

--host/-h hostname

Specifies the name of the host computer to which the listing applies.

--dbname/-d dbname

Specifies the names of the databases whose backup pieces you want to list.

--dbid/-i dbid

Specifies the DBIDs of the databases whose backup pieces you want to list.

--content/-c content

Specifies the types of backup information contained by the backup piece. Refer to "content" for a description of the content placeholder.

--vid/-v vid_list | --void/-V oid_list

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.

piecename

Specifies the names of the backup pieces to which the listing applies.

Output

Table 2-13 describes the output of the lspiece command.

Table 2-13 lspiece Output

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

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

Algorithm

The encryption algorithm used

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.

Example

Example 2-111 Displaying Backup Pieces

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

Example 2-112 Displaying Volume ID Used by Backup Pieces

The following example lists the volume ID and backup sections used by backup pieces.

ob> lspiece -l -S
Backup piece OID:       100
    Database:               oracle
    Database ID:            1566049437
    Content:                full
    Copy number:            0
    Created:                2009/07/23.15:07
    Host:                   sales-server
    Piece name:             03kks4m5_1_1
        BSOID:              100
        Volume ID:          RMAN-DEFAULT-000001
        File:               1
        Sect:               1
    Encryption:             off

lspni

Purpose

Use the lspni command to list PNI (Preferred Network Interface) definitions.

See Also:

"Preferred Network Interface Commands" for related commands

Prerequisites

You must have the display administrative domain's configuration right to use the lspni command.

Syntax

lspni::=

lspni [ server-hostname ]...

Semantics

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.

Output

Table 2-14 describes the output for the lspni command.

Table 2-14 lspni Output

Column Indicates
PNI # Sequential number, starting at 1, identifying the PNI for inbound connections to this host
UNI # Identifies the only interface used a PNI for outbound connections from this host

ONI #

Sequential number, starting at 1, identifying the PNI for outbound connections from the host

interface

IP address of the interface

useonly Only interface that must be used for outbound connections

Example

Example 2-113 Listing PNIs

This example displays the PNIs for servers brhost2 and brhost3.

ob> lspni
brhost2:
  ONI 1:
    network:                           198.51.100.1/8
    interface:                         198.51.100.1
brhost3:
  ONI 1:
    network:                           198.51.100.33/24
    interface:                         198.51.100.33

lsrestore

Purpose

Use the lsrestore command to list restore requests. These requests are awaiting delivery to the scheduler.

See Also:

"Restore Commands" for related commands

Prerequisites

If 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.

Syntax

lsrestore::=

lsrestore [ --long/-l | --detail/-d | { --short/-s [ --oneperline/-1 ] } ]
[ --position/-x ] [ --noheader/-H ] [ --raw/-R ] [ --catalog/-C ]
[ restore-item ]...

Semantics

--long/-l

Displays restore request data in long form.

--detail/-d

Displays detailed data about the backup to be used in the restore.

--short/-s

Displays restore request data in short form. This item is the default.

--oneperline/-1

Shows one item for each line when used with the --short option.

--position/-x

Displays the position of the backup on tape when used with the --detail option.

--noheader/-H

Displays data without column headings.

--raw/-R

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.

--catalog/-C

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.

restore-item

Specifies the item number of a restore request. You can display the item numbers for restore requests by running lsrestore without any options.

Output

Table 2-15 describes the output for the lsrestore command.

Table 2-15 lsrestore Output

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

Example 2-114 Listing Restore Requests

Example 2-114 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:            2012/12/02.12:37:07
    File number:        1
    Device:             tape1
    Backup ID:          1
    Volume ID:          VOL000003
    Volume tag:         ADE203
    File section:       1
    Position:           000000000009

lsrot

Purpose

Use the lsrot command to list information about rotation policies.

Prerequisites

You must have the display administrative domain's configuration right to use the lsrot command.

Syntax

lsrot::=

[ --short/-s | --long/-l ] rotationname [ rotationname... ]

Semantics

--short/-s

Displays policy information in short form.

--long/-l

Displays policy information in long form.

rotationname
Specifies the name of a rotation policy, which must be 1-31 characters.

lsrpt

Purpose

Use the lsrpt command to list media management reports.

See Also:

"Reports Commands"

Prerequisites

You must have the display administrative domain's configuration right to use the lsrpt command.

Syntax

lsrpt::=

lsrpt [ --short/-s | --long/-l ] [ --type/-t reporttype [,reporttype...] ] 
job-id ...

Semantics

--short/-s

Specifies short form listing.

--long/-l

Specifies long form listing.

--type /-t reporttype

Specifies one or more types of report to be displayed. Valid types are distribution and pick.

job-id

Specifies the identifiers of jobs whose reports are to be listed.

Example

Example 2-115 Listing Media Management Reports

This example lists details of the pick report seen in Example 2-16

ob> lsrpt --long --type pick 2
2-pick.xml:
Volumes moved:
              VOL000001
Job status   :pending enable by operator

lssched

Purpose

Use the lssched command to display information about backup, vaulting scan, duplication scan, and stage scan schedules.

See Also:

"Schedule Commands" for related commands

Prerequisites

You must have the display administrative domain's configuration right to use the lssched command.

Syntax

lssched::=

lssched [ --short/-s | --long/-l ]
[ --calendar/-c year/month
[ --trigger trigger-number[,trigger-number]... ] ]
[ --type/-Y schedule-type[,schedule-type...] ] 
[ --user/-u user-name]
[ schedulename ]...

Semantics

--short/-s

Displays schedule data in short form.

--long/-l

Displays schedule data in long form.

--calendar/-c year/month

Restricts display to schedule information in the given month and year.

--trigger trigger-number

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.

--type/-Y schedule-type

Specifies the type of schedule to be listed. Valid values are backup, duplicationscan, vaultingscan, and stagescan. Multiple schedule types can be specified.

--user/-u user-name

Displays schedules that must be run as Oracle Secure Backup user specified by user-name.

schedulename

Specifies the name of the schedule to display.

Output

Table 2-16 describes the output of the lssched command.

Table 2-16 lssched Output