3 obtool Commands: managedev to vfylibs

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

managedev

Purpose

Use the managedev command to manage the contents of disk pool and cloud storage devices.

Prerequisites

You must have a disk pool configured in your domain before using this command.

See Also:

Oracle Secure Backup Administrator's Guide, for more information on managing disk pools

Usage Notes

This command reclaims space that is occupied by expired backup image instances in disk pool and cloud storage devices.

Syntax

managedev::=

managedev 
--deleteexpired/-d
[--clearstage/-k {<stage-rule-name>[,<stage-rule-name>]...]}
[--interactive/-i] 
[--host/-h hostname[,hostname]...]
devicename...

Semantics

--deleteexpired/-d

Deletes expired backup image instances contained in disk pool and cloud storage devices.

[--clearstage/-k {<stage-rule-name>[,<stage-rule-name>]...]}

Changes the state of a backup image instance on the specified stage devices from stage-in-progress to not-staged.

This option is only needed in the rare case where a copyfromstage job failed catastrophically in a way that did not result in instances that were not copied having their stage state set back to not-staged. Instances marked stage-in-progress are never staged by a later stagescan job. The pool manager space reclaimer does not delete such instances after they expire.

Only backup image instances that match the stage rule are modified.

This option should not be used while either a stagescan job or a copyfromstage job is running.

--interactive/-i

Displays each backup image instance that is eligible for deletion and prompts you to confirm whether the instance can be deleted.

--host/-h hostname

Deletes only the expired backup image instances associated with the specified hosts.

devicename

Specifies the name of the device that is being managed.

Examples

Example 3-1 Deleting Expired Backup Image Instances for a Specified Host

This example deletes all expired image instances associated with the host brhost3 that are stored on the disk pool dp1.

ob> lsinstance --expired --host brhost2
        Instance Name                 Created       Container(s)
brhost2-20130423-110518.1         2013/04/23.04:05  dp2

ob> managedev --deleteexpired --host brhost2 dp2
Info: deleted 1 expired backup image from device dp2, space reclaimed: 128.0 KB

mkauth

Purpose

Use the mkauth command to configure an authentication object for use with Oracle Secure Backup. An authentication object specifies credentials used to perform backups to Oracle Cloud Infrastructure Object Storage and Oracle Cloud Infrastructure Object Storage Classic.

Prerequisites

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

Usage Notes

The length of the mkauth command may exceed the permitted 255 characters per line. In such cases, store the command in a Shell script and then run the script. For example, consider the following mkauth command:

# obtool -u sbt_user -p sbt_user_password mkauth -t oci -c "bmc auth" --fingerprint
e3:2b:c1:22:cf:3c:32:ed:30:a2:35:26:d6:8a:f9:09 --iddomain testdomain 
--keyfile /scratch/certcld/oci_api_key.pem --tenancyocid
ocid1.tenancy.oc21..dhrnyaaaaaj2su2ygphucdke3rw72fc4cd67podh2vdl533uakia8yqbxqff
a --url https://console.us-phoenix-1.oraclecloud.com --userocid
ocid1.user.oc21..dhrnyaaaaa48eihbdjqmlsky4nl7tnldltqjv842wlqfifvare7f3crvnkrvq
bmcauthobj

Instead of the running the actual command, store the command in a Shell script named my_script.txt and then run the script, as shown in the following command.

obtool < /osb/scripts/my_script.txt

Syntax 1

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

Semantics

mkauth::=

mkauth --type/-t oci    
[--comment/-c comment] [--inputcomment/-i] 
{--fingerprint/-f  key-finger-print} {--keyfile/-k key-file-path}
{--tenancyocid/-o tenancy-ocid} {--userocid/-u user-ocid}
[--iddomain/-d identity-domain] [--url/-r cloud-url]
authobj-name

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

--comment/-c comment

Specifies comment text to describe the authentication object.

--inputcomment/-i

Causes mkauth to prompt to enter comment text.

--fingerprint/-f key-finger-print

Specifies the fingerprint of the Oracle Cloud Infrastructure public key that is specified. A public key and private key are required to authenticate with Oracle Cloud Infrastructure. See Required Keys and OCIDs for more information about generating these keys.

--keyfile/-k key-file-path

Specifies the full path name of the RSA private key file. The key must be in 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 Oracle Cloud Infrastructure user.

--iddomain/-d identity-domain

Specifies the namespace to be used in the Oracle Cloud Infrastructure account.

--url/-r cloud-url

Specifies the region-specific URL used to access Oracle Cloud Infrastructure.

authobj-name

Specifies the name of the authentication object.

Syntax 2

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

Semantics

mkauth::=

mkauth --type/-t oci-classic    
[--comment/-c comment] [--inputcomment/-i]
{--username/-n cloud-user} {--queryp/-q}
[--iddomain/-d identity-domain] [--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 mkauth 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 mkauth to prompt for the password for the Oracle Cloud Infrastructure Classic account.

--iddomain/-d identity-domain

Specifies the namespace to be used in the Oracle Cloud Infrastructure Classic account.

--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 3-2 Creating an Authentication Object for Oracle Cloud Infrastructure

This example creates and lists an authentication object for Oracle Cloud Infrastructure.

ob> mkauth -t oci -o ocid1.tenancy.oc1..aaaaaaaavjhvwf2c2z2ozzyuob7njen5imx57i6ts3vcsb3v54w7q4whc6ka 
-u ocid1.user.oc1..aaaaaaaaqm7l5pijshvpaq67t7tnixsjkn7z7sapqusj7jqacl7pm7wm6lva 
-f c5:09:dd:f5:d6:88:2c:63:b1:19:b6:39:09:9c:90:fb -k /home/user1/oci/oci_api_key.pem 
--url https://console.us-phoenix-1.oraclecloud.com --iddomain testdomain auth_01
ob> lsauth -l
auth_01:
    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:                   69ae9858-c9fb-1036-90bb-fa163e381872
ob>

mkclass

Purpose

Use the mkclass command to define an Oracle Secure Backup user class.

Oracle Secure Backup predefines several classes, which are described in Classes and Rights.

See Also:

"Class Commands" for related commands

Prerequisites

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

Syntax

mkclass::=

mkclass [ --modself/-m { yes | no } ] [ --modconfig/-M { yes | no } ]
[ --backupself/-k { yes | no } ]  [ --backuppriv/-K { yes | no } ]
[ --restself/-r { yes | no } ]    [ --restpriv/-R { yes | no } ]
[ --listownjobs/-j { yes | no } ] [ --modownjobs/-J { yes | no } ]
[ --listanyjob/-y { yes | no } ]  [ --modanyjob/-Y { yes | no } ]
[ --mailinput/-i { yes | no } ]   [ --mailerrors/-e { yes | no } ]
[ --mailrekey/-g {yes | no}]      [ --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

The default for all mkclass options that require a yes or no value is no.

--mailrekey/-m {yes | no}

Specifies whether e-mails are sent out to the administrative class when a rekey occurs, encounters errors, or has expired keys.

--modself/-m {yes | no}

Enables Oracle Secure Backup users to modify their own password and given name.

--modconfig/-M {yes | no}

Enables Oracle Secure Backup users to modify (create, modify, rename, and remove) all objects in an Oracle Secure Backup administrative domain. These modifiable objects include objects representing classes, users, hosts, devices, defaults, and policies.

--backupself/-k {yes | no}

Enables Oracle Secure Backup users to run backups under their own user identity.

--backuppriv/-K {yes | no}

Enables Oracle Secure Backup users to run backups as the root or privileged user.

--restself/-r {yes | no}

Enables Oracle Secure Backup users to restore the contents of backup image instances under the restrictions of the access rights imposed by the user's UNIX name/group or Windows domain/account.

--restpriv/-R {yes | no}

Enables Oracle Secure Backup users to restore the contents of backup image instances as a privileged user. On Linux and UNIX hosts, a privileged restore operation runs under the root operating system identity. For example, Oracle Secure Backup user joeblogg runs under operating system account root. On Windows systems, the restore operations runs under the same account as the Oracle Secure Backup service on the Windows client.

--listownjobs/-j {yes | no}

Grants Oracle Secure Backup users the right to view the following:

• Status of scheduled, ongoing, and completed jobs that they configured

• Transcripts for jobs that they configured

--modownjobs/-J {yes | no}

Grants Oracle Secure Backup users the right to modify only jobs that they configured.

--listanyjob/-y {yes | no}

Grants Oracle Secure Backup users the right to view the following:

• Status of any scheduled, ongoing, and completed jobs

• Transcripts for any job

--modanyjob/-Y {yes | no}

Grants Oracle Secure Backup users the right to make changes to all jobs.

--mailinput/-i {yes | no}

Enables Oracle Secure Backup users to receive email when Oracle Secure Backup needs manual intervention. Occasionally, during backup and restore operations, manual intervention of an operator is required. This situation can occur if a required volume cannot be found or a volume is required to continue a backup. In such cases, Oracle Secure Backup sends e-mail to all Oracle Secure Backup users who belong to classes having this right.

--mailerrors/-e {yes | no}

Enables Oracle Secure Backup users to receive email messages describing errors that occur during Oracle Secure Backup activity.

--listownbackups/-s {yes | no}

Grants Oracle Secure Backup users the right to view information about backup images and backup image instances that they created.

--listanybackup/-u {yes | no}

Grants Oracle Secure Backup users the right to view information about any backup images or backup image instances in the administrative domain.

--modownbackups/-S {yes | no}

Enables Oracle Secure Backup users to modify backup images or backup image instances that they created.

--modanybackup/-U {yes | no}

Enables Oracle Secure Backup users to modify all backup images or backup images instances in the administrative domain.

--modcatalog/-c {yes | no}

Enables Oracle Secure Backup users to modify backup catalog information.

--querydevs/-q {yes | no}

Enables Oracle Secure Backup users to query the state of devices.

--managedevs/-d {yes | no}

Enables Oracle Secure Backup users to control the state of devices with the obtool command.

--listconfig/-L {yes | no}

Enables Oracle Secure Backup users to list objects, for example, hosts, devices, and users, in the administrative domain.

--browse/-b browserights

Grants Oracle Secure Backup users browsing rights. Specify one of the following browserights values, which are listed in order of decreasing privilege:

• privileged means that Oracle Secure Backup users can browse all directories and catalog entries.

• notdenied means that Oracle Secure Backup users can browse any catalog entries for which they are not explicitly denied access. This option differs from permitted in that it allows access to directories having no stat record stored in the catalog.

• permitted means that Oracle Secure Backup users are bound by normal UNIX permissions checking (default). Specifically, Oracle Secure Backup users can only browse directories if at least one of the following conditions is applicable:

  • The UNIX user defined in the Oracle Secure Backup identity is listed as the owner of the directory, and the owner has read rights.

  • The UNIX group defined in the Oracle Secure Backup identity is listed as the group of the directory, and the group has read rights.

  • Neither of the preceding conditions is met, but the UNIX user defined in the Oracle Secure Backup identity has read rights for the directory.

• named means that Oracle Secure Backup users are bound by normal UNIX rights checking, except that others do not have read rights. Specifically, Oracle Secure Backup users can only browse directories if at least one of the following conditions is applicable:

  • The UNIX user defined in the Oracle Secure Backup identity is listed as the owner of the directory, and the owner has read rights.

  • The UNIX group defined in the Oracle Secure Backup identity is listed as the group of the directory, and the group has read rights.

• none means that no Oracle Secure Backup user has any rights to browse any directory or catalog.

--orauser/-o {yes | no}

Enables Oracle Secure Backup users to perform Oracle Database backup and restore operations (yes or no). This right enables Oracle Secure Backup users to perform any SBT operation, regardless of what other rights they have. For example, an Oracle Secure Backup user with this right can perform SBT restore operations even if the perform restores as self right is set to no.

--orarights/-O oraclerights

Enables Oracle Secure Backup users with the specified rights to access Oracle Database backups. The oraclerights placeholders can be any of the following values:

• class means that Oracle Secure Backup users can access SBT backups created by any Oracle Secure Backup user in the same class.

• all means that Oracle Secure Backup users can access all SBT backups.

• none means that no Oracle Secure Backup user has any rights to access SBT backups.

• owner means that Oracle Secure Backup users can access only those SBT backups that they themselves have created (default).

classname

Specifies the name of the class to be created. Class names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.

Example

Example 3-3 Making a Class

This example creates a class called backup_admin. The command accepts the default value of no for --listownjobs, --modownjobs, --listanyjob, --modanyjob, --managedevs, --orauser, and --orarights. Note that because of space constraints the mkclass command in the example spans multiple lines.

ob> mkclass --listconfig yes --modself yes --modconfig yes --backupself yes
--backuppriv yes --restself yes --restpriv yes --mailinput yes --mailerrors yes
--querydevs yes --browse privileged backup_admin
ob> lsclass --long backup_admin
backup_admin:
    browse backup catalogs with this access:         privileged
    access Oracle database backups:                  owner
    access file system backups:                      owner
    display administrative domain's configuration:   yes
    modify own name and password:                    yes
    modify administrative domain's configuration:    yes
    modify catalog:                                  no
    perform file system backups as self:             yes
    perform file system backups as privileged user:  yes
    list any jobs owned by user:                     no
    modify any jobs owned by user:                   no
    perform file system restores as self:            yes
    perform file system restores as privileged user: yes
    receive email requesting operator assistance:    yes
    receive email describing internal errors:        yes
    receive email regarding expired passphrase keys: no
    query and display information about devices:     yes
    manage devices and change device state:          no
    list any job, regardless of its owner:           no
    modify any job, regardless of its owner:         no
    perform Oracle database backups and restores:    no
    list any backups owned by user:                  no
    modify any backups owned by user:                no
    list any backup, regardless of its owner:        no
    modify any backup, regardless of its owner:      no

mkdev

Purpose

Use the mkdev command to configure a device for use with Oracle Secure Backup. This command assigns Oracle Secure Backup names and attributes to the devices in your administrative domain. Devices include tape devices, tape libraries, disk pools, and cloud storage devices.

To be usable by Oracle Secure Backup, each device must have at least one attachment, which describes a data path between a host and the device itself. In the attachment, you identify a host to which the device is connected and a raw device name through which it is accessed.

See Also:

• "Device Commands" for related commands

• "mkhost" to learn about configuring an administrative domain

Prerequisites

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

You should disable any system software that scans and opens arbitrary Small Computer System Interface (SCSI) targets before configuring an Oracle Secure Backup tape device. If Oracle Secure Backup has to contend with other system software (such as monitoring software) for access to tape libraries and tape drives, then unexpected behavior can result.

Syntax 1

Use the following syntax to configure a tape drive.

mkdev::=

mkdev --type/-t tape 
[ --attach/-a aspec[,aspec]... ]
[ --inservice/-o | --notinservice/-O ] [ --wwn/-W wwn ]
[ --library/-l devicename ] [ --dte/-d dte ] 
[ --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 ]
[ --createdevfile/-k]
[ --enablechecksum/-K {yes | no | systemdefault}]
devicename...

Semantics 1

The following options enable you to configure a tape drive.

--type/-t tape

Specifies the device as a tape drive.

--attach/-a aspec

Configures an attachment, which is the physical or logical connection of a device to a host. An attachment is distinct from a device and describes a data path between a host and the device.

Oracle Secure Backup uses attachments to access a device, so a device must have at least one attachment to be usable by Oracle Secure Backup. A Fibre Channel-attached tape drive or tape library often has multiple attachments, one for each host that can directly access it. The scheduler selects the first --inservice attach point from the device's list of attach points. If the attach point's media server host is unreachable, then the scheduler takes the host "out-of-service" and retries the job.

Refer to "aspec" for a description of the aspec placeholder.

--inservice/-o

Specifies that the tape drive is logically available to Oracle Secure Backup.

--notinservice/-O

Specifies that the tape drive is not logically available to Oracle Secure Backup.

--wwn/-W wwn

Specifies the worldwide name of the device. Refer to "wwn" for an explanation of the wwn placeholder.

--library/-l devicename

Specifies the name of the tape library in which a tape drive resides.

--dte/-d dte

Specifies the data transfer element (DTE) number of a tape drive within its containing tape library. DTE is the SCSI-2 name for a tape drive in a tape library. DTEs are numbered 1 through n and are used to identify tape drives in a tape library.

You must specify a dte number if --library is specified. The dte option is not available for standalone tape drives.

When you first configure tape libraries that have multiple drives, while assigning DTE numbers to the drives in Oracle Secure Backup, it is important to observe the DTE numbering scheme from the perspective of the physical library. The numbering of the drives is not an arbitrary, sequential value that you can assign. It must correspond to the correct order within the library; else the following error occurs when Oracle Secure Backup attempts to unload a misconfigured drive: Error: can't execute command - source is empty. To determine the DTE numbers within a tape library, on the user interface or the front panel of the library, find the drive serial number for each DTE number and then ensure that you assign the correct DTE number to the corresponding drive in Oracle Secure Backup. After you configure the drives in Oracle Secure Backup, use the following command to verify that your DTE numbers are accurate:

ob> vfylibs -v

In the output of the vfylibs command, for each drive, the serial number and the DTE number must exactly match the independent output from the user interface or front panel of the library.

--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 tape. By default, Oracle Secure Backup writes 64K blocks to tape, 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 a tape whose blocking factor is unknown.

The largest value permitted for the maximum blocking factor, which is the number of 512-byte records for each physical tape block, is 4096. This value represents a maximum tape block size of 2MB. This maximum is subject to device and operating system limitations that can reduce this maximum block size.

--automount/-m {yes | no}

Sets the automount mode. The mount mode indicates the way in which Oracle Secure Backup can use a volume physically loaded into a tape drive (see the description of "mountdev").

A value of yes (default) instructs Oracle Secure Backup to mount tapes for backup and restore operations without operator intervention. If this option is set to no, then you must manually mount volumes before they are usable.

A setting of no can be useful if you dedicate a tape drive to performing on-demand restore operations, but not backups. If automount is set to yes for this tape drive when a backup is scheduled, and if the tape drive contains an unmounted, eligible tape, then Oracle Secure Backup uses the tape drive for the backup.

--erate/-e erate

Specifies the error rate percentage. The error rate is the number of recovered errors divided by the total blocks written, multiplied by 100. Oracle Secure Backup issues a warning if the error rate reported by the device exceeds the value you specify. The default is 8.

Oracle Secure Backup issues a warning if it encounters a SCSI error when trying to read or reset the error counters of the tape drive. Some tape drives do not support the SCSI commands necessary to perform these operations. To avoid these warnings, disable error rate checking by specifying none for the error rate.

--current/-T se-spec

Specifies the number of a storage element. This option only applies to a tape drive when the following criteria are met:

• The tape drive is in a tape library.

• The tape drive is known to be loaded with a tape.

• The hardware cannot determine from which storage element the tape drive was loaded.

Refer to "se-spec" for a description of the se-spec placeholder.

--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 those in the second half to be available to the second tape drive. Alternatively, you might want to set up different use lists for different types of backups on a single tape drive.

Refer to "se-range" for a description of the se-range placeholder.

--usage/-U duration

Specifies the interval for a cleaning cycle. For example, --usage 1month requests a cleaning cycle every month. Refer to "duration" for a description of the duration placeholder.

You can specify the --usage option on the chdev command to initialize the configured interval to reflect the amount of time that the tape drive has been used since the last cleaning. For example, specify --usage 1week on the chdev command to indicate that the most recent cleaning was a week ago.

--positioninterval/-q kb

Specifies the position interval in terms of kb, which is the "distance" between samplings of the tape position expressed in 1KB blocks. The maximum allowed position interval is 1048576 (1MB), which is a query interval of 1GB. A position interval of 0 disables position sampling.

During a backup, Oracle Secure Backup periodically samples the position of the tape. obtar saves this position information in the Oracle Secure Backup catalog to speed up restore operations. For some devices, however, this sampling can degrade backup performance. While Oracle Secure Backup has attempted to determine optimal position intervals for all supported tape drive types, you might find that you must adjust the position interval.

The position interval set at the device level overrides the global position interval settings.

--serial/-N serial-number

Specifies the serial number for the tape device.

If a serial number is entered, then Oracle Secure Backup stores that serial number in the device object. If no serial number is entered, then the serial number is read and stored in the device object the first time Oracle Secure Backup opens the tape device.

See Also:

"checkserialnumbers"

--model/-L model-name

Specifies the model name for the tape device. The model number is usually discovered during device configuration.

--createdevfile/-k

Creates a device file on the media server by using the SCSI information provided in the --attach argument. Oracle Secure Backup also creates a device object using this device file.

On Linux and Solaris media servers, the operating system provides the device files and you can use these device files to configure the device. Therefore, you can specify the device file by using the --attach argument and the --createdevfile argument is not required.

For HP-UX and Windows media servers, if you provide the device file as part of the --attach argument, this device file is used for the configuration. If the --attach argument provides SCSI information such as target, bus, and LUN information, Oracle Secure Backup uses this information to create a device file on the media server.

For devices attached to AIX media servers, the --createdevfile argument creates a text file containing the SCSI bus, target, and LUN information or bus, wwn, and LUN information on the media server. If you provide the name of this text file using the --attach argument, Oracle Secure Backup uses this file for the device configuration. If the --attach argument provides only the SCSI information and not the text file name, then Oracle Secure Backup uses this information to create a device file on the media server.

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

Specifies whether a checksum must be computed and stored while writing backup image instances data to this tape drive. Storing the checksum enables you to validate backups at a later date. The enablechecksum setting overrides the value that is set by using enabletapechecksum device policy.

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 device policy enabletapechecksum 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 enabletapechecksum device policy is set to yes. In this case, checksums are computed and stored for all backup image instances written to this tape device.

devicename

Specifies the name of the tape drive to be configured. If an attachment is specified, then only one devicename is allowed. Refer to "devicename" for the rules governing device names.

Syntax 2

Use the following syntax to configure a tape library.

mkdev::=

mkdev --type/-t library [ --class/-x vtl ] [ --attach/-a aspec[,aspec]... ]
[ --inservice/-o | --notinservice/-O ] [ --wwn/-W wwn ]
[ --autoclean/-C { yes | no }  ] [ --cleanemptiest/-E { yes | no }  ]
[ --cleaninterval/-i { duration | off } ]
[ --barcodereader/-B { yes | no | default } ]
[ --barcodesrequired/-b { yes | no | default}  ]
[ --unloadrequired/-Q { yes | no }  ]
[ --serial/-N serial-number ] [ --model/-L model-name ]
[ --ejection/-j etype ] [ --minwritablevolumes/-V n ]  
[ --createdevfile/-k]
devicename...

Semantics 2

The following options enable you to configure a tape library. See "Semantics 1" for identical options not listed here.

--type/-t library

Specifies the device as a tape library.

--class/-x vtl

Specifies a virtual tape library.

--autoclean/-C {yes | no}

Specifies whether automatic tape cleaning should be enabled. A cleaning cycle is initiated either when a tape drive reports that it needs cleaning or when a specified usage time has elapsed.

Oracle Secure Backup checks for cleaning requirements when a cartridge is either loaded into or unloaded from a tape drive. If at that time a cleaning is required, then Oracle Secure Backup performs the following steps:

1. Loads a cleaning cartridge

2. Waits for the cleaning cycle to complete

3. Replaces the cleaning cartridge in its original storage element

4. Continues with the requested load or unload

Note that you can run the clean command to clean a tape drive manually.

--cleanemptiest/-E {yes | no}

Specifies which cleaning tape to use. This option is useful when a tape library contains multiple cleaning tapes.

The default value of yes specifies the emptiest cleaning tape, which causes cleaning tapes to round robin as cleanings are required.

The no value specifies that obtool should use the least used cleaning tape, which uses each cleaning tape until it is exhausted, then uses the next cleaning tape until it is exhausted, and so forth.

--cleaninterval/-i {duration | off}

Specifies whether there should be a cleaning interval, and if so, the duration of the interval. The default is off. The duration is the interval of time a tape drive is used before a cleaning cycle begins. Refer to "duration" for a description of the duration placeholder.

If automatic tape drive cleaning is enabled, then duration indicates the interval between cleaning cycles. For tape drives that do not report cleaning requirements, you can specify a cleaning interval, for example, 30days.

--barcodereader/-B {yes | no | default}

Specifies whether a barcode reader is present. Many devices report whether they have a barcode reader. For these devices you can specify default. For devices that do not report this information, specify yes or no.

--barcodesrequired/-b {yes | no | default}

Specifies whether Oracle Secure Backup requires tapes in the tape library to have readable barcodes.

The default is no. If you specify yes, and if a tape in the tape library does not have a readable barcode, then Oracle Secure Backup refuses to use the tape. Use default or dft to use the barcode value specified in the device policy settings.

Typically, Oracle Secure Backup does not discriminate between tapes with readable barcodes and those without. This policy ensures that Oracle Secure Backup can always solicit a tape needed for restore by using both the barcode and the volume ID.

--unloadrequired/-Q {yes | no}

Specifies whether an unload operation is required before moving a tape from a tape drive to a storage element. Typically, you should leave this option set to default of yes, which means the value comes from the external device table ob_drives. If you encounter difficulties, however, particularly timeouts waiting for offline while unloading a tape drive, then set the value to no.

--serial/-N serial-number

Specifies the serial number for the tape device.

If a serial number is entered, then Oracle Secure Backup stores that serial number in the device object. If no serial number is entered, then the serial number is read and stored in the device object the first time Oracle Secure Backup opens the tape device.

--model/-L model-name

Specifies the model name for the tape device. The model number is usually discovered during device configuration.

--ejection/-j etype

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

--minwritablevolumes/-V n

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

devicename

Specifies the name of the tape library to be configured. If an attachment is specified, then only one devicename is allowed. Refer to "devicename" for the rules governing device names.

Syntax 3

Use the following syntax to create and configure a disk pool.

mkdev::=

mkdev --type/-t disk 
[--attach/-a <aspec>[,<aspec>]...] [--force/-Y]
[--inservice/-o | --notinservice/-O] [--initialize/-z]
[--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>]...]
[ --enablechecksum/-K {yes | no | systemdefault}]
devicename...

Semantics 3

--type/-t disk

Specifies that the device is a disk pool.

--attach/-a aspec

Configures an attachment, which is the physical or logical connection of a storage device to a host. For a disk pool, the attachment specifies the host name and the file-system directory that stores the backups. The host must an Oracle Secure Backup host with media server role and must support the NDMP file service extension.

Every disk pool must have at least one attachment to be usable by Oracle Secure Backup. If the directory specified is currently configured as a disk pool in another administrative domain, you cannot configure this disk pool in your domain until you remove it from the previous domain. If the directory specified was previously configured as a disk pool and still contains backup image instances, Oracle Secure Backup displays a message indicating that you can recatalog the contents of the file-system directory so that the existing backups can be used as restore sources.

If multiple hosts can access the file-system directory that serves as the repository for a disk pool, then you can identify each host by using separate --attach options in the mkdev command.

If multiple attach points are specified and the directory specification differs among them, Oracle Secure Backup verifies that each attach point resolves to the same file-system directory. If this verification fails, the disk pool creation is terminated.

Refer to "aspec" for a description of the aspec placeholder.

--force/-Y

Forces the configuration of the disk pool by overriding the domain membership checks that determine if the disk pool being configured is part of another Oracle Secure Backup administrative domain.

--inservice/-o

Sets the status of the disk pool so that it is logically available to Oracle Secure Backup.

--notinservice/-O

Sets the status of the disk pool so that it is not logically available to Oracle Secure Backup.

--initialize/-z

Creates the file-system directory specified in pathname, if it does not exist. If this option is not specified, the directory specified must exist on the host. The directory can either be empty or have been configured previously as a disk pool.

--capacity/-y size-spec

Specifies the amount of space that the disk pool can occupy on the file-system directory. The size-spec placeholder specifies the size of the disk pool. Enter a numeric value followed by unit. The unit for disk pool 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 disk pool. In this case, the size of the disk pool is limited only by the capacity of the underlying file-system that hosts the disk pool.

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

When you use the chdev command to modify the consumption capacity of disk pools, if the value specified by size-spec is lower than the space currently occupied by the disk pool, then the command fails.

-concurrentjobs/-J concjobs

Specifies the maximum number of jobs that can run concurrently for this disk pool. This includes backup, restore, and pool 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 disk pool. By default, Oracle Secure Backup writes 64K blocks, which is a blocking factor of 128.

When you copy a backup image instance from a disk pool device to a tape device, the blocking factor used to create the backup image instance on the disk pool device will be the blocking factor used to write the instance to the tape device. It is a best practice to set the blocking factor of the disk pool device to be the same as the blocking factor of the tape device.

See Also:

cpinstance

--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 disk pool whose blocking factor is unknown.

--freespacegoal/-G freespacegoal

Specifies the percentage of disk pool capacity that the disk pool manager must maintain by proactively deleting expired backup image instances.

--staging/-h

Controls whether staging is enabled for the disk pool device. The default value is no.

If staging is disabled on a disk pool device, then backup images written to the stage disk pool are not be marked for staging. Use the stagescan command to mark all backup image instances to be staged.

When this option is used, the following conditions apply:

• the --type/-t disk option must be specified on the command

• the target media family and restriction list for the default stage rule must be set

.

--stagerule/-H

Sets the device stage rule list. If staging is enabled, then any backup image instance contained in the disk pool device that matches a rule is staged. The rules are tested for a match in the order that they appear in the list. If any rule matches a backup image instance, then all subsequent rules in the list are ignored.

The same stage rule may be used in more than one disk pool.

There should always be at least one scheduled stage rule in the list of rules to ensure that the instances that do not match any rule are automatically staged by the default stage rule. See Oracle Secure Backup Administrator’s Guide for a description of the default stage rule.

If a stage device is listed in the restriction list for a stage rule, then that rule cannot be added to that stage device. The operation fails and an error message is returned.

When this option is used, the --type/-t disk option must also be specified on the command.

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

Specifies whether a checksum must be computed and stored while writing backup image instances to this disk pool. Storing a checksum enables you to validate backups at a later date. For this disk pool, the value specified for enablechecksum overrides the device-level setting that is configured using the enablediskchecksum device policy.

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. This is the default setting.

  For example, you set enablechecksum to systemdefault while configuring a disk pool. The device policy enablediskchecksum is set to no. In this case, checksums are not computed or stored for all backup image instances written to this disk pool.

devicename

Specifies the name of the disk pool.

Syntax 4

Use the following syntax for configuring a tape drive in an ACSLS tape library:

mkdev::=

mkdev --type/-t tape [ --attach/-a aspec[,aspec]... ]
[ --inservice/-o | --notinservice/-O ] [ --wwn/-W wwn ]
[ --library/-l devicename --lsm/s lsm_id --panel/p panel_id
--drive/r drive_id] [ --blockingfactor/-f bf ]
[ --maxblockingfactor/-F maxbf ] [ --erate/-e erate ]
[ --enablechecksum/-K {yes | no | systemdefault}]
[--positioninterval/-q <positioninterval>]
devicename...

Semantics 4

Use the following semantics for configuring a tape drive in an ACSLS tape library. See "Semantics 1" for identical options not listed here.

You can use mkdev for an ACSLS tape drive only when obacslibd is stopped.

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

Syntax 5

Use the following syntax is for configuring an ACSLS tape library.

mkdev::=

mkdev --type/-t library --class/-x acsls --acsid/-g acs_id
[--attach/-a aspec...]
[ --inservice/-o | --notinservice/-O ]
[ --userid/-n acs_userid ] [ --port/-P port_num ]
[ --ejection/-j etype ] [ --minwritablevolumes/-V minvols ]
library_devicename...

Semantics 5

Use the following semantics is for configuring an ACSLS tape library. See "Semantics 1" for identical options not listed here.

--class/-x acsls

This option specifies that this tape library is an ACS tape library.

--attach/-a aspec...

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

--acsid/-g acs_id

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

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

--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. This command does not create or modify the CAP, which is a physical item on the ACS.

mkdev::=

mkdev --type/-t cap [ --library/-l devicename ] [ --capid/-c cap_id ] 
[ --lsm/-s lsm_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.

--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 configure a cloud storage device.

mkdev::=

mkdev --type/-t cloudstorage 
{--mediasserver media server, media server,...}
[--storageclass cloud-storage-class] 
[--inservice/-o | --notinservice/-O]
[--capacity/-y size-spec] 
{--username cloud-user} 
{--querypassphrase}
{--container container-name} 
[--segmentsize segment-size]
[--streamspersjob streams-per-job] 
[--concurrentjobs/-J concjobs]
[--blockingfactor/-f bf] 
[--maxblockingfactor/-F maxbf]
[--freespacegoal/-G freespacegoal] 
{--url cloud-url} 
{--identitydomain identity-domain}
[--authobj auth-object] 
[--servicetype cloud-type]
[--compartment compartment-ocid]
[--enablechecksum/-K {yes | no | systemdefault}]
[--force]
devicename... 

Semantics 7

Use the following semantics to configure a cloud storage device.

See Also:

• Oracle Cloud Documentation for further information about cloud-related concepts in the following semantics.

--type/-t cloudstorage

Specifies that the device is a cloud storage device.

--mediasserver media server

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 Oracle Cloud. Running too many jobs on the same media server may affect performance.

The media server must have a cloud wallet. The wallet is created during the Oracle Secure Backup installation and needs to be imported into the media servers.

--storageclass cloud-storage-class

Oracle Cloud storage class options, select any of the following:

• object — specifies Oracle Cloud Infrastructure Object Storage Classic or Oracle Cloud Infrastructure Object Storage, which provides object storage for files and unstructured data.

• infrequentaccess — specifies Oracle Cloud Infrastructure Infrequent Access Storage, which provides storage for data that you access less frequently, but is made available immediately when needed. You can set infrequentaccess for an object to backup on-premises data or to store data that you have replicated or copied from another region. The minimum retention period for this storage is 31 days.

  See Understanding Storage Tiers - Infrequent Access

• archive — specifies Oracle Cloud Infrastructure Archive Storage Classic or Oracle Cloud Infrastructure Archive Storage, which provides storage for applications and workloads that require long-term retention.

Restoring data from Object Storage Classic is faster than restoring data from Archive Storage Classic because in Object Storage Classic, the data is available immediately. Whereas, data in Archive Storage Classic is made available in 3-5 hours. The Oracle Secure Backup restore job is in a running state until the data is made available.

See About Oracle Cloud Infrastructure Object Storage Classic, Understanding Storage Tiers - Infrequent Access

--inservice/-o | --notinservice/-O

--inservice sets the status of the cloud storage device so that it is logically available to Oracle Secure Backup.

--notinservice 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 Oracle 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 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 other than the limit set by the quota purchased for the Oracle Cloud account identity domain.

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

Name of the Oracle Cloud user account. This user account belongs to the defined identity domain. The user account must have the Storage_Administrator and Storage_ReadWriteGroup roles.

--querypassphrase

When the user's pass phase changes on Oracle Cloud, the querypassphrase is used to update the user's pass phase in the cloud storage device.

--container container-name

A container is a storage compartment that provides a way to organize the data stored in Oracle Storage Infrastructure. With this option, Oracle Secure Backup creates a new container with the specified name. If a container of that name already exists, then you must also specify the --force option. Oracle Secure Backup never uses an existing container that was not created by Oracle Secure Backup.

--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 the container. The segment size defines the size of object. This option allows you to specify a suitable segment size. The segment size is important because it defines the amount of data that is buffered on the media server. If the segment size is too large, then the ndmp process consumes too much memory on the media server and it may affect backup performance or cause other job failures.

--streamspersjob streams-per-job

Oracle Secure Backup can make multiple connections to Oracle Storage Infrastructure for faster uploads of data. This option lets you specify a value that defines the number of threads created for parallel uploads of backup data. It also defines the number of buffers allocated for buffering the backup data. If this value is too large, then the ndmp process may use a great amount of memory and CPU on the media server, which may affect performance and lead to job failure.

--concurrentjobs concjobs

Specifies the maximum number of jobs that can run concurrently for this device. This includes backup, restore, and cloud storage device management-related jobs. If too many concurrent jobs are run on the same media, performance may be affected. Try to evenly distribute the backup job on different media servers.

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. Increasing this value may provide an increase in performance.

--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 device capacity that the device manager must maintain by proactively deleting expired backup image instances.

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

--identitydomain identity-domain

The identity domain is a construct for managing certain features of Oracle Storage Infrastructure. Many features of Oracle Cloud are managed within and between domains.

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

--servicetype cloud-type

Specifies the type of Cloud service. Use oci for Oracle Cloud Infrastructure or oci-classic for Oracle Cloud Infrastructure Classic.

--compartment compartment-ocid

Specifies the OCID of the compartment, in Oracle Cloud Infrastructure Object Storage. The bucket that stores the backups is created in this compartment. This parameter cannot be modified once it is set using the mkdev command.

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

Specifies whether a checksum must be computed and stored while writing backup image instances to this Cloud storage device. Storing a checksum enables you to validate backups at a later date. For this Cloud storage device, the enablechecksum setting overrides the value set by the enablecloudchecksum device policy.

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 enablecloudchecksum device policy determines whether checksums must be computed and stored along with the backup data.

  For example, you configure a cloud storage device with enablechecksum set to systemdefault. The enablediskchecksum device policy is set to yes. In this case, a checksum is computed and stored for all backup image instances written to this Cloud storage device.

--force

Forces association of the device with an existing Oracle Secure Backup created container.

devicename

Specifies the name of the cloud storage device

Examples

Example 3-4 Configuring a Tape Drive

This example configures a tape drive.

ob> lsdev
library    lib1             in service
  drive 1  tape1            in service
library    lib2             in service
  drive 1  tape2            in service

ob> mkdev --type tape --inservice --library lib1 --erate 8 --dte 2
--blockingfactor 128 --uselist 1 --usage 4minute --automount yes hptape

ob> lsdev
library    lib1             in service
  drive 1  tape1            in service
  drive 2  hptape           in service
library    lib2             in service
  drive 1  tape2            in service

Example 3-5 Configuring a Tape Library

This example configures a tape library.

ob> mkdev --type library --inservice --barcodereader yes --barcodesrequired yes
--autoclean no --cleanemptiest no hplib1

Example 3-6 Configuring a Disk Pool

This example configures a disk pool dp1 with a capacity of 80GB. The file-system directory that stores backups associated with this disk pool is /scratch/osb_test/virtual_devices/dp1 on the host brhost3. The number of concurrent jobs that can run on this disk pool is 15. When the space utilized exceeds 90 percent of the disk pool capacity, no new backup or restore jobs are scheduled for this disk pool.

ob> mkdev --type disk --inservice --attach brhost3:/scratch/osb_test/virtual_devices/dp1 --capacity 80GB --freespacegoal 90 --concurrentjobs 15 dp1

Example 3-7 Configuring a Tape Library with Device File on Linux

This example specifies a device file while configuring the tape library lib1 on Linux.

ob> mkdev -t library -a -J s06:/dev/obl3+stcontroller=1+sttarget=0+stlun=1 lib1
ob> lsdev 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)
UUID:                     7fef35b4-18b1-102d-8c5b-00096b1b77b0
Attachment 1:
Host:                         s08
Raw device:              /dev/obl3

Example 3-8 Configuring a Cloud Storage Device for Oracle Cloud Infrastructure

This example configures a cloud storage device that corresponds to Oracle Cloud Infrastructure Object Storage. The authentication object myauth was created using the mkauth command.

ob> mkdev -t cloudstorage --servicetype oci --mediaserver brhost3 --auth myauth \
--compartment ocid.compartment.oc1..xyzpqrxxzxxxxacbxxxsdaf --container mycontname --storageclass object ocidev

Ob> lsdev -l ocidev

Ocidev:
    Device type: cloud storage
    Enable checksum: (system default)
    In service: yes
    Debug mode: no
    Capacity: (not set)
    Consumption: 0
    Free space goal: (system default)
    Concurrent jobs: 1
    Blocking factor: (default)
    Max blocking factor: (default)
    UUID: 1d8f5878-h81b-1539-3d1e-fg366f0edr4f
    Attachment 1:
        Host: brhost3
    Staging: no
    Container: mycontname
    Storage class: object
    Identity domain: myiddomain
    Segment size: (system default)
    Streams per job: (system default)
    Service type: oci
    Auth object: myauth

Example 3-9 Configuring a Cloud Storage Device for Oracle Cloud Infrastructure Classic

This example configures a cloud storage device that corresponds to Oracle Cloud Infrastructure Object Storage Classic. The authentication object myauth_classic was created using the mkauth command.

Ob> mkdev -t cloudstorage --servicetype oci-classic --mediaserver brhost3 --auth myauthclassic \
       --container myclassiccont --storageclass object classicdev

Ob> lsdev -l classicdev
classicdev:
    Device type: cloud storage
    Enable checksum: (system default)
    In service: yes
    Debug mode: no
    Capacity: (not set)
    Consumption: 0
    Free space goal: (system default)
    Concurrent jobs: 1
    Blocking factor: (default)
    Max blocking factor: (default)
    UUID: 1e1f2030-e38g-1037-3h1f-fa138f0edh2k
    Attachment 1:
        Host: brhost3
    Staging: no
    URL: exampledomain.storage.oraclecloud.com
    Container: myclassiccont
    Storage class: object
    Identity domain: exampledomain
    Segment size: (system default)
    Streams per job: (system default)
    Service type: oci-classic
    Auth object: myauthclassic

Example 3-10 Configuring a Disk Pool with Checksum Computation Enabled

This example configures a disk pool dp_chk with a capacity of 50GB. Because checksum computation is enabled, Oracle Secure Backup computes a checksum for all backups stored on this disk pool. This checksum can be used subsequently to validate backup images instances.

ob> mkdev --type disk --attach brhost3:/scratch/osb/disk/dp_chk 
--capacity 50GB --freespacegoal 90 --concurrentjobs 10 --enablechecksum yes dp_chk

ob> lsdev -l dp_chk
dp_chk:
    Device type:            disk pool
    Enable checksum:        yes
    In service:             yes
    Debug mode:             no
    Capacity:               (not set)
    Consumption:            15.0 MB
    Free space goal:        (system default)
    Concurrent jobs:        1
    Blocking factor:        (default)
    Max blocking factor:    (default)
    UUID:                   ee2d4402-0bb0-1037-8590-fa163e381872
    Attachment 1:
        Host:               brhost3
        Directory:          /scratch/disk_pool/dp_chk
    Staging:                no

mkds

Purpose

Use the mkds command to make a dataset file or dataset directory.

See Also:

"Dataset Commands" for related commands

Prerequisites

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

Syntax

mkds::=

mkds [ --nq ] [ --dir/-d ] [ --nocheck/-C ] [ --noedit/-E ] [ --input/-i ] 
dataset-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.

--dir/-d

Creates a dataset directory called dataset-name.

A dataset directory is a directory that contains dataset files. Dataset directories can have a hierarchy of nested subdirectories that is up to 10 levels deep.

--nocheck/-C

Disables syntactic checking of a dataset file for errors.

--noedit/-E

Prevents a default editor window (as defined by your EDITOR environment variable) from opening when creating a dataset file.

--input/-i

Lets you to input the contents of a dataset file.

dataset-name

Specifies the name of the dataset directory or dataset file. The mkds command creates the dataset file or directory relative to the directory indicated by the pwdds command. Refer to "dataset-name" for a description of the dataset-name placeholder.

Usage Notes

• When you create a dataset file, be aware that the Oracle Secure Backup dataset statement, exclude, does not support exclusion of the NDMP backup type zfs.

  However, Oracle Secure Backup does support the ability to send NDMP environmental variables to the Oracle ZFS Storage Appliance (ZFSSA) filer. The dataset statement setenv NDMP can be used to send exclude directives to the filer.

  The exclude statement is only supported for ZFS dump type backups. It is not supported for ZFS type backups because the exclude statement is file-based and ZFS is block-based.

  In a ZFSSA dump type backup, if you want to exclude a directory or file name (for example, file-or-dirname) then you must include the following statement before or after the include path line in the dataset description file:

  setenv NDMP:EXCLUDE file-or-dirname

  The following example shows the statement after the include path statement:

  include host storabcknfs8 
  	include path /export/nfs7-restore-test 
  	setenv NDMP:EXCLUDE file-or-dirname

  The EXCLUDE variable can contain one or more matching patterns, separated by commas, for files that should be excluded from the backup. The exclusion is recursive. The following rules are supported:

  Character	Description
  c	Any non-special character matches itself
  ?	Match any character
  ab	Character a followed by character b
  S	Any string of non-special characters
  AB	String A followed by string B
  *	Any string, including the empty string

Examples

Example 3-11 Creating a Dataset

This example creates a dataset directory called mydatasets1 and then creates a dataset file called test.ds in this directory.

ob> pwdds
/ (top level dataset directory)
ob> mkds --dir mydatasets1
ob> mkds --nq --input mydatasets1/test.ds
Input the new dataset contents.  Terminate with an EOF or a line
containing just a dot (".").
include host brhost2
include path /home
.
ob> lsds --recursive
Top level dataset directory:
mydatasets1/
mydatasets1/test.ds

Example 3-12 Creating a Dataset Subdirectory

This example creates a not_used subdirectory in the mydatasets1 directory.

ob> pwdds
/mydatasets1
ob> mkds --dir not_used
ob> cdds ..
ob> pwdds
/ (top level dataset directory)
ob> lsds --recursive
Top level dataset directory:
mydatasets1/
mydatasets1/not_used/
mydatasets1/test.ds

Example 3-13 Creating a Dataset for a Windows Host

This example creates a dataset file named c-winhost1.ds. This file specifies the backup of drive C:\ on a Windows host named winhost1.

ob> pwdds
/ (top level dataset directory)
ob> mkds --nq --input c-winhost1.ds
Input the new dataset contents.  Terminate with an EOF or a line
containing just a dot (".").
include host winhost1
include path "C:\" {
exclude name *.log
}
.
ob> lsds
NEWCLIENTS
c-winhost1.ds

Notes:

• Remote file systems that are mapped to drive letters on PCs cannot be backed up by Oracle Secure Backup.

• Because mapped drives are user-specific on Windows XP systems and Oracle Secure Backup runs as a service with its own security context, it cannot access drives mapped by any other users on the system. To work around this problem, back up the system that contains the mapped files directly, rather than trying to back them up from a system that maps them.

mkdup

Purpose

Create a volume duplication policy.

See Also:

"Volume Duplication Commands"

Prerequisites

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

Syntax

mkdup::=

mkdup
[ --comment/-c commentstring] [ --inputcomment/-i ]
[ --trigger/-e dupevent:duration ]
[ --restrict/-r restriction[,restriction]...] ]
[ --migrate/-m { yes | no } ]
{ --rule/-u duplicationrule[,duplicationrule...] } 
policyname...

Semantics

--comment/-c commentstring

A descriptive comment, displayed when using lsdup.

--inputcomment/-i

Prompt the backup administrator to enter a descriptive comment. After you run mkdup --inputcomment, obtool prompts you to enter the comment. End the comment with a period (.) on a line by itself.

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

Restricts duplication to specific devices within the administrative domain. You can select media server hosts or specific devices on these hosts. You must have the duplicateovernetwork policy set to yes to duplicate a volume to a different media server than the one containing the original volume being duplicated. Oracle Secure Backup does not duplicate between devices attached to different media servers by default, because it requires heavy use of network bandwidth.

If you have set duplicateovernetwork to yes and do not specify a restriction (default), then this volume duplication policy has no device restrictions, and can use any available device on any media server at the discretion of the Oracle Secure Backup scheduling system.

See Also:

• "dupevent" for a description of the dupevent placeholder

• "duration" for a description of the duration placeholder

• "restriction" for a description of the restriction placeholder

• "duplicateovernetwork" for more information on the duplicateovernetwork policy

--migrate/-m {yes|no}

Specifies volume to be migrated. If this option is set to yes, then only one rule can be specified for this volume duplication policy. If you do not specify the --migrate option, then the volume is not migrated.

--rule/-u duplicationrule

Specifies a duplication rule, in the form media-family:number.

Example

Example 3-14 Creating a Volume Duplication Policy

This example creates a volume duplication policy with the trigger for the duplication event as the firstwrite and it's duration as forever. This volume will not be migrated. It is restricted to the host brhost3 and 2 duplicates will be created to the RMAN-DEFAULT media family.

ob> mkdup --trigger firstwrite:forever --migrate no --restrict @brhost3 --rule RMAN-DEFAULT:2 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

mkhost

Purpose

Use the mkhost command to add a host to an administrative domain. The host must run Oracle Secure Backup locally or be accessible to Oracle Secure Backup with Network Data Management Protocol (NDMP).

See Also:

"Host Commands" for related commands

Prerequisites

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

Usage Notes

If your Windows host is protected by a firewall, then the firewall must be configured to permit Oracle Secure Backup daemons on the host to communicate with the other hosts in your administrative domain. Windows XP Service Pack 2 and Windows Server 2003 contain a built-in Windows firewall which, in the default configuration, blocks inbound traffic on ports used by Oracle Secure Backup. Refer to Oracle Secure Backup Installation and Configuration Guide for more information.

Syntax 1

Use the following syntax to add a host that runs Oracle Secure Backup locally to an administrative domain.

mkhost::=

mkhost
[ --access/-a ob ] 
[ --inservice/-o | --notinservice/-O ]
[ --encryption/-e { required | allowed } ] 
[ --disablerds/-d { yes | no | systemdefault }]
[ --algorithm/-l { AES128 | AES192 | AES256 } ] 
[ --keytype/-t { passphrase | transparent } ] 
[ --rekeyfrequency/-g duration ] 
[ --passphrase/-s string ]
[ --querypassphrase/-Q ]
[ --tcpbufsize/-c bufsize  ] 
[ --ndmpauth/-A authtype ]
[ --roles/-r role[,role]... ] 
[ --ip/-i ipname[,ipname]... ]
[ --nocomm/-N ] 
[ --certkeysize/-k cert-key-size ]
[ --compression/-K {off | low | medium | basic | high} ]
hostname...

Semantics 1

Use these options if the host has Oracle Secure Backup installed and uses the Oracle Secure Backup internal communications protocol to communicate.

--access/-a ob

Specifies that the host accesses a local installation of Oracle Secure Backup. By default obtool determines dynamically whether the computer is accessed through the Oracle Secure Backup RPC protocol (plus NDMP) or solely through NDMP.

--encryption/-e {required | allowed}

Specifies whether encryption is required or allowed. If set to required, then all backups from this host are encrypted. If set to allowed, then encryption is determined by the global encryption policy and encryption settings specific to the backup job. Default is required.

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

--algorithm/-l {AES128 | AES192 | AES256}

Specifies encryption algorithm used. Default is AES192.

--keytype/-t [passphrase | transparent]

Specifies how the encryption keys are generated. Values are:

• passphrase

  The backup administrator supplies a passphrase, which is then used to generate encryption keys. The keys generated using a passphrase are not stored in the Oracle wallet. If the passphrase is lost, then these backups cannot be restored.

• transparent

  The encryption keys are generated automatically and stored in the Oracle wallet.

Default is transparent.

--rekeyfrequency/-g {disabled | N duration | systemdefault | perbackup}

Specifies how often a key is generated. Values are:

• disabled

  Never generate a key

• Nduration

  Generate keys at the time interval specified. If N is0, then Oracle Secure Backup never generates a key. The minimum duration is one day.

• systemdefault

  Generate keys according to the global rekeyfrequency policy.

• perbackup

  Generate keys for each backup.

The default is 30days.

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

--querypassphrase/-Q

Queries for the passphrase used in generation of the encryption 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.

--inservice/-o

Specifies that the host is logically available to Oracle Secure Backup.

--notinservice/-O

Specifies that the host is not logically available to Oracle Secure Backup.

--roles/-r role[,role]...

Assigns one or more roles to the host. Refer to "role" for a description of the role placeholder.

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

Indicates the IP address of the host computer. IP addresses are represented as a series of four numbers separated by periods.You can also use host names for IP addresses. In this case, the host name is resolved by the underlying operating system to an IP address.

If you specify ipname, then Oracle Secure Backup never uses the user-assigned host name to obtain the host IP address; instead, it considers each specified ipname until it finds one that resolves to a working IP address. If you specified a PNI (Preferred Network Interface) for this host with the mkpni command, then Oracle Secure Backup considers the PNI address first.

Note:

The use of DHCP to assign IP addresses is not supported for hosts that participate in an Oracle Secure Backup administrative domain. You must assign static IP addresses to all hosts. If you cannot use static IP addresses, then ensure that the DHCP server guarantees that a given host is always assigned the same IP address.

If you do not specify ipname, then Oracle Secure Backup tries to resolve the specified hostname to obtain the IP address.

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. You can use this option to add a host to the domain when the host is not yet connected to the network.

--certkeysize/-k cert-key-size

Sets the size (in bits) of the public key/private key pair used for the identity certificate of this host. By default Oracle Secure Backup uses the value in the certkeysize security policy. If you specify --certkeysize, then the specified value overrides the key size in the security policy. The key size set with --certkeysize applies only to this host and does not affect the key size of any other current or future hosts.

Because larger key sizes require more computation time to generate the key pair than smaller key sizes, the key size setting can affect the processing time of the mkhost command. While the mkhost command is running, obtool might display a status message every 5 seconds (see Example 3-16). obtool displays a command prompt when the process has completed.

--compression/-K {off | low | medium | basic | high}

Specifies the compression option to use for all file system backups in this Oracle Secure Backup client where it is not set at the job level.

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.

The default value is that no compression option is set.

The compression option is available only to hosts running Oracle Secure Backup locally (--access ob).

Syntax 2

Use the following syntax to add a host that Oracle Secure Backup accesses with NDMP, such as a filer, to an administrative domain.

mkhost::=

mkhost --access/-a ndmp [ --inservice/-o | --notinservice/-O ]
[ --encryption/-e { required | allowed } ] 
[ --algorithm/-l { AES128 | AES192 | AES256 } ] 
[ --keytype/-t { passphrase | transparent } ] 
[ --rekeyfrequency/-g duration ] 
[ --passphrase/-s string ]
[ --querypassphrase/-Q ]
[ --role/-r role[,role]... ] [ --ip/-i ipname[,ipname]... ]
[ --ndmpauth/-A authtype ]
[ { --ndmppass/-p ndmp-password } | --queryndmppass/-q | --dftndmppass/-D ]
[ --ndmpport/-n portnumber ] [ --ndmppver/-v protover ]
[ --ndmpuser/-u ndmp-username ] [ --nocomm/-N ]
[ --ndmpbackuptype/-B ndmp-backup-type ]
[ --backupev/-w evariable-name=variable-value ]...
[ --restoreev/-y evariable-name=variable-value ]...
hostname...

Note:

For NDMP hosts, the following mkhost command options are only available starting with Oracle Secure Backup 10.3.0.2.0:

• encryption

• algorithm

• keytype

• rekeyfrequency

• passphrase

• querypassphrase

Semantics 2

Use these options if the host does not have Oracle Secure Backup installed (for example, a filer or Network Attached Storage (NAS) device) and uses NDMP to communicate.

--access/-a ndmp

Specifies that the host uses Network Data Management Protocol (NDMP) to communicate. An NDMP host is a storage appliance from third-party vendors such as NetApp, Mirapoint, or DynaStore. An NDMP host implements the NDMP protocol and employs NDMP daemons (rather than Oracle Secure Backup daemons) to back up and restore file systems.

--algorithm/-l {AES128 | AES192 | AES256}

Specifies encryption algorithm used. Default is AES192.

--encryption/-e {required | allowed}

Specifies encryption algorithm used. Default is AES192.

--rekeyfrequency/-g {disabled | N duration | systemdefault | perbackup}

Specifies how often a key is generated. Values are:

• disabled

  Never generate a key

• N duration

  Generate keys at the time interval specified. If N is0, then never generate a key. The minimum duration is one day.

• systemdefault

  Generate keys according to the global rekeyfrequency policy.

• perbackup

  Generate keys for each backup.

Default is 30days.

--keytype/-t {passphrase | transparent}

Specifies how the encryption keys are generated. Values are:

• passphrase

  The backup administrator supplies a passphrase, which is then used to generate encryption keys.

• transparent

  The encryption keys are generated automatically and stored in the Oracle Wallet.

--inservice/-o

Specifies that the host is logically available to Oracle Secure Backup.

--notinservice/-O

Specifies that the host is not logically available to Oracle Secure Backup.

--role/-r role[,role]...

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

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

Indicates the IP address of the host computer. The use of DHCP to assign IP addresses is not supported for hosts that participate in an Oracle Secure Backup administrative domain. You must assign static IP addresses to all hosts. If you cannot use static IP addresses, then ensure that the DHCP server guarantees that a given host is always assigned the same IP address.

Note:

You can use host names for IP addresses. In this case, the host name is resolved by the underlying operating system to an IP address.

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

--ndmpauth/-A authtype

Provides an authorization type. Refer to "authtype" for a description of the authtype placeholder.

The authorization type is the mode in which Oracle Secure Backup authenticates itself to the NDMP server. Typically, you should use the negotiated default setting. You can change the setting if necessary; for example, if you have a malfunctioning NDMP server.

--ndmppass/-p ndmp-password

The obtool mkhost or obtool chhost commands specify the ZFSSA NDMP username and password when configuring a ZFSSA client and/or mediaserver. The ZFSSA DMA username and password must be specified for this authentication. The DMA password is set in the ZFSSA UI under Services > NDMP. Refer to the ZFSSA documentation for further information on configuring the DMA user. If the Oracle Secure Backup mkhost or chhost options for either --ndmppass or --queryndmppass are not specified, then Oracle Secure Backup reverts to the default NDMP password defined in the OSB ndmp/password policy. To change this password, use the chhost command.

--queryndmppass/-q

Prompts you for the NDMP password.

--dftndmppass/-D

Uses the default NDMP password defined in the ndmp/password policy.

--ndmpport/-n portnumber

Specifies a TCP port number for use with NDMP. Typically, the port 10000 is used. You can specify another port if this server uses a port other than the default.

--ndmppver/-v protover

Specifies a protocol version. Refer to "protover" for a description of the protover placeholder. The default is null (""), which means "as proposed by server."

--ndmpuser/-u ndmp-username

Specifies a user name. The user name is used to authenticate Oracle Secure Backup to this NDMP server. If left blank, then the user name value in the ndmp/username policy is used.

--nocomm/-N

Suppresses communication with the host computer. You can use this option to add a host to the domain when the host is not yet connected to the network.

--ndmpbackuptype/-B ndmp-backup-type

Specifies a default NDMP backup format. The default is defined by the NDMP data service running on the client. Refer to "ndmp-backup-type" for a description of the ndmp-backup-type placeholder.

--backupev/-w evariable-name=variable-value

Declares NDMP backup environment variables that are passed to the host's NDMP Data Service for a backup.

--restoreev/-y evariable-name=variable-value

Declares NDMP restore environment variables that are passed to the host's NDMP Data Service for a restore.

hostname

Specifies name of the host to be added to the administrative domain. Note that you cannot specify multiple hosts if you specify an IP address with the --ip option.

Host names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.

Examples

Example 3-15 Adding a Host Running Oracle Secure Backup Locally

This example adds host sfserver1, which runs Oracle Secure Backup locally, to the administrative domain.

ob> lshost
brhost2          client                            (via OB)   in service
brhost3          mediaserver,client                (via OB)   in service
osbsvr1          admin,mediaserver,client          (via OB)   in service
ob> mkhost --access ob --inservice --roles mediaserver,client --nocomm sfserver1
ob> lshost
brhost2          client                            (via OB)   in service
brhost3          mediaserver,client                (via OB)   in service
sfserver1        mediaserver,client                (via OB)   in service
osbsvr1          admin,mediaserver,client          (via OB)   in service
 

Example 3-16 Adding a Host with a Large Key Size

This example adds a host with a certificate key size of 4096. The sample output shows the periodic status message.

ob> mkhost --inservice --role client --certkeysize 4096 osbsvr2
Info: waiting for host to update certification status...
Info: waiting for host to update certification status...
Info: waiting for host to update certification status...
Info: waiting for host to update certification status...
ob> lshost osbsvr2
osbsvr2          client                            (via OB)   in service

Example 3-17 Adding an NDMP Host

This example adds a host that Oracle Secure Backup accesses with NDMP. Due to space constraints the sample command has been reformatted to fit on the page.

ob> mkhost --nocomm --access ndmp --ip 192.0.2.151 --inservice --roles client
--ndmpauth none --ndmpuser jim --ndmppass ndmpdmapassword --ndmppver "" ndmphost1
ob> lshost
brhost2          client                            (via OB)   in service
brhost3          mediaserver,client                (via OB)   in service
sfserver1        mediaserver,client                (via OB)   in service
ndmphost1        client                            (via NDMP) in service
osbsvr1          admin,mediaserver,client          (via OB)   in service

Example 3-18 Changing the NDMP Host Password

This example displays how to change the password for the NDMP host that you configured above.

ob> chhost --ndmppass <new filer DMA user password> ndmphost1

mkloc

Purpose

Create a location object.

Note:

The mkloc command can only be used to create a storage location. Oracle Secure Backup automatically creates an active location corresponding to each tape library and tape drive in the administrative domain.

See Also:

"Location Commands" for related commands

Prerequisites

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

Syntax

mkloc::=

mkloc
  [ --inputcomment/-i | --comment/-c comment ]
  [ --mailto/-m email-target[,email-target]... ]
  [ --customerid/-I customerid ] 
  [ --notification/-n ntype ]
  [ --recalltime/-R duration ] 
  locationname...

Semantics

--inputcomment/-i

Allows input of an optional comment for the location. After you run mkloc --inputcomment, obtool prompts you to enter the comment. End the comment with a period (.) on a line by itself.

--comment/-c commentstring

Specifies a descriptive comment for the location.

--customerid/-I idstring

A customer ID string. Note: Only valid for storage locations.

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

The e-mail addresses specified here receive the pick or distribution reports for media movement involving volumes at the specified location. An e-mail system must be operational on the administrative server for this feature to operate. Separate multiple entries with a comma.

--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 3-19 Creating a Location Object

This example creates the location object testloc. The email target for this location is [e-mail] and it's recall time is 1 year. No notifications will be provided for any media movement in this storage location.

ob> mkloc --mailto [e-mail] --recalltime 1y --notification none testloc
ob> lsloc --long
Media_Recycle_Bin:
    Comment:                OSB-generated location
    Recalltime:             disabled
    UUID:                   632c3c50-0e77-1031-8e47-00163e527899
testloc:
    Recalltime:             1 year
    Mail to:                [e-mail]
    UUID:                   3331c846-18c0-1031-b040-00163e527899
vlib1:
    Associated device:      vlib1 (library)
    Comment:                OSB-generated location for library vlib1
    Recalltime:             disabled
    UUID:                   712a478e-0e77-1031-b040-00163e527899

mkmf

Purpose

Use the mkmf command to create a media family, which is a named classification of backup volumes. A media family ensures that volumes created at different times have similar characteristics. For example, you can create a media family for backups with a six-month retention period. If you specify this family on successive backup commands, then all created volumes have a six-month retention period.

A media family has either of the following types of mutually exclusive expiration policies: content-managed (default) or time-managed. In a content-managed policy, volumes expire only when every backup piece recorded on a volume has been marked as deleted. In a time-managed policy, volumes expire when they reach the expiration time, which is calculated as the sum of the --writewindow time, the --retain time, and the volume creation time.

See Also:

"Media Family Commands" for related commands

Prerequisites

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

Syntax

mkmf::=

mkmf [ --writewindow/-w duration ] [ --retain/-r duration ]
[ [ --vidunique/-u ] | 
  [ --vidfile/-F vid-pathname ] |
  [ --viddefault/-d ] | 
  [ --vidfamily/-f media-family-name ] ]
[ [ --inputcomment/-i | 
  [ --comment/-c comment ] ]
[ --contentmanaged/-C ] [ --append/-a ] [ --noappend/-A ]
[ --rotationpolicy/-R policyname ] 
[ --duplicationpolicy/-D policyname ] 
[ --acsscratchid/-d acsscratch_id ]
media-family-name...

Semantics

--writewindow/-w duration

Specifies a write-allowed time period for the media family. Refer to "duration" for a description of the duration placeholder. The default is disabled, which means that Oracle Secure Backup does not consider the write window when computing the volume expiration time.

A write window is the period for which a volume set remains open for updates, usually by appending backup image instances. All volumes in the family are considered part of the same volume set. The write window opens when Oracle Secure Backup writes the first file to the first volume in the set and closes after the specified period elapses. When the write window closes, Oracle Secure Backup disallows further updates to the volume set until one of the following conditions is met:

• It expires.

• It is relabeled.

• It is reused.

• It is unlabeled.

• It is forcibly overwritten.

Oracle Secure Backup continues using the volume set for backup operations until the write window closes.

Note that if you select forever or disabled as a duration, then you cannot enter a number. For example, you can set the write window as 14days or specify forever to make the volume set eligible to be updated indefinitely. All volume sets that are members of the media family remain open for updates for the same time period.

This option has no effect for media families used for automated tape duplication.

--retain/-r duration

Specifies the retention period, which is amount of time to retain the volumes in the volume set. By specifying this option, you indicate that this media family is time-managed rather than content-managed. Refer to "duration" for a description of the duration placeholder.

The volume expiration time is the date and time on which a volume expires. Oracle Secure Backup computes this time by adding the write window duration (--writewindow), if it is specified, to the time at which it wrote backup image file number 1 to a volume, and then adding the volume retention time (--retain).

The retention period prevents you from overwriting any volume included as a member of this media family until the end of the specified time period. If one volume becomes full, and if Oracle Secure Backup continues the backup onto subsequent volumes, then it assigns each volume in the volume set the same retention time.

You can make Recovery Manager (RMAN) backups to time-managed volumes. Thus, volumes with a time-managed expiration policy can contain a mixture of file-system and RMAN backup pieces.

Note:

If you make RMAN backups to time-managed volumes, then it is possible for a volume to expire and be recycled while the RMAN repository reports the backup pieces as available. In this case, you must use the CROSSCHECK command in RMAN to resolve the discrepancy.

You can change a media family from time-managed to content-managed by specifying --contentmanaged on the chmf command.

Media families used for automated tape duplication must have the same expiration policy as the associated original volumes. If the original volume has a time-managed expiration policy, then the duplicate volumes must be time-managed as well.

--vidunique/-u

Creates a volume ID unique to this media family. The volume ID begins with the string media-family-name-000001 and increments the volume sequence number each time it is used. For example, MYVOLUME-000001 would be the volume ID for the first volume in the MYVOLUME media family, MYVOLUME-000002 would be the ID for the second volume, and so forth.

--vidfile/-F vid-pathname

Specifies the name of the volume sequence file for the media family that you are creating. Specify either a relative filename, in which case the file is created in the administrative directory on the administrative server, or an absolute filename.

Because Oracle Secure Backup does not create this file automatically, you must create it manually. If you select the --vidfile option, then use a text editor to customize the vid- prefix. Enter the first volume ID to be assigned to the media family as a single line of text, for example, MYVOLUME-000001.

Note:

You must create the volume ID file before specifying the --vidfile option.

--viddefault/-d

Specifies the system default, that is, Oracle Secure Backup uses the same volume ID sequencing that it would use if no media family were assigned. The default volume ID begins at VOL000001 and increments each time it is used.

--vidfamily/-f media-family-name

Uses the same volume ID sequencing as is used for the media family identified by media-family-name.

--inputcomment/-i

Allows input of an optional comment for the media family. After you run mkmf --inputcomment, obtool prompts you to enter the comment. End the comment with a period (.) on a line by itself.

--comment/-c comment

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

--contentmanaged/-C

Specifies that volumes in this media family are content-managed rather than time-managed. Volumes that use this expiration policy are intended for RMAN backups: you cannot write a file-system backup to a content-managed volume.

A content-managed volume is eligible to be overwritten when all backup image sections have been marked as deleted. You can delete backup pieces through RMAN or through the rmpiece command in obtool. A volume in a content-managed volume set can expire even though other volumes in the same set are not expired.

You can change a media family from content-managed to time-managed by specifying --retain on the chmf command.

Media families used for automated tape duplication must have the same expiration policy as the associated original volumes. If the original volume has a content-managed expiration policy, then the duplicate volumes must be content-managed as well.

--append/-a

Specifies that additional backup image instances can be appended to volumes in the media family (default). This option has no effect for media families used for automated tape duplication.

Although a volume might be unexpired and have tape remaining, Oracle Secure Backup does not write to a volume that is lower than the most recent volume sequence number for the media family. Every backup tries to append to the most recent volume in the media family. If this volume is full, then it writes to a different volume.

--noappend/-A

Specifies that additional backup image instances cannot be appended to volumes in the media family. This option ensures that a volume set contains only a single backup image instance, which is useful if you perform a full backup and then use the tapes to re-create the original file system.

--rotationpolicy/-R

Specifies the rotation policy for the media family.

This option has no effect for media families used for automated tape duplication.

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

--duplicationpolicy/-D

Specifies the duplication policy for the media family.

To clear the 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.

media-family-name

Specifies the name of the media family to create. Media family names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 24 characters.

Examples

Example 3-20 Creating a Time-Managed Media Family

This example creates a time-managed media family called time-man-family. Volumes in the volume set are available for update for 7 days. Because the retention period is 28 days, a volume in the media family expires 35 days after Oracle Secure Backup first writes to it.

ob> mkmf --vidunique --writewindow 7days --retain 28days time-man-family

Example 3-21 Creating a Content-Managed Media Family

This example creates a content-managed media family called content-man-family. Because the write window is forever, volumes in this family are eligible for update indefinitely. Volumes only expire when RMAN shows the status of all backup pieces on the volumes as DELETED.

ob> mkmf --vidunique --writewindow forever content-man-family

mkpni

Purpose

Use the mkpni command to define a PNI (Preferred Network Interface) for an existing host. A network can have multiple physical connections between a client and the server performing a backup or restore on behalf of that client. The mkpni command is used to configure an outbound interface for a host and a preferred inbound interface for incoming connections from a set of hosts.

A PNI for inbound connections enables you to specify which of the host’s network interfaces is used when a remote host connects to this host. The number of PNIs for an inbound connection depends on the number of interfaces available on the host. A PNI for outbound connections specifies the network and interface that must be used when the host connects to a remote host. The number of PNIs for outbound connections depends on the number of networks to which the host is connected.

See Also:

"Preferred Network Interface Commands" for related commands

Prerequisites

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

Syntax

mkpni::=

mkpni 
[ --interface/-i ipname
{ --client/-c client-hostname[,client-hostname]... }]
[{--network/-n network/prefix,ipaddr} …| {--useonly/-o ipaddr}]
hostname

Semantics

--interface/-i ipname

Specifies the IP address or the DNS host name that the specified clients should use when communicating with the host specified by hostname. Use this option to configure an interface for inbound connections to a particular host.

Oracle Secure Backup supports Internet Protocol v4 (IPv4), Internet Protocol v6 (IPv6), mixed IPv4/IPv6 environments on all platforms that support IPv6, and RDS/RDMA (Reliable Datagram Socket/Remote Direct Access Memory) if the client supports RDS/RDMA.

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

Specifies one or more clients that should use the ipname when communicating with hostname. The client-hostname specifies the host name or internet address of the client as seen from the server. The hostname must be a host name that you created with the mkhost command.

You cannot use this option with the --network or --useonly options in a single mkpni command.

--network/-n network/prefix, ipaddr

Specifies the network that must be used for all outbound connections from the host specified by hostname. Optionally, you can specify a bind address for the network. Oracle Secure Backup binds the specified address for outgoing connections. When no bind address is specified, the operating system determines the bind address.

network/prefix represents the network address with the prefix length. ipaddr represents the IP address to bind for outbound connection and this address must exist in the host object. Multiple outbound networks can be configured for a host. However, for each network, you can specify only one bind address. You can use this option to select RDS as the outbound connection.

If the host to which a connection must be created does not belong to any of the configured PNI networks, you can specify that any available network path can be used to establish a connection to that host. Use the following network addresses to configure any available network for outgoing connections:

• 0.0.0.0/0 for IPv4 connections

• 0::0/0 for IPV6 connections

• 0/0 for IPv4 or IPv6 connections

--useonly/-o ipaddr

Specifies that only the interface represented by ipaddr must be used for all outbound connections from the host hostname. ipaddr must be exist in the host object.

You can configure one interface for each address family (IPv4 and IPv6). You must not use this option for RDS connections.

hostname

Specifies the name of the host for which PNI is being configured.

Example

Example 3-22 Defining a PNI

This example defines a PNI that specifies that the client hosts osbsvr1 and brhost3 should use the IP address 192.0.2.1 when communicating with server brhost2.

ob> mkpni --interface 192.0.2.1 --client osbsvr1, brhost3 brhost2
ob> lspni
brhost2:
    PNI 1:
        interface:          192.0.2.1
        clients:            osbsvr1, brhost3

Example 3-23 Configuring a Single Interface for Outbound Connections

This example configures a PNI for all outbound connections from the host brhost2. Including the --useonly option indicates that the specified network must be used for all outbound connections.

ob> mkpni –-useonly 192.0.2.25 brhost2
ob> lspni
brhost2:
    UNI 1:
        useonly: 192.0.2.25

Example 3-24 Configuring a Network for Outbound Connections

This example configures a PNI for outbound connections from the host brhost3. The following two networks are configured as PNI: 192.51.100.0/24 and 203.0.113.0/24. When making outbound connections from brhost3, Oracle Secure Backup checks the ipnames in the remote host object. The first ipname in the remote host object that matches any specified outbound network, 192.51.100.0/24 or 203.0.113.0/24, is used. For example, if the remote host has ipname 203.0.113.4, and it appears before 192.51.100.33 in the list of ipnames in the host object, then 203.0.113.4 is used for the outbound connection.

ob> mkpni -–network 192.51.100.0/24,192.51.100.11 --network 203.0.113.0/24  brhost3
ob> lspni
brhost3:
    ONI 1:
        network: 192.51.100.0/24
        interface: 192.51.100.11
    ONI 2:
        network: 203.0.113.0/24

Example 3-25 Using Any Network to Establish and Outbound Connection

This example configures a PNI for outbound connections from the host brhost3.

When creating an outbound connection from brhost3, Oracle Secure Backup checks the ipnames in the remote host object. If the ipname on the remote host is part of the network 192.51.100.0.24, then this ipname is used and the outbound connection binds to the interface 192.51.100.11. If the ipname on the remote host is not part of the same subnet, then no binding is performed.

ob> mkpni --network 192.51.100.0/24,192.51.100.11 --network 0.0.0.0/24 brhost3
ob> lspni
brhost3:
    ONI 1:
        network: 192.51.100.0/24
        interface: 192.51.100.11
    ONI 2:
        network: 0.0.0.0/0

mkrot

Purpose

Create a rotation policy.

See Also:

"Rotation Policy Commands"

Prerequisites

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

Syntax

mkrot::=

mkrot [ --comment/-c commentstring | --inputcomment/-i commentstring ]
--rule/-u rotation-rule[,rotation-rule]... 
policyname. ..

Semantics

--comment/-c commentstring

A descriptive comment, displayed when using lsrot. You can specify either --comment or --inputcomment, but not both.

--inputcomment/-i

Allows input of an optional comment. After you run mkrot --inputcomment, obtool prompts you to enter the comment. End the comment with a period (.) on a line by itself. You can specify either --comment or --inputcomment, but not both.

--rule/-u rotation-rule

Specifies a set of rotation rules to be applied to the rotation policy.

The rotationrule argument is of the form locationname[:event[:duration]], where

• locationname is either the name of an existing location object or a wildcard (*).

  If an existing location object is specified as the first locationname in a rotation rule, then the rotation rule is constrained to that location. If a wildcard (*) is specified as the first location in a rotation rule, then the rotation rule can apply to any active location. A wildcard is permitted only for the first locationname in a rotation rule.

  A location can appear only once in a rotation policy. An attempt to include a location more than once in the entire set of location/duration tuples for the rotation policy results in an error message and failure of the command.

• event is the volume-specific event that triggers the point at which the duration specified in this tuple begins to count. The event value can be one of the following:

  • firstwrite

    This is the point at which the first write to a volume occurs. This value is valid only for an active location.

  • lastwrite

    This is the point at which the last write to a volume occurs. This value is valid only for an active location.

  • windowclosed

    This is the point at which the write window closes. This value is valid only for an active location.

  • nonwritable

    This is the point at which a volume can no longer be written to, either because the write window has closed or because the volume is full. This value is valid only for an active location.

  • arrival

    This is the point at which the volume arrived at this location. This value is valid only for a storage location.

  • expiration

    This is the point at which the volume expires. This value is valid only for a storage location.

• duration

  This is the length of time media remain at the location specified in this tuple. It is expressed in standard Oracle Secure Backup time duration syntax.

  The duration value must be specified for all locations except a buffer location. The duration value is expressed as an integer n followed by seconds, minutes, hours, days, weeks, months, or years. Examples of valid values are 14days, 3weeks, and 2months.

  If you specify DISABLED as the duration value, then the volume remains at the associated location forever. The DISABLED value is allowed only for the final location in a rotation policy.

policyname

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

mksched

Purpose

Use the mksched command to create a backup, vaulting scan, duplication scan, or stage scan schedule.

A schedule contains 0 or more triggers. A trigger is a user-defined set of days (--day) and times (--time) when the scheduled backup, vaulting scan, or duplication scan should run. At the beginning of the day, Oracle Secure Backup inspects the triggers in each enabled schedule.

You can use the chsched command to add, change, or remove triggers in an existing schedule.

See Also:

"Schedule Commands" for related commands

Prerequisites

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

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.

Syntax 1

Use the following syntax to create a backup schedule, which describes what, when, and how Oracle Secure Backup should back up. The backup schedule contains the name of each dataset and its associated media family.

For each trigger that fires on a particular day, Oracle Secure Backup creates one backup job for each dataset listed in the schedule. Unlike on-demand (one-time-only) backups created with the backup command, the scheduler creates jobs directly and does not first create a backup request.

mksched::=

mksched 
  [ --type/-Y backup ]
  [ --dataset/-D dataset-name[,dataset-name]... ]
  [ --comment/-c comment | --inputcomment/-i ]
  [ --priority/-p schedule-priority ]
  [ --restrict/-r restriction[,restriction]... ]
  [ --enabled/-z | --disabled/-Z ]
  [ --encryption/-e  { yes | no } ]
  [ [ --day/-d day-date] [ --time/-t time ]
    [ --level/-l backup-level][ --family/-f media-family-name ]
    [ --expires/-x duration] ]...
  [--user/-u user-name]
  [ --compression/-K  {off | low | medium | basic | high}]  
schedulename ...

Semantics 1

--type/-Y schedule-type

Specifies the type of schedule to create. Valid values are backup, duplicationscan, vaultingscan, and stagescan.

--dataset/-D dataset-name

Specifies the dataset to include in the backup job.

If no datasets are specified in the schedule, then Oracle Secure Backup does not initiate backups based on the schedule. You can add a dataset to an existing schedule by using the chsched command.

--comment/-c comment

Adds a comment to the schedule.

--inputcomment/-i

Prompts for a comment. After you run mksched, obtool prompts you to enter the comment. End the comment with a period (.) on a line by itself.

--priority/-p schedule-priority

Assigns a schedule priority to a backup. Refer to "schedule-priority" for a description of the schedule-priority placeholder.

--restrict/-r restriction

Restricts the backup to specific devices within an administrative domain. You can select media server hosts or specific devices on these hosts. If you do not specify a restriction (default), then the current schedule has no device restrictions and can use any available device on any media server at the discretion of the Oracle Secure Backup scheduling system. Refer to "restriction" for a description of the restriction placeholder.

--enabled/-z

Specifies that the backup schedule be enabled when created. If you do not specify either --enabled/-z or --disabled/-Z, then the schedule is enabled when created.

--disabled/-Z

Specifies that the backup schedule be disabled when created. If you specify this option, then you can later enable the backup schedule with a chsched command.

See Also:

"chsched"

--encryption/-e {yes | no}

Specifies encryption flags for the backup schedule or job. Valid values are:

• yes

  Backups for these scheduled jobs are always encrypted, regardless of settings for the global or host-specific encryption policies.

• no

  If the global or host-specific encryption policies are set to allowed, then backups created for these jobs are not encrypted. This is the default.

  If both global and host-specific encryption policies are set to allowed, then backups created for these jobs are not encrypted.

  If either the global encryption policy or the host-specific encryption policy is set to required, then that policy overrides this setting and backups are always encrypted. The encryption algorithm and keys are determined by the policies of each client host.

--day/-d day-date

Specifies the day on which Oracle Secure Backup triggers the scheduled backup. If you do not specify a day or time, then Oracle Secure Backup does not run backup jobs based on the schedule. If you specify a day but no time, then the time defaults to 00:00. Refer to "day-date" for a description of the day-date placeholder.

--time/-t time

Specifies the time at which Oracle Secure Backup triggers the scheduled backup. You cannot specify a time without a day. Refer to "time" for a description of the time placeholder.

--level/-l backup-level

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

--family/-f media-family-name

Specifies the name of the media family to which the data of this scheduled backup should be assigned. The default is the null media family.

--expires/-x duration

Specifies an expiration time period. Refer to "duration" for a description of the duration placeholder. Specifying this option expires the backup, vaulting scan, or duplication scan if it is not processed by duration after the trigger time.

--user/-u username

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

schedulename

Specifies the name of the schedule to create. Schedule names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.

--compression/-K {off | low | medium | basic | high}

Specifies the compression option to use 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.

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.

Syntax 2

Use the following syntax to create a vaulting scan schedule, which describes the time or times when Oracle Secure Backup scans the volumes catalog to determine which volumes are eligible for vaulting. Vaulting schedules have the --type option set to vaultingscan. Vaulting scan control job types are queued for processing by the media manager component of Oracle Secure Backup at the time or times specified in the schedule.

The scan occurs on a location-by-location basis. Scheduled vaulting jobs run in specified vaulting windows and when resources are available.

mksched::=

mksched
[ --type/-Y vaultingscan ]
[ --comment/-c comment|--inputcomment/-i ]
[ --priority/-p schedule-priority ]
[ --restrict/-r vault_restriction[,vault_restriction]... ]
[ --location/-L location_name[,location_name]... ]
[ --enabled/-z | --disabled/-Z ]
[ --select/-S select_criterion[,select_criterion]... ]
[ [ --day/-d day-date ] [ --time/-t time ][ --expires/-x duration ] ]... 
schedulename...

Semantics 2

--type/-Y schedule-type

Specifies the type of schedule to create. Valid values are backup, duplicationscan, vaultingscan, and stagescan.

--comment/-c comment

Adds a comment to the schedule.

--inputcomment/-i

Prompts for a comment. After you run mksched, obtool prompts you to enter the comment. End the comment with a period (.) on a line by itself.

--priority/-p schedule-priority

Assigns a schedule priority to a vaulting scan. Refer to "schedule-priority" for a description of the schedule-priority placeholder.

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

--location/-L locationname

Specifies one or more locations to be applied to the vaulting scan schedule. If no location is specified, then the schedule applies to all locations.

Note:

The --location option is deprecated for vaulting scan schedules in this release, but it is supported for backward compatibility. Oracle recommends that you use the --restrict option to limit vaulting scans to particular locations.

--enabled/-z

Specifies that the vaulting scan schedule be enabled when created. If you do not specify either --enabled/-z or --disabled/-Z, then the schedule is enabled when created by default.

--disabled/-Z

Specifies that the vaulting scan schedule be disabled when created. If you specify this option, then you can later enable the backup schedule with a chsched command.

See Also:

"chsched"

--select/-S select_criterion

Restricts a vaulting scan to one or more media families.

--day/-d day-date

Specifies the day on which Oracle Secure Backup triggers the scheduled vaulting scan. If you do not specify a day or time, then Oracle Secure Backup does not run vaulting scan jobs based on the schedule. If you specify a day but no time, then the time defaults to 00:00. Refer to "day-date" for a description of the day-date placeholder.

--time/-t time

Specifies the time at which Oracle Secure Backup triggers the scheduled vaulting scan. You cannot specify a time without a day. Refer to "time" for a description of the time placeholder.

--expires/-x duration

Specifies an expiration time period. Specifying this option expires the vaulting scan if it is not processed by duration after the trigger time.

See "duration" for more information on the duration placeholder.

schedulename

Specifies the name of the schedule to create. Schedule names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.

Syntax 3

Use the following syntax to create a duplication schedule, which describes the time or times when Oracle Secure Backup scans the volumes catalog to determine which volumes are eligible for duplication. Duplication schedules have the --type option set to duplicationscan. Duplication scan control job types are queued for processing by the media manager component of Oracle Secure Backup at the time or times specified in the schedule.

The scan occurs on a location-by-location basis. Scheduled duplication jobs run in specified duplication windows and when resources are available.

mksched::=

mksched
[ --type/-Y duplicationscan ]
[ --comment/-c comment | --inputcomment/-i ]
[ --priority/-p schedule-priority ]
[ --enabled/-z | --disabled/-Z ]
[ --location/-L locationname[,locationname]... ]
[ [ --day/-d day-date ] [ --time/-t time ] [ --expires/-x duration ] ]... 
schedulename...

Semantics 3

--type/-Y schedule-type

Specifies the type of schedule to create. Valid values are backup, duplicationscan, vaultingscan, and stagescan.

--comment/-c comment

Adds a comment to the schedule.

--inputcomment/-i

Prompts for a comment. After you run mksched, obtool prompts you to enter the comment. End the comment with a period (.) on a line by itself.

--priority/-p schedule-priority

Assigns a schedule priority to a duplication scan. Refer to "schedule-priority" for a description of the schedule-priority placeholder.

--day/-d day-date

Specifies the day on which Oracle Secure Backup triggers the scheduled duplication scan. If you do not specify a day or time, then Oracle Secure Backup does not run duplication scan jobs based on the schedule. If you specify a day but no time, then the time defaults to 00:00. Refer to "day-date" for a description of the day-date placeholder.

--time/-t time

Specifies the time at which Oracle Secure Backup triggers the scheduled duplication scan. You cannot specify a time without a day. Refer to "time" for a description of the time placeholder.

--expires/-x duration

Specifies an expiration time period. Refer to "duration" for a description of the duration placeholder. Specifying this option expires the duplication scan if it is not processed by duration after the trigger time.

--enabled/-z

Specifies that the duplication scan schedule be enabled when created. If you do not specify either --enabled/-z or --disabled/-Z, then the schedule is enabled when created by default.

--disabled/-Z

Specifies that the duplication scan schedule be disabled when created. If you specify this option, then you can later enable the backup schedule with a chsched command.

See Also:

"chsched"

--location/-L locationname

Specifies one or more locations to be applied to the duplication schedule. Only an active location can be specified in a duplication schedule. If no location is specified, then the schedule applies to all locations.

schedulename

Specifies the name of the schedule to create. Schedule names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.

Syntax 4

Use the following syntax to create a stagescan schedule.

The name of the scan job schedule can be added to a stage rule. If the stage rule is added to a disk pool device and staging is enabled, then the stagescan job launched by this schedule creates copyfromstage jobs for all backup image instances in the disk pool that match attributes of the stage rule.

You can create multiple stagescan schedules. However, it is best to create only a few because scanning all instances in a disk pool is a CPU-intensive operation.

mksched::=

mksched
[ --type/-Y stagescan ]
[ --comment/-c comment | --inputcomment/-i ]
[ --priority/-p schedule-priority ]
[ --enabled/-z | --disabled/-Z ]
[ [ --day/-d day-date ] [ --time/-t time ]  
schedulename...

Semantics 4

--type/-Y schedule-type

Specifies the type of schedule to create. Valid values are backup, duplicationscan, vaultingscan, and stagescan.

When the schedule type is stagescan and no --priority value is specified, the priority is set to the staging/defaultscanjobpriority policy value.

--comment/-c comment

Adds a comment to the schedule.

--inputcomment/-i

Prompts for a comment. After you run mksched, obtool prompts you to enter the comment. End the comment with a period (.) on a line by itself.

--priority/-p schedule-priority

Assigns a schedule priority to a duplication scan. Refer to "schedule-priority" for a description of the schedule-priority placeholder.

--day/-d day-date

Specifies the day on which Oracle Secure Backup triggers the scheduled duplication scan. If you do not specify a day or time, then Oracle Secure Backup does not run duplication scan jobs based on the schedule. If you specify a day but no time, then the time defaults to 00:00. Refer to "day-date" for a description of the day-date placeholder.

--time/-t time

Specifies the time at which Oracle Secure Backup triggers the scheduled duplication scan. You cannot specify a time without a day. Refer to "time" for a description of the time placeholder.

--enabled/-z

Specifies that the duplication scan schedule be enabled when created. If you do not specify either --enabled/-z or --disabled/-Z, then the schedule is enabled when created by default.

--disabled/-Z

Specifies that the duplication scan schedule be disabled when created. If you specify this option, then you can later enable the backup schedule with a chsched command.

See Also:

"chsched"

schedulename

Specifies the name of the schedule to create. Schedule names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.

Example

Example 3-26 Scheduling a Weekly Backup

This example schedules a backup every Thursday at 9:00 p.m.

ob> lssched --long
OSB-CATALOG-SCHED:
    Type:                   backup
    Dataset:                OSB-CATALOG-DS
    Priority:               50
    Encryption:             no
    Comment:                catalog backup schedule
ob> mksched --priority 5 --dataset datadir.ds --day thursday --time 21:00 datadir
ob> lssched --long
OSB-CATALOG-SCHED:
    Type:                   backup
    Dataset:                OSB-CATALOG-DS
    Priority:               50
    Encryption:             no
    Comment:                catalog backup schedule
datadir:
    Type:                   backup
    Dataset:                datadir.ds
    Priority:               5
    Encryption:             no
    Trigger 1:
        Day/date:           thursdays
        At:                 21:00
        Backup level:       full
        Media family:       (null)
ob> lsjob --pending
Job ID           Sched time  Contents                       State
---------------- ----------- ------------------------------ ----------------------
3                10/06.21:00 dataset datadir.ds             future work

mksnap

Purpose

Use the mksnap command to create a snapshot. A snapshot is a consistent copy of a volume or a file system. Snapshots are supported only for a Network Appliance filer running Data ONTAP 6.4 or later.

See Also:

"Snapshot Commands" for related commands

Prerequisites

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

Syntax

mksnap::=

mksnap [ --host/-h hostname ] [ --fs/-f filesystem-name ]
[ --nowait/-n ] snapshot-name...

Semantics

--host/-h hostname

Specifies the name of a Network Data Management Protocol (NDMP) host. If you do not specify a host name, then Oracle Secure Backup uses the value from the host variable.

--fs/-f filesystem-name

Specifies the name of an NDMP file system. If you do not specify the --fs option, then the fs variable must be set.

--nowait/-n

Does not wait for the snapshot operation to complete.

snapshot-name

Specifies the name to give the snapshot. Snapshot names must conform to the filename rules in effect where the snapshot is created.

Example

Example 3-27 Creating a Snapshot

This example creates a snapshot of the file system /vol/vol0 on the NDMP host named lucy.

ob> mksnap --host lucy --fs /vol/vol0 lucy_snap
ob> lssnap --long lucy_snap
File system /vol/vol0:
    Max snapshots:          255
    Reserved space:           44.8 GB
    % reserved space:       30
    Snapshot:               lucy_snap
        Of:                 /vol/vol0
        Taken at:           2013/03/28.20:52
        Used %:               0
        Total %:              0
        Busy:               no
        Dependency:         no

mkssel

Purpose

Use the mkssel command to create a database backup storage selector. Oracle Secure Backup uses the information encapsulated in storage selectors for a backup job when interacting with Recovery Manager (RMAN). You can modify the storage selector with the chssel command.

See Also:

• "Database Backup Storage Selector Commands" for related commands

• "Database Backup Storage Selectors and RMAN Media Management Parameters" for an explanation of how storage selectors interact with RMAN media management parameters

• Oracle Secure Backup Administrator's Guide for a conceptual explanation of storage selectors

Prerequisites

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

Syntax

mkssel::=

mkssel
{ --dbname/-d { * | dbname[,dbname]... } | --dbid/-i { * | dbid[,dbid]... } }
{ --host/-h { * | hostname[,hostname]... } }
{ --family/-f media-family }
[ --content/-c { * | content[,content]... } ]
[ --restrict/-r restriction[,restriction]... ]
[ --copynum/-n { * | 1 | 2 | 3 | 4 } ]
[ --encryption/-e {off|on|forcedoff|swencryption}]
[ --waittime/-w  duration ] [--name/-N name-format]
[--priority/-p default | schedule-priority ]
sselname

Semantics

See "chssel" for options that are not described in this section.

--dbname/-d dbname

Specifies the names of the databases to which this storage selector object applies. Specifying an asterisk (*) indicates that the storage selector applies to all database names. You cannot combine the asterisk character (*) with individual database names.

You must specify either --dbname, --dbid, or both. If you specify a database name but not a database ID (DBID), then the DBID defaults to all (*).

--dbid/-i dbid

Specifies the DBIDs of the databases to which this storage selector object applies. Specifying an asterisk (*) indicates that the storage selector applies to all DBIDs. You cannot combine the asterisk character (*) with individual DBIDs.

You must specify either --dbname, --dbid, or both. If you specify a DBID but not a database name, then the database name defaults to all (*).

--host/-h hostname

Specifies the names of the database hosts to which this storage selector applies. Specifying an asterisk character (*) indicates that the storage selector applies to all database hosts. You cannot combine the asterisk character (*) with individual hosts. You must specify at least one host name.

--family/-f media-family

Specifies the name of the media family to be used for backups under the control of this storage selector object. You can specify a media family that uses either a content-managed expiration policy or time-managed expiration policy. You create media families with the mkmf command.

--content/-c content

Specifies the backup contents to which this storage selector applies. Refer to "content" for a description of the content placeholder. Specify an asterisk (*) to indicate all content types.

--restrict/-r restriction

Specifies the names of devices to which backups controlled by this storage selector are restricted. By default, Oracle Secure Backup uses device polling to find any available device for use in backup operations. Refer to "restriction" for a description of the restriction placeholder.

--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 of 1 to 4. Specify an asterisk (*) to indicate that the storage selector applies to any copy number (default).

--waittime/-w duration

Specifies how long to wait for the availability of resources required by backups under the control of this storage selector. The default wait time is 1 hour. Refer to "duration" for a description of the duration placeholder.

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

sselname

Specifies the name of the database backup storage selector. Storage selector names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.

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

See Also:

About Setting the Job Priority for RMAN Operations

Example

Example 3-28 Creating a Database Backup Storage Selector

This example creates a storage selector named ssel_full. The storage selector applies to the database with a DBID of 1557185567 on host brhost2.

ob> mkssel --dbid 1557185567 --host brhost2 --content full --family f1 ssel_full

mkstage

Purpose

The mkstage command creates a stage rule.

Prerequisites

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

Syntax

mkstage::=

mkstage [--comment/-c comment]
                  [--schedule/-T schedulename]
                  [--matchfamily/-f media-family-name[,media-family-name]…]
                  {[--dbname/-d { * | dbname[,dbname]...}] |
                    [--dbid/-i { * | dbid [,dbid]...}] |
                    [--fshost/-h { * | fshostname[,fshostname]...}]}
                  [--mincopysize/-s size-spec]
                  [--mincopyage/-a duration]
                  {--targetfamily/-t target-media-family-name}
                  [--restrict/-r restriction[,restriction]...]
                  [--encryption/-e {yes | no | forcedoff }]
                  [--algorithm/-L enc-algorithm]
                  [--priority/-p {schedule-priority | default}] 
                  [--migrate/-m {yes | no}]
                  stage-rule-name

Semantics

--comment/-c comment

Specifies a comment that is shown when using the long form of the lsstage command.

--schedule/-T schedulename

Specifies a stagescan schedule that specifies the time that a stagescan job will run.

If the --schedule option is not set, then it defaults to the empty string (“”). If a stage rule contains the empty string it matches all stagescan schedules; otherwise, the rule matches the named stagescan schedule. You can explicitly specify the empty string.

While an empty schedule specification does match all schedules during a scan, it does not cause the pool to be scanned for all schedules. A disk pool device is only scanned during the schedules referenced in the stage rules that were added to the disk pool device.

--matchfamily/-f media-family-name

Specifies the media families for backup instances that will be staged by this rule.

If no match media family is specified, then this option defaults to an asterisk (*) so that all media families match the rule.

--dbname/-d dbname

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

--dbid/-i dbid

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

--fshost/-h fshostname

Specifies one or more Oracle Secure Backup client host names. A backup image instance for any file-system backup for any specified client host in the list of hosts matches this rule. An asterisk (*) matches all hosts. The default is the empty string so that no hosts match the stage rule.

--mincopysize/-s size-spec

The total size of all backup image instances that match the rule must be at least the minimum copy size or the staging job will not run.

If the minimum copy size option is not specified or the size is set to 0, then this option is ignored. The minimum copy size defaults to the value 0.

--mincopyage/-a duration

Specifies the minimum age of a backup image instance before it is eligible to be copied. This option can be used separately or with the –schedule option.

If the --schedule option is specified, then the copyfromstage job runs at the specified day and time.

The minimum copy age value defaults to the value 0.

--targetfamily/-t target-media-family-name

Specifies the media family used with the target device when backup images that match this rule are staged. This option must be specified.

If any media family specified using --matchfamily is time-managed, then the target media family must also be a time-managed media family.

--restrict/-r restriction

Restricts the copyfromstage job to specific devices within an administrative domain. You can select media server hosts or specific devices on these hosts. If you do not specify a restriction (default), then the current schedule has no device restrictions and can use any available device on the media server that hosts the disk pool, or if no tape device is available there, then on any media server.

A restriction has the following form:

restriction::= devicename | @hostname | devicename@hostname

See Also:

• restriction

  for a description of the restriction placeholder

If the restriction list contains a disk pool device, then the rule cannot be added to the set of stage rules for that disk pool device. This prevents backup image instances from being copied back into the same disk pool stage device where the backup images already reside.

If there are any configured tape devices, then using an empty restriction list lets any tape device in the system become the target device for the copy, and a disk pool is never used. However, if there are no configured tape devices, then any disk pool can be chosen. Note that this can prevent the removal of the last configured tape device, because the empty restriction list could cause a stage loop by allowing an earlier source pool to become a potential target device for the copy.

The restriction list cannot contain both cloud devices and non-cloud devices.

The default stage rule restriction list cannot be set to a cloud device.

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

Specifies encryption flags for the copyfromstage job. Valid values are:

• yes

  Use encryption for the copyfromstage job. If the backup image instance is not encrypted, then 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 the copyfromstage job . This is 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 the copyfromstage job, regardless of global or client backup policy.

--algorithm/-L enc-algorithm

Specifies the encryption algorithm the copyfromstage jobs uses. Values include AES128, AES192, and AES256. The default algorithm is AES192.

--priority/-p schedule-priority

The scheduler priority value for the copyfromstage job. This is a value between 1 and 2147483647. A lower priority value designates a higher priority job.

If this option is not specified, then the copyinstance/defaultpriority policy value is used. That policy defaults to a priority value of 150. Using --priority default unsets any existing priority value so that the policy value is used (this is typically only used with the chstage command).

--migrate/-m {yes | no}

The yes option causes all backup image instances that were successfully coped to the destination container by a copyfromstage job to be deleted from the source stage device immediately after being copied. Even content-managed backup image instances are deleted.

RMAN content-managed backup image instances that are not migrated remain in the stage disk pool until RMAN deletes the database piece associated with the backup image instance.

If the migrate option is set to yes, then even a content managed backup image instance is deleted from the staging disk pool immediately after being stage-copied.

stage-rule-name

The name of the Oracle Secure Backup stage rule. A stage rule name must be no more than 31 characters long and must start with a letter. Other characters in the name come from the set of letters, decimal digits, and an underscore character. The name is case-sensitive. The name must be unique within the Oracle Secure Backup domain.

Examples

Example 3-29 Generating Stage Rules That Match RMAN Backup Images

This example generates a stage rule that matches any RMAN database backup image instance that was created with one of two specific media families. A copyfromstage job schedule runs every Monday at 4:00 PM. After the backup image instances are copied, they are immediately deleted from the stage disk pool device.

ob> mkstage --targetfamily tmf --matchfamily mymf1,mymf2 --dbname * --schedule sscanmonat4pm --migrate yes mydbrule

Example 3-30 Generating Stage Rules That Match RMAN Backup Images of a Specified Age

This example generates a stage rule that matches the same rule options as in the previous example, but only copies backup image instances that are at least 10 days old at the specified schedule time.

ob> mkstage --targetfamily tmf --matchfamily mymf1,mymf2 --dbname * --schedule sscanmonat4pm --mincopyage 10day --migrate yes mydbrule2

Example 3-31 Staging File-system Backups for Two Hosts

The following example causes file-system backup image instances with media family mymf for either host sys1 or sys2 to be staged. The instances are staged immediately because the schedule is an empty string (“”), which is the default value when the schedule name is omitted. The time-managed backup image instances are deleted when they reach their expiration time.

ob> mkstage --targetfamily tmf --matchfamily mymf --fshosts sys1,sys2 myfsrule

Example 3-32 Staging File-system Backups for a Single Host That Are at Least 4TB Size Total

The following stage rule matches backup image instances with a media family of mymf and host sys3. If all of the backup image instances that match this rule have a cumulative size of at least 4TB, then the instances are copied.

ob> mkstage --targetfamily tmf --matchfamily mymf --fshosts sys3 --mincopysize 4TB mysizerule1

Example 3-33 Copying Backup Image Instances With Any Media Family Containing Database Pieces

The following stage rule copies backup image instances with any media family that contain database pieces for the database with id 12345, and where the instances add up to a total size of at least 4TB. Either dev1 or dev2 will be the destination device.

ob> mkstage --targetfamily tmf --dbid 12345 –mincopysize 4TB –restrict dev1,dev2 --schedule sscandaily mysizerule2

mksum

Purpose

Use the mksum command to create a job summary schedule. The schedule indicates when and in what circumstances Oracle Secure Backup should generate a backup, restore, or duplication job summary, which is a text file report that indicates whether the job was successful.

See Also:

"Summary Commands" for related commands

Prerequisites

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

Syntax

mksum::=

mksum [--days/-d produce-days[,produce-days]...]
             [--reporttime/-t time]
             [--mailto/-m email-target[,email-target]...]
             [--host/-h hostname[,hostname]...]
             [ [--covers/-c duration] |
               [--since/-s "summary-start-day[ ]time"] ]
             [--backup/-B {yes | no}] [--restore/-R {yes | no}]
             [--orabackup/-b {yes | no}] [--orarestore/-e {yes | no}]
             [--scheduled/-S {yes | no}] [--user/-U {yes | no}]
             [--subjobs/-J {yes | no}] [--superseded/-D {yes | no}]
             [--duplication/-P {yes | no}] [--mediamovement/-M {yes | no}]
             [--catimport/-I {yes | no}] [--catalog/-C {yes | no}]
             [--copyinstance/-p {yes | no}] [--copyfromstage/-E {yes | no}]
             summary-name...

Semantics

--days/-d produce-days

Specifies the days of the week on which to generate a job summary. Refer to "produce-days" for a description of the produce-days placeholder.

--reporttime/-t time

Specifies the time at which to generate a job summary. Refer to "time" for a description of the time placeholder.

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

Specifies email addresses of users who receive job summaries. An email system must be operational on the administrative server for this feature to operate. Separate multiple entries with a comma.

--host/-h hostname

Generates reports only for the specified host.

--covers/-c duration

Specifies the time frame covered by the report. Refer to "duration" for a description of the duration placeholder.

--since/-s "summary-start-day time"

Specifies the starting point of the time period that the report covers. Refer to "summary-start-day" for a description of the summary-start-day placeholder. Refer to "time" for a description of the time placeholder.

--backup/-B {yes | no}

Specifies whether backup jobs should be included in the report. The default is yes.

--restore/-R {yes | no}

Specifies whether restore jobs should be included in the report. The default is yes.

--orabackup/-b {yes | no}

Specifies whether Recovery Manager (RMAN) backup jobs should be included in the report. The default is yes.

--orarestore/-e {yes | no}

Specifies whether RMAN restore jobs should be included in the report. The default is yes.

--scheduled/-S {yes | no}

Specifies whether all jobs waiting to be processed in the scheduler should be included in the report. A scheduled job is a job that has yet to be run. The default is yes.

--user/-U {yes | no}

Specifies whether the report should include user-initiated jobs. The default is yes. If it is set to no, then the summary only shows scheduled jobs.

--subjobs/-J {yes | no}

Specifies whether the report should include subordinate jobs. The default is yes.

--superseded/-D {yes | no}

Specifies whether the report should include all jobs that have identical criteria. The default is no.

A job is superseded when an identical job was scheduled after the initial job had a chance to run. For example, suppose you schedule an incremental backup scheduled every night at 9 p.m. On Wednesday morning you discover that the Tuesday night backup did not run because no tapes were available in the tape library. The incremental backup scheduled for Wednesday supersedes the backup from the previous night.

--duplication/-P {yes | no}

Specifies whether volume duplication jobs should be included in the report. The default is yes.

--catalog/-C {yes | no}

Specifies that the report should include information about catalog backups, including:

• The volume ID and barcode for each catalog backup

• The file number for the catalog backup

• Results of the verification step when the backup job was run

Note:

Catalog backups are also listed in summary reports that include information on backup jobs. However, they are mixed in with other backups and not marked specifically as catalog backups. The --catalog option is intended to help monitor the status of catalog backups independently of other backup jobs.

--mediamovement/-M {yes | no}

Specifies whether to include media movement jobs in the report. The default is yes.

--copyinstance/-p {yes|no}

Specifies whether copy instance jobs must be included in the summary report. The default is yes.

--catimport/-I {yes | no}

Specifies whether catalog import jobs must be included in the summary report. The default is yes.

copyfromstage/-E {yes | no}

Controls whether copyfromstage jobs appear in the OSB summary report.

summary-name

Specifies the name of the job summary schedule. Names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 127 characters.

Examples

Example 3-34 Scheduling a Job Summary

This example schedules a backup summary named weekly_report.

ob> mksum --days wed --reporttime 12:00 --mailto [e-mail] weekly_report
ob> lssum --long
weekly_report:
    Produce on:              Wed at 12:00
    Mail to:                 [e-mail]
    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>

Example 3-35 Sample Job Summary

This example shows parts of a sample summary. Note that the sample output has been reformatted to fit on the page.

I. Pending jobs.
 
None.
  
II. Ready and running jobs.
 
None.
 
III. Successful jobs.
 
                Scheduled or                                           Backup   File Volume IDs
Job ID         *Introduced at   Completed at     Content               Size        # (Barcodes)
-------------- ---------------- ---------------- --------------------- --------- --- -------
admin/1        *2013/03/24.09:52 2013/03/24.09:52 dataset tbrset/entire_backup
admin/1.1      *2013/03/24.09:52 2013/03/24.09:52    host brhost2      3.5 MB  1 VOL000001 (ADE202)
admin/2        *2013/03/24.09:52 2013/03/24.09:52 restore to brhost2      
 
IV. Unsuccessful jobs.
 
                   Scheduled or
Job ID            *Introduced at    Content                  Status
------------------ ---------------- ------------------------ ------------------------
admin/7           *2013/03/24.16:41 dataset homedir.ds        failed - host isn't administrative 
                                                              domain member (OB job mgr)
admin/7.1         *2013/03/24.16:41     host brhost4(DELETED) failed - host isn't administrative 
                                                              domain member (OB job mgr)

mkuser

Purpose

Use the mkuser command to define an Oracle Secure Backup user. Each Oracle Secure Backup user account belongs to exactly one class, which defines the rights of the Oracle Secure Backup user.

See Also:

• "User Commands" for related commands

• "Class Commands"

Prerequisites

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

Usage Notes

When an Oracle Secure Backup user performs a backup or restore operation on a host with the default --unprivileged option, the host is accessed with an operating system identity.

If a Linux or UNIX host is backed up or restored, then Oracle Secure Backup uses the --unixname and --unixgroup values for the operating system identity.

If a Windows host is backed up or restored, then Oracle Secure Backup begins with the first domain triplet in the list—skipping any with a wildcard (*) for the domain name—and checks whether the domain and username allows access to the host.

Note:

Oracle Secure Backup uses the LookupAccountName system call to determine whether access is allowed. No attempt at logging on actually occurs during the check, nor is there any attempt to enumerate all the valid Windows domains.

If access is allowed, then Oracle Secure Backup uses this logon information to run the job. If access is not allowed, then Oracle Secure Backup proceeds to the next domain triplet in the list. If Oracle Secure Backup does not find a triplet that allows access to the host, then it checks whether a triplet exists with a wildcard (*) as domain name.

Syntax

mkuser::=

mkuser --class/-c userclass
[ --password/-p password | --querypassword/-q ]
[ --pwdlifetime ] [ --pwdgracetime ] [ --pwdreusetime ]
[ --unixname/-U unix-user ] [ --unixgroup/-G unix-group ]
[ --domain/-d { windows-domain | * },windows-account[,windows-password ] ]...
[ --ndmpuser/-N { yes | no }  ]
[ --email/-e emailaddr ] [ --givenname/-g givenname ]
[ --preauth/-h preauth-spec[,preauth-spec]... ]
username

Semantics

--class/-c userclass

Specifies the name of the class to which the Oracle Secure Backup user should belong. Table 8-1 describes the predefined classes and rights.

--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. Ensure that you enter the password enclosed in quotes.

The minimum password length is determined by the minuserpasswordlen security policy. Its default value is 0, which means a null password is permitted.

See Also:

"minuserpasswordlen"

The practice of supplying a password in clear text on a command line or in a command script is not recommended by Oracle. It is a security vulnerability. The recommended procedure is to have the Oracle Secure Backup user be prompted for the password.

--querypassword/-q

Specifies that you should be prompted for the password, which is not echoed.

--pwdlifetime

Specifies the lifetime of a user password, in number of days. This value must be greater than or equal to 1 day. The default lifetime of a password is set to 180 days. If the password lifetime is set to disabled, then the password never expires.

--pwdgracetime

Specifies the grace time of the password during which the user can continue using the current password even after it has expired. This value must be greater than or equal to 1 day. The default password grace time is set to 3 days. If the grace time is set to disabled, no grace time is provided and the user must change the password during the next login after the password expiration.

--pwdreusetime

Specifies the time period after which a user password that was previously used can be reused. This value must be greater than or equal to 1 day. The default password reuse time is set to 1 year. If the reuse time is set to disabled, the password can never be reused.

--unixname/-U unix-user

Specifies a user name for a Linux or UNIX host. The default user name is the first defined of guest, nobody, none, and user.

--unixgroup/-G unix-group

Specifies a group for a Linux or UNIX host. The default is none.

--domain/-d {windows-domain | *},windows-account[,windows-password]

Specifies a Windows domain name, user account, and password. If you do not enter the Windows password, then obtool prompts you for it. For windows-domain, enter an asterisk (*) if the windows-account and windows-password apply to all Windows domains. The --domain option has no default value.

Always enclose the Windows name, user account, and password string in quotes.

The Windows user account must have access to the following privileges so that obtar can run:

• SeBackupPrivilege

  User right: Back up files and directories

• SeRestorePrivilege

  User Right: Restore files and directories

• SeChangeNotifyPrivilege

  User right: Bypass traverse checking

You must grant the preceding privileges to the user account when it is created or grant them afterward.

--ndmpuser/-N {yes | no}

Indicates whether the Oracle Secure Backup user is permitted to log in to an Network Data Management Protocol (NDMP) server. Specify yes to enable the Oracle Secure Backup user to access an NDMP server and no if you do not. The default is no. This login is achieved with an external client program.

--email/-e emailaddr

Specifies the email address for the Oracle Secure Backup user. When Oracle Secure Backup wants to communicate with this user, such as to deliver a job summary or notify the user of a pending input request, it sends email to this address.

--givenname/-g givenname

Specifies the given name of the Oracle Secure Backup user if different from the user name, for example, "Jim W. Smith" for user name jsmith.

--preauth/-h preauth-spec

Grants the specified operating system user preauthorized access to the administrative domain as the Oracle Secure Backup user. By default there is no preauthorization.

A preauthorization dictates how an operating system user can be automatically logged in to Oracle Secure Backup. Access is authorized only for the specified operating system user on the specified host. For each host within an Oracle Secure Backup administrative domain, you can declare one or more one-to-one mappings between operating system and Oracle Secure Backup user identities. For example, you can create a preauthorization so that UNIX user bkpadmin is automatically logged in to obtool as Oracle Secure Backup user admin.

Refer to "preauth-spec" for a description of the preauth-spec placeholder. Duplicate preauthorizations are not permitted. Preauthorizations are considered to be duplicates if they have the same hostname, user ID, and domain.

username

Specifies a name for the Oracle Secure Backup user. User names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 127 characters.

The user name must be unique among all Oracle Secure Backup user names. Formally, it is unrelated to any other name used in your computing environment or the Oracle Secure Backup administrative domain.

Example

Example 3-36 Creating an Oracle Secure Backup User

This example creates an administrative Oracle Secure Backup user named janedoe. This user runs unprivileged backup and restore operations on Linux and UNIX hosts under the jdoe operating system account. Because no Windows domains are specified, this user is not permitted to run backup or restore operations on Windows hosts. The jdoe operating system user is preauthorized to make Recovery Manager (RMAN) backups on host osbsvr1.

ob> lsuser
admin            admin
sbt              admin
tadmin           admin
ob> mkuser janedoe --class admin --password "x45y" --givenname "jane" --unixname
jdoe --unixgroup "dba" --preauth osbsvr1:jdoe+rman+cmdline --ndmpuser no
--email [e-mail]
ob> lsuser
admin            admin
janedoe          admin
sbt              admin
tadmin           admin

Example 3-37 Creating an Oracle Backup User with Specific Password Settings

This example creates an administrative Oracle Secure Backup user dave01 with the password being queried once the command is completed. The –querypassword clause strengthens user security as the password is not visible on the command line. The password lifetime is set to 80 days. Similarly, the password grace time is set to 2 days and the password reuse time is set to 120 days. The example also lists all the attributes of the user.

ob> mkuser dave01 --class admin --querypassword  --pwdlifetime 80days --pwdgracetime 2days --pwdreusetime 120days --givenname "dave" --preauth brhost3:rman+cmdline --ndmpuser no
Password: 
Password (again): 
ob> lsuser --long dave01
dave01:
    Password:                   (set)
    Password last changed:      2012/10/30.02:33
    Password change required:   no
    Password lifetime:          80 days
    Password grace time:        2 days
    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

Example 3-38 Creating an Oracle Secure Backup User with a Windows Domain

This example creates an administrative Oracle Secure Backup user named winadmin for a Windows domain. The Windows user account name for this user is winuser1 and the Windows user password is pwd. The asterik ( * ) ensures that these Windows credentials apply to all Windows domains. This user can perform backup and restore operations on Windows hosts.

ob> mkuser winadmin --class admin --domain "*,\winuser1,pwd"
ob> lsuser --long winadmin
winadmin:
    Password:                   (not set)
    Password last changed:      2013/07/24.05:55
    Password change required:   no
    Password lifetime:          180 days (system default)
    Password grace time:        3 days (system default)
    Password reuse time:        1 year (system default)
    User class:                 admin
    Given name:                 [none]
    UNIX name:                  [none]
    UNIX group:                 [none]
    Windows domain/acct:        [all] winuser1
    NDMP server user:           no
    Email address:              [none]
    UUID:                       e4a96afa-d6c8-1030-9b32-00163e527899
    Preauthorized access:       [none]

mountdev

Purpose

Use the mountdev command to mount a tape volume that was previously loaded into a tape drive. When a volume is mounted in a tape drive, the Oracle Secure Backup scheduler is notified that the mounted volume is available for use. You can set the mode of use for the volume with the mountdev options.

You can use this command if the tape drive is not set to automount, which is the recommended, default setting. In special situations the mountdev and unmountdev commands provide additional control over your tape drive.

See Also:

"Device Commands" for related commands

Prerequisites

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

Syntax

mountdev::=

mountdev { --read/-r | --write/-w | --overwrite/-o }
[ --unmount/-u | --norewind/-R ] devicename ...

Semantics

--read/-r

Identifies the mount mode as read. In this mode, Oracle Secure Backup mounts the volume for reading only.

--write/-w

Identifies the mount mode as write. In this mode, Oracle Secure Backup mounts the volume so that it can append any backups to the end of the volume.

--overwrite/-o

Identifies the mount mode as overwrite. In this mode, Oracle Secure Backup mounts a volume on the device and positions it at the beginning of the tape so that the existing contents of the volume are overwritten. If you use this option, then you are granting permission to overwrite a volume even though its volume expiration policy might not deem it eligible to be overwritten. Specify this option only in situations that warrant or require overwriting unexpired volumes.

--unmount/-u

Unmounts the currently mounted tape before running the mount request. If a tape is mounted in the tape drive, and you do not first unmount the tape by specifying --unmount, then the mountdev command fails.

--norewind/-R

Specifies that the tape should not be rewound when Oracle Secure Backup finishes writing to it. This option enables Oracle Secure Backup to remain in position to write the next backup image.

devicename

Specifies the device on which you want to mount a volume. Refer to "devicename" for the rules governing device names.

Example

Example 3-39 Manually Mounting a Tape Volume

This example manually unmounts a tape volume from tape drive tape1, which is automounted, and then manually mounts a tape in write mode. Note that the sample lsdev output has been reformatted to fit on the page.

ob> lsdev --long tape1
tape1:
    Device type:            tape
    Model:                  [none]
    Serial number:          [none]
    In service:             yes
    Library:                lib1
    DTE:                    1
    Automount:              yes
    Error rate:             8
    Position interval:      3145679KB (-1073791796 bytes) (from driver)
    Debug mode:             no
    Blocking factor:        (default)
    Max blocking factor:    (default)
    Current tape:           1
    Use list:               all
    Drive usage:            14 seconds
    Cleaning required:      no
    UUID:                   b7c3a1a8-74d0-1027-aac5-000cf1d9be50
    Attachment 1:
        Host:               brhost3
        Raw device:         /dev/obt0
ob> mountdev --unmount --write tape1
ob> lsdev --mount tape1
drive        tape1        in service       write      rbtar   VOL000003     ADE203

movevol

Purpose

Use the movevol command to move a volume from one element to another element within a tape library. You can only move one volume at a time.

See Also:

"Library Commands" for related commands

Prerequisites

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

Syntax

movevol::=

movevol [ --library/-L libraryname | --drive/-D drivename ]
{ vol-spec | element-spec } element-spec

Semantics

--library/-L libraryname

Specifies the name of the tape library in which you want to move a volume.

If you do not specify --library or --drive, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.

--drive/-D drivename

Specifies the name of a tape drive in the tape library in which you want to move a volume.

If you do not specify --library or --drive, then Oracle Secure Backup uses the value of the library or drive variable. Oracle Secure Backup issues a warning if it can obtain neither the tape library nor tape drive setting.

vol-spec

Specifies the volume to be moved. Refer to "vol-spec" for a description of the vol-spec placeholder.

element-spec

Specifies the number of a storage element, import/export location, or a tape drive. Refer to "element-spec" for a description of the element-spec placeholder.

If you specify vol-spec, then element-spec represents the location to which the volume should be moved. If you specify element-spec twice, then the first represents the location from which the volume should be moved and the second represents the location to which the volume should be moved.

Example

Example 3-40 Moving a Volume

This example moves the volume in storage element 3 to the import/export element iee3. Note that the sample output has been reformatted to fit on the page.

ob> lsvol --library lib1 --long
Inventory of library lib1:
    in    mte:           vacant
    in    1:             vacant
    in    2:             volume VOL000001, barcode ADE201, oid 102, 48319392 kb remaining
    in    3:             volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47725600 kb 
                         remaining, content manages reuse
    in    4:             vacant
    in    iee1:          barcode ADE203, oid 114, 47725344 kb remaining, lastse 4
    in    iee2:          volume VOL000002, barcode ADE204, oid 110, 47670368 kb remaining, lastse 1
    in    iee3:          vacant
    in    dte:           vacant
ob> movevol --library lib1 3 iee3
ob> lsvol --library lib1 --long
Inventory of library lib1:
    in    mte:           vacant
    in    1:             vacant
    in    2:             volume VOL000001, barcode ADE201, oid 102, 48319392 kb remaining
    in    3:             vacant
    in    4:             vacant
    in    iee1:          barcode ADE203, oid 114, 47725344 kb remaining, lastse 4
    in    iee2:          volume VOL000002, barcode ADE204, oid 110, 47670368 kb remaining, lastse 1
    in    iee3:          volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47725600 kb 
                         remaining, content manages reuse, lastse 3
    in    dte:           vacant

opendoor

Purpose

Use the opendoor command to open the import/export door of a tape library. This command only works for libraries that support it.

The import/export door is a mechanism that an operator uses to transfer tapes into and out of the tape library. You can then run the importvol command to move volumes to internal slots in the tape library and the exportvol command to move volumes out of the tape library. Because the tape library itself is not opened during this process, a reinventory is not required.

See Also:

"Library Commands" for related commands

Prerequisites

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

Syntax

opendoor::=

opendoor [ --library/-L libraryname ]

Semantics

--library/-L libraryname

Specifies the name of the tape library on which you want to open the import/export door. If you do not specify a tape library name, then the library variable must be set.

Example

Example 3-41 Opening an Import/Export Door

This example opens the import/export door in tape library lib1.

ob> lsvol --library lib1 --long
Inventory of library lib1:
    in    mte:           vacant
    in    1:             vacant
    in    2:             volume VOL000001, barcode ADE201, oid 102, 48319392 kb remaining
    in    3:             vacant
    in    4:             vacant
    in    iee1:          barcode ADE203, oid 114, 47725344 kb remaining, lastse 4
    in    iee2:          volume VOL000002, barcode ADE204, oid 110, 47670368 kb remaining, lastse 1
    in    iee3:          volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47725600 kb 
                         remaining, content manages reuse, lastse 3
    in    dte:           vacant
ob> opendoor --library lib1

pingdev

Purpose

Use the pingdev command to determine whether a device is accessible to Oracle Secure Backup with all configured attachments.

For each attachment defined for the device, Oracle Secure Backup performs the following steps:

1. Establishes a connection to the device

2. Queries the device's identity by using the Small Computer System Interface (SCSI) inquiry command

3. Closes the connection

For each attachment that is remote from the host running obtool, Oracle Secure Backup establishes a Network Data Management Protocol (NDMP) session with the remote media server to test the attachment. When the pingdev command is issued for a cloud storage device, the accessibility of Oracle Cloud services through all attached media servers is verified.

See Also:

"Device Commands" for related commands

Prerequisites

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

Syntax

pingdev::=

pingdev [ --nohierarchy/-H ] [ --quiet/-q | --verbose/-v ]
[ --host/-h hostname ]... { --all/-a | devicename ... }

Semantics

--nohierarchy/-H

Suppresses access to each tape drive contained in a tape library. By default, obtool pings each tape drive contained in the tape library.

--quiet/-q

Suppresses output. By default, obtool displays the output shown in Example 3-42.

--verbose/-v

Displays verbose output as shown in the following sample output:

ob> pingdev --verbose lib1
Info: pinging library lib1.
Info: library    lib1             accessible.
Info: pinging drive tape1.
Info:   drive  1 tape1            accessible.

By default, obtool displays the output shown in Example 3-42.

--host/-h hostname

Specifies the name of the host computer whose attached devices you are pinging.

--all/-a

Pings all defined devices.

devicename

Specifies the name of the device to ping. Refer to "devicename" for the rules governing device names.

Example

Example 3-42 Pinging a Tape Drive with Multiple Attachments

This example pings the tape drive called tape3. The tape device has attachments to multiple hosts.

ob> pingdev tape3
Info: drive      tape3            via host osbsvr1 accessible.
Info: drive      tape3            via host brhost3 accessible.
ob> pingdev --host brhost3 tape3
Info: drive      tape3            via host brhost3 accessible.

pinghost

Purpose

Use the pinghost command to determine whether a host in an administrative domain is responsive to requests from Oracle Secure Backup. This operation is useful for ensuring that a host is responsive on all of its configured IP addresses.

See Also:

"Host Commands" for related commands

Prerequisites

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

Usage Notes

This command attempts to establish a TCP connection to the host on each of the IP addresses that you have configured for it. For hosts that use the Oracle Secure Backup protocol, the command connects through TCP port 400; for hosts using Network Data Management Protocol (NDMP), it connects through the configured NDMP TCP port, usually 10000. Oracle Secure Backup reports the status of each connection attempt and immediately closes each connection that was established successfully.

Syntax

pinghost::=

pinghost [ --quiet/-q | --verbose/-v ] hostname...

Semantics

--quiet/-q

Suppresses output.

--verbose/-v

Displays output. This option is the default.

hostname

Specifies the name of the host computer to ping.

Example

Example 3-43 Pinging a Host

This example queries the hosts in the administrative domain and then pings host brhost2.

ob> lshost
brhost2          client                            (via OB)   in service
brhost3          mediaserver,client                (via OB)   in service
sfserver1        client                            (via OB)   in service
ndmphost1        client                            (via NDMP) in service
osbsvr1          admin,mediaserver,client          (via OB)   in service
ob> pinghost brhost2
brhost2 (address 192.0.2.1): Oracle Secure Backup and NDMP services are available

pwd

Purpose

Use the pwd command to display the name of the directory in the Oracle Secure Backup catalog that you are browsing.

See Also:

"Browser Commands" for related commands

Prerequisites

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

Syntax

pwd::=

pwd [ --short/-s | --long/-l ] [ --noescape/-B ]

Semantics

--short/-s

Displays data in short form.

--long/-l

Displays data in long form.

--noescape/-B

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

Example

Example 3-44 Displaying the Current Directory

This example displays the path information for brhost2.

ob> cd --host brhost2
ob> pwd --long
Browsemode:         catalog
Host:               brhost2
Data selector:      latest
Viewmode:           inclusive
Pathname:           <super-dir>

pwdds

Purpose

Use the pwdds command to show the name of the current directory in the dataset directory tree.

See Also:

"Dataset Commands" for related commands

Prerequisites

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

Syntax

pwdds::=

pwdds

Example

Example 3-45 Displaying the Current Directory

This example shows the current directory, changes into a different directory, and then shows the current directory again.

ob> pwdds
/ (top level dataset directory)
ob> lsds
Top level dataset directory:
mydatasets1/
mydatasets/
admin_domain.ds
ob> cdds mydatasets
ob> pwdds
/mydatasets

pwdp

Purpose

Use the pwdp command to display the identity of the current policy.

The policy data is represented as a directory tree with / as the root. You can use cdp to navigate the tree and lsp and pwdp to display data.

See Also:

• "Policy Commands" for related commands

• Defaults and Policies for a complete list of policies and policy classes

Prerequisites

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

Syntax

pwdp::=

pwdp

Example

Example 3-46 Displaying the Current Directory in the Policy Tree

This example uses cdp to browse the policies and pwdp to display the current directory in the policy directory tree.

ob> pwdp
/
ob> lsp
daemons              daemon and service control policies
devices              device management policies
index                index catalog generation and management policies
local                Oracle Secure Backup configuration data for the local machine
logs                 log and history management policies
media                general media management policies
naming               WINS host name resolution server identification
ndmp                 NDMP Data Management Agent (DMA) defaults
operations           policies for backup, restore and related operations
scheduler            Oracle Secure Backup backup scheduler policies
security             security-related policies
testing              controls for Oracle Secure Backup's test and debug tools
ob> cdp daemons/auditlogins
ob> pwdp
/daemons/auditlogins
ob> lsp
auditlogins           no        [default]
ob> cdp ../..
ob> pwdp
/
ob> lsp
daemons              daemon and service control policies
devices              device management policies
index                index catalog generation and management policies
local                Oracle Secure Backup configuration data for the local machine
logs                 log and history management policies
media                general media management policies
naming               WINS host name resolution server identification
ndmp                 NDMP Data Management Agent (DMA) defaults
operations           policies for backup, restore and related operations
scheduler            Oracle Secure Backup backup scheduler policies
security             security-related policies
testing              controls for Oracle Secure Backup's test and debug tools

quit

Purpose

Use the quit command to exit obtool. This command is identical in functionality to the exit command.

See Also:

"Miscellaneous Commands" for related commands

Syntax

quit::=

quit [ --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 quit 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 3-47 Quitting obtool

This example uses the --force option to quit obtool when a backup job is pending.

ob> backup --dataset fullbackup.ds
ob> quit
Error: one or more backup requests are pending.  Use "quit --force" to
       quit now, or send the requests to the scheduler with "backup --go".
ob> quit --force

recallvol

Purpose

Recalls a tape volume from an offsite storage location.

See Also:

"Volume Rotation Commands"

Prerequisites

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

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 recall. You can select one or more of the volumes, all of them, or none of them. The default selection is all volumes.

If you specify a volume ID and the volume belongs to a volume set, then Oracle Secure Backup lists all volumes in the volume set. You can select all or none of them, but you cannot select individual members of the volume set. The default selection is quit, which means that no volumes are selected.

See Also:

"chvol" for a pair of examples illustrating volume ID matching

Syntax

recallvol::=

recallvol
    [ --immediate/-I ] 
    [ --piece/-p  piecename | vol-spec ]
    [ --tolocation/-t locationname ] 

Semantics

--immediate/-I

Creates a media movement job immediately.

--piece/-p piecename

Recall the volume or volumes containing the specified backup piece. The --piece and vol-spec options are mutually exclusive.

vol-spec

The volume ID or the barcode value of the volume. The --piece and vol-spec options are mutually exclusive.

--tolocation/-t locationname

Specifies the location to which the volumes should be recalled. If the --tolocation option is not specified for the recallvolume command, then the volume are recalled to the originating location.

releasevol

Purpose

Releases recalled volumes, for return to the location dictated by their rotation policies.

See Also:

"Volume Rotation Commands"

Prerequisites

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

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 release. You can select one or more of the volumes, all of them, or none of them. The default selection is all volumes.

If you specify a volume ID and the volume belongs to a volume set, then Oracle Secure Backup lists all volumes in the volume set. You can select all or none of them, but you cannot select individual members of the volume set. The default selection is quit.

See Also:

"chvol" for a pair of examples illustrating volume ID matching

Syntax

releasevolume::=

releasevol
   { --all/-a | vol-spec }

Semantics

--all/-a

Releases all volumes currently in the recalled state.

vol-spec

The volume ID or the barcode value of the volume to be released.

renauth

Purpose

Use the renauth command to rename authentication objects. Devices that refer to the old authentication object name automatically change to refer to the new authentication object name. Without the --nq/--noquery option, renauth queries how to proceed with the rename operation.

Prerequisites

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

Syntax

Use the following syntax to rename authentication objects.

Semantics

renauth::=

renauth [--nq/--noquery] {old-authobj-name  new-authobj-name}
      ...

[--nq/--noquery]

Causes renauth to perform the requested rename operations with no interaction.

{old-authobj-name new-authobj-name}

Specifies the old and new authentication object names. renauth accepts multiple pairs of old and new names.

Examples

Example 3-48 Renaming an Authentication Object

This example renames an authentication object and requires confirmation.

ob> lsauth
auth_01          
auth_02 
ob> renauth auth_02 auth_03
rename auth object auth_02? (a, n, q, y, ?) [y]: y
ob> lsauth
auth_01          
auth_03          
ob>

Example 3-49 Renaming an Authentication Object Without Query

This example renames an authentication object without requiring confirmation.

ob> renauth --nq auth_03 auth_04
ob> lsauth
auth_01          
auth_04          
ob>

Example 3-50 Showing renauth Query Options

This example shows the renauth query options, without renaming the authentication object.

ob> renauth auth_05 auth_06
rename auth object auth_05? (a, n, q, y, ?) [y]: ?
Enter 'a' to rename auth_05 and all remaining auth objects
      'n' to not rename auth_05
      'q' to not rename auth_05 or any more auth objects
      'y' to rename auth_05
      '?' to repeat this message
rename auth object auth_05? (a, n, q, y, ?) [y]: q
ob>

renbkup

Purpose

Use the renbkup command to modify the externally-visible name of a backup image. When you rename a backup image, Oracle Secure Backup renames the backup image instances associated with this backup image to reflect the changed name.

Prerequisites

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

Syntax

renbkup::=

renbkup 
[--nq] {old-backup-image-name new-backup-image-name}...

Semantics

--nq

Does not ask for confirmation before modifying the backup image name.

old-backup-image-name

Specifies the name of the existing backup image that needs to be modified.

new-backup-image-name

Specifies the new name for the backup image. If the name specified already exists, then the renbkup command fails.

Examples

Example 3-51 Renaming Backup Images

This example renames the backup image my_bi_fs to new_bi_fs. Notice that when you rename the backup image, the corresponding backup image instance name is also modified to match the new backup image name.

ob> lsbkup --long --instances my_bi_fs
Backup image name:    my_bi_fs
    Type:                   file system
    Client:                 brhost2
    Backup level:           0
    Size:                   128.0 KB
    Backup owner:           admin
    Owner class:            admin
    Backup date and time:   2013/04/23.04:20
    Created by job:         admin/12.1
    UUID:                   7123076c-8e70-1030-84cd-00163e359724
    Instance name:          my_bi_fs.1
        Container:              dp2
        Encryption:             off
        Created:                2013/04/23.04:20
        Expires:                2013/12/31.01:00
        Created by job:         admin/12.1
        UUID:                   7123078a-8e70-1030-84cd-00163e359724

ob> renbkup --nq my_bi_fs new_bi_fs

ob> ob> lsbkup --long --instances new_bi_fs
Backup image name:    new_bi_fs
    Type:                   file system
    Client:                 brhost2
    Backup level:           0
    Size:                   128.0 KB
    Backup owner:           admin
    Owner class:            admin
    Backup date and time:   2013/04/23.04:20
    Created by job:         admin/12.1
    UUID:                   7123076c-8e70-1030-84cd-00163e359724
    Instance name:          new_bi_fs.1
        Container:              dp2
        Encryption:             off
        Created:                2013/04/23.04:20
        Expires:                2013/12/31.01:00
        Created by job:         admin/12.1
        UUID:                   7123078a-8e70-1030-84cd-00163e359724

renclass

Purpose

Use the renclass command to rename an Oracle Secure Backup user class.

See Also:

• "Class Commands" for related commands

• Classes and Rights for a descriptions of the default Oracle Secure Backup classes and rights

Prerequisites

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

Syntax

renclass::=

renclass [ --nq ] { old-classname new-classname }...

Semantics

--nq

Does not display a confirmation message. Without this option, the command displays a confirmation message. "obtool Interactive Mode" describes the confirmation message.

old-classname new-classname

Renames old-classname to new-classname. Class names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.

Example

Example 3-52 Renaming a Class

This example renames class backup_admin to bkup_admin.

ob> renclass backup_admin bkup_admin
rename class backup_admin? (a, n, q, y, ?) [y]: a
ob> lsclass bkup_admin
bkup_admin

rendev

Purpose

Use the rendev command to rename a configured device.

See Also:

"Device Commands" for related commands

Prerequisites

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

Syntax

rendev::=

rendev [ --nq ] { old-devicename new-devicename }...

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.

old-devicename

Specifies the name of the existing device. Refer to "devicename" for the rules governing device names.

new-devicename

Specifies the name for the device. Refer to "devicename" for the rules governing device names.

If the device name specified already exists in the administrative domain, the command fails.

Example

Example 3-53 Renaming a Device

This example renames two tape devices.

ob> lsdev
library    lib1             in service
  drive 1  tape1            in service
library    lib2             in service
  drive 1  tape2            in service
ob> rendev tape1 t1 tape2 t2
rename device tape1? (a, n, q, y, ?) [y]: y
rename device tape2? (a, n, q, y, ?) [y]: y
ob> lsdev
library    lib1             in service
  drive 1  t1               in service
library    lib2             in service
  drive 1  t2               in service

rends

Purpose

Use the rends command to rename a dataset file or dataset directory. For example, the following command renames old_file to new_file and moves it from old_dir to new_dir:

ob> rends old_dir/old_file new_dir/new_file

The following command creates new_file in the current directory:

ob> rends old_dir/old_file new_file

See Also:

"Dataset Commands" for related commands

Prerequisites

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

Syntax

rends::=

rends [ --nq ] { old-dataset-name new-dataset-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.

old-dataset-name

Specifies the name of the existing dataset file or directory to rename. Refer to "dataset-name" for a descriptions of the dataset-name placeholder.

new-dataset-name

Specifies a name for the dataset file or directory. Note that you can use new-dataset-name to specify a dataset path. Refer to "dataset-name" for a descriptions of the dataset-name placeholder.

Example

Example 3-54 Renaming a Dataset

This example renames dataset datadir.ds in the top-level directory to tbrset/ddir.ds.

ob> lsds
Top level dataset directory:
tbrset/
datadir.ds
ob> rends --nq datadir.ds tbrset/ddir.ds
ob> cdds tbrset
ob> lsds
Dataset directory tbrset:
ddir.ds
entire_backup
tiny_backup

rendup

Purpose

Renames duplication policies.

See Also:

"Volume Duplication Commands"

Prerequisites

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

Syntax

rendup::=

rendup [ --nq/--noquery ] { oldpolicyname newpolicyname }
[ oldpolicyname newpolicyname... ]

Semantics

--nq/--noquery

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.

oldpolicyname newpolicyname

For each pair of duplication policy names, the policy with the first name in the pair is renamed to the second name in the pair

Example

Example 3-55 Renaming a Volume Duplication Policy

This example renames the voldup1 duplication policy to voldup.

ob> lsdup --long voldup1
voldup1:
    Migrate:                no
    Trigger:                lastwrite : forever
    Rule 1:                 RMAN-DEFAULT : 3
    UUID:                   db4bfd64-18af-1031-b040-00163e527899
ob> rendup --nq voldup1 voldup   
ob> lsdup
voldup      

renhost

Purpose

Use the renhost command to rename a configured Oracle Secure Backup host.

See Also:

"Host Commands" for related commands

Prerequisites

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

Syntax

renhost::=

renhost [ --nq ] [ --nocomm/-N ] { old-hostname new-hostname }...

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.

--nocomm/-N

Suppresses communication with the host computer. Use this option to rename a computer that is not connected to the network.

old-hostname

Specifies the name of the existing host to rename.

new-hostname

Specifies the name for the host. Host names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.

Example

Example 3-56 Renaming a Host

Example 3-56 displays configured hosts and then renames ndmphost1 to ndmphost.

ob> lshost
brhost2          client                            (via OB)   in service
brhost3          mediaserver,client                (via OB)   in service
sfserver1        client                            (via OB)   in service
ndmphost1        client                            (via NDMP) in service
osbsvr1          admin,mediaserver,client          (via OB)   in service
ob> renhost --nq ndmphost1 ndmphost
ob> lshost
brhost2          client                            (via OB)   in service
brhost3          mediaserver,client                (via OB)   in service
sfserver1        client                            (via OB)   in service
ndmphost         client                            (via NDMP) in service
osbsvr1          admin,mediaserver,client          (via OB)   in service

renloc

Purpose

Renames a storage location.

See Also:

"Location Commands" for related commands

Prerequisites

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

Syntax

renloc::=

renloc [ --nq ] oldlocationname newlocationname  
[ oldlocationname newlocationname... ]

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.

oldlocationname newlocationname

For each pair of location name arguments, the location with the first name in the pair is renamed to the second name in the pair.

renmf

Purpose

Use the renmf command to rename a media family.

See Also:

"Media Family Commands" for related commands

Prerequisites

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

Syntax

renmf::=

renmf [ --nq ] { old-media-family-name new-media-family-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.

old-media-family-name

Specifies the name of the existing media family. Note that you cannot rename the RMAN-DEFAULT media family.

new-media-family-name

Specifies the name for the media family. Media family names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 31 characters.

Example

Example 3-57 Renaming a Media Family

This example renames media family full_bkup to full_backup.

ob> lsmf
RMAN-DEFAULT                              content manages reuse
content-man-family write forever            content manages reuse
full_bkup        write 7 days             content manages reuse
time-man-family  write 7 days             keep 28 days
ob> renmf full_bkup full_backup
rename media family full_bkup? (a, n, q, y, ?) [y]: y
ob> lsmf
RMAN-DEFAULT                              content manages reuse
content-man-family write forever            content manages reuse
full_backup      write 7 days             content manages reuse
time-man-family  write 7 days             keep 28 days

renrot

Purpose

Renames rotation policies.

See Also:

"Rotation Policy Commands"

Prerequisites

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

Syntax

renrot::=

renrot [ -nq ] oldpolicyname newpolicyname  
[ oldpolicyname newpolicyname... ]

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.

oldpolicyname newpolicyname

For each pair of policy names, the policy with the first name in the pair is renamed to the second name in the pair. Oracle Secure Backup rotation policy names must be 1-31 characters.

rensched

Purpose

Use the rensched command to rename a schedule. Run the lssched command to display schedule names.

See Also:

"Schedule Commands" for related commands

Prerequisites

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

Syntax

rensched::=

rensched [ --nq ] { old-schedulename new-schedulename }...

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.

old-schedulename

Specifies the name of an existing schedule.

new-schedulename

Specifies a name for the old-schedulename schedule. Schedule names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They may contain at most 127 characters.

Example

Example 3-58 Renaming a Backup Schedule

Example 3-58 renames schedule full_backup to weekday_sunday_backup.

ob> lssched
full_backup         sundays, weekdays              fullbackup.ds
ob> rensched --nq full_backup weekday_sunday_backup
ob> lssched
weekday_sunday_backup sundays, weekdays              fullbackup.ds

rensnap

Purpose

Use the rensnap command to rename a snapshot.

See Also:

"Snapshot Commands" for related commands

Prerequisites

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

Syntax

rensnap::=

rensnap [ --nq ] [ --host/-h hostname ] [ --fs/-f filesystem-name ]
{ old-snapshot-name new-snapshot-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.

--host/-h hostname

Specifies the name of the Network Data Management Protocol (NDMP) host computer where you want to rename the snapshot. If you do not specify a host name, then Oracle Secure Backup uses the value from the host variable.

--fs/-f filesystem-name

Specifies the name of the file system included in the snapshot. If you do not specify the --fs option, then the fs variable must be set.

old-snapshot-name

Specifies the name of an existing snapshot.

new-snapshot-name

Specifies a name for old-snapshot-name.

Example

Example 3-59 Renaming a Snapshot

This example renames snapshot lucy_snap to lucy.0.

ob> lssnap --long lucy_snap
File system /vol/vol0:
    Max snapshots:          255
    Reserved space:           44.8 GB
    % reserved space:       30
    Snapshot:               lucy_snap
        Of:                 /vol/vol0
        Taken at:           2013/03/28.20:52
        Used %:               0
        Total %:              0
        Busy:               no
        Dependency:         no
ob> rensnap --nq --host lucy --fs /vol/vol0 lucy_snap lucy.0
ob> lssnap
File system /vol/vol0:
Snapshot Of                Taken at      %Used  %Total Snapshot Name
/vol/vol0              2013/03/28.21:00     0      0   hourly.0
/vol/vol0              2013/03/28.20:52     0      0   lucy.0
/vol/vol0              2013/03/28.17:00     0      0   hourly.1
/vol/vol0              2013/03/28.13:00     0      0   hourly.2
/vol/vol0              2013/03/28.05:00     0      0   nightly.0
/vol/vol0              2013/03/28.01:00     0      0   hourly.3
/vol/vol0              2013/03/27.21:00     0      0   hourly.4
/vol/vol0              2013/03/27.17:00     0      0   hourly.5
/vol/vol0              2013/03/27.05:00     0      0   nightly.1
/vol/vol0              2012/08/21.11:30    22      7   myhost_snap

renssel

Purpose

Use the renssel command to rename a database backup storage selector.

See Also:

"Database Backup Storage Selector Commands" for related commands

Prerequisites

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

Syntax

renssel::=

renssel [ --nq ] { old-sselname new-sselname }...

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.

old-sselname

Specifies the name of the existing database backup storage selector.

new-sselname

Specifies the name of a database backup storage selector.

Example

Example 3-60 Renaming a Database Backup Storage Selector

This example uses the mkssel command to create a storage selector and specifies the content as full. The example uses the chssel command to add archived logs to the content of the selector, then renames the selector from ssel_full to ssel_full_arch.

ob> mkssel --dbid 1557615826 --host brhost2 --content full --family f1 ssel_full
ob> chssel --addcontent archivelog ssel_full
ob> renssel ssel_full ssel_full_arch
rename ssel ssel_full? (a, n, q, y, ?) [y]: y
ob> lsssel --short
ssel_full_arch

renstage

Purpose

The renstage command renames one or more stage rules.

Prerequisites

Syntax

renstage::=

renstage [--nq] { old-stage-rule-name new-stage-rule-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.

old-stage-rule-name

Specifies the name of an existing stage rule.

new-stage-rule-name

Specifies the new name for the stage rule. The name is case-sensitive and must be no more than 31 characters long and must start with a letter. The name must be unique within the Oracle Secure Backup domain.

Example

Example 3-61 Renaming a Stage Rule

ob> renstage --nq stageruleabc stagerulexyz

rensum

Purpose

Use the rensum command to rename a job summary schedule.

See Also:

"Summary Commands" for related commands

Prerequisites

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

Syntax

rensum::=

rensum [ --nq ] { old-summary-name new-summary-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.

old-summary-name

Specifies the name of an existing job summary schedule.

new-summary-name

Specifies the name of the job summary schedule. Names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 127 characters.

Example

Example 3-62 Renaming a Job Summary Schedule

This example renames schedule weekly_report to wed_report.

ob> lssum
weekly_report            Wed at 12:00
ob> rensum --nq weekly_report wed_report
ob> lssum
wed_report               Wed at 12:00

renuser

Purpose

Use the renuser command to rename an Oracle Secure Backup user.

See Also:

"User Commands" for related commands

Prerequisites

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

Syntax

renuser::=

renuser [ --nq ] { old-username new-username }...

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.

old-username

Specifies the current Oracle Secure Backup user name.

new-username

Specifies the name for the Oracle Secure Backup user. User names are case-sensitive and must start with an alphanumeric character. They can contain only letters, numerals, dashes, underscores, and periods (no spaces). They can contain at most 127 characters.

Example

Example 3-63 Renaming an Oracle Secure Backup User

This example renames Oracle Secure Backup user bkpadmin to backup_admin.

ob> renuser --nq bkpadmin backup_admin

resdev

Purpose

Use the resdev command to reserve a tape device for your exclusive use. While you hold the reservation, no Oracle Secure Backup component accesses the device.

See Also:

"Device Commands" for related commands

Prerequisites

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

Usage Notes

During normal operations, Oracle Secure Backup temporarily assigns exclusive use of shared resources to its processes and jobs. It assigns this use through a built-in resource reservation system managed by the service daemons on the administrative server.

You might encounter situations in which you want exclusive and explicit use of a device. When such situations arise, you can direct Oracle Secure Backup to reserve a device for your use and, when you are finished, to release that reservation with the unresdev command. While you hold the reservation, no Oracle Secure Backup component can access the device.

The resdev command fails with an error if you try to reserve a device that is reserved. The command also fails if you attempt to select a tape drive in a tape library but all devices are reserved or no tape drives are configured.

Syntax

resdev::=

resdev [ --nowarn/-W ] { --in/-i libraryname ... | devicename ... }

Semantics

--nowarn/-W

Does not warn about devices that are out of service.

--in/-i libraryname

Finds and reserves any reservable tape drive in the specified libraries.

devicename

Specifies either the name of a tape drive or a tape library to be reserved.

Refer to "devicename" for the rules governing device names.

Example

Example 3-64 Reserving a Device

This example reserves all tape drives in tape library lib1. In this example, lib1 contains a single tape drive. The example shows the warnings that result from attempting to reserve a reserved tape drive.

ob> lsdev
library    lib1             in service
  drive 1  tape1            in service
library    lib2             in service
  drive 1  tape2            in service
ob> lsdev --reserved
ob> resdev --in lib1
Drive tape1 reserved.
ob> resdev --in lib1
Error: no drive is available in library lib1.
ob> resdev tape1
Error: you already have drive tape1 reserved.

resetp

Purpose

Use the resetp command to reset the value of a one or more policies to the default value.

The policy data is represented as a directory tree with / as the root. You can use cdp to navigate the tree and lsp and pwd to display data.

See Also:

• "Policy Commands" for related commands

• Defaults and Policies for a complete list of policies and policy classes

Prerequisites

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

Syntax

resetp::=

resetp [ --nq ] policy-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.

policy-name

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

Example

Example 3-65 Resetting Policies to Their Default Values

This example resets the policies in the logs class to their defaults.

ob> lsp logs
adminlogevents                   all
adminlogfile                     /tmp/logs/adminevents.log
clientlogevents                  (none)                      [default]
jobretaintime                    60 days
logretaintime                    14 days
transcriptretaintime             14 days
unixclientlogfile                (none)                      [default]
windowsclientlogfile             (none)                      [default]
ob> resetp logs
Really reset ALL logs policies [no]? y
ob>

Example 3-66 Resetting Password Policies to Their Default Values

This example resets all policies in the security class to their defaults.

ob> lsp security
autocertissue                    yes                         [default]
certkeysize                      1024                        [default]
certlifetime                     3 years                    
certwarning                      7 days                     
encryptdataintransit             no                          [default]
loginduration                    forever                    
minuserpasswordlen               0                          
passwordgracetime                10 days                    
passwordlifetime                 30 days                    
passwordreusetime                180 days                   
securecomms                      yes                         [default]
trustedhosts                     yes                         [default]
webinactivitytimeout             15 minutes                  [default]
websessiontimeout                24 hours                    [default]
ob> resetp security
Really reset ALL security policies [no]? y
ob> lsp security 
autocertissue                    yes                         [default]
certkeysize                      1024                        [default]
certlifetime                     10 years                    [default]
certwarning                      14 days                     [default]
encryptdataintransit             no                          [default]
loginduration                    15 minutes                  [default]
minuserpasswordlen               8                           [default]
passwordgracetime                3 days                      [default]
passwordlifetime                 180 days                    [default]
passwordreusetime                1 year                      [default]
securecomms                      yes                         [default]
trustedhosts                     yes                         [default]
webinactivitytimeout             15 minutes                  [default]
websessiontimeout                24 hours                    [default]

restore

Purpose

Use the restore command to create a file-system restore request. File-system restore operations are distinct from database restore operations, which are initiated by Recovery Manager (RMAN).

You can use the restore command to perform catalog-based or raw restore operations. In a catalog-based restore, you browse the catalog for the objects to be restored. When you have located their names and selected the instances, you can restore the objects. In a raw restore, you must have independent knowledge of the secondary storage location (volume ID and backup image file number) of a backup. You can either restore all data in the backup or specify an individual file or directory.

A restore request is held locally in obtool until you run the restore command with the --go, --gocatalog, or --goraw option, at which time Oracle Secure Backup converts all restore requests into jobs and sends them to the Oracle Secure Backup scheduler.

See Also:

"Restore Commands" for related commands

Prerequisites

If you have specified that the restore run in privileged mode, or if you are restoring files to a host accessed through Network Data Management Protocol (NDMP), then you must have the right to perform file system restores as privileged user to use the restore command. Otherwise, you must have the right to perform file system restores as self.

Usage Notes

obtool uses the host variable to determine the name of the host whose backups are being restored. The default value for host is the name of the host on which obtool is running. You can set the host variable with the set or cd command.

If you specify a volume ID that matches multiple volumes in the Oracle Secure Backup volumes catalog, then Oracle Secure Backup asks which volume or volumes you want to recall. You can select one or more of the volumes, all of them, or none of them. The default selection is all volumes.

If you specify a volume ID and the volume belongs to a volume set, then Oracle Secure Backup lists all volumes in the volume set. You can select all or none of them, but you cannot select individual members of the volume set. The default selection is quit.

You can use Oracle Secure Backup wildcard pattern matching while performing the restore operation.

See Also:

"chvol" for a pair of examples illustrating volume ID matching

See Also:

find for a description on wildcard characters and pattern matching.

Syntax 1

Use the following syntax to restore data by browsing the Oracle Secure Backup catalog.

restore::=

restore 
[ --tohost/-h hostname ] 
[ --device/-d drivename ]
[ --privileged/-g | --unprivileged/-G ]
[ --replaceexisting/-e | --keepexisting/-E ]
[ --replaceinuse/-u | --keepinuse/-U ] 
[ --incremental/-i ]
[ --noposition/-X ] 
[ --priority/-p schedule-priority ]
[ --select/-s data-selector[,data-selector]... ]
[ --passphrase/-P string | --querypassphrase/-Q  ]
[ --algorithm/-l enc_algorithm] 
[ --ignoremismatch/-w]
[ --obtaropt/-o obtar-option ]... [--waitfor/-W <duration>]
[[ --recall/-r ] [--immediate/-I]| [--preview	/-y] | --go | --gocatalog | --goraw ]
pathname [ --aspath/-a pathname ] ...

Semantics 1

--tohost/-h hostname

Specifies the name of the host computer to which you want to restore data.

--device/-d drivename

Specifies a tape drive used to perform the restore operation. The tape drive name must be a valid device name. Refer to "devicename" for the rules governing device names.

--privileged/-g

Specifies that the restore operation should run in privileged mode.

On UNIX systems, a privileged restore job runs under the root user identity. On Windows systems, the job runs under the same account identity as the Oracle Secure Backup service on the Windows client.

--unprivileged/-G

Specifies that the restore operation should run in unprivileged mode (default).

An unprivileged restore job runs under the UNIX user or Windows account identity specified in the mkuser command. Access to file-system data is constrained by the rights of the UNIX user or Windows account having this identity.

--replaceexisting/-e

Overwrites existing files (default).

--keepexisting/-E

Does not overwrite existing files.

--replaceinuse/-u

Replaces in-use files with those from the backup image instance. Windows deletes each in-use file when the last user closes it. This option is available on Windows only.

--keepinuse/-U

Leaves in-use files unchanged (default). This option is available on Windows only.

--incremental/-i

Directs Network Attached Storage (NAS) data servers to apply incremental restore rules. This option applies only to NAS data servers that implement this feature. This option does not apply to a file-system backup created with obtar.

Normally, restore operations are additive: each file and directory restored from a full or an incremental backup is added to its destination directory. If files have been added to a directory since the most recent Oracle Secure Backup backup, then a restore operation does not remove the newly added files.

When you specify --incremental, NAS data servers restore each directory to its state during the last incremental backup. Files that were deleted before the last incremental backup are deleted by the NAS data service when restoring this incremental backup.

For example, assume you make an incremental backup of /home, which contains file1 and file2. You delete file1 and make another incremental backup of /home. After a normal restore of /home, the directory would contain file1 and file2; after an NDMP incremental restore of /home, the directory would contain only file2.

--noposition/-X

Indicates that Oracle Secure Backup should not use available position data to speed the restore operation. You might use this option if position data is corrupted.

--priority/-p schedule-priority

A schedule priority you assign to a restore.

See "schedule-priority" for more information on the schedule-priority placeholder.

--select/-s data-selector

Filters data based on the specified data-selector.

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

--passphrase/-p

Specifies a passphrase-generated decryption key for the entire backup volume set to be restored.

--querypassphrase/-Q

Queries the operator for a passphrase to use in generating decryption keys for the entire backup volume set to be restored.

--algorithm/-l

Specifies the backup algorithm to use for decryption during restore. Required if --passphrase is used.

--ignoremismatch/-w

Causes mismatches of the encryption algorithm or passphrase as supplied by the --algorithm or --passphrase options to be treated as warnings instead of failures. This option is targeted at the situation where the header on the tape has been corrupted, but you still want to recover as much of the encrypted data as possible.

Mismatched encryption parameters are processed at different times depending on the restore type. For a raw restore the mismatch is caught and handled after the job is created, the tape is loaded, and the header is read off the tape. The job transcript for the raw restore reflects the encryption parameter mismatch. For a catalog-based restore, however, the mismatch is caught immediately and the job is never created.

Note:

The risk with restoring data using the incorrect --algorithm or --passphrase is that the restored data will be garbled on the disk.

--obtaropt/-o obtar-option

Specifies obtar options. For example -J enables debug mode and provides more details in the restore transcript.

See "obtar Options" for more information on obtar options.

–waitfor/-W duration

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

See duration for more information on the duration placeholder.

--preview/-y

Lists the volumes needed for a restore and gets their status as either onsite or offsite. An onsite status means that the volume is in a library or drive. An offsite status means that the volume is in a storage location and must be recalled.

This option is available only for catalog restore operations. It is not supported for raw restore operations.

--recall/-r

Starts recalls for any volumes needed by a restore if the volumes are offsite.

This option is available only for catalog restore operations. It is not supported for raw restore operations.

--go

Releases all queued restore requests to the Oracle Secure Backup scheduler.

--gocatalog

Releases queued restore requests from a backup catalog to the Oracle Secure Backup scheduler.

--goraw

Releases queued raw restore requests to the Oracle Secure Backup scheduler. A raw restore request does not use backup catalog data.

pathname

Specifies the path name obtained by browsing the backup catalog for files that you backed up. If you do not specify --aspath, then Oracle Secure Backup restores the backup to the same path. If pathname does not exist on the host to which you are restoring, then Oracle Secure Backup creates it.

For example, assume that you browse the backup catalog for brhost2 and locate the /home directory, which you want to restore. The restore /home command restores the backup to the /home directory on brhost2.

--aspath/-a pathname

Specifies an alternative path name where Oracle Secure Backup can restore the files. For example, to restore a backup of /home to /tmp/home, specify restore /home --aspath /tmp/home.

Note that if pathname does not exist on the host to which you are restoring, then Oracle Secure Backup creates it.

Syntax 2

Use the following syntax for raw restore operations.

restore::=

restore --raw/-R [ --tohost/-h hostname ] [ --device/-d drivename ]
[ --privileged/-g | --unprivileged/-G ]
{ --filenumber/-F filenumber }
{ --vid/-v vid[,vid ]... } [ --tag/-t tag[,tag]... ]
[ --replaceexisting/-e | --keepexisting/-E ]
[ --replaceinuse/-u | --keepinuse/-U ] [ --incremental/-i ]
[ --priority/-p schedule-priority ]
[ {--passphrase/-P <passphrase>} | --querypassphrase/-Q ]
[--algorithm/-l <enc-algorithm>] [--ignoremismatch/-w]
[ --obtaropt/-o obtar-option ]... [--waitfor/-W <duration>]
[ --go | --gocatalog | --goraw ]
{ --all/-A pathname | {[ --aspath/-a pathname ] [ --position/-x position ] ... }}

Semantics 2

This section describes additional options used in Syntax 2. Options that are also used with Syntax 1 are not described in this section.

--raw/-R

Specifies a raw restore operation, which is a restore operation that does not use an Oracle Secure Backup catalog. You must specify the identity (volume ID or barcode) of the tape volumes to which the file-system objects were backed up and the backup image instance file number in which they are stored.

--filenumber/-F filenumber

Specifies the file number on the tape where the backup is located. Refer to "filenumber" for a description of the filenumber placeholder.

--vid/-v vid

Selects backups based on volume ID. Refer to "vid" for a description of the vid placeholder.

--tag tag

Selects backups based on the volume tag (barcode).

--all/-A

Restores all data in the backup.

pathname

Specifies the absolute path name of the file or directory that you backed up. If you do not know the absolute path names for the files when they were backed up, then you can use obtar -tvf to find them or restore an entire backup image instance. If you do not specify --aspath, then Oracle Secure Backup restores the backup to the same path.

Oracle Secure Backup does not support the use of wildcard characters in restore path names. The following wildcard characters are supported for backup include paths: *, ?, [, and ]. If you have path names to restore that include any of these wildcard characters, then no special escaping is required for the restore command.

Note that if pathname does not exist on the host to which you are restoring, then Oracle Secure Backup creates it.

--aspath/-a pathname

Specifies an alternative path name where Oracle Secure Backup can restore the files. For example, to restore a backup of /private/bkpadmin to /tmp/private/bkpadmin, specify the following:

restore /private/bkpadmin --aspath /tmp/private/bkpadmin

Note that if pathname does not exist on the host to which you are restoring, then Oracle Secure Backup creates it.

--position/-x position

Specifies the position of the data on the tape.

Examples

Example 3-67 Performing a Raw Restore Operation Based on the Oracle Secure Backup Catalog

This example displays the latest backup image instance of the /home/data directory stored in the Oracle Secure Backup catalog. The restore command submits the request to the scheduler with priority 1. Oracle Secure Backup runs the job and restores the data.

ob> set host brhost2
ob> cd /home/data
ob> ls
bin/  c_files/  tree/
ob> lsbackup latest
      Backup       Backup  Volume            Volume       File Sect Backup
   Date and Time       ID  ID                Tag             #    #  Level
2013/03/28.11:17:02     2  VOL000003         ADE201          1    1      0
ob> restore --select latest --priority 1 --go /home/data
Info: 1 catalog restore request item submitted; job id is admin/16.
ob> lsjob admin/16
Job ID           Sched time  Contents                       State
---------------- ----------- ------------------------------ ---------------------------------------
admin/16          none        restore 1 item to brhost2      completed successfully at 
                                                            2013/03/29.16:34

Example 3-68 Performing a Raw Restore Operation

This example submits a raw restore request to the scheduler. The request specifies that the /home/data directory should be restored from volume VOL000003. Oracle Secure Backup runs the job and restores the data.

ob> restore --raw --filenumber 1 --vid VOL000003 /home/data
ob> restore --go
Info: raw restore request 1 submitted; job id is admin/76.
ob> lsjob admin/7
Job ID           Sched time  Contents                       State
---------------- ----------- ------------------------------ ---------------------------------------
admin/7          none        restore 1 item to brhost2      completed successfully at
                                                            2013/03/29.17:00

Example 3-69 Performing a Catalog Based Restore using Oracle Secure Backup Wildcard Pattern Matching

restore --tohost brhost2 --select latest --incremental --priority 100 --go /tmp*

returndev

Purpose

Use the returndev command to return a tape drive that you borrowed with the borrowdev command.

See Also:

"Device Commands" for related commands

Prerequisites

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

Syntax

returndev::=

returndev { drivename... | --all/-a }

Semantics

drivename

Specifies the name of the tape drive to return.

--all/-a

Returns all the tape drives that you currently have borrowed.

Example

Example 3-70 Returning Borrowed Devices

This example returns all borrowed devices.

ob> returndev --all

reusevol

Purpose

Use the reusevol command to recycle selected volumes. Oracle Secure Backup loads the selected volumes and deletes their backup image instances.

Each volume has a volume label stored at Beginning of Tape (BOT). The label consists of the volume ID, the barcode tag (if any), and other information about the volume. The reusevol command is similar to the unlabelvol command, but reusevol directs Oracle Secure Backup to preserve the existing volume label.

See Also:

"Library Commands" for related commands

Prerequisites

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

Syntax

reusevol::=

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

Semantics

--drive/-D drivename

Specifies the name of the tape drive to be used to relabel the volume. If you do not specify a tape drive name, then the drive variable must be set.

--force/-f

Forces the reuse of a volume. Oracle Secure Backup disregards the expiration date, if any, found in the volume label. If the --force option is not employed and the volume is not expired, then reusevol fails.

--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 the range of storage elements holding the volumes to be reused. If omitted, then the volume currently loaded in the tape drive is reused. Refer to "se-range" for a description of the se-range placeholder.

Example

Example 3-71 Reusing a Volume

This example displays information about the tape located in storage element 2 of tape library lib1. The volume in this storage element is not empty. The reusevol command forcibly reuses the volume, thereby deleting its contents and removing its volume ID. The barcode of the volume is retained. Note that the sample output has been reformatted to fit on the page.

ob> lsvol --long --library lib1
Inventory of library lib1:
    in    mte:           vacant
    in    1:             barcode ADE202, oid 117, 47447360 kb remaining, content manages reuse
    in    2:             volume VOL000004, barcode ADE204, oid 120, 47420448 kb remaining
    in    3:             barcode ADE201, oid 116, 47462976 kb remaining
    in    4:             volume VOL000001, barcode ADE200, oid 102, 47424064 kb remaining
    in    iee1:          barcode ADE203, oid 114, 47725344 kb remaining, 
                         lastse 4
    in    iee2:          vacant
    in    iee3:          vacant
    in    dte:           vacant
ob> lsvol --barcode ADE204 --content
    VOID Seq Volume ID          Barcode     Family                Created     Attributes
     120   1 VOL000004          ADE204   04/01.09:16 never closes
        BSOID  File Sect  Level  Host             Created     Attributes
          172     1 1         0  brhost2          04/01.09:16
ob> reusevol --drive tape1 --force 2
ob> lsvol --barcode ADE204 --content
    VOID Seq Volume ID          Barcode     Family      Created     Attributes
     122                        ADE204

revhost

Purpose

Use the revhost command to revoke a host identity certificate.

See Also:

• Oracle Secure Backup Installation and Configuration Guide for more information on revoking a host identity certificate

• "Host Commands" for related commands

Prerequisites

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

Syntax

revhost::=

revhost [ --nq ] hostname...

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.

hostname

The name of the host whose identity certificate is to be revoked.

rmauth

Purpose

Use the rmauth command to remove authentication objects. Removing an authentication object will fail if any cloud storage device references the object. To remove a referenced object, you must either modify cloud storage devices that reference the object so that they reference a different authentication object, or remove cloud storage devices that reference the object.

Without the --nq/--noquery option, rmauth queries how to proceed with the remove operation.

Prerequisites

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

Syntax

Use the following syntax to remove authentication objects.

Semantics

rmauth::=

rmauth [--nq/--noquery] {authobj-name} ...

[--nq/--noquery]

(need description)

[authobj-name]

Specifies authentication objects to remove. rmauth accepts multiple authentication object names.

Examples

Example 3-72 Showing rmauth Query Options

This example shows the rmauth query options, without removing the authentication object.

ob> rmauth auth_05
remove auth object auth_05? (a, n, q, y, ?) [n]: ?
Enter 'a' to remove auth_05 and all remaining auth objects
      'n' to not remove auth_05
      'q' to not remove auth_05 or any more auth objects
      'y' to remove auth_05
      '?' to repeat this message
remove auth object auth_05? (a, n, q, y, ?) [n]: n
ob>

Example 3-73 Removing an Authentication Object Without Query

This example removes an authentication object without requiring confirmation.

ob> lsauth
auth_01          
auth_05          
ob> rmauth --nq auth_05
ob> lsauth
auth_01          
ob>

rmbackup

Purpose

Use the rmbackup command to remove a backup request, set of backup requests, or all backup requests that are queued in obtool. A backup request is held locally in obtool until you run the backup command with the --go option, at which time Oracle Secure Backup makes each backup request into a dataset backup job and forwards it to the scheduler.

See Also:

"Backup Commands" for related commands

Prerequisites

You must have the perform file system backups as privileged user right if you specified the --privileged option when you requested the backup. Otherwise, you must have the perform file system backups as self right.

Syntax

rmbackup::=

rmbackup { --all/-a | backup-item... }

Semantics

--all/-a

Removes all backup requests in the queue.

backup-item

Specifies an identifier assigned by obtool to a backup request created with the backup command. The identifier is a small integer number. Run the lsbackup command with the --long option to display backup identifiers.

Example

Example 3-74 Deleting a Backup Request

This example queries the backup requests awaiting delivery to the scheduler and deletes the backup request with the identifier 2.

ob> lsbackup --long
1:
    Dataset:                fullbackup.ds
    Media family:           (null)
    Backup level:           full
    Priority:               100
    Privileged op:          no
    Eligible to run:        upon "backup --go"
    Job expires:            never
    Restriction:            any device
2:
    Dataset:                partialbackup.ds
    Media family:           (null)
    Backup level:           full
    Priority:               100
    Privileged op:          no
    Eligible to run:        upon "backup --go"
    Job expires:            never
    Restriction:            any device
ob> rmbackup 2
ob> lsbackup --long
1:
    Dataset:                fullbackup.ds
    Media family:           (null)
    Backup level:           full
    Priority:               100
    Privileged op:          no
    Eligible to run:        upon "backup --go"
    Job expires:            never
    Restriction:            any device

rmbw

Purpose

Use the rmbw command to remove a backup window or specific time ranges. The command displays an error if no backup windows within the specified range exist.

See Also:

"Backup Window Commands" for related commands

Prerequisites

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

Syntax

rmbw::=

rmbw [ --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 3-75 Removing Backup Windows

This example removes the backup windows created by the addbw command in Example 2-1.

ob> rmbw --times 00:00-08:00 mon-friob> rmbw --times 20:00-24:00 mon-friob> rmbw --times 08:00-20:00 weekend

rmcheckpoint

Purpose

Use the rmcheckpoint command to remove checkpoint information for the specified jobs. When you issue this command, Oracle Secure Backup immediately removes all administrative-host resident checkpoint data for the specified job. It cleans up filer-resident data at the beginning of the next backup of this filer or within 24 hours, whichever comes first.

If no checkpoints exist, then obtool displays the following error message:

Error: no checkpoints matched the selection criteria.

See Also:

"Checkpoint Commands" for related commands

Prerequisites

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

Syntax

rmcheckpoint::=

rmcheckpoint [ --nq ] { { --host/-h hostname[,hostname]... }... | --all/-a | 
job-id... }

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.

--host/-h hostname

Deletes all checkpoints describing the client host specified by hostname.

--all/-a

Deletes all checkpoints within the administrative domain.

job-id

Deletes the checkpoint identified by job ID job-id.

Example

Example 3-76 Removing Checkpoints

This example removes two checkpoints: one specified by job ID and the other by host.

ob> rmcheckpoint 1660.3
ob> rmcheckpoint --host brhost2,brhost3

rmclass

Purpose

Use the rmclass command to remove an Oracle Secure Backup user class from an administrative domain.

See Also:

• "Class Commands" for related commands

• Classes and Rights for a descriptions of the default Oracle Secure Backup classes and rights

Prerequisites

You must have the modify administrative domain's configuration right to use the rmclass command. The class must be empty, that is, have no Oracle Secure Backup users, to be deleted.

Syntax

rmclass::=

rmclass [ --nq ] classname...

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.

classname

Specifies the name of the class to delete.

Example

Example 3-77 Removing a Class

This example confirms that the bkup_admin class exists, deletes it, and then confirms that the class is deleted.

ob> lsclass bkup_admin
bkup_admin
ob> rmclass --nq bkup_admin
ob> lsclass bkup_admin
Error: class bkup_admin - name not found

rmdev

Purpose

Use the rmdev command to remove a device from an administrative domain or to move it from one location to another within the administrative domain. You can run the mkdev command to reconfigure a device for use by Oracle Secure Backup.

See Also:

"Device Commands" for related commands

Prerequisites

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

Usage Notes

• When you remove a disk pool or cloud storage device, Oracle Secure Backup does not automatically delete its contents. The contents are deleted only if you specify the --deletecontents option. Regardless of whether its contents are deleted or not, all backup catalog data associated with backup image instances contained in the disk pool or cloud storage device is deleted from the backup catalog. The catalog data is deleted during the next regular catalog cycle as specified by the index/indexcleanup policy.

Syntax

rmdev::=

rmdev [ --nq ] [ --migrate/-m new_devicename ]
[--deletecontents/-d] [--force/-f]
devicename...

Semantics

--nq

Does not display a confirmation message before removing the device from the administrative domain. If you do not specify this option, then the command displays a confirmation message. "Command Execution in Interactive Mode" describes the confirmation message.

--migrate/-m new_devicename

Logically migrates all volumes that have references to the location corresponding to devicename to the location corresponding to new_devicename. The --migrate option can specify only one device name at a time.

--deletecontents/-d

Deletes all content from a cloud storage device (and also removes the cloud container), or deletes all backup image instances stored in the disk pool. If the container contains unexpired backup image instances, then Oracle Secure Backup displays a message indicating that the --force option must be used to delete the contents.

--force/-f

Deletes all backup image instances, even if they are valid and not expired.

devicename

Specifies the name of the device to remove or move to a different location. Refer to "devicename" for the rules governing device names.

Example

Example 3-78 Removing a Tape Drive

This example removes a tape drive from a tape library.

ob> lsdev
library    lib1             in service
  drive 1  tape1            in service
library    lib2             in service
  drive 1  tape2            in service
  drive 2  tape2a           in service
ob> rmdev tape2a
Warning: removing a device to which a job is restricted will cause the job
         to become unusable.
remove device tape2a? (a, n, q, y, ?) [n]: y
ob> lsdev
library    lib1             in service
  drive 1  tape1            in service
library    lib2             in service
  drive 1  tape2            in service

Example 3-79 Removing a Disk Pool and Its Contents

This example removes a disk pool dp2 and its contents. The --force option indicates that unexpired backup image instances must also be deleted.

ob> rmdev --deletecontents --force dp2
Warning: removing a device to which a job is restricted will cause the job
         to become unusable.
remove device dp2? (a, n, q, y, ?) [n]: y

rmds

Purpose

Use the rmds command to remove a dataset file or dataset directory.

See Also:

"Dataset Commands" for related commands

Prerequisites

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

Syntax

rmds::=

rmds [ --nq ] dataset-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.

dataset-name

Specifies the name of the dataset directory or dataset file that you created with the mkds or rends command. Refer to "dataset-name" for a description of the dataset-name placeholder.

Example

Example 3-80 Removing a Dataset

This example removes a dataset directory named mydatasets and a dataset file named full_backup.ds.

ob> lsds
Top level dataset directory:
mydatasets/
full_backup.ds
ob> rmds --nq mydatasets
ob> lsds
Top level dataset directory:
full_backup.ds
ob> rmds --nq full_backup.ds
ob> lsds
Top level dataset directory:
ob>

rmdup

Purpose

Removes one or more duplication policies.

See Also:

"Volume Duplication Commands"

Prerequisites

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

Syntax

rmdup::=

rmdup [ -nq/--noquery ] { policyname } [ policyname ]...

Semantics

-nq/--noquery

By default, the backup administrator is prompted before the duplication policy is removed. With --nq, no confirmation is requested.

policyname

The duplication policy with the specified name is removed.

Example

Example 3-81 Removing a Duplication Policy

This example removes the voldup duplication policy.

ob> lsdup
voldup           
ob> rmdup --nq voldup
ob> lsdup
ob> 

rmdw

Purpose

Use the rmdw command to remove a duplication window.

See Also:

"Duplication Window Commands" for related commands

Prerequisites

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

Syntax

rmdw::=

rmdw { --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 3-82 Removing a Duplication Window

This example removes an existing duplication window.

ob> lsdw09/30 15:30-16:30:30weekend 10:00-21:00weekday 10:00-20:00b> rmdw --times 0900-0930 tuesday
ob> lsdw
09/30 15:30-16:30:30
weekend 10:00-21:00
Mon Wed-Fri 10:00-20:00

rmhost

Purpose

Use the rmhost command to remove a host from the Oracle Secure Backup administrative domain. When you remove a host, Oracle Secure Backup destroys all information pertinent to the host, including:

• Configuration data

• Incremental backup state information

• Metadata in the backup catalog

• Device attachments

• PNI (Preferred Network Interface) references

Moreover, when you remove a UNIX or Windows host, Oracle Secure Backup contacts that host and directs it to delete the administrative domain membership information that it maintains locally. You can suppress this communication if the host is no longer accessible.

See Also:

"Host Commands" for related commands

Prerequisites

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

Usage Notes

• The rmhost command fails if there are any stage rules that contain the Oracle Secure Backup host name. All stage rules that contain the Oracle Secure Backup host name are listed in the error message.

• If you attempt to delete a host that is contained in a stage rule, then the rmhost command fails with an error.

Syntax

rmhost::=

rmhost [ --nq ] [ --nocomm/-N ] hostname...

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.

--nocomm/-N

Suppresses communication with the host computer. Use this option to remove a computer that is not connected to the network. This option does not apply to hosts accessible only through Network Data Management Protocol (NDMP).

hostname

Specifies the name of the host to remove.

Example

Example 3-83 Removing a Host

This example shows that brhost4 is not in service and then removes brhost4 from the administrative domain.

ob> lshost
brhost2          client                            (via OB)   in service
brhost3          mediaserver,client                (via OB)   in service
brhost4          client                            (via OB)   not in service
sfserver1        client                            (via OB)   in service
osbsvr1          admin,mediaserver,client          (via OB)   in service
ob> rmhost --nq --nocomm brhost4
ob> lshost
brhost2          client                            (via OB)   in service
brhost3          mediaserver,client                (via OB)   in service
sfserver1        client                            (via OB)   in service
osbsvr1          admin,mediaserver,client          (via OB)   in service

rminstance

Purpose

The rminstance command deletes backup image instances from disk pool and cloud storage devices.

Prerequisites

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

Usage Notes

You can use the rminstance command only to delete backup image instances that are stored on disk pool or cloud storage devices. When you delete a backup image instance, Oracle Secure Backup removes the associated information from the backup catalog. If all the backup image instances associated with a particular backup image are stored on disk pool or cloud storage devices, then Oracle Secure Backup removes the backup image also when the last backup image instance is deleted.

If the backup image instance specified in the rminstance command is currently being used in another operation (for example, in a cpinstance command), then Oracle Secure Backup marks this instance for deletion and deletes it after the operation is completed.

Syntax

rminstance::=

rminstance [--nq] [--force/-f]
{ [--uuid/-u backup-instance-uuid]... | backup-instance-name... }

Semantics

--nq

Specifies that no confirmation is required before removing the backup image instance.

--force/-f

Forces a delete of the backup image instance even if it has not expired. Use this option to remove active backup image instances that are unexpired.

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

Specifies the UUID or name of the backup image instance that must be deleted. If the specified instance has not expired, then you cannot delete it unless you use the --force option.

Examples

This example deletes the backup image instance bk_fs_test.3 that is stored on the disk pool dp1. The --force option is used because the backup image instance has not expired. Oracle Secure Backup asks for confirmation before deleting the backup image instance.

ob> rminstance --force bk_fs_test.3
Info: backup instance bk_fs_test.3 has not expired
delete backup instance bk_fs_test.3? (a, n, q, y, ?) [n]: y

rmjob

Purpose

Use the rmjob command to remove jobs. Removing a job has the effect of canceling it and deleting all record of the existence of the job and its subordinate jobs. You can remove a job only if it is not running. After removing a job, you cannot view its status.

See Also:

"Job Commands" for related commands

Prerequisites

If you are attempting to remove the jobs of another Oracle Secure Backup user, then you must have the right to modify any job, regardless of its owner. If you are attempting to remove your own jobs, then you must have the right to modify any jobs owned by user.

Syntax

rmjob::=

rmjob [ --nq ] [ --keepxcr/-k ] [ --quiet/-q | --verbose/-v ] job-id...

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.

--keepxcr/-k

Keeps the job transcript. The default is to delete the transcript of the job.

--quiet/-q

Removes the job quietly.

--verbose/-v

Displays verbose output about the job removal.

job-id

Specifies the job IDs of the jobs to remove.

Example

Example 3-84 Removing a Job

This example displays all active and pending jobs and removes them.

ob> lsjob
Job ID           Sched time  Contents                       State
---------------- ----------- ------------------------------ ----------------------
sbt/13           03/23.00:00 dataset fullbackup.ds          future work
ob> rmjob --nq sbt/13
Info: removing job sbt/13.
ob> lsjob
ob>

rmloc

Purpose

Use the rmloc command to remove a location.

See Also:

"Location Commands" for related commands

Prerequisites

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

Syntax

rmloc::=

rmloc [ --nq ] locationname...

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.

locationname

Specifies the location to remove, using its location name.

rmmf

Purpose

Use the rmmf command to remove a media family.

Removing a media family does not affect the metadata on tapes that were originally written using that media family.

See Also:

"Media Family Commands" for related commands

Prerequisites

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

Usage Notes

• The rmmf command fails if any there are any stage rules that contain the media family. All stage rules that contain the media family are listed in the error message.

Syntax

rmmf::=

rmmf [ --nq ] media-family-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.

media-family-name

Specifies the name of the media family you want to remove. Note that you cannot remove the RMAN-DEFAULT media family.

Example

Example 3-85 Removing Media Families

This example removes the media families named content-man-family and time-man-family.

ob> lsmf
RMAN-DEFAULT                              content manages reuse
content-man-family write forever          content manages reuse
full_backup      write 7 days             content manages reuse
time-man-family  write 7 days             keep 28 days
ob> rmmf --nq content-man-family time-man-family
ob> lsmf
RMAN-DEFAULT                              content manages reuse
full_backup      write 7 days             content manages reuse

rmp

Purpose

Use the rmp command to remove a variable name-value pair from a policy.

See Also:

• "Policy Commands" for related commands

• Defaults and Policies for a complete list of policies and policy classes

Prerequisites

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

Syntax

rmp::=

rmp policy-name member-name...

Semantics

policy-name

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

member-name

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

Example

Example 3-86 Enabling Verbose Output from the NDMP Data Service

This example uses the rmp command to unset the VERBOSE environment variable for an ndmp/backupev policy. Example 2-3 shows how to set the variable for the policy.

ob> pwdp
/
ob> lsp ndmp/backupev
backupev                         VERBOSE        y
ob> rmp ndmp/backupev VERBOSE
ob> lsp ndmp/backupev
backupev                         (none)                      [default]

rmpiece

Purpose

Use the rmpiece command to delete a Recovery Manager (RMAN) backup piece from the Oracle Secure Backup catalog. This command scans the catalog and updates it to be in sync with the RMAN catalog. If a backup piece has been removed from he RMAN catalog, the rmpiece command ensures that the same backup piece and related database backup information is also removed from the Oracle Secure Backup catalog.

This command cannot be undone and therefore must be used sparingly. Using RMAN is the recommended method for managing backup pieces.

See Also:

"Backup Piece Commands" for related commands

Prerequisites

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

Syntax

rmpiece::=

rmpiece [ --nq ] [ --oid/-o oid-list ]... [ piecename ]...

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.

--oid/-o oid-list

Specifies or more backup piece identifiers in the Oracle Secure Backup catalog. Refer to "oid" for a description of the oid placeholder.

piecename

Specifies the names of the backup pieces to which the listing applies. The name of a backup piece is indicated by the Piece name heading in the lspiece output.

Example

Example 3-87 Removing Backup Pieces

This example displays information about two RMAN backup pieces and then deletes them.

ob> lspiece
    POID Database   Content    Copy Created      Host             Piece name
     104 ob         full          0 03/18.16:25  osbsvr1          05gfkmq9_1_1
     105 ob         archivelog    0 03/18.16:32  osbsvr1          06gfkn8h_1_1
ob> rmpiece --oid 104,105
remove backup piece OID 104? (a, n, q, y, ?) [n]: y
remove backup piece OID 105? (a, n, q, y, ?) [n]: y
ob> lspiece
ob>

rmpni

Purpose

Use the rmpni command to remove PNI (Preferred Network Interface) definitions.

See Also:

"Preferred Network Interface Commands" for related commands

Prerequisites

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

Syntax 1

Use the following syntax to remove all PNIs defined for a server.

rmpni::=

rmpni server-hostname...

Syntax 2

Use the following syntax to remove a client host from all PNI definitions.

rmpni::=

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

Syntax 3

Use the following syntax to remove all PNIs that use a specific interface on a server.

rmpni::=

rmpni [ --interface/-i server-ipname[,server-ipname]... ]...

Syntax 4

Use the following syntax to remove a client host from the PNI defined for the specified server.

rmpni::=

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

Semantics

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

Specifies one or more client hosts from which you want to remove PNIs.

--interface/-i server-ipname[,server-ipname]...

Specifies the IP address or the DNS name of the interface to be removed.

server-hostname

Specifies the name of the server computer.

Examples

Example 3-88 Removing All PNI Definitions for a Host

This example uses the syntax shown in Syntax 1 to remove all network interfaces for host brhost3.

ob> lspni
brhost2:
    PNI 1:
        interface:          192.0.2.1
        clients:            osbsvr1, brhost4, sfserver1
brhost3:
    PNI 1:
        interface:          192.0.2.200
        clients:            osbsvr1, brhost4, sfserver1
ob> rmpni brhost3
ob> lspni
brhost2:
    PNI 1:
        interface:          192.0.2.1
        clients:            osbsvr1, brhost3, sfserver1

Example 3-89 Removing a Client from All PNI Definitions

This example uses the syntax shown in Syntax 2 to remove the client hosts sfserver1 and osbsvr1 from all network interfaces definitions.

ob> lspni
brhost2:
    PNI 1:
        interface:          192.0.2.1
        clients:            osbsvr1, brhost4, sfserver1
brhost3:
    PNI 1:
        interface:          192.0.2.200
        clients:            osbsvr1, brhost4, sfserver1
ob> rmpni --client sfserver1,osbsvr1
ob> lspni
brhost2:
    PNI 1:
        interface:          192.0.2.1
        clients:            brhost4
brhost3:
    PNI 1:
        interface:          192.0.2.200
        clients:            brhost4

Example 3-90 Removing All PNI Definitions That Use a Specified Interface

This example uses the syntax shown in Syntax 3 to remove all PNIs that use interface 192.0.2.1 on a server.

ob> lspni
brhost2:
    PNI 1:
        interface:          192.0.2.1
        clients:            osbsvr1, brhost4, sfserver1
brhost3:
    PNI 1:
        interface:          192.0.2.200
        clients:            osbsvr1, brhost4, sfserver1
ob> rmpni --interface 192.0.2.1
ob> lspni
brhost3:
    PNI 1:
        interface:          192.0.2.200
        clients:            osbsvr1, brhost4, sfserver1

Example 3-91 Removing Clients from a PNI Definition

This example uses the syntax shown in Syntax 4 to remove the clients osbsvr1 and sfserver1 from the PNI definition for server brhost2.

ob> lspni
brhost2:
    PNI 1:
        interface:          192.0.2.1
        clients:            osbsvr1, brhost4, sfserver1
ob> rmpni --client osbsvr1,sfserver1 brhost2
ob> lspni
brhost2:
    PNI 1:
        interface:          192.0.2.1
        clients:            brhost4

rmrestore

Purpose

Use the rmrestore command to remove a restore request from the queue.

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

rmrestore::=

rmrestore { --all /-a | restores-item... }

Semantics

--all

Removes all restore requests.

restores-item

Specifies the item number of the restore request to remove. You can display the item numbers for restore requests by running the lsrestore command.

Example

Example 3-92 Removing a Restore Request

This example removes a queued restore request by specifying its item number.

ob> lsrestore
Item     Restore data saved from...          To...
  #      Host        Path                    Host        Path
1        brhost2     /home/data/backup       brhost2     (original location)
ob> rmrestore 1
ob> lsrestore

rmrot

Purpose

Removes rotation policies.

See Also:

"Rotation Policy Commands"

Prerequisites

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

Syntax

rmrot::=

rmrot
   --noquery/-nq   
    rotationname [ rotationname... ]

Semantics

--noquery/-nq

By default, the backup administrator is prompted before the policy is removed. With --noquery, no confirmation is requested.

rotationname

The name of the rotation policy to remove.

rmsched

Purpose

Use the rmsched command to remove a backup schedule. Run the lssched command to display backup schedules.

See Also:

"Schedule Commands" for related commands

Prerequisites

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

Syntax

rmsched::=

rmsched [ --nq ] schedulename...

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.

schedulename

Specifies the name of the schedule to remove.

Example

Example 3-93 Removing a Backup Schedule

Example 3-93 removes the backup schedule named incremental.

ob> lssched
full_backup         sundays                        homedir.ds
incremental         mondays tuesdays wednesdays thursdays homedir.ds
ob> rmsched --nq incremental
ob> lsschedfull_backup         sundays                        homedir.ds

rmsection

Purpose

Use the rmsection command to inform Oracle Secure Backup that a backup section is deleted. Oracle Secure Backup does not physically remove the section from the volume, but indicates in its backup sections catalog that the section is removed. You can view the status of a section by running the lssection command. Typically, you use rmssection only when the backup sections catalogs require manual update.

Note:

If you remove a backup section that contains a Recovery Manager (RMAN) backup piece, then Oracle Secure Backup responds to RMAN queries concerning the backup piece by saying that it does not exist.

See Also:

"Section Commands" for related commands

Prerequisites

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

Syntax

rmsection::=

rmsection [ --nq ] [ --oid/-o oid-list ]...[ --vid/-v vid { --file/-f filenumber-list }... ]

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.

--oid oid-list

Selects backup sections with the object identifiers matching those in oid-list. Refer to "oid-list" for a description of the oid-list placeholder.

--vid vid

Selects backup sections contained on the volume specified by vid. Refer to "vid" for a description of the vid placeholder.

--file/-f filenumber-list

Selects the backup sections with the file numbers specified in the list. Refer to "filenumber-list" for a description of the filenumber-list placeholder.

Example

Example 3-94 Removing Backup Sections

This example deletes a section that contains an RMAN backup piece. A query of the backup sections catalog shows that the backup section has the attribute deleted.

ob> lssection --short
   BSOID
     106
     107
ob> rmsection --nq --oid 107
ob> lssection --long
Backup section OID:    106
    Containing volume:      VOL000003
    Containing volume OID:  110
    File:                   1
    Section:                1
    Backup level:           0
    Client:                 brhost2
    Created:                2013/04/19.11:36
    Attributes:             never expires
Backup section OID:    107
    Containing volume:      RMAN-DEFAULT-000002
    Containing volume OID:  112
    File:                   1
    Section:                1
    Backup level:           0
    Client:                 osbsvr1
    Created:                2013/04/19.11:37
    Attributes:             deleted

rmsnap

Purpose

Use the rmsnap command to remove a snapshot.

See Also:

"Snapshot Commands" for related commands

Prerequisites

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

Syntax

rmsnap::=

rmsnap [ --host/-h hostname ] [ --fs/-f filesystem-name ]
[ --nowait/-n ] snapshot-name...

Semantics

--host/-h hostname

Specifies the name of the Network Data Management Protocol (NDMP) host that contains the snapshot to remove. If you do not specify a host name, then Oracle Secure Backup uses the value from the host variable.

--fs/-f filesystem-name

Specifies the name of the file system included in the snapshot. If you do not specify the --fs option, then the fs variable must be set.

--nowait/-n

Does not wait for the snapshot removal operation to complete.

snapshot-name

Specifies the name of the snapshot to remove.

Example

Example 3-95 Removing a Snapshot

This example creates a snapshot called test and then deletes it.

ob> set fs /vol/vol0
ob> mksnap --host lucy
ob> lssnap test
File system /vol/vol0:
Snapshot Of                Taken at      %Used  %Total Snapshot Name
/vol/vol0              2013/03/28.21:11     0      0   test
ob> rmsnap test
ob> lssnap test
Warning: snapshot test not found on host lucy, file system /vol/vol0.

Example 3-96 Removing a Snapshot

This example deletes three snapshots from the host storabcknfs4.

ob> lssnap -h storabcknfs4
File system /vol/vol1:
Snapshot Of  Taken at         %Used   %Total   Snapshot Name
/vol/vol1   2010/08/18.04:00  0        0        nightly.0
/vol/vol1   2010/08/18.02:47  0        0        snapshot_for_backup.8204
/vol/vol1   2010/08/18.00:00  0        0        hourly.0
/vol/vol1   2010/08/17.20:00  0        0        hourly.1
/vol/vol1   2010/08/17.16:00  0        0        hourly.2
/vol/vol1   2010/08/17.12:00  0        0        hourly.3
/vol/vol1   2010/08/17.04:00  0        0        nightly.1
/vol/vol1   2010/08/16.04:00  0        0        weekly.0
/vol/vol1   2010/08/15.04:00  0        0        nightly.2
/vol/vol1   2010/08/14.04:00  1        0        nightly.3
/vol/vol1   2010/08/13.04:00  0        0        nightly.4
/vol/vol1   2010/08/09.04:00  9        5        weekly.1
ob> rmsnap -h storabcknfs4 -f/vol/vol1 hourly.3
ob> rmsnap -h storabcknfs4 -f/vol/vol1 nightly.4
ob> rmsnap -h storabcknfs4 -f/vol/vol1 nightly.3
ob> lssnap -h storabcknfs4
File system /vol/vol1:
Snapshot Of Taken at          %Used   %Total   Snapshot Name
/vol/vol1  2010/08/18.04:00   0       0        nightly.0
/vol/vol1  2010/08/18.02:47   0       0        snapshot_for_backup.8204
/vol/vol1  2010/08/18.00:00   0       0        hourly.0
/vol/vol1  2010/08/17.20:00   0       0        hourly.1
/vol/vol1  2010/08/17.16:00   0       0        hourly.2
/vol/vol1  2010/08/17.04:00   0       0        nightly.1
/vol/vol1  2010/08/16.04:00   0       0        weekly.0
/vol/vol1  2010/08/15.04:00   0       0        nightly.2
/vol/vol1  2010/08/09.04:00   9       5        weekly.1

rmssel

Purpose

Use the rmssel command to remove a database backup storage selector.

See Also:

"Database Backup Storage Selector Commands" for related commands

Prerequisites

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

Syntax

rmssel::=

rmssel [ --nq ] sselname...

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.

sselname

Specifies the names of the database backup storage selectors to remove.

Example

Example 3-97 Deleting a Database Backup Storage Selector

This example deletes the storage selector named ssel_full_arch.

ob> lsssel --short
ssel_full_arch
ob> rmssel ssel_full_arch
remove ssel ssel_full_arch? (a, n, q, y, ?) [n]: y
ob> lsssel
ob>

rmstage

Purpose

The rmstage command deletes one or more stage rules.

Usage Notes

The rmstage command fails if any stage rule is currently set in a staging disk pool device, and all stage devices that contain the stage rule are listed in the error message.

Syntax

rmstage::=

rmstage [--nq ] stage-rule-name [stage-rule-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.

stage-rule-name

Specifies the name of the stage rule to remove.

Example

Example 3-98 Example Title

ob> rmstage --nq stagerulexyz

rmsum

Purpose

Use the rmsum command to remove a job summary schedule.

See Also:

"Summary Commands" for related commands

Prerequisites

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

Syntax

rmsum::=

rmsum [ --nq ] summary-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.

summary-name

Specifies the name of the job summary schedule to remove.

Example

Example 3-99 Removing a Job Summary Schedule

This example removes the job summary schedule named weekly_report.

ob> lssum
weekly_report            Wed at 12:00
ob> rmsum --nq weekly_report
ob> lssum
ob>

rmuser

Purpose

Use the rmuser command to remove an Oracle Secure Backup user from the administrative domain.

See Also:

"User Commands" for related commands

Prerequisites

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

Syntax

rmuser::=

rmuser [ --nq ] username...

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.

username

Specifies the name of the Oracle Secure Backup user to remove.

Example

Example 3-100 Removing an Oracle Secure Backup User

This example removes Oracle Secure Backup user bkpadmin.

ob> lsuser
admin            admin
bkpadmin         oracle
sbt              admin
tadmin           admin
ob> rmuser --nq bkpadmin
ob> lsuser
admin            admin
sbt              admin
tadmin           admin

rmvol

Purpose

Use the rmvol command to remove volume records from the Oracle Secure Backup catalog permanently. The only way to undo the removal is to import the volume again, so that the Oracle Secure Backup catalog is repopulated.

See Also:

"Volume Rotation Commands" for related commands

Prerequisites

You must have the modify catalog right to use the rmvol command.

Syntax

rmvol::=

rmvol [ --nq ] [ --force/-f ] 
{ [ --vid/-v vol-spec[,vol-spec]... ]
  [ --barcode/-b barcode_value[,barcode_value]... ]
  [ --location/-l location_name[,location_name]... ] 
}

Semantics

--nq

Does not display a confirmation message. If you do not specify this option, then you are prompted for confirmation before the volume is deleted. You can reply to the confirmation request with one of the following:

• a

  Remove records for all volume selections. Enter this response when prompted for confirmation for the first volume in the selection.

• n

  Remove no records.

• q

  Remove no records and quit the command.

• y

  Remove the record for this volume.

• ?

  Repeat the prompt.

--force/-f

By default, you can only remove the records of expired volumes. You can specify --force to override this restriction and remove the records of unexpired volumes as well.

--vid/-v vol-spec

Specifies the volume ID of the volume whose record you want to remove. See "vol-spec" for more information on the vol-spec placeholder.

--barcode/-b barcode_value

Specifies the barcode of the volume whose record you want to remove.

--location/-l location_name

Specifies the location of the volume or volumes whose records you want to remove. Oracle Secure Backup removes the records of all volumes at the specified location.

Note:

You must specify --vid, --barcode, or --location, but you can specify multiple options.

If the volumes database contains multiple entries matching a specified vol-spec or barcode, then Oracle Secure Backup displays a list of the matching volumes from which you can choose volumes to remove. The following example shows multiple matches for vol-spec VOL000001:

ob> rmvol -f -v VOL000001
Your vol-spec, "VOL000001", matched the following volumes:
 
   Volume ID   Barcode                           Created
 1 VOL000001   def5768a15b710295f7000423a5cbf4   
 2 VOL000001   3f2e113415b7102a59e000423a5cbf4   06/05.15:28
 
Please select the volume(s) that you wish to modify (1, 2, ..., a(ll), n(one), q(uit): 

rpyjob

Purpose

Use the rpyjob command to respond to a job that is prompting for input or assistance. You can display jobs of this type by specifying --inputrequest on the lsjob command. You can determine what a job is requesting by performing a catxcr command.

See Also:

"Job Commands" for related commands

Prerequisites

If you are attempting to respond to the job prompts of another Oracle Secure Backup user, then you must have the right to modify any job, regardless of its owner. If you are attempting to respond to your own job prompts, then you must have the right to modify any jobs owned by user.

Syntax

rpyjob::=

rpyjob  --reply/-r text job-id...

Semantics

--reply/-r text

Specifies the textual reply to the prompt. To include white space in the value, surround the text with quotes.

job-id

Specifies the identifier of the job to which the reply is to be sent.

Example

Example 3-101 Displaying Information About a Job Requesting Assistance

This example uses lsjob to display jobs that are requesting assistance and then runs catxcr to display the transcript for job admin/7.1.

The transcript shows that the tape library does not contain a usable tape for the backup job. Press the Enter key after running catxcr to return to the obtool prompt.

ob> lsjob --inputrequest --long
admin/7.1:
    Type:                   backup brhost2
    Level:                  full
    Family:                 (null)
    Scheduled time:         none
    State:                  running since 2013/01/09.12:38
    Priority:               100
    Privileged op:          no
    Run on host:            brhost2
    Attempts:               1

ob> catxcr --tail 12 admin/7.1
End of tape has been reached.  Please wait while I rewind and unload the tape.
The Volume ID of the next tape to be written is VOL000005.
The tape has been unloaded.
 obtar: couldn't perform auto-swap - can't find usable volume in library (OB device
 mgr)   Enter a command from the following list:
       load <n>     .. load the tape from element <n> into the drive
       unload <n>   .. unload the tape from the drive into element <n>
       help         .. display other commands to modify drive's database
       go           .. to use the tape you selected
       quit         .. to give up and abort this backup or restore
:

Example 3-102 Displaying Information About a Job Requesting Assistance

This example inserts a volume into the tape library and then uses rpyjob to reply with two commands: load 3 and go. Specifying --inputrequest on lsjob generates a null response, which means that no jobs require input.

ob> insertvol --library lib2 unlabeled 3
ob> rpyjob --reply "load 3" admin/7.1
ob> rpyjob --reply "go" admin/7.1
ob> lsjob --inputrequest
ob> 

runjob

Purpose

Use the runjob command to control how a job is processed. The command enables you to start a job in the following ways:

• Immediately

• In an order different from that of the scheduler

• On a specific device or a device from which the job was previously restricted

See Also:

"Job Commands" for related commands

Prerequisites

If you are attempting to control jobs belonging to another Oracle Secure Backup user are processed, then you must have the right to modify any job, regardless of its owner. If you are attempting to control the processing of your own jobs, then you must have the right to modify any jobs owned by user.

Syntax

runjob::=

runjob { --asap/-a | --now/-n | { --priority/-p schedule-priority } }
[ --device/-d device-name ] [ --mediamovement/-m ] [ --quiet/-q | --verbose/-v ]
job-id...

Semantics

--asap/-a

Starts the job as soon a possible by raising it to priority 1.

--now/-n

Starts the job now. If Oracle Secure Backup cannot start the job, then it generates an error message.

--priority/-p schedule-priority

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

--device/-d device-name

Runs the job on the device specified by device-name, ignoring job requirements.

--mediamovement/-m

Enables the pending media movement job specified by job-id.

--quiet/-q

Runs the job in quiet mode. --quiet directs obtool to suppress status messages it would normally write to stdout. Note that Oracle Secure Backup never suppresses error messages.

--verbose/-v

Displays output when running the job.

job-id

Specifies the identification number of the job you want to run. Run the lsjob command to display job IDs.

Example

Example 3-103 Running a Job Now

This example lists a pending job and runs it immediately.

ob> lsjob --pending
Job ID           Sched time  Contents                       State
---------------- ----------- ------------------------------ ----------------------
sbt/23           03/22.21:00 dataset workdata.ds            future work
ob> runjob --device tape1 --now sbt/23
ob> lsjob --all sbt/23
Job ID           Sched time  Contents                       State
---------------- ----------- ------------------------------ ----------------------
sbt/23           03/22.21:00 dataset workdata.ds            completed successfully 
                                                            at 2013/03/22.18:09

set

Purpose

Use the set command to set or reset the value of an obtool variable in the current session.

See Also:

obtool Variables for a complete list of obtool variables

Syntax

set::=

set [ variable-name [ variable-value ] ]

Semantics

variable-name

Specifies the name of the variable to set. If you do not specify a variable name, then set displays the variables that are currently set.

variable-value

Specifies the value to which variable-name should be set.

Example

Example 3-104 Setting a Variable

This example sets the errors variable to long so that errors include descriptive text and the obtool component name and then resets it to short.

ob> show errors
errors         (not set)
ob> set errors long
ob> show errors
errors         long
ob> set errors short
ob> show errors
errors         short

setbw

Purpose

Use the setbw command to change the settings of a backup window. This command replaces an existing backup window, as opposed to the addbw command, which adds a backup window.

See Also:

"Backup Window Commands" for related commands

Prerequisites

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

Syntax

setbw::=

setbw { --times/-t { none | 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 3-105 Changing Backup Windows

This example changes the settings of the backup windows created in Example 2-1. These backup windows allow backups from 7 a.m. until 9 p.m. on weekdays and any time during the weekend.

ob> setbw --times 00:00-07:00 mon-fri
ob> setbw --times 21:00-24:00 mon-fri
ob> setbw --times 00:00-24:00 weekend

setdw

Purpose

Use the setdw command to set a duplication window, which is a time and day range.

See Also:

"Duplication Window Commands" for related commands

Prerequisites

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

Syntax

setdw::=

setdw { --times/-t none | 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 3-106 Setting a Duplication Window

This example sets a duplication window for 9 a.m. to 9:30 a.m. for Tuesdays.

ob> setdw -t 0900-0930 tuesday
ob> lsdw
09/30 15:30-16:30:30
weekend 10:00-21:00
Mon Wed-Fri 10:00-20:00
Tue 09:00-09:30

setp

Purpose

Use the setp command to set the value of a policy. Note that you can reset a value with the resetp command.

The policy data is represented as a directory tree with / as the root. You can use cdp to navigate the tree and lsp and pwdp to display data.

See Also:

• "Policy Commands" for related commands

• Defaults and Policies for a complete list of policies and policy classes

When you use the setp command to set the port number for an NDMP daemon on Windows, in addition to specifying the port number, you must add an entry in the Windows services file. The Windows services file is called services and is located in the C:\WINDOWS\system32\drivers\etc directory. Example 3-108 describes how to set the port number for an NDMP daemon on Windows.

Prerequisites

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

Syntax

setp::=

setp policy-name policy-value

Semantics

policy-name

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

policy-value

Specifies the policy value, which is dependent on the policy type.

Example

Example 3-107 Setting Policy Values

This example sets the Web server password to pandora, configures the Web server so that it starts automatically, and then sets the Network Data Management Protocol (NDMP) host password to mehitibel.

ob> pwdp
/
ob> lsp daemons/webpass
webpass                          (set)
ob> setp daemons/webpass pandora
ob> lsp --nodefault daemons/webauto
webautostart                     no
ob> setp daemons/webauto yes
ob> lsp --nodefault ndmp/password
password                         (not set)
ob> setp ndmp/password mehitibel

Example 3-108 Setting the Port Number for NDMP Daemons

This example sets the port number for an NDMP daemon on Windows to 9000. Setting the port number on Windows includes the following steps:

1. Set the port number for the NDMP daemon using the setp command.

2. Edit the Windows services file and add an entry for the port number.

3. Restart the observiced daemon.

To set the port number using the setp command:

ob> setp ndmp/port 9000
ob> lsp -l ndmp/port
port                        9000
    Default port number via which to connect to an NDMP server

To add an entry for the port number in the Windows services file, edit the C:\WINDOWS\system32\drivers\etc\services file and include the following entry:

ndmp                     9000/tcp

After changing the port number, you must restart the observiced daemon using the following commands:

net stop observiced
net start observiced

Example 3-109 Setting the Password Lifetime Security Policy

This example sets the global password lifetime security policy to 30 days. This specifies that a user password will expire after 30 days. Per-User settings may differ from the global password security settings.

ob> setp security/passwordlifetime 30days
ob> lsp --nodefault security/passwordlifetime
passwordlifetime                 30 days

Example 3-110 Setting the Policy to Cross Mount Points During a File-System Backup

This example sets the backupoptions policy and ensures that obtar crosses all mount points while performing a file-system backup. By default, obtar does not cross mount points.

ob> lsp operations/backupoptions
backupoptions                    (none)                      [default]
ob> setp operations/backupoptions -Xcrossmp

Example 3-111 Setting the Certificate Lifetime and Warning Policies

This example sets the certlifetime policy, to define the duration of validity of the signing certificates on the current domain, to 3 years. It also sets the certwarning policy, that defines the warning notification period before the certificate expires, to 7 days.

ob> setp security/certlifetime 3 years
ob> setp security/certlifetime 7 days
ob> lsp security
autocertissue                    yes                         [default]
certkeysize                      1024                        [default]
certlifetime                     3 years                    
certwarning                      7 days                     
encryptdataintransit             no                          [default]
loginduration                    forever                    
minuserpasswordlen               0                          
passwordgracetime                10 days                    
passwordlifetime                 30 days                    
passwordreusetime                180 days                   
securecomms                      yes                         [default]
trustedhosts                     yes                         [default]
webinactivitytimeout             15 minutes                  [default]
websessiontimeout                24 hours                    [default]

show

Purpose

Use the show command to display the value of one or more variables.

See Also:

obtool Variables for a complete list of obtool variables

Syntax

show::=

show [ variable-name ]...

Semantics

variable-name

Specifies the name of the variable whose value you want to display. If you do not specify a variable name, then show displays all variables that are currently set.

Example

Example 3-112 Showing the Value of a Variable

This example sets the drive variable and then displays the drive and host variables.

ob> show
browsemode     catalog
escape         &
host           osbsvr1
viewmode       inclusive
ob> set drive tape1
ob> show drive host
drive          tape1
host           osbsvr1

stagescan

Purpose

Use the stagescan command to run an on-demand stagescan job that will scan the specified device, and create copyfromstage jobs to copy backup image instances stored in the device.

Prerequisites

The target media family and the restriction list must be set in the default stage rule OSB-DEFAULT-STAGE-RULE. This only needs to be done one time.

Usage Notes

• The stagescan command will work with disk pool devices that do not have staging enabled.

Syntax

stagescan::=

stagescan {--device/-d devicename}
                    {--stagerule/-r stage-rule-name[,stage-rule-name]…}
                     [--noage/-a]  [--nosize/-s] [--quiet/-q]
                     [--priority/-p schedule-priority]

Semantics

--device/-d devicename

Starts an on-demand stagescan job for backup image instances in the specified stage device. The specified device must be a disk pool, but the disk pool does not have to have staging enabled

stage-rule-name

The name of the Oracle Secure Backup stage rule. An on-demand stagescan job is started that creates copyfromstage jobs for backup image instances that match a stage rule in the list of rules. The stage rules are scanned in the order in which they appear in the list. The default stage rule is not used automatically; it is only used if it appears in the specified list of stage rules.

--noage/-a

If this option is specified, then the minimum copy age (--mincopyage) filter value of a stage rule is ignored by this command, and all instances that match all other stage rule parameters are copied.

--nosize/-s

If this option is specified, then the minimum copy size (--mincopysize) filter value of a stage rule is ignored by this command, and all instances that match all other stage rule parameters are copied.

--quiet/-q

This option suppresses non-error output.

--priority/-p schedule-priority

This option is used to set the stagescan job schedule priority. If this option is not used, then the stagescan job priority defaults to the stagescan/defaultscanjobpriority policy value of 150.

Example

Example 3-113 Running an On-Demand Stagescan Job

The following command copies all instances that have not already been copied in the disk pool mypool that match the stage rule host2rule. The mincopysize and mincopyage values in the stage rule are ignored.

ob> stagescan --stagerule host2rule --device mypool --nosize --noage

unlabelvol

Purpose

Use the unlabelvol command to load selected volumes and physically remove the Oracle Secure Backup volume label and backup data from each of them.

Each volume has a volume label stored at Beginning of Tape (BOT). The label consists of the volume ID, the barcode (if any), and other information about the volume. Typically, you use the unlabelvol command to remove all traces of a backup and its associated volume label from an unexpired tape and from the Oracle Secure Backup catalog.

See Also:

"Library Commands" for related commands

Prerequisites

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

Syntax

unlabelvol::=

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

Semantics

--drive/-D drivename

Specifies the name of the tape drive to be used to unlabel the volume. If you do not specify a tape drive name, then the drive variable must be set.

--force/-f

Forces obtool to ignore the expiration policy for the volume. If the --force option is not used and the volume is not expired according to its expiration policy, then unlabelvol fails.

se-range

Specifies the range of storage elements holding the volumes to be unlabeled. If this option is omitted, then the volume currently loaded in the tape drive is unlabeled. Refer to "se-range" for a description of the se-range placeholder.

Example

Example 3-114 Unlabeling a Volume

This example unlabels the volume in storage element 1 of tape library lib1.

ob> lsvol --library lib1 --long
Inventory of library lib1:
    in    mte:           vacant
    in    1:             volume VOL000002, barcode ADE201, oid 110, 16962752 kb remaining
    in    2:             vacant
    in    3:             volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 17017984 remaining, 
                         content manages reuse
    in    4:             vacant
    in    iee1:          vacant
    in    iee2:          vacant
    in    iee3:          vacant
    in    dte:           vacant
ob> unlabelvol --force --drive tape1 1
ob> lsvol --library lib1 --long
Inventory of library lib1:
    in    mte:           vacant
    in    1:             unlabeled
    in    2:             vacant
    in    3:             volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 17017984 remaining, 
                         content manages reuse
    in    4:             vacant
    in    iee1:          vacant
    in    iee2:          vacant
    in    iee3:          vacant
    in    dte:           vacant

unloadvol

Purpose

Use the unloadvol command to unload a volume from a tape drive. The unload operation rewinds the tape before moving it to its storage slot.

See Also:

"Library Commands" for related commands

Prerequisites

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

Syntax

unloadvol::=

unloadvol [ --drive/-D drivename ] [ element-spec ]

Semantics

--drive/-D drivename

Specifies the name of the tape drive to be unloaded. If you do not specify a tape drive name, then the drive variable must be set.

element-spec

Specifies the destination storage element for the volume to be unloaded. Refer to "element-spec" for a description of the element-spec placeholder.

You can specify vacant to make Oracle Secure Backup unload the volume to any vacant storage element. If element-spec is omitted, then the source (if known) of the volume is used. The source element of the volume in the dte is displayed after the string lastse when you run lsvol.

Example

Example 3-115 Unloading a Volume from a Tape Drive

This example unloads a volume from tape drive tape1 and inserts it into the source element for the volume. The text lastse 3 in the dte output indicates that the source for the volume is element 3. Note that the sample output has been formatted to fit on the page.

ob> lsvol --library lib1 --long
Inventory of library lib1:
    in    mte:           vacant
    in    1:             volume VOL000002, barcode ADE204, oid 110, 47670368 kb remaining
    in    2:             volume VOL000001, barcode ADE201, oid 102, 48319392 kb remaining
    in    3:             vacant
    in    4:             vacant
    in    iee1:          barcode ADE203, oid 114, 47725344 kb remaining, lastse 4
    in    iee2:          vacant
    in    iee3:          vacant
    in    dte:           volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47725600 kb 
                         remaining, content manages reuse, lastse 3
ob> unloadvol --drive tape1
ob> lsvol --library lib1 --long
Inventory of library lib1:
    in    mte:           vacant
    in    1:             volume VOL000002, barcode ADE204, oid 110, 47670368 kb remaining
    in    2:             volume VOL000001, barcode ADE201, oid 102, 48319392 kb remaining
    in    3:             volume RMAN-DEFAULT-000002, barcode ADE202, oid 112, 47725600 kb 
                         remaining, content manages reuse
    in    4:             vacant
    in    iee1:          barcode ADE203, oid 114, 47725344 kb remaining, lastse 4
    in    iee2:          vacant
    in    iee3:          vacant
    in    dte:           vacant

unmountdev

Purpose

Use the unmountdev command to unmount tape volumes manually. When a tape is unmounted, the tape is no longer in a mode in which Oracle Secure Backup can read or write to it. You can use the mountdev command to mount an unmounted tape.

The unmountdev command is particularly useful when the tape drive is not set to automount, which is the recommended, default configuration setting. In special situations the unmountdev and mountdev commands provide additional control over your tape drive.

See Also:

"Device Commands" for related commands

Prerequisites

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

Syntax

unmountdev::=

unmountdev [ --unload/-u | --norewind/-R ] devicename...

Semantics

--unload/-u

Unloads a volume from the tape drive.

--norewind/-R

Specifies that the tape should not be rewound when Oracle Secure Backup finishes writing to it.

devicename

Specifies the device from which you want to unmount a volume. Refer to "devicename" for the rules governing device names.

Example

Example 3-116 Unmounting a Tape Volume

This example unmounts an automounted tape drive called tape1.

ob> lsdev --long tape1
tape1:
    Device type:            tape
    Model:                  [none]
    Serial number:          [none]
    In service:             yes
    Library:                lib1
    DTE:                    1
    Automount:              yes
    Error rate:             8
    Position interval:        3145679KB (-1073791796 bytes) (from driver)
    Debug mode:             no
    Blocking factor:        (default)
    Max blocking factor:    (default)
    Current tape:           1
    Use list:               all
    Drive usage:            14 seconds
    Cleaning required:      no
    UUID:                   b7c3a1a8-74d0-1027-aac5-000cf1d9be50
    Attachment 1:
        Host:               brhost3
        Raw device:         /dev/obt0
ob> unmountdev --norewind tape1
ob> lsdev --mount tape1
drive      tape1            in service           unmounted                                                                                 

unresdev

Purpose

Use the unresdev command to unreserve a device previously reserved with the resdev command.

See Also:

"Device Commands" for related commands

Prerequisites

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

Syntax

unresdev::=

unresdev { --all/-a | devicename... }

Semantics

--all/-a

Unreserve all devices reserved by the current Oracle Secure Backup user.

devicename

Specifies the name of the device to be unreserved. Refer to "devicename" for the rules governing device names.

Example

Example 3-117 Unreserving a Device

This example unreserves tape drive tape1.

ob> lsdev --reserved
  drive 1  tape1            in service
ob> unresdev tape1
ob> lsdev --reserved
ob>

unrmsection

Purpose

Use the unrmsection command to undo the effect of the rmsection command. The command resets the deleted flag in the backup section records, which you can view by running the lssection command.

The unrmsection command fails if the volume containing the selected backup sections has been recycled or unlabeled after all of the backup sections it contains were deleted.

See Also:

"Section Commands" for related commands

Prerequisites

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

Syntax

Syntax

unrmsection::=

unrmsection [ --nq ] [ --oid/-o oid-list ]...[ --vid/-v vid { --file/-f filenumber-list }... ]

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.

--oid oid-list

Selects backup sections with the object identifiers matching those in oid-list. Refer to "oid-list" for a description of the oid-list placeholder.

--vid vid

Selects backup sections contained on the volume specified by vid.

--file/-f filenumber-list

Selects the backup sections with the file numbers specified in the list. Refer to "filenumber-list" for a description of the filenumber-list placeholder.

Example

Example 3-118 Undoing the Deletion of Backup Sections

This example undoes the deletion of two backup sections that have an attribute of deleted.

ob> lssection
   BSOID  Volume           File Sect  Level  Client           Created     Attributes
     100  VOL000001           1 1         0  brhost2          03/24.09:52 never expires
     105  RMAN-DEFAULT-000002    1 1         0  osbsvr1          03/24.10:13 deleted
     106  VOL000002           1 1         0  brhost2          03/24.10:13 never expires
     107  VOL000003           1 1         0  brhost2          03/24.10:13 never expires
     108  RMAN-DEFAULT-000002    2 1         0  osbsvr1          03/24.10:14 deleted
     109  VOL000003           2 1         0  brhost2          03/24.11:27 never expires
     110  VOL000003           3 1         0  brhost2          03/24.11:27 never expires
ob> unrmsection --nq --oid 105,108
ob> lssection
   BSOID  Volume           File Sect  Level  Client           Created     Attributes
     100  VOL000001           1 1         0  brhost2          03/24.09:52 never expires
     105  RMAN-DEFAULT-000002    1 1         0  osbsvr1          03/24.10:13 content manages reuse
     106  VOL000002           1 1         0  brhost2          03/24.10:13 never expires
     107  VOL000003           1 1         0  brhost2          03/24.10:13 never expires
     108  RMAN-DEFAULT-000002    2 1         0  osbsvr1          03/24.10:14 content manages reuse
     109  VOL000003           2 1         0  brhost2          03/24.11:27 never expires
     110  VOL000003           3 1         0  brhost2          03/24.11:27 never expires

unset

Purpose

Use the unset command to undefine a variable.

See Also:

obtool Variables for a complete list of obtool variables

Syntax

unset::=

unset variable-name...

Semantics

variable-name

Specifies the name of the variable to undefine.

Example

Example 3-119 Undefining a Variable

This example unsets the drive variable.

ob> show drive
drive          tape1
ob> unset drive
ob> show drive
drive          (not set)

updatehost

Purpose

Use the updatehost command to instruct Oracle Secure Backup to complete the inclusion of a host in the administrative domain. Typically, you use this command when you initially configured a host when it was offline.

When you run the mkhost or chhost command for a host, Oracle Secure Backup exchanges messages with the host to inform it of its state. If you run mkhost or chhost with the --nocomm option because communication with the host is not possible, then the host contains out-of-date configuration information. When the host becomes available, use an updatehost command to synchronize the Oracle Secure Backup configuration information between the administrative server and the host.

See Also:

"Host Commands" for related commands

Prerequisites

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

Syntax

updatehost::=

updatehost [ --force/-f ] [--recertify/-r] hostname...

Semantics

--force/-f

Forces an update. The updatehost command normally fails if the internal name (UUID) stored on the subject host disagrees with the internal name for the subject stored on the administrative server. This situation arises if the subject host is reassigned to this administrative domain from another domain. To update the subject host regardless of this situation, use --force.

--recertify/-r

Recertifies a client host that was earlier decertified and brings it back into the Oracle Secure Backup administrative domain, without destroying the restore catalog data of the client. The host could have been decertified either by using the obcm decertify command or by the reinstallation of Oracle Secure Backup.

If you remove a client and then add it, the catalog restore data would be destroyed in the process.

Note:

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

hostname

Specifies the name of the host to update. This command is useful only for hosts accessed with the Oracle Secure Backup protocol. NDMP hosts do not maintain any Oracle Secure Backup state data and are therefore not applicable to this function.

Examples

Example 3-120 Updating a Host

This example updates a host that had been offline when it was added with mkhost.

ob> lshost
brhost2          client                            (via OB)   in service
brhost3          mediaserver,client                (via OB)   in service
sfserver1        client                            (via OB)   not in service
osbsvr1          admin,mediaserver,client          (via OB)   in service
ob> updatehost sfserver1
ob> pinghost sfserver1
sfserver1:               Oracle Secure Backup and NDMP services are available

Example 3-121 Recertifying a Host

This example recertifies the host brhost46, that was previously decertified using the obcm decertify command, and brings it back into the Oracle Secure Backup administrative domain. The commands are run using the obtool utility on the administrative server.

ob> updatehost --recertify brhost46
 Info: waiting for host to update certification status...
 Info: waiting for host to update certification status...
ob> pinghost brhost46
 stadc46: Oracle Secure Backup and NDMP services are available 

validatechecksum

Purpose

Use the validatechecksum command to verify the integrity of the specified backup image instance.

A new validate checksum job is created for each validatechecksum command.

Prerequisites

The backup image instance being validated must have the checksum and stored at the time of creating the backup image instance.

Syntax

validatechecksum::=

validatechecksum [--priority/-p schedule-priority] [--at/-a date-time]
[--quiet/-q]
[--waitfor/-W duration]
[--restrict/-r restriction[,restriction]...]
{ [--uuid/-u backup-instance-uuid] | backup-instance-name }

Semantics

--priority/-p schedule-priority

Specifies the priority to be assigned to the validate checksum job.

--at/-a date-time

Specifies the time at which the validate checksum job must be run. If this option is omitted, the job is run immediately.

--quiet/-q

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

--waitfor/-W duration

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

--restrict/-r restriction

Restricts the validate checksum job to the specified tape devices, disk pools, or Cloud devices. In the absence of a restriction, Oracle Secure Backup chooses a suitable device for the specified backup image instance.

--uuid/-u backup-instance-uuid

Specifies either the UUID or the name of the backup image instance that must be validated. Only one backup image instance can be specified in a single command.

Examples

Example 3-122 Validating a Backup Image Instance Stored in a Disk Pool

This example validates the backup image instance with the specified name on the disk pool disk_2.

ob> validatechecksum --restrict disk_2 my_bkup-190205-125715.1
Info: validate checksum for instance my_bk_instance.1 submitted; job id is admin/5.

ob> lsjob --long admin/5
admin/5:
    Type:                   validate checksum for my_bkup-190205-125715.1
    Scheduled time:         none
    State:                  completed successfully at 2019/02/06.02:10
    Priority:               160
    Privileged op:          no
    Run on host:            brhost2
    Attempts:               1

vault

Purpose

Use the vault command to perform a one-time on-demand vaulting scan.

See Also:

"Volume Rotation Commands" for related commands

Syntax

vault::=

vault
[ --select/-S select_criterion[, select_criterion]...
[ --quiet/-q ]
[ --at/-a date-time ]
[ --priority/-p schedule-priority ]
[ --restrict/-r restriction[,restriction]... ]
[ --waitfor/-W duration ]
[ --expires/-x duration ] ]...

Semantics

--select/-S select_criterion

Restricts a vaulting scan to one or more media families.

--quiet/-q

Specifies that neither job ID nor status information is displayed when the vaulting scan job is dispatched to the scheduler.

--at/-a date-time

Specifies a date and time to perform the vaulting scan. If a date and time is not specified, then the vaulting scan runs immediately.

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

--priority/-p schedule-priority

Assigns a schedule priority to the vaulting scan.

See "schedule-priority" for more information on the schedule-priority placeholder.

--restrict/-r restriction

Specifies locations to be scanned during the vaulting scan. It the location corresponds to an ACSLS library, then this option also specifies the cartridge access point to be used for media ejection. Restrictions can be specified in any of the following forms:

• location

• location@capname

• @capname

–waitfor/-W duration

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

See duration for more information on the duration placeholder.

--expires/-x duration

Specifies an expiration time period. Specifying this option expires the vaulting scan if it is not processed by duration after the trigger time.

See "duration" for more information on the duration placeholder.

Example

Example 3-123 Scheduling an On-Demand Vaulting Scan

This example uses the vault command to schedule a one time vaulting scan on November 12 at 5:30 p.m.

ob> vault --quiet --at 11/12.5:30:00
ob> lsjob --pending
Job ID           Sched time  Contents                       State
---------------- ----------- ------------------------------ --------
admin/3          11/12.05:30 volume vaulting scan           future work

vfylibs

Purpose

Use the vfylibs command to check the configuration of one or more libraries and drives. You specify which libraries to check, and vfylibs checks the drive ID of each tape drive in each of the specified libraries against a list of all defined libraries and drive IDs for all tape drives in those libraries.

Prerequisites

The drives can be open and in use when you run the vfylibs command, but vfylibs fails if an active robot process is associated with the library.

The vfylibs command is not supported for ACSLS libraries.

Usage Notes

For each specified library, vfylibs performs the following configuration checks:

1. The device ID (DVCID) for each tape drive in the library is obtained by a Read Element Status command with the DVCID bit set.

   Note:

   Some libraries, particularly older models, do not support the DVCID bit. The accuracy of the vfylibs command is reduced when it encounters libraries of this type.

2. The drive object for each tape drive in the library is fetched.

3. For each attach point specified with this drive object, the drive is opened.

4. An ID for the drive is constructed using SCSI Inquiry commands.

5. The constructed ID is compared with the ID returned with the element status for the tape drive.

The vfylibs command checks for and reports the following configuration errors:

• There is no drive object for a library and tape drive number.

• The drive object for a library and tape drive is not in service.

• The drive object for a library and tape drive has no attach points.

• The host for an attach point could not be resolved (host object not found).

• The host for an attach point is not in service.

• The ID obtained through an attach point does not match the ID reported by the library.

Note:

If vfylibs finds an ID mismatch, then it also searches the IDs of all drives to see if the incorrect ID matches the ID of a tape drive in some other library.

See Also:

"Device Commands" for related commands

Syntax

vfylibs::=

vfylibs library_name [ [library_name]... | --all/-a ] [ --verbose/-v ]

Semantics

library_name

The name of the library whose configuration you want to check. You can specify multiple library names. Specifying no names at all, which is the same as specifying --all, requests verification of all libraries in your configuration.

--verbose/-v

Displays the serial number of the device. If the serial number of an IBM ULTRIUM-DT2 drive is 1110229581, for example, then vfylibs displays:

IBM      ULTRIUM-TD2      1110229581

Examples

Example 3-124 Checking the Configuration of a Tape Library

In this example, the vfylibs command runs successfully, and the IDs match:

ob> pingd l2
Info: library    l2               accessible.
Error: drive l2_t1 is in use by obt on host bkpservr04, process 5487.
Error: drive l2_t2 is in use by obt on host bkpservr04, process 5513.
 
ob> vfylib -v l2
 
collecting dte info...
   lib l2 ...
      dte 1:  l2_t1  (IBM      ULTRIUM-TD2      1110229581)
      dte 2:  l2_t2  (IBM      ULTRIUM-TD2      1110229610)
 
verifying dte definitions against drive objects...
   lib l2 ...
      dte 1  l2_t1  (IBM      ULTRIUM-TD2      1110229581) ...
         att bkpservr04:/dev/sg3 ...
            id matches
      dte 2  l2_t2  (IBM      ULTRIUM-TD2      1110229610) ...
         att bkpservr04:/dev/sg4 ...
            id matches
0 errors found

Example 3-125 Running vftlibs When a Robot Process Is Active

In this example, the vfylibs command returns an error because an active robot process is associated with the library:

ob> pingd l2
Error: library l2 is in use by obt on host bkpservr04, process 5487.
Error: drive l2_t1 is in use by obt on host bkpservr04, process 5487.
Error: drive l2_t2 is in use by obt on host bkpservr04, process 5513.
ob> vfylib -v
 
collecting dte info...
Error: library l2 is in use by obt on host bkpservr04, process 5487.
0 errors found

Example 3-126 Running vfylibs When IDs Do Not Match

In this example, the vfylibs command runs successfully but the IDs do not match:

ob> vfylib l1 -v
 
collecting dte info...
   lib l1 ...
      dte 1  [not determined] ...
      getting DVCID: bad id type in DVCID
Error: the following requested library name(s) were not found:
   l1
1 error found