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 or restore job summary, which is a text file report that indicates whether a backup or restore job was successful.

Prerequisites

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

Syntax

mksum::=

mksu•m [ --days/-d produce-days[,produce-days]... ]
[ --reporttime/-t time ]
[ --mailto/-m email-target[,email-target]... ]
[ [ --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 } ]
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 needs to be operational on the administrative server for this feature to operate. Separate multiple entries with a comma.

--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 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 executed 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 set to no, 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 library. The incremental backup scheduled for Wednesday supersedes the backup from the previous night.

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 may contain at most 127 characters.

Example

Example 2-95 schedules a backup summary named weekly_report.

ob> mksum --days wed --reporttime 12:00 --mailto lance@company.com weekly_report
ob> lssum --long
weekly_report:
    Produce on:              Wed at 12:00
    Mail to:                 lance@company.com
    In the report, include:
        Backup jobs:             yes
        Restore jobs:            yes
        Scheduled jobs:          yes
        User jobs:               yes
        Subordinate jobs:        yes
        Superseded jobs:         no

Example 2-96 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        *2005/03/24.09:52 2005/03/24.09:52 dataset tbrset/entire_backup
admin/1.1      *2005/03/24.09:52 2005/03/24.09:52    host brhost2      3.5 MB  1 VOL000001 (ADE202)
admin/2        *2005/03/24.09:52 2005/03/24.09:52 restore to brhost2      
 
IV. Unsuccessful jobs.
 
                   Scheduled or
Job ID            *Introduced at    Content                  Status
------------------ ---------------- ------------------------ ------------------------
admin/7           *2005/03/24.16:41 dataset homedir.ds        failed - host isn't administrative 
                                                              domain member (OB job mgr)
admin/7.1         *2005/03/24.16:41     host brhost4(DELETED) failed - host isn't administrative 
                                                              domain member (OB job mgr)