obtool Placeholders

aspec

Description

The aspec placeholder represents a physical attachment for a tape device. The attachment describes a data path between a host and the tape device or disk pool.

Syntax 1

The format for NDMP and SCSI devices is as follows:

aspec::=

hostname:rawdevicename[+scsidevice=altrawdevicename][+stdevice=stdevicename]\
[+stcontroller=stcontroller][+sttarget=sttarget][+stlun=stlun]

Note that the backslash (\) is not a literal, but represents line continuation.

Syntax 2

The format for disk pools is as follows:

aspec::=

hostname:pathname

Syntax 3

The format for an ACSLS servers is as follows:

aspec::=

osb_mediaserver_hostname:acsls_server_hostname

Restrictions and Usage Notes

The settings other than hostname and rawdevicename are used only for Network Data Management Protocol (NDMP) servers that run protocol version 2. The requirements to set each of these options are server-specific.

Use the following guidelines when creating attachments:

For tape devices connected to Linux and UNIX systems, the raw device name is the name of the device special file that was created when you set up tape devices for use by Oracle Secure Backup. The installob and makedev tools displayed each such name.
For Windows systems, the raw device name is the Universal Naming Convention (UNC) name of the device.
For Network Attached Storage (NAS) systems, the raw device name is a device name assigned by the host operating system (for example, Network Appliance Data ONTAP). You must choose a device name for which no ancillary tape operations, such as rewind or unload, occur either when the tape drive is opened or when it is closed. These names usually begin or end with the letter "n."

The basic raw device naming convention is obln for libraries and obtn for tape drives, where n is 0 for the first device and increments by one for each subsequent device. Note that the l character in obln is an alphabet letter and not the numeral 1. Table 4-1 shows raw device names for popular systems.

Table 4-1 Raw Device Names for Popular Systems

Operating System	Attachment for First Drive	Attachment for First Library
AIX	`/dev/obt0`	`/dev/obl0`
Quantum NDMP server	`/dev/nst0`	`/dev/sg0`
HP-UX	`/dev/obt/0m`	`/dev/obl/0`
Linux	`/dev/obt0`	`/dev/obl0`
SGI	`/dev/obt2`	`/dev/obl0`
Solaris	`/dev/obt`	`/dev/obl0`
Windows	`//./obt0`	`//./obl0`
Data ONTAP	`nrst1a`	`mc2`

Semantics 1

hostname: The name of the host computer to which the device is attached.
rawdevicename: A name assigned by the NDMP server implementer or operating system implementer to represent the device. A rawdevicename is the equivalent of a device special file name on UNIX (see Table 4-1). Note that the name can include the notation "$WWN" to refer to the worldwide name of the device.
altrawdevicename: The name of a separate Small Computer System Interface (SCSI) pass-through interface that Oracle Secure Backup must use to pass through SCSI operations to the tape device.
stdevicename: The equivalent device name used when Oracle Secure Backup issues an NDMP_SCSI_SET_TARGET message to the server. It specifies an operating system-specific string that identifies the SCSI host bus adapter (HBA) or device.
stcontroller: The SCSI controller index or channel number of the device when NDMP_SCSI_SET_TARGET is used.
sttarget: The SCSI bus target ID of the device when NDMP_SCSI_SET_TARGET is used.
stlun: The SCSI LUN of the device when NDMP_SCSI_SET_TARGET is used.

Semantics 2

hostname: The name of the host computer that serves as a repository for backup image instances. The host must be an Oracle Secure Backup host that is configured as a media server. It must also support the NDMP file service extension protocol.
pathname: The name of the file-system directory on the specified host that stores the backups.

Semantics 3

osb_mediaserver_hostname: The name of the host computer that is configured as a media server in the Oracle Secure Backup administrative domain.
acsls_server_hostname: The name of the host computer that is configured as the ACSLS server.

Example

Example 4-1 aspec

Sample values for aspec include the following:

w0x0f:/dev/obt0    # a tape drive connected to Linux host w0x0f
darth:/dev/obl0    # a tape library connected to Solaris host darth
ethel:nrst0a       # a tape drive connected to NetApp filer ethel
winserv:\\.\obl0   # a tape library connected to Windows media server winserv
//winserv/obl0     # equivalent to the preceding aspec

authtype

The authtype placeholder specifies an authorization type, which is the mode in which Oracle Secure Backup authenticates itself to the Network Data Management Protocol (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.

Syntax

authtype::=

none | negotiated | text | md5

Semantics

none: Oracle Secure Backup sends the NDMP server an authorize client message specifying NDMP's none authentication mode. Most servers do not accept this type of authentication.
negotiated: Oracle Secure Backup determines (with the NDMP server) the best authentication mode to use. This is the default setting for the NDMP default and policies value.
text: Oracle Secure Backup uses plain, unencrypted text to authenticate.
md5: Oracle Secure Backup uses the MD5 digest algorithm to authenticate.

backup-container

Description

The backup-container placeholder specifies a backup container to store the backup images and backup image instances. This can be the volume ID of a tape volume or the name of a disk pool.

Syntax

backup-container::=

backup-container

Semantics

backup-container: Specifies the name of the backup container. This can be the name of a disk pool or tape volume.

backup-level

Description

The backup-level placeholder specifies the level of a backup created with the backup command.

Syntax

backup-level::=

full | incr_level | incr | offsite

incr_level::=

1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

Semantics

full: Specifies that Oracle Secure Backup should back up all files defined in a dataset regardless of when they were last backed up. This option is equivalent to level 0. This is the default value.
incr_level: Specifies an incremental level from 1 to 9 and backs up only those files that have changed since the last backup at a lower level.
incr: Specifies that Oracle Secure Backup should back up any file that has been modified since the last incremental backup at the same level or lower. The incr option is equivalent to level 10. This level is platform-dependent and is incompatible with some client operating systems such as the Netapp filer Data ONTAP.
offsite: Equivalent to a full (level 0) backup except that Oracle Secure Backup keeps a record of this backup in such a way that it does not affect the full or incremental backup schedule. This option is useful when you want to create a backup image for offsite storage without disturbing your schedule of incremental backups.

concjobs

Description

Specifies the maximum number of jobs that can be run concurrently for a particular disk pool or cloud storage device.

Syntax

concjobs::=: n | unlimited

Semantics

n: Specifies a number that is greater than or equal to 1.

unlimited: There is no limit on the number of concurrent jobs for a disk pool or cloud storage device.

content

Description

The content placeholder represents the type of backup content in a database backup storage selector.

Syntax

content::=

archivelog | full | incremental | autobackup

Semantics

archivelog: Backs up or restores database archived redo logs.
full: Backs up or restores the database files, regardless of when they were last backed up. This option is identical to a level 0 backup.
incremental: Backs up or restores only data that has been modified since the last backup, regardless of the backup level.
autobackup: Backs up or restores control files.

data-selector

Description

The data-selector placeholder represents Oracle Secure Backup catalog data that is selected based on user-specified values.

Syntax

data-selector::=

latest | earliest | all | backup-id | date-time | date-range

Semantics

latest

Most recent. If the following conditions are met, then Oracle Secure Backup includes all backups on which the incremental is dependent up to and including the preceding full backup:

The file-system object is a directory.
The most recent instance is an incremental backup.

earliest

Least recent. If the file-system object is a directory, then Oracle Secure Backup selects the instance of the directory and its contents found in the earliest full backup.

all

All instances.

backup-id

The specific instance contained in the backup image section identified by backup-id. The backup ID is a small integer assigned by obtool for reference purposes only.

date-time

The file-system object as it existed in a backup no later than the given date-time (see "date-time"). If the file-system object is a directory, and if the most recent instance is an incremental backup, then Oracle Secure Backup includes all predicates (backups on which the incremental is dependent) up to and including the preceding full backup.

date-range

All objects backed up exactly between the two specified date-time values (see "date-range"). Unlike the single date-time expression, Oracle Secure Backup gives no special consideration to incremental backups of directories.

dataset-dir-name

Description

The dataset-dir-name placeholder specifies the name of a dataset directory. Like Windows and UNIX file systems, Oracle Secure Backup dataset files are organized in a naming tree on the administrative server. 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.

Syntax

dataset-dir-name::=

dataset-dir-name

Semantics

dataset-dir-name

Specifies the name of a dataset directory. Dataset directory 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.

Standard notation for directory paths applies to dataset directories. For example, a single period (.) specifies the current directory and two consecutive periods (..) specifies one level higher than the current directory.

dataset-file-name

Description

The dataset-file-name placeholder specifies the name of a dataset file. As described in "dataset-dir-name", dataset files are organized in a directory tree.

Syntax

dataset-file-name::=

dataset-file-name

Semantics

dataset-file-name: Specifies the name of a dataset file. Dataset file 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.

dataset-name

Description

Specifies the name of a dataset directory or dataset file.

Syntax

dataset-name::=

dataset-file-name | dataset-dir-name

Semantics

"dataset-dir-name" describes the dataset-dir-name placeholder. "dataset-file-name" describes the dataset-file-name placeholder.

date-range

Description

The date-range placeholder represents a range of dates in a data-selector.

Syntax

date-range::=

date-time-date-time

Semantics

Refer to "date-range" for a description of the date-time placeholder. Note that the formats of the beginning and end of the date-range are not required to be parallel. For example, you can express the time in the beginning of the range and then omit the time in the end of the range.

Example

Sample values for date-range include the following:

2013/1/1-2013/1/31
5/25.08:00:00-5/25.08:30:00
2012/03/01-05/3/2.22:00:00

date-time

Description

The date-time placeholder represents a date and time.

Syntax

date-time::=

[year/]month/day[.hour][:minute][:second]

Semantics

year: Specifies a one-digit, two-digit, or four-digit year number. If year is absent, then the current year is assumed unless explicitly documented otherwise.
month: Specifies a one-digit or two-digit month number.
day: Specifies a one-digit or two-digit day number.
hour: Specifies a one-digit or two-digit hour number. Hours are represented in military format.
minute: Specifies a one-digit or two-digit minute number.
second: Specifies a one-digit or two-digit second number.

Example

Example 4-2 date-time

Sample values for date-time include the following:

2012/1/1
5/25.08:30:00
2/2
10/16.1:15

day-date

Description

The day-date placeholder identifies a day or group of days.

Syntax

day-date::=

weekday-expr | relative-weekday-expr | 
day n { each month | each quarter | each year } | year/month/day | month/day |
month/day each quarter

weekday-expr::=

weekday-name | weekday-aggregate | weekday-range [ weekday-name | 
weekday-aggregate | weekday-range ]...

weekday-name::=

monday[s] | tuesday[s] | wednesday[s] | thursday[s] | friday[s] |
saturday[s] | sunday[s]

weekday-aggregate::=

daily | weekend[s] | weekday[s]

weekday-range::=

weekday-name-weekday-name

relative-weekday-expr::=

[ weekday-ordinal weekday-name ]... |
[ { weekday_name }... except weekday-ordinal ]... |
[ { weekday_name }... [ except ] { before | after } weekday-ordinal weekday-name ]...

weekday-ordinal::=

first | second | third | fourth | fifth | last

Note:

Any day-date string with embedded spaces must be enclosed in double quotation marks.

Semantics

weekday-expr

Identifies one or more weekdays independently of where they occur in a month.

If you specify multiple weekday expressions, then they must be individually separated by spaces and collectively enclosed with double quotation marks. To specify Monday, Wednesday, and Friday, for example, use "monday wednesday friday".

Mixed expressions are permitted, but they must be enclosed by double quotation marks. To specify Wednesdays and weekends, for example, use "wednesday weekend".

Weekday ranges must run from earlier to later in the week. For example, sunday-friday is permitted but not thursday-tuesday.

Note:

Oracle Secure Backup for Windows does not support mixed-case or uppercase weekday names. Specifying Monday or MONDAY as a weekday name, for example, returns an error.

relative-weekday-expr

Identifies one or more weekdays based on where they occur in a month.

weekday-ordinal weekday-name

Identifies weekdays by the order in which they occur in the month.

weekday-name except weekday-ordinal

Identifies weekdays by name, but excludes those that fall within the specified order.

day-of-week [except] {before | after} weekday-ordinal weekday-name

Identifies specific weekdays that fall before or after another day, or weekdays except those that fall before or after another day.

day n each {month | quarter | year}

Identifies the nth ordinal day of each month, quarter, or year. There are 92 days in a quarter; day 92 is considered last even if there are fewer days in the quarter.

year/month/day

Identifies the specified day only once.

month/day

Identifies the specified day every year.

month/day each quarter

Identifies the day of the given relative month (1, 2, or 3) in every calendar quarter.

Examples

Example 4-3 day-date

Sample values include the following:

daily
tuesdays
"monday wednesday friday"
"monday-thursday saturday"
"wednesday weekends"
"last saturday"
"second thursday third sunday"
"thursday friday saturday except first"
"saturday except third"
"saturday sunday after first friday"
"weekdays before last saturday"
"weekends except after last friday"
"monday wednesday except before first sunday"
"day 4 each month"
"day 31 each quarter"
"day 90 each year"
2012/12/25
12/25
"3/1 each quarter"

day-specifier

Description

The day-specifier placeholder represents a range of time in terms of days.

Syntax

day-specifier::=

year/month/day | month/day | wday | wday-wday | weekday[s] | weekend[s] | daily |
today | yesterday

wday::=

sunday[s] | monday[s] | tuesday[s] | wednesday[s] | thursday[s] | friday[s] 
| saturday[s]

Semantics

"day-date" describes the possible values for the placeholders year, month, and day.

devicename

Description

The devicename placeholder specifies the name of a tape library, tape drive, or disk pool. The tape device name must be unique among all Oracle Secure Backup device names. It is unrelated to any other name used in your computing environment or the Oracle Secure Backup administrative domain. The disk pool name must be unique within the Oracle Secure Backup administrative domain.

Syntax

devicename::=

devicename

Semantics

devicename: Specifies the name of a tape drive, tape library, or disk pool. Device 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.

dupevent

Description

The volume-specific event that determines when the duration specified in a duplication policy begins to elapse. A duplication job is scheduled only if one of these events occurs at the first active location, because duplication takes place only at the first active location.

Syntax

dupevent::=

firstwrite | lastwrite | windowclosed | nonwritable | firstmove

Semantics

firstwrite: The point at which the first write to a volume occurs.
lastwrite: The point at which the last write to a volume occurs.
windowclosed: The point at which the write window closes.
nonwritable: 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.
firstmove: The point at which volume becomes eligible to move from its first active location.

duplicationrule

Description

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

Syntax

duplicationrule::=

mediafamily: number

Semantics

mediafamily: Identifies the media family for this duplication rule.
number: Specifies the number of duplicates to be created for the specified media family.

duration

Description

The duration placeholder represents a length of time.

Syntax

duration::=

forever | disabled | number{s[econds] | mi[nutes] | h[ours] | d[ays] | w[eeks] | 
mo[nths] | y[ears]}

Semantics

forever: Specifies that the duration is unlimited.
disabled: Specifies no duration. This value is not legal for the --waittime option in database storage selectors.
number: Specifies the duration in terms of an integer value of temporal units. To avoid quoting you cannot include a space between number and the value that follows it. For example, 3days is a legal value, but 3 days is not. The value 3" days" is valid.

Example

Example 4-4 duration

Examples of duration values include the following:

10minutes
forever
30" sec"
1y

element-spec

Description

The element-spec placeholder represents the name of a tape library element.

Syntax

element-spec::=

se-spec | ieen | dten

Semantics

se-spec: Specifies the number of a storage element in the tape library. Refer to the description of se-spec in "se-spec".
ieen: Specifies the import/export element n.
dten: Specifies tape drive n.

event

Description

The volume-specific event that determines when the duration specified in a rotation rule begins to elapse. Some events are valid only at an active location, and other events are valid only at a storage location.

Syntax

event::=

firstwrite | lastwrite | windowclosed | nonwritable | arrival | expiration

Semantics

firstwrite: The point at which the first write to a volume occurs. This value is valid only at active locations.
lastwrite: The point at which the last write to a volume occurs. This value is valid only at active locations.
windowclosed: The point at which the write window closes. This value is valid only at active locations.
nonwritable: 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 at active locations.
arrival: The point at which the volume arrives at a storage location. This value is valid only at storage locations.
expiration: The point at which a volume expires. This value is valid only at storage locations.

filenumber

Description

The filenumber placeholder identifies ordinal position of the backup image within the volume set.

Syntax

filenumber::=

filenumber

Semantics

filenumber: Specifies the file number. The first backup image instance of each volume set is file number 1.

filenumber-list

Description

The filenumber-list placeholder represents one or more ordinal filenumber values.

Syntax

filenumber-list::=

filenumber[,filenumber]... | filenumber-filenumber

Semantics

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

iee-range

Description

The iee-range placeholder represents a range of import/export elements. The elements need not be continuous.

Syntax

iee-range::=

vacant | none | iee-subrange[,iee-subrange]...

iee-subrange::=

iee-spec-iee-spec | iee-spec[,iee-spec]...

Semantics

Refer to "iee-spec" for a description of the placeholders and keywords in the iee-range syntax. The dash in iee-spec-iee-spec expresses an inclusive range of elements.

Example

Example 4-5 iee-range

Examples of iee-range values include the following:

iee1
iee1-iee3
iee1,iee3,iee7-iee9
vacant
none

iee-spec

Description

The iee-spec placeholder represents the number of an import/export storage element in a tape library.

Syntax

iee-spec::=

[iee]n | none | vacant

Semantics

[iee]n

where n is a number ranging from 1 to the maximum number of import/export elements in the tape library.

Elements are referenced by their abbreviation (iee) followed by the number of the element, for example, iee2. When multiple elements of a particular type exist, element numbering starts at 1. When there is only one element of a type, the number can be omitted: iee1 and iee both refer to the first and only import/export element.

none

Indicates no import/export element.

vacant

Indicates any empty import/export element.

job-type

Description

The type of an Oracle Secure Backup job.

Syntax

job-type::=

dataset | backup | restore | orabackup | orarestore | scan |
mediamovement | duplication | oraparent | catimport | copyinstance | 
copyfromstage | stagescan | validatechecksum

Semantics

dataset

A dataset job is a backup of a specified dataset. Oracle Secure Backup assigns a dataset job an identifier consisting of the username of the logged in Oracle Secure Backup user, a slash, and a unique numeric identifier. An example of a dataset job identifier is admin/15.

backup

For each dataset job, Oracle Secure Backup creates one subordinate job for each host that it includes. Oracle Secure Backup assigns each backup job an identifier whose prefix is the parent (dataset) job id, followed by a dot (.), then followed by a unique small number. An example of a backup job identifier is admin/15.1.

restore

Oracle Secure Backup creates a restore job for each backup image that must be read to initiate a restore operation. Oracle Secure Backup assigns each job an identifier consisting of the logged in username, a slash, and a unique numeric identifier. An example of a restore job identifier is admin/16.

orabackup

Oracle Secure Backup creates an Oracle backup job when the Recovery Manager (RMAN) BACKUP command backs up database files. This job attaches to a parent job whose identifier is created by an Oracle Secure Backup user name, a slash, and a numeric identifier. The Oracle Secure Backup user name is the one that the operating system user is preauthorized to assume (see the --preauth option of the mkuser command). An example of a parent job identifier is sbt/15.

The job identifier of an Oracle backup job is created by using the job identifier of the parent job followed by a dot and a unique numeric identifier to identify each subordinate job. An example of an Oracle backup job identifier is sbt/15.1.

orarestore

Oracle Secure Backup creates an Oracle restore job when the Recovery Manager (RMAN) RESTORE command restores database files from a backup image instance. This job attaches to a parent job whose identifier is created by an Oracle Secure Backup user name, a slash, and a numeric identifier. The Oracle Secure Backup user name is the one that the operating system user is preauthorized to assume (see the --preauth option of the mkuser command). An example of a parent job identifier is sbt/16.

The job identifier of an Oracle restore job is created by using the job identifier of the parent job followed by a dot and a unique numeric identifier to identify each subordinate job. An example of an Oracle restore job identifier is sbt/16.1.

scan

A scan job runs at a time specified by the backup administrator and scans the volumes catalog to determine which volumes are eligible for media movement or duplication jobs. The scan occurs on a location-by-location basis. These media movement and duplication jobs run in specified media movement or duplication windows and when resources are available.

mediamovement

A media movement job specifies that media should be moved from one location to another, to satisfy its associated rotation policy or when recalled from a storage location.

duplication

A duplication job specifies that media should be duplicated in accordance with its associated duplication policy.

oraparent

Oracle Secure Backup creates an Oracle backup job when the Recovery Manager (RMAN) BACKUP command backs up database files. A parent job is identified by an Oracle Secure Backup user name, a slash, and a numeric identifier. The Oracle Secure Backup user name is the one that the operating system user is preauthorized to assume. An example of a parent job identifier is sbt/16.

The oraparent is the parent job associated with the orabackup job.

catimport

Oracle Secure Backup creates a catalog import job when the catalog command is used to import catalog information from all the backup image instances in a backup container. When this job completes, the catalog is updated with the metadata imported from the specified backup container.

copyinstance

Oracle Secure Backup creates a copy instance job when a cpinstance command to create a copy of a backup image instance. Each copy instance job is assigned a unique identifier and can be run either immediately or at a later time.

copyfromstage

A copyfromstage job copies the backup image instances created by a stage source job to a destination container. A copyfromstage job inherits policies from cpinstance policies.

stagescan

A stagescan job is launched by either a stagescan schedule or an on-demand stagescan command. A stagescan job scans and filters the backup image instances in one or more stage disk pool devices. Instances that match a stage-rule that is attached to the device are grouped and copied by a copyfromstage job created by the stagescan job. A stagescan job can create zero or more copyfromstage jobs.

validatechecksum

Oracle Secure Backup creates a validatechecksum job when a validatechecksum command is used to verify the integrity of backup image instances.

name-format

Description

The name-format placeholder specifies the format used for naming backup images.

Valid values for names include upper case alphabets, lower case alphabets, digits, hyphen, underscore, or a period. These can be combined with the name format variables %H, %T, %t, %R, %d, or %S.

If you do not explicitly specify a name format, Oracle Secure Backup uses %H-%T-%t. For example, if a backup is created on the host brhost2 at 10:23:46 on 04/12/2013, then the name used for the backup image is brhost2-102346-20130412.

Syntax

name-format::=

%H | %T | %t | %R | %d | %S

Semantics

%H: Specifies the name of the host.
%T: Specifies the date when backup was created in yyyymmdd format.
%t: Specifies the time when backup was created in hhmmss format
%R: Specifies the name of the Oracle Secure Backup user who created the backup job. This is applicable only for on-demand backups.
%d: Specifies the name of the Oracle Database. This is applicable only for RMAN backups.
%S: Specifies the name of the dataset that contained details about the directories backed up. This is applicable only for file-system backups.

ndmp-backup-type

Description

The ndmp-backup-type placeholder specifies the type of Network Data Management Protocol (NDMP) backup for certain Network Attached Storage (NAS) devices.

The placeholder values are specific to NDMP filer vendors so check the applicable backup type with your filer vendor.

Note:

The value specified for ndmp-backup-type is case-sensitive. You must use lowercase while specifying the NDMP backup type.

Syntax

ndmp-backup-type::=

dump | image | zfs

Semantics

dump: This mode runs backups less quickly, dumps the /usr/store file system in tar format, and permits selective restore of individual user mailboxes.
image: This mode runs backups quickly and dumps the whole /usr/store file system. Only complete file-system restore operations are possible.
zfs: This mode runs backups that are specific to the Oracle ZFS Storage Appliance.

numberformat

Description

The numberformat placeholder specifies the format in which to display large numbers. If numberformat is not specified, then obtool uses the value of the numberformat variable. If this variable is unset, then the default is friendly.

Syntax

numberformat::=

friendly | precise | plain

Semantics

friendly: Specifies this keyword to display large values in KB, MB, and so on.
precise: Specify this keyword to display precise values with commas.
plain: Specify this keyword to display precise values without commas.

oid

Description

The oid placeholder represents the catalog identifier of a volume, backup image section, or backup piece record. You can obtain an oid in the following ways:

Run the lsvol command to display the volume ID (VOID) for a volume.
Run the lsbu command to display the backup ID for a backup section.
Run the lspiece command with the --long option to display the backup piece OID for a backup piece.

Syntax

oid::=

oid

Semantics

oid: Specifies the object identifier. Within the Oracle Secure Backup catalog, Oracle Secure Backup identifies each backup image section with a numeric backup ID. Oracle Secure Backup assigns backup IDs without regard to the time order of backups. For example, backup ID 25 can represent a Monday backup whereas backup ID 6 represents a backup on the following day.

oid-list

Description

The oid-list placeholder represents one or more catalog identifiers. The oid placeholder represents a catalog identifier.

Syntax

oid-list::=

oid[,oid]... | oid-oid

Semantics

Refer to "oid" for a description of the oid placeholder. The dash in oid-oid expresses an inclusive range of oid values.

Example

Example 4-6 oid-list

The following examples show valid values for oid-list:

3,42,16
1-5

policyname

Description

Specifies the name of a duplication or rotation policy.

preauth-spec

Description

The preauth-spec placeholder defines an operating system user who is preauthorized to access Oracle Secure Backup.

Syntax

preauth-spec::=

hostname[:os-username[:windows-domain]]+preauth-attr[+preauth-attr]...

Semantics

hostname

This placeholder specifies the host for the operating system user who has preauthorized access to Oracle Secure Backup. Use an asterisk character (*) as a wildcard to indicate all hosts in the administrative domain.

os-username

This placeholder grants the specified operating system preauthorized access to Oracle Secure Backup. If you specify os-username as a Windows account name, then you must explicitly state the windows-domain name either as a wildcard or a specific name. Use an asterisk character (*) as a wildcard to indicate all operating system users on the host. By default, all users on the specified host are preauthorized.

windows-domain

This placeholder specifies the Windows domain of hostname. This placeholder is only applicable to preauthorized logins from a Windows host. Use an asterisk character (*) as a wildcard to indicate all Windows domains. By default, preauthorized access on the specified host is permitted for all Windows domains.

preauth-attr

Defines the Oracle Secure Backup resources to which the preauthorized operating system user has access. You can specify the following values:

rman

This value preauthorizes Oracle Database SBT backups through Recovery Manager (RMAN). If a matching preauthorization cannot be found for a given SBT request, then the request fails.
cmdline

This value preauthorizes login through the user-invoked Oracle Secure Backup command-line utilities.

Example

Example 4-7 preauth-spec

obhost1+rman
obhost2:jblogg+rman+cmdline
obhost2:*:Win-domain+rman
*:jblogg:*+cmdline

produce-days

Description

The produce-days placeholder specifies days of the week on which a summary report is to be produced.

Syntax

produce-days::=

weekday-name | daily | weekday | weekend

weekday-name::=

monday[s] | tuesday[s] | wednesday[s] | thursday[s] | friday[s] |
saturday[s] | sunday[s]

Semantics

The values are self-explanatory.

protover

Description

The protover placeholder represents a Network Data Management Protocol (NDMP) protocol version. Typically, you can allow Oracle Secure Backup to choose the highest protocol version that the server can use to communicate. If it is necessary for testing or some other purpose, then you can change the NDMP protocol version with which Oracle Secure Backup communicates with this server. If an NDMP server cannot communicate using the protocol version you select, then Oracle Secure Backup reports an error rather than using a mutually supported version.

Syntax

protover::=

version_number

Semantics

version_number: Specifies the protocol version number. Valid values are 2, 3, 4, and null (""), which means "as proposed by server". The default is null.

restriction

Description

The restriction placeholder specifies the restriction of an operation to a tape, disk pool, or cloud storage device. When multiple tape device restrictions are specified in a list, Oracle Secure Backup selects a tape device from only one of them.

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

Syntax

restriction::=

devicename | @hostname | devicename@hostname

Semantics

devicename: Uses the specified tape, disk pool, or cloud storage device.
@hostname: Uses any tape device attached to the host with the name hostname.
devicename@hostname: Uses any tape, disk pool, or cloud storage device attached to the host with the name hostname. Preference is given to tape when there are multiple device types attached to the host.

role

Description

The role placeholder represents a host role in an administrative domain.

Syntax

role::=

admin | client | mediaserver

Semantics

admin: Specifies the host computer in your administrative domain that contains a copy of Oracle Secure Backup software and the catalogs that store configuration settings and backup history.
client: Specifies a host computer whose locally-accessed data are backed up by Oracle Secure Backup. Most computers defined within the administrative domain are client hosts.
mediaserver: Specifies a host computer that has one or more secondary storage devices, such as tape libraries, connected to it.

rotationrule

Description

The rotationrule placeholder specifies how long a volume stays at a particular location, as part of a rotation policy.

Syntax

rotationrule::=

     locationname[:event[:duration]]

Semantics

locationname: The name of an existing location object.
event: The volume-specific event that determines when the duration specified in the rotation rule begins to elapse.

See Also:

"event" for more information on the event placeholder
duration: The length of time after the event that the media remains at the location specified in this rotation rule.

See Also:

"duration" for details about valid values

schedule-priority

Description

The schedule-priority placeholder specifies a schedule priority for a backup, restore, vaulting scan, or volume duplication scan job. The priority for a job is a positive numeric value.

The foremost decision criterion that the scheduler uses to perform a job (after the earliest time to run this job has arrived) is the schedule priority. The scheduler dispatches higher priority jobs over lower priority ones, providing all resources required to run the job are available. For example, if twenty jobs are in the scheduler and ready for execution, then Oracle Secure Backup runs the job with the lowest numeric schedule priority.

Syntax

schedule-priority::=

priority_num

Semantics

priority_num: Specifies a positive numeric value. The lower the value, the greater the priority assigned to the job by the scheduler. The default schedule priority is 100. Priority 1 is the highest priority that you can assign to a job.

se-range

Description

The se-range placeholder represents a range of storage elements. The elements need not be continuous.

Syntax

se-range::=

all | none | se-subrange[,se-subrange]...

se-subrange::=

se-spec | se-spec-se-spec

Semantics

Refer to "se-spec" for a description of the se-spec placeholder. The dash in se-spec-se-spec expresses an inclusive range of se-spec values.

Example

Example 4-8 se-range

Examples of se-range values include the following:

1
1-2
1,3,5,se10-se30
all
none

se-spec

Description

The se-spec placeholder represents the number of a storage element in a tape library.

Syntax

se-spec::=

[se]n | none | vacant

Semantics

[se]n

where n is a number ranging from 1 to the maximum number of storage elements in the tape library.

Elements are referenced by their abbreviation (se) followed by the number of the element, for example, se5. When multiple elements of a particular type exist, element numbering starts at 1. When there is only one element of a type, you can omit the number: se1 and se both refer to the first and only storage element. If you omit the abbreviation, then a storage element is assumed. For example, se4 and 4 both refer to the fourth storage element.

none

Indicates no storage element.

vacant

Indicates any empty storage element. Specify vacant only if the tape drive is known to be loaded.

size-spec

Description

The size-spec placeholder specifies the size of disk pools.

Syntax

size-spec::=

0 | n [ KB | MB | GB | TB | PB | EB ]

Semantics

n: The numeric value that indicates the size of a disk pool. Use one of the following values to specify the unit of the disk pool size: KB, MB, GB, TB, PB, or EB.
0: Specifies that the size of the disk pool is limited only by the size of the underlying file-system that hosts the disk pool.

summary-start-day

Description

The summary-start-day placeholder specifies the first day of the week for which summary data is to be produced.

Syntax

summary-start-day::=

weekday-name | yesterday | today

weekday-name::=

monday[s] | tuesday[s] | wednesday[s] | thursday[s] | friday[s] |
saturday[s] | sunday[s]

Semantics

The values are self-explanatory.

time

Description

The time placeholder identifies a time in terms of hours, minutes, and (optionally) seconds. Hours are expressed in 24-hour military format.

Syntax

time::=

hhmm | h[h]:mm | h[h]:mm:ss

Semantics

h: Indicates a one-digit hour number, for example, 3 (which represents 3 a.m.).
hh: Indicates a two-digit hour number, for example, 22 (which represents 10 p.m.).
mm: Indicates a two-digit minute number, for example, 30.
ss: Indicates a two-digit second number, for example, 59.

Example

Example 4-9 time

Sample values for time include the following:

8:00
2250
14:35:30

time-range

Description

The time-range placeholder represents a time-of-day range.

Syntax

time-range::=

start-time-end-time

Semantics

"time" describes the formats for the start-time and end-time. The dash in start-time-end-time expresses an inclusive range of times.

Example

Example 4-10 time-range

The time range is local-time based and takes into account Daylight Savings Time, if it applies to your locale. Sample values for time-range include the following:

08:00:00-08:30:00
1430-1530
1430-14:35:30

vid

Description

The vid placeholder represents a unique alphanumeric identifier assigned by Oracle Secure Backup when the volume was labeled.

Syntax

vid::=

vid

Semantics

vid: Specifies an identity for a volume. The volume ID usually includes the media family name of the volume, a dash, and a unique volume sequence number. For example, a volume ID in the RMAN-DEFAULT media family could be RMAN-DEFAULT-000002. A vid can contain up to 31 characters, in any combination of alphabetic and numeric characters, but the last 6 characters must be numeric.

vol-range

Description

The vol-range placeholder represents a list of volumes in a tape library. You can specify a volume ID list or a barcode list.

Syntax

vol-range::=

--volume/-v vid[,vid]... | --barcode/-b tag[,tag]...

Semantics

"vid" describes the format for the vid placeholder.

Example

Example 4-11 vol-range

Sample values for vol-range include the following:

--volume VOL000001,VOL000002,VOL000005
--barcode ADE210,ADE202

vol-spec

Description

The vol-spec placeholder represents the specification of a volume in a tape library.

Syntax

vol-spec::=

--volume/-v vid | --barcode/-b tag

Semantics

"vid" describes the format for the vid placeholder.

vol-status

Description

The vol-status placeholder represents the current status of a volume and whether it is available for backup and restore operations.

Syntax

vol-status::=

usable | readonly | out-of-service

Semantics

usable: Indicates that the volume can be used for any operation.
readonly: Indicates that the volume can be used only for read operations.
out-of-service: Indicates that the volume cannot be used for any operation.

wwn

Description

The wwn placeholder represents the World Wide Name (WWN) of a tape device. A WWN is a 64-bit address used to uniquely identify a tape device in a Fibre Channel network. A WWN is typically assigned to a tape device by the tape device manufacturer, although the WWN can be later changed by a network user.

Restrictions and Usage Notes

Oracle Secure Backup supports tape devices whose operating system-assigned logical names can vary at each operating system restart. Fibre Channel-attached tape drives and libraries connected to Network Attached Storage (NAS) devices fall into this category. You can refer to these tape devices by their WWNs, for example, nr.WWN[2:000:0090a5:0003f7].a, rather than their logical names, for example, nrst0a. Unlike the logical name, the WWN does not change when you restart.

Any substring of the attachment raw device name that is the string $WWN is replaced with the value of wwn each time the device is opened. For example, a usable raw device name for a Network Appliance filer attached to a Storage Area Network (SAN) is nr.$WWN.a. This name specifies a no-rewind, best-compression tape device having the worldwide name you specify with the --wwn/-W option, for example, --wwn WWN[2:000:0090a5:0003f7].

Syntax

wwn::=

wwn

Semantics

wwn: Specifies a World Wide Name.