Oracle RMAN Agent 19.4 Administration Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 141

PowerProtect Oracle RMAN Agent

Administration Guide
Version 19.4

Dell Inc.

July 2020
Rev. 02
Notes, cautions, and warnings

NOTE: A NOTE indicates important information that helps you make better use of your product.

CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the
problem.

WARNING: A WARNING indicates a potential for property damage, personal injury, or death.

© 2012 - 2020 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other
trademarks may be trademarks of their respective owners.
Contents

Figures.......................................................................................................................................... 7

Tables............................................................................................................................................8

Preface..........................................................................................................................................9

Chapter 1: Introducing the Oracle RMAN Agent................................................................................12


Overview of Oracle RMAN agent...................................................................................................................................... 12
Supported configurations....................................................................................................................................................13

Chapter 2: DD Boost Features.........................................................................................................14


Distributed segment processing.........................................................................................................................................14
Advanced load balancing and link failover.........................................................................................................................16
Configuration restrictions.............................................................................................................................................. 17
DD Boost-over-Fibre Channel transport........................................................................................................................... 17
DD Boost-over-Fibre Channel path management........................................................................................................... 18
Initial path selection........................................................................................................................................................19
Client path failover........................................................................................................................................................ 20
Dynamic re-balancing....................................................................................................................................................20
Queue-depth constraints..............................................................................................................................................20
Encrypted managed file replication....................................................................................................................................21
DD Boost and high availability.............................................................................................................................................21
DD Boost, HA, and failover............................................................................................................................................21
Partial HA configurations ..............................................................................................................................................21
Low-bandwidth optimization............................................................................................................................................. 22
Client access validation.......................................................................................................................................................22
In-flight encryption.............................................................................................................................................................. 22
Marker support ................................................................................................................................................................... 23

Chapter 3: Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments.... 24
Oracle RMAN agent and DD OS upgrades...................................................................................................................... 24
Firewalls and ports...............................................................................................................................................................24
Enabling DD Boost on a Data Domain system................................................................................................................. 24
Enabling Oracle optimized deduplication..........................................................................................................................25
Configuring the DD Boost server...................................................................................................................................... 26
Creating storage units...................................................................................................................................................26
Configuring distributed segment processing............................................................................................................. 26
Configuring advanced load balancing and link failover..............................................................................................26
Enabling low-bandwidth optimization ........................................................................................................................ 27
Enabling encrypted file replication...............................................................................................................................28
Configuring client access validation............................................................................................................................ 28
Configuring DD Boost-over-FC service............................................................................................................................29
Sizing DD Boost-over-FC device-set......................................................................................................................... 30

Contents 3
Sizing calculation............................................................................................................................................................ 31
Configuring the SCSI device driver for AIX clients....................................................................................................33
Configuring the SCSI generic device driver for Solaris clients................................................................................ 33

Chapter 4: Configuring the Oracle RMAN Agent for Stand-alone Deployment.................................... 35


Installing and configuring the Oracle RMAN agent on AIX, Linux, and Solaris systems.............................................35
Installing the Oracle RMAN agent on database servers...........................................................................................35
Installing the Oracle RMAN agent on Linux and UNIX..............................................................................................37
Uninstalling the Oracle RMAN agent on database servers...................................................................................... 40
Uninstalling the Oracle RMAN agent on Linux and UNIX..........................................................................................41
Configuring the software on Linux and UNIX systems............................................................................................. 41
Installing and configuring the Oracle RMAN agent on Windows systems................................................................... 42
Installing the Oracle RMAN agent on database servers........................................................................................... 42
Installing the Oracle RMAN agent on Windows systems......................................................................................... 42
Uninstalling the Oracle RMAN agent on Windows systems.................................................................................... 44
Configuring the software on Windows systems........................................................................................................45
Registering each Data Domain system............................................................................................................................. 45
Registering a standard Data Domain system............................................................................................................. 45
Registering a Data Domain system with DD Boost over Fibre Channel................................................................. 47
Registering a Data Domain system for shared lockbox access............................................................................... 48
Migrating an Oracle configuration from the database application agent.....................................................................50
Updating the RMAN scripts for Oracle RMAN agent operations............................................................................51
Using the correct RMAN script for restore, crosscheck, and delete operations..................................................52
Updating the data movement policy for cloud tier operations................................................................................ 53
Performing backups of a clustered environment to Data Domain................................................................................54
Data Domain replication......................................................................................................................................................55
Performing managed file replication (MFR)...............................................................................................................55
Restoring from MTree replicated backups.................................................................................................................57
Specifying subdirectories for Oracle RMAN agent backups......................................................................................... 58
Performing backups and restores of Oracle CDBs and PDBs.......................................................................................60
Performing DD Boost compressed restores.................................................................................................................... 60
Display and deletion of backups......................................................................................................................................... 61
Using the ddutil command to display and delete backups........................................................................................ 61
Using the ddutil command to display backup information........................................................................................64
Using the ddutil command to delete backups............................................................................................................66
Using the ddutil command to prune backups based on age.................................................................................... 66
Oracle Incremental Merge operations...............................................................................................................................67
Overview of Oracle Incremental Merge features...................................................................................................... 67
Installation requirements for Oracle Incremental Merge.......................................................................................... 68
Configuration requirements for Oracle Incremental Merge..................................................................................... 69
Performing the Oracle Incremental Merge operations............................................................................................. 76
Configuring the use of Data Domain Cloud Tier for data movement to the cloud..................................................... 98
Setting up the data movement to the cloud..............................................................................................................99
Performing the data recall from the cloud................................................................................................................100
RMAN crosscheck and deletion of backup data in the cloud................................................................................ 100
Usage limits on Data Domain resources..........................................................................................................................100
Oracle RMAN agent operations with Data Domain usage limits on capacity....................................................... 101
Oracle RMAN agent operations with Data Domain usage limits on streams........................................................ 101
Configuring usage limits on Data Domain resources................................................................................................ 101
Estimating the Data Domain resource usage on Oracle systems.......................................................................... 102

4 Contents
Chapter 5: Data Domain System Administration............................................................................. 104
Restricting DD Boost access to specific database servers.......................................................................................... 104
File replication version compatibility................................................................................................................................ 105
Modifying an interface group........................................................................................................................................... 105
Removing the advanced load balancing and link failover configuration................................................................105

Chapter 6: Troubleshooting.......................................................................................................... 107


Troubleshooting overview.................................................................................................................................................107
Investigating problems.......................................................................................................................................................107
Oracle limitations................................................................................................................................................................ 107
Reporting problems............................................................................................................................................................107
Data Domain system settings for file replication........................................................................................................... 108
Lockbox troubleshooting information..............................................................................................................................108
Failure to load the media management library............................................................................................................... 109

Chapter 7: Using DD Boost Commands...........................................................................................110


DD Boost command summary.......................................................................................................................................... 110
The ddboost command options........................................................................................................................................ 110
access.............................................................................................................................................................................110
clients.............................................................................................................................................................................. 111
destroy............................................................................................................................................................................ 111
disable..............................................................................................................................................................................111
enable.............................................................................................................................................................................. 111
fc..................................................................................................................................................................................... 112
file-replication................................................................................................................................................................ 112
ifgroup............................................................................................................................................................................ 115
option..............................................................................................................................................................................116
reset................................................................................................................................................................................ 117
set user-name................................................................................................................................................................117
show............................................................................................................................................................................... 118
status..............................................................................................................................................................................119
storage-unit................................................................................................................................................................... 119

Appendix A: Installation and Configuration Checklist....................................................................... 121


Configure the Data Domain system................................................................................................................................. 121
Download and install the Oracle RMAN agent................................................................................................................121
Configure RMAN for the environment............................................................................................................................ 121
Test the installation by using sbttest (optional) ............................................................................................................122
Backup examples................................................................................................................................................................122

Appendix B: Performing a Backup with Oracle Enterprise Manager.................................................. 123


Example screens................................................................................................................................................................ 123

Appendix C: Installing and Configuring the Oracle RMAN Agent.......................................................126


Installation and configuration examples.......................................................................................................................... 126

Appendix D: Oracle RMAN Agent Command Reference................................................................... 130


The ddbmoim command and options.............................................................................................................................. 130

Contents 5
The ddutil command and options.....................................................................................................................................136

6 Contents
Figures
1. Oracle RMAN agent configuration.......................................................................................................................... 12

2. High-level data flow with distributed segment processing disabled....................................................... 15

3. High-level data flow with distributed segment processing enabled........................................................15

4. Example of advanced load balancing and link failover configuration...................................................... 16

5. DD Boost-over-IP transport...................................................................................................................................... 17

6. SCSI commands between media server and Data Domain system.........................................................18

7. Fibre Channel communication path........................................................................................................................ 18

8. DD Boost-over-FC path management scenario...............................................................................................19

9. Login window................................................................................................................................................................. 123

10. Database instance page...........................................................................................................................................123

11. Processing page........................................................................................................................................................... 124

12. Schedule Customized Backup: Options page................................................................................................ 124

13. Schedule Customized Backup: Schedule page............................................................................................. 124

14. Schedule Customized Backup: Review page.................................................................................................125

15. Execution page............................................................................................................................................................ 125

Figures 7
Tables
1. Revision history..................................................................................................................................................................9

2. Style conventions........................................................................................................................................................... 10

3. Environment variables for installation or upgrade of Oracle RMAN agent..........................................36

4. Software package names on UNIX and Linux...................................................................................................37

5. Product software components on Linux or UNIX...........................................................................................38

6. Environment variables for uninstallation of Oracle RMAN agent............................................................ 40

7. Product software components on Windows.....................................................................................................43

8. The ddutil command options for backup display and deletion...................................................................62

9. Configuration file parameters for Oracle Incremental Merge.....................................................................71

10. The ddbmoim command options for Oracle Incremental Merge operations.................................... 76

11. Summary of DD Boost commands....................................................................................................................... 110

12. Inbound and outbound file transfer..................................................................................................................... 114

13. Inbound and outbound data transfer..................................................................................................................114

14. Output definitions for DD Boost histogram.....................................................................................................118

15. The ddbmoim command options for Oracle Incremental Merge operations...................................130

16. The ddutil command options................................................................................................................................. 138

8 Tables
Preface
As part of an effort to improve product lines, periodic revisions of software and hardware are released. Therefore, all versions of the
software or hardware currently in use might not support some functions that are described in this document. The product release notes
provide the most up-to-date information on product features.
If a product does not function correctly or does not function as described in this document, contact a technical support professional.
NOTE: This document was accurate at publication time. To ensure that you are using the latest version of this
document, go to the Support website https://www.dell.com/support.

Purpose
This document describes how to install, configure, and use the PowerProtect Oracle RMAN agent version 19.4 software.
In earlier versions of the product, the Oracle RMAN agent was known as Data Domain Boost (DD Boost) for Oracle Recovery Manager
(RMAN) or the RMAN plug-in. In version 4.0, the product name changed to Oracle RMAN agent.

NOTE: The Oracle RMAN agent uses Application Direct workflows, known in previous releases as DD Boost workflows.

Audience
This guide is for system administrators who are familiar with Oracle backup applications and general backup administration.

Revision history
The following table presents the revision history of this document.

Table 1. Revision history


Revision Date Description
02 July 13, 2020 Updated the following topic at the start of Chapter 4:
• Installing the Oracle RMAN agent on database servers—Added
information in the first Note about the requirement for installation in a
non-default directory path.

01 March 31, 2020 Initial release of this document for Oracle RMAN agent 19.4.

Related documentation
The following publications provide additional information:
• PowerProtect Oracle RMAN Agent Release Notes
• DDBEA section of the eLab Navigator at https://elabnavigator.emc.com/eln/modernHomeDataProtection
• Data Domain Operating System documentation
• Data Domain system installation and setup guide for each supported platform, for example DD890, DD670, and so on
• PowerProtect Data Manager Administration and User Guide
• PowerProtect Data Manager Deployment Guide
• PowerProtect Data Manager Security Configuration Guide
• PowerProtect X400 Administration and User Guide
• PowerProtect X400 Deployment Guide
• PowerProtect X400 Security Configuration Guide

Preface 9
RMAN Documentation
Oracle 18c: From the Oracle Database Documentation library at https://docs.oracle.com/en/database/oracle/oracle-database/18/, select
Administration and select a guide under Backup and Recovery:
• Database Backup and Recovery Reference
• Database Backup and Recovery User’s Guide
Oracle 12c Release 2: From the Oracle Database Documentation library at https://docs.oracle.com/en/database/oracle/oracle-database/
12.2/index.html, select Administration and select a guide under Backup and Recovery:
• Database Backup and Recovery Reference
• Database Backup and Recovery User’s Guide
Oracle 12c Release 1: From the Oracle Database Documentation library at https://docs.oracle.com/database/121/index.htm, select
Database Administration and select a guide under Backup and Recovery:
• Backup and Recovery User’s Guide
• Backup and Recovery Reference
Oracle 11g Release 2: From the Oracle Database Documentation library at www.oracle.com/pls/db112/homepage, select Database
Administration and select a guide under Backup and Recovery:
• Backup and Recovery User’s Guide
• Backup and Recovery Reference
Oracle 10g Release 2: From the Oracle Database Documentation library at www.oracle.com/pls/db102/homepage, select Administration
and select a guide under Backup and Recovery:
• Backup and Recovery Reference
• Backup and Recovery Advanced User’s Guide

Typographical conventions
The following type style conventions are used in this document:

Table 2. Style conventions


Bold Used for interface elements that a user specifically selects or clicks, for example, names of buttons,
fields, tab names, and menu paths. Also used for the name of a dialog box, page, pane, screen area
with title, table label, and window.
Italic Used for full titles of publications that are referenced in text.
Monospace Used for:
• System code
• System output, such as an error message or script
• Pathnames, file names, file name extensions, prompts, and syntax
• Commands and options

Monospace italic Used for variables.


Monospace bold Used for user input.
[] Square brackets enclose optional values.
| Vertical line indicates alternate selections. The vertical line means or for the alternate selections.
{} Braces enclose content that the user must specify, such as x, y, or z.
... Ellipses indicate non-essential information that is omitted from the example.

You can use the following resources to find more information about this product, obtain support, and provide feedback.

Where to find product documentation


• https://www.dell.com/support
• https://community.emc.com

10 Preface
Where to get support
The Support website https://www.dell.com/support provides access to product licensing, documentation, advisories, downloads, and
how-to and troubleshooting information. The information can enable you to resolve a product issue before you contact Support.
To access a product-specific page:
1. Go to https://www.dell.com/support.
2. In the search box, type a product name, and then from the list that appears, select the product.

Knowledgebase
The Knowledgebase contains applicable solutions that you can search for either by solution number (for example, KB000xxxxxx) or by
keyword.
To search the Knowledgebase:
1. Go to https://www.dell.com/support.
2. On the Support tab, click Knowledge Base.
3. In the search box, type either the solution number or keywords. Optionally, you can limit the search to specific products by typing a
product name in the search box, and then selecting the product from the list that appears.

Live chat
To participate in a live interactive chat with a support agent:
1. Go to https://www.dell.com/support.
2. On the Support tab, click Contact Support.
3. On the Contact Information page, click the relevant support, and then proceed.

Service requests
To obtain in-depth help from Licensing, submit a service request. To submit a service request:
1. Go to https://www.dell.com/support.
2. On the Support tab, click Service Requests.
NOTE: To create a service request, you must have a valid support agreement. For details about either an account or
obtaining a valid support agreement, contact a sales representative. To find the details of a service request, in the
Service Request Number field, type the service request number, and then click the right arrow.

To review an open service request:


1. Go to https://www.dell.com/support.
2. On the Support tab, click Service Requests.
3. On the Service Requests page, under Manage Your Service Requests, click View All Dell Service Requests.

Online communities
For peer contacts, conversations, and content on product support and solutions, go to the Community Network https://
community.emc.com. Interactively engage with customers, partners, and certified professionals online.

How to provide feedback


Feedback helps to improve the accuracy, organization, and overall quality of publications. You can send feedback to
[email protected].

Preface 11
1
Introducing the Oracle RMAN Agent
Topics:
• Overview of Oracle RMAN agent
• Supported configurations

Overview of Oracle RMAN agent


The Oracle RMAN agent enables database servers to communicate with Data Domain and PowerProtect X400 systems in an optimized
way, without the need to use a backup application.
NOTE:

• In earlier versions of the product, the Oracle RMAN agent was known as Data Domain Boost (DD Boost) for Oracle
Recovery Manager (RMAN) or the RMAN plug-in. In version 4.0, the product name changed to Oracle RMAN agent.
• The Oracle RMAN agent uses Application Direct workflows, known in previous releases as DD Boost workflows.
• Self-service backups and restores are backups and restores that you perform through RMAN or Oracle Enterprise
Manager (OEM).
The use of the Oracle RMAN agent improves performance while reducing the amount of data that is transferred over the LAN. In the
context of Oracle RMAN, the software has two components:
• An RMAN agent that you install on each database server. This RMAN agent includes the DD Boost libraries for communicating with
the DD Boost server that runs on the Data Domain system.
• The DD Boost server that runs on the Data Domain systems.
RMAN sets policies that control when backups and replications occur. Administrators manage backup, replication, and restore from a
single console and can use all the features of DD Boost, including WAN-efficient replicator software. RMAN manages all the files
(collections of data) in the catalog, even those created by the Data Domain system.
The Data Domain or PowerProtect X400 system exposes pre-made disk volumes called storage units to a DD Boost enabled database
server. Multiple database servers, each with the Oracle RMAN agent, can use the same storage unit on a Data Domain system as a
storage server. Each database server can run a different operating system, provided that it is supported by Data Domain.
The following figure shows an example configuration of the Oracle RMAN agent with Data Domain systems.

Figure 1. Oracle RMAN agent configuration

12 Introducing the Oracle RMAN Agent


Supported configurations
The Oracle RMAN agent version must be compatible with the Data Domain or PowerProtect X400 system and RMAN configurations.
Data Domain and PowerProtect X400 do not support combinations other than those detailed in the eLab Navigator at https://
elabnavigator.emc.com/eln/modernHomeDataProtection. The information about Oracle RMAN agent is available in the DDBEA section of
the eLab Navigator. Check that information before you upgrade either the Oracle RMAN agent or the Data Domain or PowerProtect
X400 system.

Introducing the Oracle RMAN Agent 13


2
DD Boost Features
Topics:
• Distributed segment processing
• Advanced load balancing and link failover
• DD Boost-over-Fibre Channel transport
• DD Boost-over-Fibre Channel path management
• Encrypted managed file replication
• DD Boost and high availability
• Low-bandwidth optimization
• Client access validation
• In-flight encryption
• Marker support

Distributed segment processing


Distributed segment processing enables parts of the deduplication process to be performed by the Oracle RMAN agent, which prevents
the sending of duplicate data to the Data Domain or PowerProtect X400 system that is configured as a storage server. The option to
distribute the processing is enabled or disabled on the Data Domain or PowerProtect X400 system. The Oracle RMAN agent negotiates
with the Data Domain or PowerProtect X400 system for the current setting of the option and behaves appropriately. The Oracle RMAN
agent offers two modes of operation for sending backup data to a Data Domain or PowerProtect X400 system, one with distributed
segment processing enabled and the other with distributed segment processing disabled.
Distributed segment processing provides the following benefits:
• Higher throughput is possible because the Oracle RMAN agent sends only unique data to a Data Domain or PowerProtect X400
system, instead of sending all the data over the LAN. Throughput improvements depend on the redundant nature of the data being
backed up, the overall workload on the database server, and the capability of the database server. In general, greater throughput is
attained with higher redundancy, greater database server workload, and database server capability.
• The network bandwidth requirements are significantly reduced because only the unique data is sent over the LAN to the Data Domain
or PowerProtect X400 system.
• Recovery from failed backups can potentially proceed much faster. If a large backup fails in the middle or towards the end, when it is
restarted by RMAN, the data already sent to the Data Domain or PowerProtect X400 system does not have to be resent. This results
in faster completion of the backup on retry.
The Data Domain Operating System Administration Guide provides more information about local compression and its configuration.
You manage distributed segment processing through the ddboost option commands only with a Data Domain system. Data Domain
recommends that you use distributed segment processing if your network connection is 1 Gb Ethernet. Configuring distributed segment
processing on page 26 provides details.

Distributed segment processing disabled


In this mode, the Oracle RMAN agent sends the data directly to the Data Domain or PowerProtect X400 system over the LAN. The Data
Domain or PowerProtect X400 system then segments, deduplicates, and compresses the data before it is written to the disk. The Oracle
RMAN agent runs on the database server.
NOTE: Distributed segment processing cannot be disabled on an Extended Retention Data Domain or PowerProtect
X400 system.
The following figure shows a high-level data flow scenario for a single-system Data Domain system with distributed segment processing
disabled.

14 DD Boost Features
Figure 2. High-level data flow with distributed segment processing disabled

Distributed segment processing enabled


In this mode, the deduplication process is distributed between the Oracle RMAN agent and the Data Domain or PowerProtect X400
system. The Oracle RMAN agent runs on the database server. Parts of the deduplication process are run on the Oracle RMAN agent so
that only unique data is sent to a Data Domain or PowerProtect X400 system over the LAN.
The Oracle RMAN agent segments the data, computes IDs for the segments, checks with the Data Domain or PowerProtect X400
system for duplicate segments, compresses unique segments that are not found on the Data Domain or PowerProtect X400 system, and
sends the compressed data to the Data Domain or PowerProtect X400 system. The Data Domain or PowerProtect X400 system then
writes the unique data to disk.
The Oracle RMAN agent’s handling of data is transparent to RMAN, and the agent does not store any data on the database server.
The following figure shows a high-level data flow scenario for a single-system Data Domain system with distributed segment processing
enabled.

Figure 3. High-level data flow with distributed segment processing enabled

DD Boost Features 15
Advanced load balancing and link failover
NOTE: PowerProtect X400 systems do not support the advanced load balancing and link failover feature. This topic
applies only to Data Domain systems.
The advanced load balancing and link failover feature enables the combination of multiple Ethernet links into a group. Only one of the
interfaces on the Data Domain system is registered with RMAN. The Oracle RMAN agent negotiates with the Data Domain system on the
interface registered with RMAN to obtain an interface to send the data. The load balancing provides higher physical throughput to the
Data Domain system compared to configuring the interfaces into a virtual interface using Ethernet level aggregation.
The Data Domain system load balances the connections coming in from multiple database servers on all the interfaces in the group. The
load balancing is transparent to RMAN. Because advanced load balancing and link failover works at the software layer of the Oracle
RMAN agent, it is seamless to the underlying network connectivity and supports both physical and virtual interfaces.
The data transfer is load balanced based on the number of connections outstanding on the interfaces. Only connections for backup and
restore jobs are load balanced.
NOTE:

• The file replication connection between the Data Domain systems is not part of the load balancing. A single IP
address is used for the target Data Domain system.
• It is recommended that you exclude one interface from the interface group (ifgroup) and reserve it for the file
replication path between the source and target Data Domain systems. Every Oracle RMAN agent must be able to
connect to every interface that is a member of the interface group on the Data Domain system.
The following figure shows an example high-level configuration diagram. The interface marked in red is registered with RMAN.

Figure 4. Example of advanced load balancing and link failover configuration

The advanced load balancing and link failover feature can be used with other network layer aggregation and failover technologies. The
sample configuration in the preceding figure shows one such possibility. The links connecting the database servers and the switch that
connects to Data Domain system are put in an aggregated failover mode. This configuration provides end-to-end network failover
functionality. Any of the available aggregation technologies can be used between the database server and the switch.
The advanced load balancing and link failover functionality also works with other network layer functionality on the Data Domain systems,
including VLAN tagging and IP aliasing. This functionality enables additional flexibility in segregating traffic into multiple virtual networks, all
of which run over the same physical links on the Data Domain system.
NOTE: The Data Domain Operating System Administration Guide provides more information about how to configure
VLAN tagging and IP aliasing on a Data Domain system.

16 DD Boost Features
Advanced load balancing and link failover provides the following benefits:
• Eliminates the need to register multiple storage servers (one for each interface) with RMAN, which can potentially simplify installation
management.
• If one of the interfaces in the group goes down while the Data Domain system is still operational, the subsequent incoming backup jobs
are routed to the available interfaces.
• The backup and restore jobs are automatically load balanced on multiple interfaces in the group, which can potentially result in higher
utilization of the links.
• All in-flight jobs to the failed interface are failed over transparently to healthy operational links. From the point of view of RMAN, the
jobs continue uninterrupted.
Configuring advanced load balancing and link failover on page 26 provides more details.

Configuration restrictions
• Interfaces can be added only to the group by using an IP address.
• Although the advanced load balancing and link failover feature works with mixed 1 GbE interfaces and 10 GbE interfaces in a group,
this is not a recommended setup. It is recommended to have interfaces with the same link speed in a group.
• Prior to DD OS 5.2, only one interface group was supported on a Data Domain system. This meant that, to connect more than one
database server, a switch was needed in the middle. DD OS 5.2 and later support multiple interface groups, so this restriction no
longer applies.

DD Boost-over-Fibre Channel transport


NOTE: Data Domain Virtual Edition and PowerProtect X400 systems do not support the Fibre Channel transport.

Prior to DD OS release 5.3, all communication between the DD Boost library and any Data Domain system was performed by using IP
networking. The application specified the Data Domain system by using its hostname or IP address, and the DD Boost Library used TCP/IP
connections to transmit requests to, and receive responses from, the Data Domain system, as shown in the following figure.

Figure 5. DD Boost-over-IP transport

DD OS release 5.3 introduced Fibre Channel as an alternative transport mechanism for communication between the DD Boost library and
the Data Domain system.
Certain installations prefer or require the use of Fibre Channel as the media for data transfer between media servers and storage systems.
The DD Boost-over-Fibre Channel transport (DD Boost-over-FC) enables such installations to access the features provided by the DD
Boost technology.
Although Fibre Channel is specified as a general-purpose data transport mechanism, in practice Fibre Channel is used solely as a transport
for SCSI device access. In standard host operating systems, such as Windows and Linux, Fibre Channel hardware and drivers reside solely
within the SCSI protocol stacks. Therefore, the DD Boost-over-FC transport must use SCSI commands for all communication.
In the DD Boost-over-FC solution, the Data Domain system advertises one or more SCSI devices of type Processor. The media server
operating system discovers these devices, and makes them available to applications through a generic SCSI mechanism (Linux: SCSI
Generic driver; Windows: SCSI Pass-Through Interface).
To request access to a Data Domain system by using the DD Boost-over-FC transport, the application specifies the Data Domain system
by using the special string DFC-<dfc-server-name>, where dfc-server-name is the DD Boost-over-FC server name configured for the

DD Boost Features 17
Data Domain system. The DD Boost-over-FC transport logic within the DD Boost library examines the set of generic SCSI devices
available on the media server and uses SCSI commands to identify a catalog of devices, which are paths to the specified Data Domain
system.
Referencing this catalog, the DD Boost-over-FC transport logic issues SCSI commands to the identified generic SCSI devices, to transfer
DD Boost protocol requests and responses between the library and the Data Domain system.

Figure 6. SCSI commands between media server and Data Domain system

Most DD Boost features are independent of the transport. One notable exception is the DD Boost-over-IP advanced load balancing and
link failover feature, and its associated ifgroups. This feature is specific to the IP transport. For the DD Boost-over-FC transport, load
balancing and link-level high availability is achieved through different means.
The DD Boost-over-FC communication path applies only between the media server/DD Boost library and the Data Domain system, and
does not apply to communication between two Data Domain systems. For example, the managed file replication section of this document
describes efficient replication of data from one Data Domain system to another, possibly over a WAN. As shown in the following figure,
such communication is always over a TCP/IP network, regardless of the communication path between the media server and the Data
Domain systems.

Figure 7. Fibre Channel communication path

DD Boost-over-Fibre Channel path management


NOTE: Data Domain Virtual Edition and PowerProtect X400 systems do not support the Fibre Channel transport.

The Dynamic Interface Group (DIG)-based mechanism is based on Ethernet interfaces and is not applicable to the Fibre Channel
transport. Instead, a different path mechanism is provided for the DD Boost-over-FC solution.
The Data Domain system advertises one or more SCSI processor-type devices to the backup server, over one or more physical paths. The
operating system discovers all devices through all available paths, and creates a generic SCSI device for each discovered device and path.
For example, consider the following case:

18 DD Boost Features
• Backup server has 2 initiator HBA ports (A and B)
• Data Domain System has 2 FC target endpoints (C and D)
• Fibre Channel Fabric zoning is configured such that both initiator HBA ports can access both FC target endpoints
• Data Domain system is configured with a SCSI target access group that contains:
○ Both FC target endpoints on the Data Domain System
○ Both initiator HBA ports
○ 4 devices (0, 1, 2, and 3)

Figure 8. DD Boost-over-FC path management scenario

1. Four devices
2. Backup Server
3. HBA Initiator A
4. HBA Initiator B
5. Data Domain System
6. Fibre Channel Endpoint C
7. Fibre Channel Endpoint D
In this case, the backup server operating system may discover up to 16 generic SCSI devices, one for each combination of initiator, target
endpoint, and device number:
• /dev/sg11: (A, C, 0)
• /dev/sg12: (A, C, 1)
• /dev/sg13: (A, C, 2)
• /dev/sg14: (A, C, 3)
• /dev/sg15: (A, D, 0)
• /dev/sg16: (A, D, 1)
• /dev/sg17: (A, D, 2)
• /dev/sg18: (A, D, 3)
• /dev/sg19: (B, C, 0)
• /dev/sg20: (B, C, 1)
• /dev/sg21: (B, C, 2)
• /dev/sg22: (B, C, 3)
• /dev/sg23: (B, D, 0)
• /dev/sg24: (B, D, 1)
• /dev/sg25: (B, D, 2)
• /dev/sg26: (B, D, 3)
When the application requests that the DD Boost library establish a connection to the server, the DD Boost-over-FC transport logic within
the DD Boost library uses SCSI requests to build a catalog of these 16 generic SCSI devices, which are paths to access the DD Boost-
over-FC service on the required Data Domain system. As part of establishing the connection to the server, the DD Boost-over-FC
transport logic provides to the server this catalog of paths.

Initial path selection


The server maintains statistics on the DD Boost-over-FC traffic over the various target endpoints and known initiators. During the
connection setup procedure, path management logic in the server consults these statistics, and selects the path to be used for this
connection, based upon the following criteria:

DD Boost Features 19
• For queue-depth constrained clients (see below), evenly distribute the connections across different paths.
• Choose the least-busy target endpoint.
• Choose the least-busy initiator from among paths to the selected target endpoint.

Client path failover


The client may start using a different path because it is directed to do so by the server dynamic re-balancing logic. However, the client
may also decide, on its own, to start using a different available path. This happens if the client receives errors when using the connection's
current path.
For example, assume the path catalog for a connection consists of eight paths:
/dev/sg21: (A, C, 0)
/dev/sg22: (A, C, 1)
/dev/sg23: (A, D, 0)
/dev/sg24: (A, D, 1)
/dev/sg25: (B, C, 0)
/dev/sg26: (B, C, 1)
/dev/sg27: (B, D, 0)
/dev/sg28: (B, D, 1)
The server selects the (A, C, 0) path during initial path selection. The DFC transport logic in the DD Boost library starts sending and
receiving data for the connection, using SCSI commands to /dev/sg21.
Later, the link from target endpoint C to its switch becomes unavailable, due to cable pull or some hardware failure. Any subsequent SCSI
request submitted by the DFC transport logic to /dev/sg21 fails with an error code indicating that the SCSI request could not be
delivered to the device.
In this case, the DFC transport logic looks in the catalog of devices, for a path with a different physical component; that is, a different
combination of initiator and target endpoint. The SCSI request is retried on the selected path, and the process is repeated until a path is
discovered over which the SCSI request can be successfully completed.

Dynamic re-balancing
The server periodically performs dynamic re-balancing. This involves consulting the statistics to look for situations where:
• For queue-depth constrained clients (see below), connections are distributed unequally across available paths.
• Workload across target endpoints is out of balance.
• Workload across initiators is out of balance.
If such a situation is discovered, the server can mark one or more connections for server-directed path migration. This is achieved by
having the server request, during a future data transfer operation, that the DD Boost library start using a different available path from the
catalog for subsequent operations.

Queue-depth constraints
For the purposes of the DD Boost-over-FC solution, the specific SCSI device over which a request is received is irrelevant. All SCSI
devices are identical, destination objects for SCSI commands as required by the SCSI protocol. When processing a SCSI request, the
server logic gives no consideration to the specific device on which the SCSI request arrived.
Why bother to allow for more than one device? Because certain client-side operating systems impose a restriction on the number of
outstanding I/O requests that can be conducted simultaneously over a given generic SCSI device. For example, the Windows SCSI Pass-
Through Interface mechanism will only conduct one SCSI request at a time through each of its generic SCSI devices. This impacts the
performance of the DD Boost-over FC solution, if multiple connections (such as backup jobs) try to use the same generic SCSI device.
Additionally, the Data Domain system also imposes a limit on the number of outstanding I/O requests per advertised SCSI device. For
performance reasons with larger workloads, multiple SCSI devices may need to be advertised on the Data Domain system.
The term queue-depth describes the system-imposed limit on the number of simultaneous SCSI requests on a single device. Client
systems, such as Windows, whose queue depth is so low as to impact performance are considered queue-depth constrained.
Refer to Sizing DD Boost-over-FC device-set on page 30 for guidance on how many devices to configure based on the workload, type of
Data Domain system, and whether or not the client system is queue-depth constrained.

20 DD Boost Features
Encrypted managed file replication
NOTE: If you have a PowerProtect X400 system, refer to the PowerProtect X400 documentation for information on how
to enable encryption of managed file replication. This topic applies only to Data Domain systems.
By default, file replication jobs are set up between two Data Domain systems without encryption after being authenticated by using the
preconfigured DD Boost username and password. If the encrypted file replication feature is enabled, the session between the source and
destination Data Domain systems is encrypted by using Secure Sockets Layer (SSL), which ensures that all the image data and metadata
is sent encrypted over the WAN.
Enabling this option on the Data Domain system is transparent to RMAN. When RMAN requests the Data Domain system to perform a file
replication job, the source and destination systems negotiate automatically to perform encryption without the knowledge of RMAN.
Encrypted file replication uses the ADH-AES256-SHA cipher suite. There is no ability to configure a different suite in the DD OS.
Encrypted file replication is available to a Data Domain system with an installed Replicator license, and applies to all the file replication jobs
on that system. Both the source and the destination Data Domain systems that are participating in file replication jobs must have this
option enabled. Otherwise, replication fails.
Encrypted file replication can be used with the encryption of data-at-rest feature that is available on the DD OS with the optional
Encryption license. When encrypted file replication is used with the encryption of data-at-rest feature, the encrypted backup image data is
encrypted again by using SSL for sending over a WAN.
NOTE:

• Both the source and the destination Data Domain systems must run DD OS 5.0 or later to use this feature.
• Enabling this feature does not require restarting the file system on a Data Domain system.
• The low-bandwidth optimization and the encryption options can be used with each other.
Enabling encrypted file replication on page 28 and the Data Domain Operating System Administration Guide provide more information
about this topic.

DD Boost and high availability


NOTE: If you have a PowerProtect X400 system, refer to the PowerProtect X400 documentation for information on the
high availability options provided by PowerProtect X400 systems. This topic applies only to Data Domain systems.
Starting with DD OS 5.7.1, Data Domain systems with DD Boost can accommodate high availability (HA) configurations.
During normal operations, DD Boost on the active node sends to the standby node any DD Boost data and state information necessary to
continue the DD Boost operations on the standby node if a failure should occur.

NOTE: DD Boost currently supports only active-standby configurations.

DD Boost performs periodic operations to force the user data to disk on the server. DD Boost on the client buffers all the user data
between these periodic synchronize-to-disk operations so that if a DD server fails, the data can be resent.
This method also applies to virtual writes. You can mix standard write operations with synthetic write operations.

DD Boost, HA, and failover


When a Data Domain system with HA enabled fails, recovery occurs in less than ten minutes. Once the failed system recovers, DD Boost
recovery begins and applications that use DD Boost automatically recover without failing or receiving an error. DD Boost recovery might
take longer than ten minutes because DD Boost recovery cannot start until the failover of the DD system is complete.
No changes are necessary to allow applications to take advantage of DD Boost HA capabilities. With DD Boost 3.2.1 and DD OS 5.7.1 on
HA configurations, applications automatically recover if a failover occurs. No action is required from the application.

Partial HA configurations
Managed file replication (MFR) is supported between any two Data Domain systems that run compatible versions of DD OS, regardless of
whether one or both of the DD systems is enabled for HA.
MFR between two HA systems succeeds in the event of failure of either system because both systems support HA. An MFR in progress
recovers seamlessly if either the source HA system or the destination HA system fails.

DD Boost Features 21
MFR between an HA system and a non-HA system succeeds if the HA system fails, but does not succeed if the non-HA system fails.

MFR to HA enabled systems


A single-node Data Domain system that runs DD OS 5.7 or later and performs MFR to an HA system recovers seamlessly if the HA system
fails. The MFR does not recover seamlessly if the single-node Data Domain source system fails.

MFR from HA enabled systems


An MFR from an HA system to a single-node Data Domain system that runs DD OS 5.7 or later recovers seamlessly if the source HA
system fails. However, the MFR does not recover seamlessly if the single-node Data Domain destination system fails.
In all cases that involve partial HA configurations, the non-HA system must run DD OS 5.7 to enable an MFR to continue seamlessly when
a failure occurs. In partial HA configurations where the non-HA system runs a DD OS version earlier than 5.7, the MFR does not recover
seamlessly from a failure of either system.
In all cases, the application must use DD HA Boost 3.2.1 libraries to enable the seamless recovery of the MFR.

Low-bandwidth optimization
NOTE: If you have a PowerProtect X400 system, refer to the PowerProtect X400 documentation for information on the
replication options. This topic applies only to Data Domain systems.
The low-bandwidth Replicator option reduces the WAN bandwidth utilization. This option is useful if file replication is performed over a
low-bandwidth network (WAN) link. This option provides additional compression during data transfer and is recommended only for file
replication jobs that occur over WAN links that have fewer than 6 Mb/s of available bandwidth.
The low-bandwidth optimization option is available to Data Domain systems with an installed Replicator license. The option is enabled on a
Data Domain system and applies to all the file replication jobs on that system.
Enabling this option on Data Domain system is transparent to RMAN. When RMAN requests a Data Domain system to perform a file
replication job, the source and destination systems automatically perform the additional compression without involving RMAN.
Each Data Domain system that participates in managed file replication must have this option enabled.
Enabling low-bandwidth optimization on page 27 and the Data Domain Operating System Administration Guide provide more information
about this topic.

Client access validation


Configuring client access validation for DD Boost limits the access to the Data Domain system for DD Boost clients by requiring DD Boost
authentication per connection for:
• The initial connection to the Data Domain system
• Each restart of DD Boost (Enable/Disable)
• Each file system restart
• Each Data Domain system reboot
The list of clients can be updated at any time without a restart requirement, which eliminates the access validation impact on jobs in
progress.

In-flight encryption
NOTE: PowerProtect X400 systems do not support the in-flight encryption feature. This topic applies only to Data
Domain systems.
In-flight encryption enables applications to encrypt in-flight backup or restore data over the LAN from the Data Domain system. This
feature was introduced to offer a more secure data transport capability.
When configured, the client is able to use TLS to encrypt the session between the client and the Data Domain system. The specific cipher
suite used is either ADH-AES256-SHA, if the HIGH encryption option is selected, or ADH-AES128-SHA, if the MEDIUM encryption option
is selected.

22 DD Boost Features
Marker support
The default marker support setting is auto marker handling. If any marker is encountered in the first 512 KB of a write stream, support is
enabled for that stream. Users can toggle the marker settings on a protection system. The DD OS Administration Guide provides details.

DD Boost Features 23
3
Configuring the Data Domain System for
Stand-alone Oracle RMAN Agent Deployments
NOTE: When the Oracle RMAN agent is deployed with PowerProtect Data Manager or PowerProtect X400, refer to the
PowerProtect Data Manager or PowerProtect X400 documentation for information about the protection target
configuration.

Topics:
• Oracle RMAN agent and DD OS upgrades
• Firewalls and ports
• Enabling DD Boost on a Data Domain system
• Enabling Oracle optimized deduplication
• Configuring the DD Boost server
• Configuring DD Boost-over-FC service

Oracle RMAN agent and DD OS upgrades


The Oracle RMAN agent and DD OS maintenance compatibility is defined in the eLab Navigator at https://elabnavigator.emc.com/eln/
modernHomeDataProtection. The information about Oracle RMAN agent is available in the DDBEA section of the eLab Navigator. Consult
that publication before you upgrade either the Oracle RMAN agent or the DD OS.

Firewalls and ports


The Data Domain system as it is initially configured does not work through a firewall (a database server to a Data Domain system, or from
one Data Domain system to another). If you need the Data Domain system to work in the presence of a firewall, contact your network
support provider.
The following ports must be open in a firewall to enable the DD Boost backups and file replication:
• TCP 2049 (NFS)
• TCP 2051 (Replication)
• TCP 111 (NFS portmapper)
• TCP xxx (Select a port for NFS mountd. The default MOUNTD port is 2052.)

Enabling DD Boost on a Data Domain system


About this task
Every Data Domain system that is enabled for DD Boost must have a unique name. You can use the Data Domain system’s DNS name,
which is always unique.

Steps
1. On the Data Domain system, log in as an administrative user.
2. Verify that the file system is enabled and running:

# filesys status

The file system is enabled and running.

24 Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments
If disabled, enable the file system:

# filesys enable

3. Verify that the DD Boost license is enabled:

# license show

Feature licenses:

## License Key Feature


-- -------------------- --------
1 ABCD-EFGH-IJKL-MNOP DDBOOST
-- -------------------- --------
If disabled, enter the license key that is provided:

# license add <license-key>

License “ABCE-BCDA-CDAB-DABC” added.

4. Establish the DD Boost username and password for the Data Domain system.
NOTE: The username and password are case-sensitive, and must match the username and password provided in
Registering each Data Domain system on page 45.

# user add <username> password <password>


# ddboost user assign <username>

NOTE: If the username is changed or deleted, the change in access rights does not affect any current operations.
For example, deleting the current clients from the DD Boost access list by using the ddboost clients del
<client-list> command does not stop a file backup that is already in progress. All operations in progress continue.
The change in access rights does not cause existing operations to fail. It is recommended to change access rights
only when no RMAN operations are in progress. The ddboost disable command can be used to prevent operations
while access is changed. Disabling DD Boost terminates any existing operations, so be careful that no RMAN
operations are in progress when you disable DD Boost. After changing access, ddboost enable re-enables DD
Boost and enables RMAN operations that are then subject to the changed access rights.

5. Enable DD Boost:

# ddboost enable

DD Boost enabled

Enabling Oracle optimized deduplication


About this task
For Oracle RMAN agent operations, ensure that you have enabled the Oracle optimized deduplication feature at the MTree level in the
Data Domain system by running the following command:

# mtree option set app-optimized-compression oracle1 mtree <mtree_path>

In the following command output, the MTrees with the value of oracle1 have the Oracle optimized deduplication enabled:

# mtree option show

Name Option Value


--------------------- ------------------------- ------------------
/data/col1/db2west app-optimized-compression global (none)
/data/col1/nfswest app-optimized-compression oracle1
/data/col1/oracleoldf app-optimized-compression global (none)
/data/col1/oraclevlab app-optimized-compression oracle1

Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments 25
/data/col1/pool-test app-optimized-compression global (none)
/data/col1/tdeoracle app-optimized-compression oracle1
Refer to the online white paper, Dell EMC Data Domain Oracle Optimized Deduplication, for more details on when to enable the Oracle
optimized deduplication feature.

Configuring the DD Boost server


Use the tasks in this section to configure the DD Boost server.

Creating storage units


About this task
Create one or more storage units on each Data Domain system that will be used with RMAN. Each storage unit name on a single Data
Domain system must be unique. However, you can use the same storage unit name on more than one Data Domain system. You must
provide the storage unit name when you perform the RMAN backup and restore operations.
Storage unit names are case-sensitive.
Configuring the software on Linux and UNIX systems on page 41 and Configuring the software on Windows systems on page 45
provide more information.

Steps
1. On the Data Domain system, enter the following command:

# ddboost storage-unit create <storage_unit_name> user <username>

2. Repeat step 1 for each storage unit that you want to create. Create at least one storage unit on each Data Domain system that you
will use with RMAN. You can share a storage unit on a Data Domain system with more than one RMAN client system.

Configuring distributed segment processing


The distributed segment processing option is configured on the Data Domain system and applies to all the database servers and the Oracle
RMAN agents that are installed on them.
If distributed segment processing is disabled on the Data Domain system, then the data flow from the database servers is as shown in
Figure 2. High-level data flow with distributed segment processing disabled on page 15. If distributed segment processing is enabled, then
the data flow is as shown in Figure 3. High-level data flow with distributed segment processing enabled on page 15.
To configure the option, run the following command:

# ddboost option set distributed-segment-processing {enabled | disabled}

NOTE: Enabling or disabling the distributed segment processing option does not require a restart of the Data Domain
file system.
Distributed segment processing is supported with the Oracle RMAN agent 1.0 or later communicating with a Data Domain system that
runs DD OS 5.0 or later.
Distributed segment processing is enabled by default on a system initially installed with DD OS 5.2. If a system is upgraded from DD OS
5.0.x or 5.1.x to DD OS 5.2, distributed segment processing is left in its previous state.

Configuring advanced load balancing and link failover


About this task
If an interface group is configured, when the Data Domain system receives data from the database server clients, the data transfer is load
balanced and distributed as separate jobs on the private network, providing higher throughput, especially for customers who use multiple 1
GbE connections. Advanced load balancing and link failover on page 16 provides details.

26 Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments
Create an interface group on the Data Domain system by adding existing interfaces to the group and registering the Data Domain system
with RMAN, as described in the following steps.

Steps
1. Add the interfaces into the group (the interfaces must have been created already with the net command):

# ifgroup add default interface 192.168.1.1


# ifgroup add default interface 192.168.1.2
# ifgroup add default interface 192.168.1.3
# ifgroup add default interface 192.168.1.4

NOTE: This example assumes that no additional named interface groups have been created and uses the default
interface group. To see help for the net command, enter the command with no arguments at the DD OS prompt.

2. Select one interface on the Data Domain system to register with RMAN. It is recommended that you create a failover aggregated
interface and register that interface with RMAN.
NOTE: It is not mandatory to use an interface in the ifgroup to register with RMAN. An interface that is not part of
the ifgroup can also be used to register with RMAN. It is recommended that the interface be registered with a
resolvable name using DNS or any other name resolution mechanism.

3. Enable the feature on the Data Domain system:

# ifgroup enable default

Verify the configuration:

# ifgroup show config default interfaces

Group Name Status Interface


------------------ ------------
default enabled 192.168.1.1
default enabled 192.168.1.2
default enabled 192.168.1.3
default enabled 192.168.1.4

After the interface group is set up, you can add or delete interfaces from the group. Modifying an interface group on page 105
provides details.
NOTE:

You can manage the advanced load balancing and link failover through either of the following methods:

• Run the ddboost ifgroup command, as described in ifgroup on page 115.


• Use the Data Domain System Manager (DD System Manager) Data Management > DD Boost page, as described in
the Data Domain Operating System Administration Guide.

Enabling low-bandwidth optimization


To enable the low-bandwidth option, run the following command:

# ddboost file-replication option set low-bw-optim enabled

Low bandwidth optimization for file-replication set to “enabled”.


NOTE: Enabling or disabling the low-bandwidth optimization option does not require a restart of the Data Domain file
system. However, after low-bandwidth optimization is enabled, a full cleaning cycle on the Data Domain system is
needed for effective operation.
You can monitor and manage the low-bandwidth optimization through either of the following methods:
• Run the ddboost file-replication command, as described in file-replication on page 112.
• Use the DD System Manager Data Management > DD Boost page, as described in the Data Domain Operating System
Administration Guide.

Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments 27
No configuration changes are required on the database server as this feature is transparent to RMAN.
NOTE:

• Enabling this feature takes additional resources of CPU and memory on the Data Domain system, so it is
recommended that this option be used only when file replication is being done over low-bandwidth networks with
less than 6 Mbps aggregate bandwidth.
• The Data Domain Operating System Administration Guide provides more information about this feature.

Enabling encrypted file replication


To enable the encrypted file replication option, run the following command:

# ddboost file-replication option set encryption enabled

The output indicates that the encryption you requested was enabled.
file-replication on page 112 provides more details about how to monitor and manage the encryption option for file replication.
Turning on this feature takes additional resources of CPU and memory on the Data Domain system.
NOTE: Enabling or disabling the encrypted file replication option does not require a restart of the Data Domain file
system. For more information on this feature, see the discussion about this topic in the Data Domain Operating System
Administration Guide.
Encrypted file replication must be enabled on both of the Data Domain systems involved in the replication. If either system does not have
encryption file replication enabled, encryption will not be used during replication between the two Data Domain systems.

Configuring client access validation


Configuring the client access control for DD Boost limits the access to the Data Domain system for DD Boost clients and removes the
dependency on the DNS. By default, if no clients are added to the clients list when DD Boost is enabled, all clients are automatically
included in the clients list. By default, a * wildcard is used.
To restrict access, remove the * wildcard from the list and then add the new clients.
The backup server client list may contain both fully qualified domain names or short names. The backup host's fully qualified domain name
needs to be correctly configured for reverse lookup in DNS.
To delete all the clients from the DD Boost clients list, run the following command:

# ddboost clients del <client-list>

Optionally, to delete all the clients previously added and reset the DD Boost clients list, run the following command:

# ddboost client reset

Clients can be added as both fully qualified domain names and short names. To add clients to the DD Boost clients list, run the following
command:

# ddboost clients add <client-list> [encryption-strength {medium | high} authentication-mode


{one-way | two-way | two-way-password | anonymous}] | [authentication-mode kerberos]

For example:

# ddboost clients add ddboost-dl.emc.com ddboost-dlddboost-dl.emc.com

: Addedddboost-dl : Added
To view the DD Boost clients list, run the following command:

# ddboost clients show config

Client Encryption Strength Authentication Mode


----------------------- ------------------- -------------------
* none none

28 Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments
*.corp.emc.com medium anonymous
rtp-ost-ms02.domain high anonymous
rtp-ost-ms02.domain.com high anonymous
During access validation, the following search order is used to restrict access:
• Wild card * followed by partial, for example, *.emc.com followed by *.com
• Perfect match of sent client name, for example, ddboost-dl.emc.com
If the search does not find a matching entry for the client, the client will be denied access.

Enabling in-flight encryption


To enable in-flight encryption for backup and restore operations over a LAN, run the following command:

# ddboost clients add <client-list> [encryption-strength {medium | high} authentication-mode


{one-way | two-way | anonymous}]

This command can enable encryption for a single client or for a set of clients. The authentication-mode option is used to configure the
minimum authentication requirement. A client trying to connect by using a weaker authentication setting will be blocked. Both one-way
and two-way authentication require the client to be knowledgeable about certificates.

One-Way The DD Boost client requests authentication from the Data Domain server, and the Data Domain server sends the
Authentication appropriate certificate to the DD Boost client. The DD Boost client verifies the certificate. The communication
channel between the DD Boost client and the Data Domain server is encrypted.
Two-Way The DD Boost client requests authentication from the Data Domain server using the server certificate. The Data
Authentication Domain server also requests authentication from the DD Boost client using the client certificate. After
authentication through an SSL handshake, the communication channel between the DD Boost client and the Data
Domain server is encrypted.
Anonymous No certificates are exchanged, but information is exchanged. After the SSL handshake, the communication
Authentication channel between the DD Boost client and the Data Domain server is encrypted.

NOTE: This option does not apply to DD Boost-over-Fibre Channel (FC). If both IP and FC are in use, encryption can be
enabled on IP connections.

Configuring DD Boost-over-FC service


About this task
To enable the DD Boost-over-FC service, install the supported Fibre Channel Target HBAs into the system. The Data Domain Operating
System Command Reference Guide and Administration Guide provide information about scsitarget as a related command that may be
helpful in managing the SCSI target subsystem.
The following additional configuration steps are also required.

Steps
1. Enable the DD Boost-over-FC service:

# ddboost option set fc enabled

2. Optionally set the DFC-server-name:

# ddboost fc dfc-server-name set <server-name>

Or accept the default, which is the base hostname of the Data Domain system. A valid dfc-server-name consists of one or more of the
following characters:
• lower-case letters ("a"–"z")
• upper-case letters ("A"–"Z")
• digits ("0"–"9")
• underscore ("_")
• dash ("–")

Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments 29
NOTE:

• The dot or period character (".") is not valid within a dfc-server-name; this precludes using the fully-qualified
domain name of a Data Domain system as its dfc-server-name.
• Similar to IP hostnames, the dfc-server-name is not case-sensitive. Multiple Data Domain sytems accessible by
the same clients using DDBoost-over-FC should be configured without case-sensitive dfc-server-name.

3. Create a SCSI target access group:

# ddboost fc group create <group-name>

For example:

# ddboost fc group create lab_group

4. To display the available list of scitarget endpoint:

# scsitarget endpoint show list

Endpoint System Address Transport Enabled Status


------------- -------------- ------------ ------- ------
endpoint-fc-0 6a FibreChannel Yes Online
endpoint-fc-1 6b FibreChannel Yes Online
------------- -------------- ------------ ------- ------

5. Configure the device set of the SCSI target access group for one of the endpoint:

# ddboost fc group modify <group-name> device-set count <count> endpoint <endpoint-list>

For example:

# ddboost fc group modify lab_group device-set count 8 endpoint 6a

6. Add initiators to the SCSI target access group:

# ddboost fc group add <group-name> initiator <initiator-spec>

For example:

# ddboost fc group add lab_group initiator "initiator-15,initiator-16"

Sizing DD Boost-over-FC device-set


The Data Domain system advertises one or more "DFC devices" of type Processor, which the DD Boost library uses to communicate with
the DD Boost-over-FC service. On the Data Domain system, access to these DFC devices is granted to one or more initiators by adding
the initiators to a ddboost-type scsitarget access group:

# ddboost fc group add lab_group initiator "initiator-15,initiator-16"

The number of DFC devices advertised to the initiator is controlled by configuring the device-set of the scsitarget access group:

# ddboost fc group modify lab_group device-set count 4

The maximum number of supported DFC devices per Data Domain system is 64. You can have the same devices in multiple groups, but
each group is limited to 64 devices.
NOTE: AIX DDdfc drivers support 128 devices. However, if you use the disk option with the ddboost fc add
command, this limitation is removed.
Because the DFC client sees each path to the Data Domain system as a separate device, more paths and more DFC devices mean better
performance for constrained clients such as AIX, Windows, and Solaris.
So, how many DFC devices should be advertised to initiators on a given backup server? The answer depends upon several factors:

30 Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments
1. Is the backup server queue-depth constrained?
Windows platforms are considered "queue-depth constrained," because the Windows SCSI Pass-Through Interface mechanism will
only conduct 1 SCSI request at a time through each of its generic SCSI devices. This impacts the performance of the DD Boost-over
FC solution, if multiple connections (for example, backup jobs) are trying to use the same generic SCSI device. So, for Windows
platforms running more than one job, it is useful to advertise multiple DFC devices.
Contrast this with the behavior of the Linux SCSI Generic driver, which imposes no such restriction. Linux is not considered "queue-
depth constrained," so it is sufficient to simply advertise one DFC device to initiators on Linux systems.
2. Number of physical paths between backup server and Data Domain system
For each advertised DFC device, the backup server operating system will create n generic SCSI devices, one for each physical path
through which the backup server OS can access the device.
For example, if:
• Backup server has 2 initiator HBA ports (A and B)
• Data Domain System has 2 FC target endpoints (C and D)
• Fibre Channel Fabric zoning is configured such that both initiator HBA ports can access both FC target endpoints
then the backup server OS will see each device through four physical paths:
A -> C
A -> D
B -> C
B -> D
and will create 4 generic SCSI devices for each advertised DFC device.
For a Windows backup server (with its queue-depth=1 limitation), this allows up to 4 simultaneous SCSI requests to the Data Domain
system, even with only one DFC device advertised.

Sizing calculation
The following calculation may be used to determine the number of DFC devices to advertise on the Data Domain system and to the
initiators on a specified media server. It is recommended that the same number of DFC devices be advertised to all initiators on the same
media server.

On the Data Domain system


The Data Domain system imposes a limit on the number of simultaneous requests to a single DFC SCSI device. Because of this limit, the
number of devices advertised needs to be tuned depending on the maximum number of simultaneous jobs to the system at any given
time. In general, the larger the number of jobs expected from media servers using DD Boost over FC, the higher the number of devices
advertised.
Let J be the maximum number of simultaneous jobs running using DFC, to the Data Domain system at any given time.
Let C be the maximum number of connections per job:
• 3 for DD Extended Retention systems
• 1 for other types of Data Domain systems
Calculate:
• Maximum simultaneous connections to the Data Domain system, using DFC, from all backup servers:
○ S=J*C
○ DFC device count D = minimum(64, 2*(S/128)), round up
○ All DFC access groups must be configured with "D" devices.

Example
Assume:
• 8 backup servers, DD Extended Retention systems, each server running a maximum of 30 jobs at any given time.
• Here, J = 8 * 30 = 240, C = 3 (DD Extended Retention systems), S = J * C = 720, D = 2 * 720 / 128 = 11.25, round up to 12.
• As a result, all DFC groups on the Data Domain system must be configured with 12 devices.

Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments 31
Linux backup servers
The number of DFC devices advertised on the Data Domain system using the calculations listed under On the Data Domain system on
page 31 is sufficient for Linux backup servers. No additional configuration is required. Linux backup servers are not queue-depth
constrained, so many connections can share the same DFC generic SCSI device with no performance impact.

Windows backup servers


The Data Domain server path management logic spreads out connections across available logical paths (Initiator, Target Endpoint, DFC
Device). Enough DFC devices must be configured so that each connection uses its own generic SCSI device (logical path) on the backup
server, with a maximum DFC device count of 64.
Let X be the number of DFC devices configured on the Data Domain system (from On the Data Domain system on page 31).
Let P be the number of physical paths between backup server and Data Domain system.
Let J be the maximum number of simultaneous jobs.
Let C be the maximum number of connections per job:
• 3 for DD Extended Retention systems
• 1 for other types of Data Domain systems
Calculate, assuming the following:
• 4 physical paths between the backup server and Data Domain system, 30 maximum jobs, DD Extended Retention system
• In this case, X = 25, P = 4, J = 30, and C = 3
• Maximum simultaneous connections from backup server S = (J * C) = 90
• DFC device count D = (90/4, 25) = 25
As a result, the Data Domain system should be configured to advertise 25 devices to each initiator on the backup server.
Assume:
• 2 physical paths between the backup server and Data Domain system, 50 maximum jobs, single Data Domain system
• In this case, X=18, P = 2, J = 40, C = 1
• Maximum simultaneous connections from backup server S = (J * C) = 40
• DFC device count D = maximum(40/2, 18) = 20
As a result, the Data Domain system should be configured to advertise 20 devices to each initiator on the backup server.
Because the value of D (20) is greater than the value of X (18), it is sufficient to configure two devices only for the DFC access group
with Windows clients.

AIX backup servers


For AIX, the proprietary device entries are exclusively locked on a per-process basis—one and only one process can use a device entry.
Calculations are based on application instance usage. If an application spawns multiple processes, each process exclusively locks at least
one device entry. Multi-threaded applications lock one device per thread. For these reasons, you should configure the Data Domain system
to advertise as many DFC devices as possible (up to the maximum of 128). A Device Busy error can result if there are not enough
devices accessible to the AIX clients.
NOTE: If you are using the proprietary device driver, the total number of streams in a policy should not exceed the
number of AIX DFC devices available; otherwise, the backup job might fail.

Solaris backup servers


For Solaris, device entries are exclusively locked on a per-process basis—one and only one process can use a device entry. Calculations
are based on application instance usage. If an application spawns multiple processes, each process exclusively locks at least one device
entry. Multi-threaded applications lock one device per thread. For these reasons, configure the Data Domain system to advertise as many
DFC devices as possible to avoid "in use" errors from the sgen device driver. A Device Busy error can result if there are not enough
devices accessible to the Solaris clients.
The number of sgen devices is the number of Fibre Channel ports accessible to the Solaris instance times the number of different paths to
the Data Domain system endpoints times the number of LUNs in the access group.

32 Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments
Configuring the SCSI device driver for AIX clients
DD Boost-over-FC is supported on clients that run the supported AIX versions on IBM Power hardware. DFC for AIX uses the SCSI
generic device driver, which is included in the AIX installation.
By default, the Oracle RMAN agent uses the SCSI generic device driver, which does not require the installation of any drivers.
To check for the SCSI generic device driver, you can run the lsdev command and review the command output. The command output for
this device driver includes the device names as hdisk* and the type as Other FC SCSI Disk Drive. For example:

lsdev

hdisk1 Available 05-00-01 Other FC SCSI Disk Drive


hdisk2 Available 05-00-01 Other FC SCSI Disk Drive
hdisk3 Available 05-00-01 Other FC SCSI Disk Drive
NOTE: To discover the DD Boost devices that are added to the DD Boost FC group in Data Domain system, run the
cfgmgr command on the client. You might need to run the cfgmgr command if the lsdev command cannot show all the
devices.
To complete the configuration and integration of the device driver on an AIX system, perform the following steps.
1. Follow the required instructions in the Data Domain Fibre Channel Configuration and Integration with Data Domain Boost for
Enterprise Applications Database Application Agent Technical Notes. Follow the instructions on configuration of an AIX DFC setup
without DFC drivers by adding disk type devices. The document is available on the Support website at https://support.emc.com.
2. To ensure that the DBA can perform backup and restore operations as a non-root user, follow the configuration instructions in the
section "AIX with SCSI generic disk driver" in the following Knowledgebase article:
Fibre Channel Devices with Products using DD Boost in Linux/UNIX Environment (Article Number 000182275)
The article is available on the Support website at https://support.emc.com.

Configuring the SCSI generic device driver for Solaris


clients
About this task
DD Boost-over-FC is supported on clients that run Solaris 10 and 11 on SPARC and x86 hardware. DFC for Solaris uses the SCSI generic
device driver (sgen), which is included in the Solaris installation. Use the following procedure to ensure that sgen successfully identifies the
processor devices at startup.

Steps
1. Add the following line in the forceload section of /etc/system:

forceload: drv/sgen

This step should resolve issues with sgen not properly loading during startup and keep the sgen driver loaded.
2. To check for existing usage of sgen, run the command grep sgen /etc/driver_aliases.
NOTE: The existence of a /dev/scsi, /dev/scsi/processor, or /dev/scsi/* directory does not necessarily
mean that sgen is currently configured. There could be dangling files.

3. If there is no existing use of sgen, or if sgen is used only for "scsiclass,03", perform the following steps:
a. Run the command rem_drv sgen.
b. Run the command add_drv –m '* 0600 root sys' –i '"scsiclass,03"' sgen.

NOTE: It is critical that you use single and double quotes exactly as shown.

This command should return to the prompt with no errors or warnings. Check connectivity to the Data Domain system. There
should be at least one file in /dev/scsi/processor.

c. To confirm at least one entry for three configuration files, run the command grep sgen /etc/minor_perm /etc/
name_to_major and /etc/driver_aliases.

Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments 33
Example results of this command are as follows:
/etc/minor_perm:sgen * 0600 root sys
/etc/name_to_major:sgen 151
/etc/driver_aliases:sgen "scsiclass,03"

NOTE: The name_to_major number will likely be different than this example.

4. If the sgen device is already used for other devices, perform the following steps:
a. Run the command rem_drv sgen.
b. Run the command add_drv –m '* 0600 root sys' –i '"scsiclass,03" "scsiclass,XX"' sgen.
NOTE: XX would be the device type from a previously run command grep sgen /etc/driver_aliases. It is
critical that you use single and double quotes exactly as shown.
An example of this command is as follows: add_drv –m '* 0600 root sys' –i '"scsiclass,03"
"scsiclass,06"' sgen.
This command should return to the prompt with no errors or warnings. Check connectivity to the Data Domain system. There
should be at least one file in /dev/scsi/processor.

c. To confirm at least one entry for three configuration files, run the command grep sgen /etc/minor_perm /etc/
name_to_major and /etc/driver_aliases.
d. Open the /kernel/drv/sgen.conf file. If the device-type-config-list is uncommented, add “processor” to the list to ensure
that the driver is recognized. For example, if the device-type-config-list is uncommented as in this example:
device-type-config-list="direct", "sequential", "worm", "rodirect", "optical", "changer";
Change the entry to:
device-type-config-list="direct", "sequential", "worm", "rodirect", "optical", "changer",
"processor";

34 Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments
4
Configuring the Oracle RMAN Agent for
Stand-alone Deployment
NOTE: This chapter applies only to configuration of stand-alone deployments on Data Domain systems, not
PowerProtect Data Manager or PowerProtect X400 systems.

Topics:
• Installing and configuring the Oracle RMAN agent on AIX, Linux, and Solaris systems
• Installing and configuring the Oracle RMAN agent on Windows systems
• Registering each Data Domain system
• Migrating an Oracle configuration from the database application agent
• Performing backups of a clustered environment to Data Domain
• Data Domain replication
• Specifying subdirectories for Oracle RMAN agent backups
• Performing backups and restores of Oracle CDBs and PDBs
• Performing DD Boost compressed restores
• Display and deletion of backups
• Oracle Incremental Merge operations
• Configuring the use of Data Domain Cloud Tier for data movement to the cloud
• Usage limits on Data Domain resources

Installing and configuring the Oracle RMAN agent


on AIX, Linux, and Solaris systems
Installing the Oracle RMAN agent on database servers
Install the Oracle RMAN agent on all the database servers that must access the Data Domain system.
The pre-4.0 versions of Oracle RMAN agent are installed under the ORACLE_HOME directory. Starting with Oracle RMAN agent version
4.0, the software must be installed in a directory other than the ORACLE_HOME directory.
Run the install.sh script to install the Oracle RMAN agent 19.4 or to upgrade from an earlier version of the Oracle RMAN agent. The
script installs the Oracle RMAN agent in a user-specified directory or in the default installation directory, $HOME/opt/dpsapps/
rmanagent.
Run the install.sh -h or install.sh --help command to obtain more information about the script operation.
NOTE:

The user-specified installation directory must be a directory that is created specifically for the Oracle RMAN agent 19.4
installation, and must not be the ORACLE_HOME directory. The complete directory pathname must be specified, without
a slash (/) at the end.

For an installation in a non-default directory path, you must create the directory path and assign the Oracle user
privileges to the directory path.
To upgrade from a pre-4.0 version, use either of the following methods:
• Run the uninstallation script, uninstall.sh, to uninstall the pre-4.0 software and then install the Oracle RMAN agent 19.4.
Uninstalling the Oracle RMAN agent on database servers on page 40 describes how to use the uninstallation script.
• Run the installation script to install the version 19.4 software and at the same time remove or update the pre-4.0 Oracle RMAN agent
settings.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 35


For an upgrade, if you want to continue using a pre-4.0 RMAN script without any changes, it is recommended that you run the installer
script for each ORACLE_HOME. If you do not want to reuse the RMAN script, run the installer script once and then modify the RMAN
script for Oracle RMAN agent 19.4.
You can run the install.sh script manually or automatically (silently). To enable the automatic operation, you must set the
environment variables as listed in Table 3. Environment variables for installation or upgrade of Oracle RMAN agent on page 36:
• When the variables are not set, the script runs manually and prompts you for the required values.
• When the variables are set, the script runs automatically and performs the installation or upgrade according to the environment
variable settings.
To perform an automatic (silent) upgrade to Oracle RMAN agent 19.4:
1. Run the following commands to set the required environment variables:

# export DD_CREDENTIALS_UPDATE=FALSE
# export RMAN_AGENT_HOME=<$RMAN_AGENT_HOME>
# export RMAN_AGENT_INSTALL_OPTIONS=OVERWRITE

2. Run the install.sh script without any command-line options, as described in Installing the Oracle RMAN agent on Linux and
UNIX on page 37.
NOTE: ORACLE_HOME is an Oracle environment variable. The other variables are the Oracle RMAN agent environment
variables.

Table 3. Environment variables for installation or upgrade of Oracle RMAN agent


Environment variable Description Default and valid values
DD_CREDENTIALS_UPDATE Required for an automatic (silent) upgrade. • Undefined (default).
Specifies the type of upgrade, based on • FALSE—Specifies an automatic upgrade
whether the Oracle RMAN agent is integrated when Oracle RMAN agent is not integrated
with PowerProtect Data Manager. with PowerProtect Data Manager.
• TRUE—Specifies an automatic upgrade
when Oracle RMAN agent is integrated with
PowerProtect Data Manager. In this case,
you must run the install.sh script with
appropriate command-line options, as
described in the PowerProtect Data
Manager Administration and User Guide.

ORACLE_HOME Required for an upgrade of pre-4.0 Oracle • Undefined (default).


RMAN agent. • Valid value of the ORACLE_HOME directory
Specifies the installation location of the pre-4.0 under which the pre-4.0 Oracle RMAN
Oracle RMAN agent. agent is installed.

RMAN_AGENT_HOME Required for an automatic (silent) upgrade. • $HOME/opt/dpsapps/rmanagent


Specifies the installation directory for the Oracle (default).
RMAN agent 19.4. • Valid complete pathname of the directory
for the Oracle RMAN agent 19.4 installation.
NOTE: The directory pathname
must not end with a slash (/).

RMAN_AGENT_INSTALL_ Required only when Oracle RMAN agent already • Undefined (default).
OPTIONS exists in the installation directory. • BYPASS or bypass—Specifies to bypass
Specifies whether to bypass the version 19.4 the version 19.4 installation.
installation or continue and overwrite the • OVERWRITE or overwrite—Specifies to
existing installation. continue the version 19.4 installation and
overwrite the existing installation in the
NOTE: For an upgrade from version 4.0 destination directory.
or later, set this variable to the
OVERWRITE or overwrite value.

RMAN_AGENT_UPGRADE_ Required only if a pre-4.0 Oracle RMAN agent is • Undefined (default).


OPTIONS installed.

36 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Table 3. Environment variables for installation or upgrade of Oracle RMAN agent (continued)
Environment variable Description Default and valid values

Specifies whether to keep or remove the • KEEP or keep—Specifies to keep the


pre-4.0 installation, and whether to update the pre-4.0 installation.
Oracle settings to enable the reuse of pre-4.0 • UNINSTALL or uninstall—Specifies to
RMAN scripts without any script changes. uninstall the pre-4.0 installation.
• UPGRADE or upgrade—Specifies to
NOTE: For an upgrade from the pre-4.0 uninstall the pre-4.0 installation and also
agent, it is recommended that you set update the Oracle settings so that the
this variable to the UPGRADE or pre-4.0 RMAN scripts can be reused
upgrade value. without any script changes.

Perform the download and installation steps for the environment as described in the following topic.

Installing the Oracle RMAN agent on Linux and UNIX


About this task

Steps
1. Ensure that no backups are running. Stop the RMAN processes before you install the Oracle RMAN agent.
NOTE: If you use AIX and you experience copy failures, you might need to run /usr/bin/slibclean as the root
user after you stop the RMAN processes.

2. Download the Oracle RMAN agent as the software package for the operating system from the Support website at https://
support.emc.com.
The following table shows the software package names for the supported operating systems.

Table 4. Software package names on UNIX and Linux


Operating system Software package name
AIX (64-bit) ddrman194_aixpower.tar

Linux x64 (64-bit) ddrman194_linux_x86_64.tar

Solaris AMD (64-bit) ddrman194_solaris_x86_64.tar

Solaris SPARC (64-bit) ddrman194_solaris64.tar

3. Change the ownership of the tar file to the oracle user by running the following command:

# chown -R oracle:oinstall <file_name>

Uncompress the downloaded tar file using the oracle user by running the following command:

# tar -vxf <file_name>

4. If you want the installation script to run automatically, ensure that you set the multiple environment variables that are described in
Installing the Oracle RMAN agent on database servers on page 35.
For example, you want to run an automatic installation that overwrites an existing Oracle RMAN agent 19.4 in the default directory and
uninstalls a pre-4.0 installation under ORACLE_HOME without any prompts. In this case, run the following commands to set the
required environment variables before you run the installation script:

# export DD_CREDENTIALS_UPDATE=FALSE
# export ORACLE_HOME=/home/oracle/app/oracle/product/11.2.0/dbhome_1/
# export RMAN_AGENT_INSTALL_OPTIONS=overwrite
# export RMAN_AGENT_HOME=/home/oracle/opt/dpsapps/rmanagent/
# export RMAN_AGENT_UPGRADE_OPTIONS=uninstall

Configuring the Oracle RMAN Agent for Stand-alone Deployment 37


For an automatic upgrade from Oracle RMAN agent version 4.0 or later to version 19.4, ensure that you run the following commands:

# export DD_CREDENTIALS_UPDATE=FALSE
# export RMAN_AGENT_HOME=<$RMAN_AGENT_HOME>
# export RMAN_AGENT_INSTALL_OPTIONS=OVERWRITE

To verify the value of an environment variable, run the echo command. For example:

# echo $RMAN_AGENT_HOME

/home/oracle/opt/dpsapps/rmanagent

5. As an Oracle user, run the install.sh script:

./install.sh

NOTE: When you set the required environment variables for an automatic (silent) install or upgrade, the
install.sh script runs without displaying prompts. Otherwise, the script displays specific prompts, described as
follows.
If RMAN_AGENT_HOME is not set, the script displays the following prompt:
Do you want to install under the default installation directory $HOME/opt/dpsapps/rmanagent?
(y or n)
Type the appropriate value:
• To install to the default directory, type y.
• To install in a non-default directory, type n.
The script prompts you to enter the installation directory pathname:
A directory outside of the ORACLE_HOME directory must have been created specifically for
this installation. Enter the full pathname of the installation destination:
Type the pathname of an already created installation directory.

6. If a previous version of the Oracle RMAN agent is installed:


NOTE: The following prompts for detailed entries are displayed only when you do not run the export command to
set the environment variables as described in step 4.
a. The installer prompts for an existing Data Domain server and storage unit name:

As a PowerProtect Data Manager user, update the existing Data Domain details? (y or n) y
Data Domain server name: 10.31.140.205
Data Domain storage unit name: rman

b. The installer prompts whether to uninstall pre-4.0 software. Type the appropriate value:
• To uninstall the pre-4.0 software, type y.
• To keep and use the pre-4.0 software, type n. You can later run the uninstallation script if required to uninstall the pre-4.0
software, as described in Uninstalling the Oracle RMAN agent on Linux and UNIX on page 41.
c. If you selected to uninstall pre-4.0 software in the preceding step, the installer prompts whether to update the Oracle settings
under $ORACLE_HOME. The updated settings will enable the reuse of RMAN scripts from the previous version without any script
changes. Type the appropriate value:
• To enable the reuse of the pre-4.0 RMAN scripts without script changes, type y.
• To prevent updates of the Oracle settings, type n. Then, to make any pre-4.0 RMAN script usable with the Oracle RMAN
agent 19.4, you must change the following items in the script:
○ Set SBT_LIBRARY to $RMAN_AGENT_HOME/lib/libddobk.so.
○ Replace the ORACLE_HOME setting with the RMAN_AGENT_HOME setting.
The Oracle RMAN agent 19.4 files are installed in the following directories on a Linux or UNIX system.

Table 5. Product software components on Linux or UNIX


Software components Installation directory
DD Boost library files: $RMAN_AGENT_HOME/lib

38 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Table 5. Product software components on Linux or UNIX (continued)
Software components Installation directory

libddobk.so

libDDBoost.so

Configuration validation library file for PowerProtect integration $RMAN_AGENT_HOME/lib


(Linux only):
libddboravalidate.so

Lockbox library files on AIX, Linux, Solaris: $RMAN_AGENT_HOME/lib


libLockbox.so

libEnshroud-OpenSSL.so

libcrypto.so.1.0.0

libddvdisk.so

libssl.so.1.0.0

Lockbox files: $RMAN_AGENT_HOME/config


NOTE: If lockbox files exist that were created by a
ddboost.config
pre-4.0 installation and no new lockbox files are
ddboost.config.bak created by the version 19.4 software, the pre-4.0
lockbox files are upgraded to this location.
ddboost.config.FCD

ddboost.config.bak.FCD

adm-agent-19.4.0.rpm (Linux only) $RMAN_AGENT_HOME/bin

ddbmcon (Linux only) $RMAN_AGENT_HOME/bin

ddbmoim binary (Linux only) $RMAN_AGENT_HOME/bin

ddbmoim log files (Linux only) $RMAN_AGENT_HOME/logs

ddutil binary $RMAN_AGENT_HOME/bin

ddutil log files $RMAN_AGENT_HOME/logs

rman_agent.cfg (Linux only) $RMAN_AGENT_HOME/config

rman_agent_oim.cfg (Linux only)

rman_options.cfg (Linux only)

rman_agent_home.cfg $ORACLE_HOME/config
NOTE: This configuration file is created during an
update from a pre-4.0 installation.

Installation and configuration examples on page 126 provides examples.

7. After the software installation, if you want to use an existing lockbox in a non-default directory, upgrade the lockbox through either of
the following procedures:
• Run the following ddutil -U command to upgrade the lockbox and then copy the existing lockbox files to the default directory,
$RMAN_AGENT_HOME/config. The command must include the complete pathname of the non-default directory. For example:

ddutil -U -a LOCKBOX_IMPORT=TRUE -a LOCKBOX_PATH=<non-default_lockbox_directory_pathname>


cp <non-default_lockbox_directory_pathname>/ddboost.config* $RMAN_AGENT_HOME/config

Configuring the Oracle RMAN Agent for Stand-alone Deployment 39


• Copy the existing lockbox files from the non-default directory to the default directory, $RMAN_AGENT_HOME/config, and then
run the following ddutil -U command to upgrade the lockbox:

ddutil -U -a LOCKBOX_IMPORT=TRUE

CAUTION: If you do not run the appropriate ddutil -U command to upgrade the existing lockbox, any subsequent
backup, restore, and query operations will fail with an error message.

Uninstalling the Oracle RMAN agent on database servers


Run the uninstall.sh script to uninstall the Oracle RMAN agent 19.4. You can also run the script to uninstall a previous version of the
Oracle RMAN agent.
Run the uninstall.sh -h or uninstall.sh --help command to obtain more information about the script operation.
You can run the uninstall.sh script manually or automatically. To enable the automatic operation, you must set the appropriate
environment variables as listed in Table 6. Environment variables for uninstallation of Oracle RMAN agent on page 40:
• When the variables are not set, the script runs manually and prompts for the required values.
• When the variables are set, the script runs automatically and performs the uninstallation according to the environment variable
settings.
NOTE: ORACLE_HOME is an Oracle environment variable. The other variables are the Oracle RMAN agent environment
variables.

Table 6. Environment variables for uninstallation of Oracle RMAN agent


Environment variable Description Default and valid values
ORACLE_HOME Specifies the installation location of a pre-4.0 • Undefined (default).
Oracle RMAN agent. • Valid value of the ORACLE_HOME directory
under which the pre-4.0 Oracle RMAN
agent is installed.

RMAN_AGENT_HOME Specifies the installation directory for the Oracle • /home/oracle1/opt/dpsapps/


RMAN agent 4.0 or later. rmanagent (default).
• Valid complete pathname of the directory
for installation of Oracle RMAN agent 4.0 or
later.
NOTE: The directory pathname
must not end with a slash (/).

RMAN_AGENT_UNINSTALL_ Required only for an uninstallation of Oracle • Undefined (default).


OPTIONS RMAN agent 4.0 or later. Specifies the software • NONE or none—Specifies to keep the
components to uninstall. version 4.0 or later software, and not
perform the uninstallation.
• BINARY or binary—Specifies to uninstall the
version 4.0 or later software, but not the
lockbox.
• FULL or full—Specifies to uninstall both the
version 4.0 or later software and the
lockbox.

RMAN_AGENT_UNINSTALL_ Required only for an uninstallation of pre-4.0 • Undefined (default).


PRE40_OPTIONS Oracle RMAN agent software. Specifies the • NONE or none—Specifies to keep the
components to uninstall for the pre-4.0 pre-4.0 software, and not perform the
software. uninstallation.
• BINARY or binary—Specifies to uninstall the
pre-4.0 software, but not the lockbox.
• FULL or full—Specifies to uninstall both the
pre-4.0 software and the lockbox.

40 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Perform the uninstallation steps as described in the following topic.

Uninstalling the Oracle RMAN agent on Linux and UNIX


About this task
NOTE: It is not necessary to uninstall the Oracle RMAN agent for an upgrade on Linux or UNIX. An existing Oracle RMAN
agent is overwritten during an upgrade.

Steps
1. Ensure that backup and restore operations are not in progress when you uninstall the Oracle RMAN agent.
2. If you want the uninstallation script to run automatically, ensure that the required environment variables are set as described in
Uninstalling the Oracle RMAN agent on database servers on page 40. To verify the value of an environment variable, run the echo
command. For example:

# echo $RMAN_AGENT_HOME

/home/oracle/opt/dpsapps/rmanagent
To set the RMAN_AGENT_HOME environment variable, run the export command. For example:

# export RMAN_AGENT_HOME=/opt/dpsapps/rmanagent

3. As an Oracle user, run the uninstall.sh script:


NOTE: It is recommended that you set the RMAN_AGENT_HOME environment variable before you run the
uninstall.sh script.

# ./uninstall.sh

4. If the script does not run automatically, type the appropriate values at the prompts.
When prompted for a directory pathname for the uninstallation, you can specify the pathname of the Oracle RMAN agent that is
installed. Type the complete pathname without a slash (/) at the end.
If the script detects an additional installation of Oracle RMAN agent, the script prompts whether to uninstall that version. You can
specify to keep or uninstall the software.

Configuring the software on Linux and UNIX systems


From within RMAN, configure a channel.
NOTE:

The storage unit specified in the following command must already exist on the Data Domain system.

The same storage unit must be used for both manual and scheduled backups. The latest PowerProtect Data Manager or
PowerProtect X400 documentation provides details on how to set up and perform scheduled backups.
The following example shows the command syntax for configuring a channel in a Linux or UNIX environment.

RMAN> CONFIGURE CHANNEL DEVICE TYPE 'SBT_TAPE' TRACE <trace-level>


PARMS 'BLKSIZE=1048576,
SBT_LIBRARY=<path-to-$RMAN_AGENT_HOME>/lib/libddobk.so,
ENV=(STORAGE_UNIT=<storage-unit-on-Data-Domain-system>,
BACKUP_HOST=<hostname-of-Data-Domain-system>,
RMAN_AGENT_HOME=<path-to-$RMAN_AGENT_HOME>)';

The configuration that you specify is also displayed in the Media Management Settings field of Oracle Enterprise Manager (OEM).

Configuring the Oracle RMAN Agent for Stand-alone Deployment 41


Installing and configuring the Oracle RMAN agent
on Windows systems
Installing the Oracle RMAN agent on database servers
Install the Oracle RMAN agent on all the database servers that must access the Data Domain system. The installation can be performed by
an administrator or an Oracle user.
The pre-4.0 versions of Oracle RMAN agent are installed under the ORACLE_HOME directory. Starting with Oracle RMAN agent version
4.0, the software must be installed in a directory other than the ORACLE_HOME directory.
Before you install the Oracle RMAN agent, ensure that all the Oracle and RMAN processes are stopped and no RMAN backup or restore
processes are running.
During an upgrade of a preexisting Windows Oracle RMAN agent, the installation might fail unless all the Oracle instances are stopped.
Stop all the Oracle instances before you perform a Windows installation.
The user that performs the Oracle RMAN agent installation must have permissions to install the Microsoft Installer (MSI) technology
binaries. If the local users do not have such permissions, the administrator must perform the installation on behalf of the local users.
For each user that performs the installation, a set of Oracle RMAN agent files is installed. By default, the software files are installed under
the user profile directory. If you want a single copy of the software files to be installed per computer, specify a non-default shared
directory for the installation and manually set the appropriate read and write permissions on the directory.
An installation of the Oracle RMAN agent requires at least 50 MB of available disk space in the installation user profile directory.
Perform the download and installation steps for the environment as described in the following topic.

Installing the Oracle RMAN agent on Windows systems


About this task
NOTE: During an upgrade of Oracle RMAN agent on Windows, you do not need to uninstall the previous-version
software. An existing Oracle RMAN agent is overwritten during an upgrade.

Steps
1. Download the Oracle RMAN agent as the Windows software package from the Support website at https://support.emc.com/.
The Windows software package name is ddrman194_ntx64.zip.
2. Install the Oracle RMAN agent by using either of the following methods:
• Interactive method with the installation wizard:
a. Double-click Oracle RMAN agent.exe to launch the installation wizard.
The Welcome to the Setup Wizard page appears.
NOTE: Run only one instance of the installation wizard at a time. If you try to run more than one instance, the
wizard operation terminates with an error.
b. Read the terms of the Software License and Support Services Agreement, select I Agree, and then click Next to continue.
c. The Change Install Location page displays the default destination directory for the installation as %LOCALAPPDATA%
\RMANAgent, for example, C:\Users\Administrator\AppData\Local\RMANAgent. The Oracle RMAN agent
components will be installed in subdirectories in this destination directory.
Accept or change the installation directory:
○ To accept the displayed directory for the installation, click Install.
○ To change the displayed directory, click Change and browse to select a different directory. When the correct directory is
displayed, click Install.
d. If any previous versions of Oracle RMAN agent are installed, an Upgrade Options page displays a list of the previous
installations. Select to keep or remove the previous installations as required:
○ To uninstall all the previous installations, select Remove all the previous Oracle RMAN agent installations.
○ To copy the pre-4.0 lockbox files from one of the displayed installations to the %RMAN_AGENT_HOME%\config directory:

42 Configuring the Oracle RMAN Agent for Stand-alone Deployment


▪ Select Copy a legacy lockbox into the new installation directory (select only one item).
▪ Select only one of the displayed pre-4.0 installations in the list.
NOTE: The uninstallation of previous versions is irreversible. Pre-4.0 lockbox files are not removed by the
version 19.4 installation.
When you have completed the selections on the Upgrade Options page, click Install and respond to any displayed prompts.
NOTE: The upgrade of Oracle RMAN agent from a previous version includes an automatic upgrade of the
lockbox.
e. The Installation Progress window displays a progress bar. To cancel the installation at any time, click Cancel.
f. When the installation completes, the Complete the Setup window displays information about the log, any errors, and the
software installation status. Click Finish to exit the wizard.
• Silent installation method:
Run the Oracle RMAN agent.exe command with the appropriate command options:

Oracle RMAN agent.exe <installation_options>

where <installation_options> includes the following options:


○ /s /qn are the only mandatory options, to suppress the GUI output. Without these options, the Windows installer GUI is
launched to perform the installation.
○ ProductInstallPath <pathname> specifies the installation directory for the Oracle RMAN agent files. Enclose
<pathname> in double quotes if it includes a space. The default directory is %LOCALAPPDATA%\RMANAgent, for example,
C:\Users\Administrator\AppData\Local\RMANAgent. Use this option to specify a non-default installation
directory.
○ RemoveOldVersions=1 specifies to uninstall all pre-4.0 versions of Oracle RMAN agent that are installed on the Windows
system. The uninstallation is irreversible, and does not display any prompts for confirmation.
○ CopyLockboxBinaries <pathname> specifies to copy the pre-4.0 lockbox files from the <pathname> directory to the
%RMAN_AGENT_HOME%\config directory. The Oracle RMAN 19.4 installation directory is %RMAN_AGENT_HOME%.
NOTE: You can use the CopyLockboxBinaries option only when RemoveOldVersions=1 appears in the
same command. The command can copy the lockbox files from only one pre-4.0 directory. Pre-4.0 lockbox
files are not removed by a version 19.4 installation.
For example, the following command silently installs the Oracle RMAN agent 19.4 software in the directory C:\Program Files
\RMANAgent, and uninstalls all pre-4.0 versions of the software. The command also copies the pre-4.0 lockbox files from
C:\app\oracle\product\12.1.0\dbhome_2\config to %RMAN_AGENT_HOME%\config:

"Oracle RMAN agent.exe" /s /qn ProductInstallPath="C:\Program Files\RMANAgent"


RemoveOldVersions=1 CopyLockboxBinaries="C:\app\oracle\product\12.1.0\dbhome_2"

NOTE: The upgrade of Oracle RMAN agent from a previous version includes an automatic upgrade of the lockbox.

The Oracle RMAN agent 19.4 files are installed in the following directories on a Windows system.

Table 7. Product software components on Windows


Software components Installation directory
DD Boost library files: %RMAN_AGENT_HOME%\BIN
libddobk.dll

libDDBoost.dll

libDataDomainoncrpc.dll

libDataDomainpthread.dll

Lockbox library files: %RMAN_AGENT_HOME%\cst


Lockbox.dll

Enshroud-OpenSSL.dll

Configuring the Oracle RMAN Agent for Stand-alone Deployment 43


Table 7. Product software components on Windows (continued)
Software components Installation directory
Other library files: %RMAN_AGENT_HOME%\BIN
msvcr80.dll

msvcr100.dll

Lockbox files: %RMAN_AGENT_HOME%\config


ddboost.config

ddboost.config.bak

ddboost.config.FCD

ddboost.config.bak.FCD

ddutil.exe binary %RMAN_AGENT_HOME%\BIN

ddutil.exe log files %RMAN_AGENT_HOME%\logs

3. After the software installation, if you want to use an existing lockbox in a non-default directory, upgrade the lockbox through either of
the following procedures:
• Run the following ddutil -U command to upgrade the lockbox and then copy the existing lockbox files to the default directory,
%RMAN_AGENT_HOME%\config. The command must include the complete pathname of the non-default directory. For example:

ddutil -U -a LOCKBOX_IMPORT=TRUE -a LOCKBOX_PATH=<non-default_lockbox_directory_pathname>


cp <non-default_lockbox_directory_pathname>\ddboost.config* %RMAN_AGENT_HOME%\config

• Copy the existing lockbox files from the non-default directory to the default directory, %RMAN_AGENT_HOME%\config, and then
run the following ddutil -U command to upgrade the lockbox:

ddutil -U -a LOCKBOX_IMPORT=TRUE

CAUTION: If you do not run the appropriate ddutil -U command to upgrade the existing lockbox, any subsequent
backup, restore, and query operations will fail with an error message.

Uninstalling the Oracle RMAN agent on Windows systems


About this task
NOTE: During an upgrade of Oracle RMAN agent on Windows, you do not need to uninstall the previous-version
software. An existing Oracle RMAN agent is overwritten during an upgrade.

Steps
1. Ensure that backup and restore operations are not in progress when you uninstall the Oracle RMAN agent.
2. Uninstall the Oracle RMAN agent by using the uninstall/change program feature in the Windows Control Panel, as used to uninstall a
typical Windows program. Be careful to select and uninstall the correct item for the Oracle RMAN agent.
Open the Windows Control Panel, and then select Program and Features.
3. In the Uninstall or change a program window, select Oracle RMAN agent and then click Uninstall.
4. In the Install Modification window, select the Remove radio button and then click Remove.
NOTE: The Change option is not supported for the Oracle RMAN agent. The Repair option can be selected to restore
the installation to its original state without affecting any user-generated files or configuration files.
The Uninstallation Progress window displays a progress bar. The software files are uninstalled without removing any user-generated
files or configuration files.

5. When the uninstallation completes, the Complete the Setup window displays information about the log, any errors, and the software
uninstallation status. Click Finish to exit the wizard.

44 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Configuring the software on Windows systems
From within RMAN, configure a channel.

NOTE: The storage unit specified in the following command must already exist on the Data Domain system.

The following example shows the Oracle RMAN command syntax for configuring a channel in a Windows environment:

RMAN> CONFIGURE CHANNEL DEVICE TYPE 'SBT_TAPE' TRACE <trace-level>


PARMS 'BLKSIZE=1048576,
SBT_LIBRARY=<path-to-%RMAN_AGENT_HOME%>\bin\libDDobk.dll,
ENV=(STORAGE_UNIT=<storage-unit-on-Data-Domain-system>,
BACKUP_HOST=<hostname-of-Data-Domain-system>,
RMAN_AGENT_HOME=<path-to-%RMAN_AGENT_HOME%>)';

The configuration that you specify is also displayed in the Media Management Settings field of Oracle Enterprise Manager (OEM).

Registering each Data Domain system


NOTE: The registration step is not required when you deploy the Oracle RMAN agent with PowerProtect Data Manager
or PowerProtect X400 because those systems automatically complete the Data Domain registration to the agents. The
manual registration step is only required when you restore from an alternate host that is not part of the same
PowerProtect protection policies.
To connect to a Data Domain system, you must first register the Data Domain system with the Oracle RMAN agent. This registration
provides the Oracle RMAN agent with the necessary username and password for connecting to the Data Domain system. The Oracle
RMAN agent stores the username and password securely in an encrypted lockbox file and retrieves the values when connecting to a Data
Domain system.
NOTE: The Oracle RMAN agent 19.1 introduced support for using multiple storage units per Data Domain system
associated with the same Oracle database host. To use more than one storage unit with the same Oracle host and Data
Domain system, you must register the username and password for each storage unit separately.
When a Data Domain system is registered for the first time, the encrypted lockbox file is created in the $RMAN_AGENT_HOME/config
directory (Linux or UNIX) or in the %RMAN_AGENT_HOME%\config directory (Windows). For security purposes, the lockbox file is
typically created so that it can only be accessed by the host system that creates it. If another host system tries to access the lockbox, the
access is denied. This prevents other systems from connecting to the Data Domain system. Typically, these other systems have their own
Oracle instance and Oracle home directory with RMAN installed and therefore will have their own lockbox file.
CAUTION: By default, the lockbox file on UNIX and Linux is created with the rw-rw---- permissions, so that the file
owner and group user can read from the file and write to the file. To implement a higher security level on the lockbox
file, you can change the file permissions to rw-r-----, so that group users cannot write to the lockbox file. Run the
chmod g-w ddboost.config command to change the permissions.

In a typical case, a single Oracle host system is in use, or multiple host systems exist and each has its own Oracle instance and its own
Oracle home directory. In this typical case, register the Data Domain systems as described in Registering a standard Data Domain system
on page 45. Each client system has its own lockbox file, accessible only to that system.
When a Data Domain system has DD Boost over Fibre Channel, register the Data Domain system as described in Registering a Data
Domain system with DD Boost over Fibre Channel on page 47.
In some cases, such as in an Oracle RAC environment, multiple system nodes share an Oracle home directory and thus share a lockbox file.
In these cases, create a lockbox file that can be accessed by multiple systems as described in Registering a Data Domain system for
shared lockbox access on page 48.

Registering a standard Data Domain system


NOTE: The registration step is not required when you deploy the Oracle RMAN agent with PowerProtect Data Manager
or PowerProtect X400 because those systems automatically complete the Data Domain registration to the agents. The
manual registration step is only required when you restore from an alternate host that is not part of the same
PowerProtect protection policies.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 45


Register each standard Data Domain system by using the ddutil command with the -C option or by using an RMAN command within a
script. Use the instructions in one of the following subtopics:
• Using a ddutil -C command to register a standard Data Domain system on page 46
• Using an RMAN command to register a standard Data Domain system on page 47
After you register a Data Domain system in the lockbox, you can perform backups and restores with the Data Domain system by using
'device type sbt_tape'. If you want all the backups to go to the Data Domain system, configure SBT_TAPE as the default device
by using the following command:

RMAN> CONFIGURE DEFAULT DEVICE TYPE TO 'SBT_TAPE';

Using a ddutil -C command to register a standard Data Domain


system
To register a Data Domain system so that RMAN can connect to it for backup operations, you can use the ddutil command with the -C
option. This registration task is required only once for each separate storage unit to be used on the same Data Domain system. Do not run
the registration command for each backup. Perform the registration before you perform any backups.
NOTE: If the lockbox does not exist when you run the ddutil -C command, the command creates the lockbox in the
default directory.
The -C option has four optional -a arguments, DD_SERVER_NAME, DD_STORAGE_UNIT, USERNAME, and VERIFY_CREDENTIAL. To
register a Data Domain system, run the ddutil -C command for each storage unit to be used on the Data Domain system and enter the
prompted values:
• When you omit the -a arguments, the command prompts for the Data Domain server name, storage unit name, DD Boost username,
and password:

ddutil -C

Data Domain server name: <server_name>


Data Domain Storage Unit name: <storage_unit_name>
DD Boost username: <username>
Password: <password>
Re-enter password: <password>
Successfully set the DD Boost credentials in the lockbox.
• When you include the -a arguments, the command prompts only for the password:

ddutil -C -a DD_SERVER_NAME=<server_name> -a DD_STORAGE_UNIT=<storage_unit_name> -a


USERNAME=<username> -a VERIFY_CREDENTIAL=TRUE

Password: <password>
Re-enter password: <password>
When you specify the -a VERIFY_CREDENTIAL=TRUE argument, the ddutil command verifies the DD Boost user credential with
the specified Data Domain server before saving the credential in the lockbox. If the credential verification fails, the command prints an
error message, stating that it cannot connect to the Data Domain system, and does not save the credential. When you do not specify the
-a VERIFY_CREDENTIAL=TRUE argument, the program saves the DD Boost user credential directly in the lockbox without performing
any credential verification.
Ensure that you specify the correct values in the command and at the prompts:
• The <server_name> value is the name of the Data Domain server exactly as specified by the BACKUP_HOST value in the CONFIGURE
CHANNEL command. The <server_name> value is case-sensitive, and the same form of the name must be specified with the ddutil
-C command as with the CONFIGURE CHANNEL command.
For example, if server1.domain.com was used when configuring the channel, you must also use server1.domain.com here. Do not use
SERVER1.domain.com or server1. An IP address can be used, if that same IP address was used in the CONFIGURE CHANNEL
command. You can register multiple forms of the server name. For example, you can register both server1 and server1.domain.com and
use either of those names in CONFIGURE CHANNEL commands.
• The <storage_unit_name> value is the name of a storage unit on the Data Domain server that will be used for backup operations with
the Oracle RMAN agent.
• The <username> value is the DD Boost username that you set with the user add command and ddboost user assign
command when you enable DD Boost on the Data Domain system. The username is case-sensitive, and must match exactly the value
set on the Data Domain system.

46 Configuring the Oracle RMAN Agent for Stand-alone Deployment


• The <password> value is the password that you set up with the DD OS CLI user command when you enable DD Boost on the Data
Domain system. The password is case-sensitive, and must match exactly the value set on the Data Domain system.

Using an RMAN command to register a standard Data Domain system


To register a Data Domain system so that RMAN can connect to it for backup operations, you can use an RMAN command as shown in
the following example. Edit the command for your environment. This registration task is required only once for each separate storage unit
to be used on the same Data Domain system. Do not include the registration command in each backup script. Perform the registration
before you perform any backups.
RUN {
ALLOCATE CHANNEL C1 TYPE 'SBT_TAPE' TRACE 5 PARMS 'BLKSIZE=1048576,
SBT_LIBRARY=/home/oracle1/rman_agent_home/lib/libddobk.so,
ENV=(BACKUP_HOST=bu-ddbea-lin-16.lss.emc.com,
RMAN_AGENT_HOME=/home/oracle1/rman_agent_home)';
send 'set username q_ost password 1X3quest servername
bu-ddbea-lin-16.lss.emc.com storageunit rman_cloud';
RELEASE CHANNEL C1;
}
Ensure that you specify the correct values in the RMAN command:
• The username is the DD Boost username that you set with the user add command and ddboost user assign command
when you enable DD Boost on the Data Domain system. The username is case-sensitive, and must match exactly the value set on the
Data Domain system.
• The password is the password that you set up with the DD OS CLI user command when you enable DD Boost on the Data Domain
system. The password is case-sensitive, and must match exactly the value set on the Data Domain system.
• The servername value is the name of the Data Domain server exactly as specified by the BACKUP_HOST value in the CONFIGURE
CHANNEL command. The servername value is case-sensitive, and the same form of the name must be used in this command as in the
CONFIGURE CHANNEL command.
For example, if server1.domain.com was used when configuring the channel, you must also use server1.domain.com here. Do not use
SERVER1.domain.com or server1. An IP address can be used, if that same IP address was used in the CONFIGURE CHANNEL
command. You can register multiple forms of the server name. For example, you can register both server1 and server1.domain.com and
use either of those names in CONFIGURE CHANNEL commands.
• The storageunit value is the name of a storage unit on the Data Domain server that will be used for backup operations with the
Oracle RMAN agent.

Registering a Data Domain system with DD Boost over


Fibre Channel
NOTE: This registration topic does not apply to PowerProtect Data Manager or PowerProtect X400 deployments.

Registering a Data Domain system with DD Boost over Fibre Channel is almost the same as registering a standard Data Domain system,
but with one important difference. For the Data Domain server name, you must specify the configured Fibre Channel server name.
Register each Data Domain system with DD Boost over Fibre Channel by using the ddutil command with the -C option or by using an
RMAN command within a script. Use the instructions in one of the following subtopics:
• Using a ddutil -C command to register a Data Domain system with DD Boost over Fibre Channel on page 48
• Using an RMAN command to register a Data Domain system with DD Boost over Fibre Channel on page 48
Specify the configured Fibre Channel server name for the BACKUP_HOST parameter:
RUN {
CONFIGURE CHANNEL DEVICE TYPE 'SBT_TAPE' PARMS 'BLKSIZE=1048576, SBT_LIBRARY=/home/oracle1/
ddboost_home/lib/libddobk.so,
ENV=(STORAGE_UNIT=<storage_unit>,BACKUP_HOST=<DFC_server_name>,
RMAN_AGENT_HOME=/home/oracle1/ddboost_home)' FORMAT '%d_%U_%t';
}
After you register a Data Domain system in the lockbox, you can perform backups and restores with the Data Domain system by using
'device type sbt_tape'. If you want all the backups to go to the Data Domain system, configure SBT_TAPE as the default device
by using the following command:

RMAN> CONFIGURE DEFAULT DEVICE TYPE TO 'SBT_TAPE';

Configuring the Oracle RMAN Agent for Stand-alone Deployment 47


Using a ddutil -C command to register a Data Domain system with DD
Boost over Fibre Channel
To register a Data Domain system with DD Boost over Fibre Channel, you can specify the Fibre Channel server name in the ddutil -C
command or when prompted by the command. Using a ddutil -C command to register a standard Data Domain system on page 46
provides more information about running the ddutil -C command.
For example, you can specify the Fibre Channel server name with the -a DD_SERVER_NAME=<DFC_server_name> argument in the
command:

ddutil -C -a DD_SERVER_NAME=<DFC_server_name> -a DD_STORAGE_UNIT=<storage_unit_name> -a


USERNAME=<DD_Boost_username> -a VERIFY_CREDENTIAL=TRUE

Password: <password>
Re-enter password: <password>
The <DFC_server_name> value is the Fibre Channel server name exactly as specified by the BACKUP_HOST value in the CONFIGURE
CHANNEL command. The <DFC_server_name> value is case-sensitive, and the same form of the name must be specified with the
ddutil -C command as with the CONFIGURE CHANNEL command.
For example, run the following command to determine the Fibre Channel server name:

ddboost fc dfc-server-name show

DDBoost dfc-server-name: ddavamarfour


Configure clients to use "DFC-ddavamarfour" for DDBoost FC.
Then, to register the Data Domain system with DD Boost over Fibre Channel, run the following command with the Fibre Channel server
name in the proper form, preceded by DFC-:

ddutil -C -a DD_SERVER_NAME=DFC-ddavamarfour -a DD_STORAGE_UNIT=<storage_unit_name> -a


USERNAME=<DD_Boost_username> -a VERIFY_CREDENTIAL=TRUE

Using an RMAN command to register a Data Domain system with DD


Boost over Fibre Channel
To register a Data Domain system with DD Boost over Fibre Channel, you can specify the Fibre Channel server name in the RMAN send
command in the RMAN script. The registration task is required once for each separate storage unit to be used on the same Data Domain
system. For example:
RUN {
ALLOCATE CHANNEL C1 TYPE 'SBT_TAPE' TRACE 5 PARMS 'BLKSIZE=1048576,
SBT_LIBRARY=/home/oracle1/rman_agent_home/lib/libddobk.so,
ENV=(BACKUP_HOST=bu-dfc-lin-16.lss.emc.com,
RMAN_AGENT_HOME=/home/oracle1/rman_agent_home)';
send 'set username q_ost password 1X3quest servername
bu-dfc-lin-16.lss.emc.com storageunit rman_cloud';
RELEASE CHANNEL C1;
}
The servername value is the Fibre Channel server name exactly as specified by the BACKUP_HOST value in the CONFIGURE
CHANNEL command. The Fibre Channel server name is case-sensitive, and the same form of the name must be specified in the RMAN
script as in the CONFIGURE CHANNEL command.

Registering a Data Domain system for shared lockbox


access
NOTE: This registration step is not required when you deploy the Oracle RMAN agent with PowerProtect Data Manager
or PowerProtect X400 because those systems automatically complete the Data Domain registration to all the nodes in
the cluster.
In some cases, such as in an Oracle RAC environment, multiple system nodes share an Oracle home directory and thus share a lockbox file.
In these cases, it is necessary to create a lockbox file that can be accessed by multiple systems.

48 Configuring the Oracle RMAN Agent for Stand-alone Deployment


If multiple database host systems must use the same lockbox file, the procedure for creating the lockbox file includes an additional step.
This step is required so that host database systems other than the one that created the lockbox can also access the lockbox. Perform this
step before any Data Domain systems are registered. After this step is performed, each Data Domain system can be registered.
Users of RMAN versions prior to RMAN 1.2 who want to share lockbox files among multiple client systems must delete the existing
lockbox files and create new lockbox files by using RMAN 1.2 and the instructions in this topic. It is not possible to upgrade a lockbox that
was created with earlier versions of RMAN so that it can be accessed by multiple client database systems.
NOTE: A lockbox file created with RMAN 1.0 or 1.1 continues to work with RMAN 1.2 when accessed from the client
database system that created it. It is not necessary to modify the lockbox file.
Register a Data Domain system for shared lockbox access by using the ddutil command with the -H option or by using an RMAN
command within a script. Use the instructions in one of the following subtopics:
• Using a ddutil -H command to register a Data Domain system for shared lockbox access on page 49
• Using an RMAN command to register a Data Domain system for shared lockbox access on page 49

Using a ddutil -H command to register a Data Domain system for


shared lockbox access
The following ddutil -H command specifies all the hosts that must access the lockbox file:

ddutil -H "hostnames <hostname-1> <hostname-2> ... <hostname-n>"

When you run this command to create the lockbox, all the hosts that you specify in the command are given access to the lockbox.
You run the ddutil -H command only once, to create the lockbox. All the hosts that share access to the lockbox must be specified in a
single ddutil -H command. It is not possible to grant additional hosts access to the lockbox later. In that case, you must delete the
existing lockbox file and then create a new lockbox file with all the hostnames.
Run the ddutil -H command before you run the registration command. All the hosts that will access the shared lockbox file must be
listed in the <hostname-1> ... <hostname-n> list. Specify each <hostname> value as a fully qualified hostname, for example,
test1.datadomain.com.
For example, the following command creates a lockbox that can be shared by three database client host systems:

ddutil -H "hostnames dbclient1.datadomain.com dbclient2.datadomain.com


dbclient3.datadomain.com"

When the Oracle RMAN agent receives the ddutil -H command, the Oracle RMAN agent checks if a lockbox file already exists. If so,
an error is reported, and a message (logged in the RMAN trace file) reports this and instructs the user to delete the lockbox file if
preferred and repeat the command. The Oracle RMAN agent does not delete an existing lockbox file.
If no lockbox file exists, the Oracle RMAN agent creates a lockbox file, and all the specified hosts are granted access to the new lockbox.
The lockbox can then be used and shared by all these hosts. Next, register each Data Domain system that these hosts will access. You can
register additional Data Domain systems at any time after the lockbox is created. Register each Data Domain system as described in
Registering a standard Data Domain system on page 45. Because all the specified hosts have access to the lockbox, you can register the
Data Domain systems on any of the listed host systems. Each Data Domain system must be registered only once.
It is not possible to add additional hostnames after the ddutil -H command has been run. The only way to add additional hostnames is
to delete the current lockbox file and then re-create the file by running the ddutil -H command again, this time with all the required
hostnames. However, the lockbox contents are lost, and all the Data Domain systems must be re-registered.

Using an RMAN command to register a Data Domain system for


shared lockbox access
The RMAN hostnames command specifies all the hosts that must access the lockbox file. When you run the hostnames command to
create the lockbox, all the hosts that you specify in the command are given access to the lockbox.
You run the hostnames command only once, to create the lockbox. All the hosts that share access to the lockbox must be specified in a
single hostnames command. It is not possible to grant additional hosts access to the lockbox later. In that case, you must delete the
existing lockbox file and then create a new lockbox file with all the hostnames.
The hostnames command format is as follows:
RUN {
ALLOCATE CHANNEL C1 TYPE SBT_TAPE PARMS
'SBT_LIBRARY=<path-to-$RMAN_AGENT_HOME>/lib/libddobk.so,

Configuring the Oracle RMAN Agent for Stand-alone Deployment 49


ENV=(RMAN_AGENT_HOME=<path-to-$RMAN_AGENT_HOME>)';
send 'hostnames <hostname-1> <hostname-2> ... <hostname-n>';
RELEASE CHANNEL C1;
}
Run this command as the first RMAN command, before the registration command. All the hosts that will access the shared lockbox file
must be listed in the <hostname-1> ... <hostname-n> list. Specify each <hostname> value as a fully qualified hostname, for example,
test1.datadomain.com.
For example, the following RMAN command creates a lockbox that can be shared by three database client host systems:
RUN {
ALLOCATE CHANNEL C1 TYPE SBT_TAPE PARMS
'SBT_LIBRARY=<path-to-$RMAN_AGENT_HOME>/lib/libddobk.so,
ENV=(RMAN_AGENT_HOME=<path-to-$RMAN_AGENT_HOME>)';
send 'hostnames dbclient1.datadomain.com
dbclient2.datadomain.com dbclient3.datadomain.com';
RELEASE CHANNEL C1;
}
When the Oracle RMAN agent receives the hostnames command, the Oracle RMAN agent checks if a lockbox file already exists. If so,
an error is reported, and a message (logged in the RMAN trace file) reports this and instructs the user to delete the lockbox file if
preferred and repeat the command. The Oracle RMAN agent does not delete an existing lockbox file.
If no lockbox file exists, the Oracle RMAN agent creates a lockbox file, and all the specified hosts are granted access to the new lockbox.
The lockbox can then be used and shared by all these hosts. Next, register each Data Domain system that these hosts will access. You can
register additional Data Domain systems at any time after the lockbox is created. Register each Data Domain system as described in
Registering a standard Data Domain system on page 45. Because all the specified hosts have access to the lockbox, you can register the
Data Domain systems on any of the listed host systems. Each Data Domain system must be registered only once.
It is not possible to add additional hostnames after the hostnames command has been run. The only way to add additional hostnames is
to delete the current lockbox file and then re-create the file by running the hostnames command again, this time with all the required
hostnames. However, the lockbox contents are lost, and all the Data Domain systems must be re-registered.

Migrating an Oracle configuration from the


database application agent
Complete the following steps to migrate an Oracle configuration from the database application agent on the Oracle database server host
to the Oracle RMAN agent.

Steps
1. Discontinue all the Oracle backups that are performed with the database application agent.
2. Install the Oracle RMAN agent according to the appropriate instructions:
• Installing and configuring the Oracle RMAN agent on AIX, Linux, and Solaris systems on page 35
• Installing and configuring the Oracle RMAN agent on Windows systems on page 42
NOTE: The Oracle RMAN agent installation does not modify any of the database application agent files on the same
system.

3. Create the required lockbox for the Oracle RMAN agent operations by using the appropriate ddutil -C command as described in
Registering each Data Domain system on page 45.
4. Update the RMAN scripts as described in Updating the RMAN scripts for Oracle RMAN agent operations on page 51.
5. Use the correct type of RMAN script for restore, crosscheck, and delete operations as described in Using the correct RMAN script for
restore, crosscheck, and delete operations on page 52.
NOTE: You must allocate channels for both the database application agent and Oracle RMAN agent, for the restore,
crosscheck, and delete operations on any unexpired Oracle backups that were previously performed with the
database application agent. You can maintain the database application agent software on the Oracle database server
host as long as needed.

6. To enable the cloud tier operations with the Oracle RMAN agent, update the required data movement policies as described in
Updating the data movement policy for cloud tier operations on page 53.

50 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Updating the RMAN scripts for Oracle RMAN agent
operations
To restore the Oracle backups that were performed with the Oracle RMAN agent, you must use an RMAN script created for these
restores, not an RMAN script created for the database application agent for Oracle restores.
The RMAN scripts used for database application agent operations will not work for Oracle RMAN agent operations because the scripts
refer to the database application agent SBT library and do not include the required parameter settings. You must update the RMAN scripts
for the Oracle RMAN agent operations.
For example, the following RMAN command includes the correct SBT_LIBRARY setting for the Oracle RMAN agent:
ALLOCATE CHANNEL CH1 TYPE 'SBT_TAPE' TRACE 5 PARMS 'BLKSIZE=1048576,
SBT_LIBRARY=libddobk.so, ENV=(STORAGE_UNIT=rman_su, BACKUP_HOST=blrv071a091.lss.emc.com,
RMAN_AGENT_HOME=/opt/dpsapps/rmanagent/)';
As described in Using the correct RMAN script for restore, crosscheck, and delete operations on page 52, you must allocate channels for
both the database application agent and Oracle RMAN agent, for the restore, crosscheck, and delete operations on any unexpired Oracle
backups that were previously performed with the database application agent. You can maintain the database application agent software
on the Oracle database server host as long as needed.
The following topics provide details about performing backups with the Oracle RMAN agent:
• Specifying subdirectories for Oracle RMAN agent backups on page 58
• Oracle RMAN agent channel configuration and backup on page 128

Identifying the types of backups


To ensure that you update the RMAN scripts properly for operations with the correct agent, identify whether the backups were
performed with the database application agent or the Oracle RMAN agent. To determine which agent performed the backups, you can run
either the RMAN command LIST BACKUP or the RMAN command RESTORE...PREVIEW:
• In the LIST BACKUP command output, the database application agent backups are indicated by a media handle (after the label
Media:) as either Database Application Agent/<storage_unit> or (for database application agent 2.5) database
app agent/<storage_unit>. The Oracle RMAN agent backups are indicated by a media handle of only <device_path>.
For example, the following output from the LIST BACKUP command shows the two types of media handles:

RMAN>LIST BACKUP;

BS Key Type LV Size Device Type Elapsed Time Completion Time
------- ---- -- ---------- ----------- ------------ ---------------
34 Full 670.00M SBT_TAPE 00:00:04 13-FEB-19
BP Key: 27 Status: AVAILABLE Compressed: NO Tag: TAG20190213T021252
Handle: ./testdir/0vtpo8d4_1 Media: s:blrv071a091.lss.emc.com:/rman_su
List of Datafiles in backup set 27
Container ID: 3, PDB Name: PDBORCL
BS Key Type LV Size Device Type Elapsed Time Completion Time
------- ---- -- ---------- ----------- ------------ ---------------
27 Full 670.00M SBT_TAPE 00:00:03 20-FEB-19
BP Key: 34 Status: AVAILABLE Compressed: NO Tag: TAG20190220T041617
Handle: ORCL_17tqau8i_1_1 Media: Database Application Agent/ddbea_su
List of Datafiles in backup set 34
Container ID: 3, PDB Name: PDBORCL
File LV Type Ckp SCN Ckp Time Name
---- -- ---- ---------- --------- ----
8 Full 1969272 04-FEB-19 /u01/app/oracle/oradata/orcl/pdborcl/system01.dbf
9 Full 1969272 04-FEB-19 /u01/app/oracle/oradata/orcl/pdborcl/sysaux01.dbf
10 Full 1969272 04-FEB-19 /u01/app/oracle/oradata/orcl/pdborcl/
SAMPLE_SCHEMA_users01.dbf
11 Full 1969272 04-FEB-19 /u01/app/oracle/oradata/orcl/pdborcl/example01.dbf

• The RMAN command RESTORE...PREVIEW shows which product performed the backup and the backup pieces required for the
restore. In the RESTORE...PREVIEW command output, the database application agent backups are indicated by a media handle
(after the label Media:) as Database Application Agent/<device_path>. The Oracle RMAN agent backups are indicated
by a media handle of only <device_path>.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 51


For example, the following output from the RESTORE...PREVIEW command shows the two types of media handles:

List of Backup Sets


===================
BS Key Type LV Size Device Type Elapsed Time Completion Time
------- ---- -- ---------- ----------- ------------ ---------------
27 Incr 0 751.50M SBT_TAPE 00:00:08 18-JUN-19
BP Key: 27 Status: AVAILABLE Compressed: NO Tag: TAG20190618T224918
Handle: DDBEA_BACKUP_ORCL_1au4el7e_1_1 Media: Database Application Agent/ddbea_su
List of Datafiles in backup set 27
File LV Type Ckp SCN Ckp Time Abs Fuz SCN Sparse Name
---- -- ---- ---------- --------- ----------- ------ ----
1 0 Incr 3099340 18-JUN-19 NO /u01/app/oracle/oradata/ORCL/
datafile/o1_mf_system_gjncgq81_.dbf
4 0 Incr 3099340 18-JUN-19 NO /u01/app/oracle/oradata/ORCL/
datafile/o1_mf_undotbs1_gjncgqch_.dbf

BS Key Type LV Size Device Type Elapsed Time Completion Time


------- ---- -- ---------- ----------- ------------ ---------------
37 Incr 1 19.25M SBT_TAPE 00:00:02 18-JUN-19
BP Key: 37 Status: AVAILABLE Compressed: NO Tag: TAG20190618T234336
Handle: DDBEA_BACKUP_ORCL_1ju4eod8_1_1 Media: Database Application Agent/ddbea_su
List of Datafiles in backup set 37
File LV Type Ckp SCN Ckp Time Abs Fuz SCN Sparse Name
---- -- ---- ---------- --------- ----------- ------ ----
1 1 Incr 3104875 18-JUN-19 NO /u01/app/oracle/oradata/ORCL/
datafile/o1_mf_system_gjncgq81_.dbf
4 1 Incr 3104875 18-JUN-19 NO /u01/app/oracle/oradata/ORCL/
datafile/o1_mf_undotbs1_gjncgqch_.dbf

BS Key Type LV Size Device Type Elapsed Time Completion Time


------- ---- -- ---------- ----------- ------------ ---------------
42 Incr 1 25.00M SBT_TAPE 00:00:01 19-JUN-19
BP Key: 42 Status: AVAILABLE Compressed: NO Tag: TAG20190619T051822
Handle: RMAN_BACKUP_ORCL_1vu4fc0u_1_1 Media: blrv071a091.lss.emc.com:/rman_su
List of Datafiles in backup set 42
File LV Type Ckp SCN Ckp Time Abs Fuz SCN Sparse Name
---- -- ---- ---------- --------- ----------- ------ ----
1 1 Incr 3123880 19-JUN-19 NO /u01/app/oracle/oradata/ORCL/
datafile/o1_mf_system_gjncgq81_.dbf
4 1 Incr 3123880 19-JUN-19 NO /u01/app/oracle/oradata/ORCL/
datafile/o1_mf_undotbs1_gjncgqch_.dbf

BS Key Type LV Size Device Type Elapsed Time Completion Time


------- ---- -- ---------- ----------- ------------ ---------------
48 Incr 1 1.00M SBT_TAPE 00:00:01 19-JUN-19
BP Key: 48 Status: AVAILABLE Compressed: NO Tag: TAG20190619T052357
Handle: RMAN_BACKUP_ORCL_28u4fcbd_1_1 Media: blrv071a091.lss.emc.com:/rman_su
List of Datafiles in backup set 48
File LV Type Ckp SCN Ckp Time Abs Fuz SCN Sparse Name
---- -- ---- ---------- --------- ----------- ------ ----
1 1 Incr 3124118 19-JUN-19 NO /u01/app/oracle/oradata/ORCL/
datafile/o1_mf_system_gjncgq81_.dbf
4 1 Incr 3124118 19-JUN-19 NO /u01/app/oracle/oradata/ORCL/
datafile/o1_mf_undotbs1_gjncgqch_.dbf

Using the correct RMAN script for restore, crosscheck,


and delete operations
You must allocate channels for both the database application agent and Oracle RMAN agent, for the restore, crosscheck, and delete
operations on any unexpired Oracle backups that were previously performed with the database application agent. You can maintain the
database application agent software on the Oracle database server host as long as needed.
For the database application agent operations, you must modify the RMAN scripts to allocate the required channels and include the
correct commands. The latest version of the Database Application Agent Installation and Administration Guide provides details on the
RMAN scripts to use with the database application agent.
For example, the following RMAN commands include the correct SBT_LIBRARY settings for the database application agent:

52 Configuring the Oracle RMAN Agent for Stand-alone Deployment


• On UNIX or Linux:

ALLOCATE CHANNEL DDBEA1 TYPE SBT_TAPE PARMS ‘BLKSIZE=1048576, SBT_LIBRARY=


SBT_LIBRARY=/opt/dpsapps/dbappagent/lib/lib64/libddboostora.so,ENV=(CONFIG_FILE=/orasnb/
oracle_ddbda.cfg)’;

• On Windows:

ALLOCATE CHANNEL DDBEA1 DEVICE TYPE SBT_TAPE PARMS 'SBT_LIBRARY=C:\PROGRA~1\DPSAPPS


\DBAPPAGENT\bin\libddboostora.dll, SBT_PARMS=(CONFIG_FILE=D:\orasnb\oracle_ddbda.cfg)'
FORMAT '%d_%U';

To identify whether a backup was performed with the database application agent or Oracle RMAN agent, follow the instructions in
Identifying the types of backups on page 51.
You must use the database application agent in the RMAN crosscheck and delete scripts to delete the database application agent backups
when they become expired according to the RMAN retention policy.
NOTE: Use the database application agent software for the recover, crosscheck, and delete operations until all the
database application agent backups have expired.
The following sample RMAN script restores a database after allocating the required channels for both the Oracle RMAN agent and
database application agent:

connect target *
RUN {
ALLOCATE CHANNEL CH1 TYPE 'SBT_TAPE' TRACE 5 PARMS 'BLKSIZE=1048576, SBT_LIBRARY=libddobk.so,
ENV=(STORAGE_UNIT=rman_su, BACKUP_HOST=blrv071a091.lss.emc.com, RMAN_AGENT_HOME=/opt/dpsapps/
rmanagent/)';
ALLOCATE CHANNEL DDBEA1 TYPE SBT_TAPE PARMS ‘BLKSIZE=1048576, SBT_LIBRARY= SBT_LIBRARY=/opt/
dpsapps/dbappagent/lib/lib64/libddboostora.so,ENV=(CONFIG_FILE=/orasnb/oracle_ddbda.cfg)’
RESTORE DATABASE;
RECOVER DATABASE
RELEASE CHANNEL CH1;
RELEASE CHANNEL DDBEA1;
}

Updating the data movement policy for cloud tier


operations
A DD Cloud Tier policy, also known as a data movement policy, is required for each MTree or storage unit that the Oracle RMAN agent
uses for data movement to the cloud. The database application agent supports an application-based data movement policy while the
Oracle RMAN agent supports an age-based data movement policy.
After you migrate an Oracle configuration from the database application agent to the Oracle RMAN agent, you must update the data
movement policy from an application-based policy to an age-based policy for cloud tiering.
For example, you can run the following command to verify the policy configurations:

data-movement policy show

Mtree Target(Tier/Unit Name) Policy Value


------------------------- ---------------------- ------------- -------
/data/col1/rman Cloud/ecs_1 age-threshold 14 days
/data/col1/exchange Cloud/ecs_1 app-managed enabled
/data/col1/DDBEA_ORACLE Cloud/ecs_1 app-managed enabled
------------------------- ---------------------- ------------- -------
After the data is moved to the cloud, complete the following steps to update the data movement policy from the application-based policy
to the age-based policy.
1. Disable the application-based policy. For example:

data-movement policy set app-managed disabled to-tier cloud cloud-unit ecs_1 mtrees /data/
col1/DDBEA_ORACLE

The data-movement app-managed policy for Mtree(s) "/data/col1/DDBEA_ORACLE" is reset to


"none".

Configuring the Oracle RMAN Agent for Stand-alone Deployment 53


2. Set the age-based policy for the Oracle RMAN agent. For example:

data-movement policy set age-threshold 14 to-tier cloud cloud-unit ecs_1 mtrees /data/col1/
DDBEA_ORACLE

The data-movement age-threshold policy is set to "14" days for the following Mtree(s):
/data/col1/DDBEA_ORACLE
Run the following command again to verify the policy configurations:

data-movement policy show

Mtree Target(Tier/Unit Name) Policy Value


------------------------- ---------------------- ------------- -------
/data/col1/rman Cloud/ecs_1 age-threshold 14 days
/data/col1/exchange Cloud/ecs_1 app-managed enabled
/data/col1/DDBEA_ORACLE Cloud/ecs_1 age-threshold 14 days
------------------------- ---------------------- ------------- -------
Use the correct type of RMAN script for data recall and restore operations as described in Performing the data recall from the cloud
on page 100.

Performing backups of a clustered environment to


Data Domain
The following examples provide the procedures in different lockbox scenarios for Oracle RMAN agent backups and restores with Oracle
RAC nodes in a clustered environment.

Scenario 1 - Lockbox in a shared location


1. Mount an NFS/CIFS path on both of the Oracle RAC nodes to be used for backups and restores.
2. Install the Oracle RMAN agent on the NSF-mounted path.
3. Run the following command to create a shared lockbox that includes the RAC node hostnames in the cluster:

send 'hostnames <hostname-1> <hostname-2> ... <hostname-n>';

4. Back up the database on node 1.


5. Restore the database backup on node 2.

Scenario 2 - Using a lockbox copy


1. Install the Oracle RMAN agent on both of the Oracle RAC nodes separately.
2. Create a lockbox, and add both of the node hostnames to the lockbox on node 1.
3. Copy the lockbox files from node 1 to node 2.
4. Back up the database on node 1.
5. Restore the database backup on node 2.

NOTE: As an alternative, you can back up the database on node 2 and then restore the backup on node 1.

Scenario 3 - Without a shared lockbox


1. Install the Oracle RMAN agent on both of the Oracle RAC nodes separately.
2. Register the lockbox separately on each node, node 1 and node 2.
3. Back up the database on node 1.
4. Restore the database backup on node 2.

54 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Data Domain replication
The Data Domain Replicator provides automated encrypted replication for disaster recovery and multisite backup and archive
consolidation. The Data Domain Replicator software asynchronously replicates only compressed, deduplicated data over a wide area
network (WAN).
You can use one of two methods to replicate the Oracle backups. Oracle RMAN agent does not support the use of both methods
together:
• Managed file replication (MFR)
MFR can be used to create multiple copies of a backup while the backup is running. As each RMAN file is created on the primary Data
Domain system during a backup, network-efficient replication automatically begins to copy the unique and compressed file segments
to the remote Data Domain system. When the RMAN backup to the local Data Domain system as well as replication to the remote
Data Domain system are complete, the RMAN catalog is updated with information about both the local and remote backup copies.
Performing managed file replication (MFR) on page 55 provides details about setting up MFR in the Oracle RMAN agent and
restoring from a backup copy.
• MTree replication
MTree replication can be used to create a copy or copies of a backup independently from the RMAN backup process. You use the
Oracle RMAN agent to create the backup on a primary Data Domain system, and the Data Domain administrator performs the MTree
replication from the primary system to the secondary system. The Oracle RMAN agent does not initiate or monitor the MTree
replication. However, the product can restore from the replicated copy on a secondary Data Domain system. Restoring from MTree
replicated backups on page 57 provides details about the restore process.
The Data Domain Operating System Administration Guide provides more information about the license requirement for Data Domain
Replicator and the compatibility between the source DD OS and destination DD OS. The guide includes detailed steps to perform and
manage the MTree replication.

Performing managed file replication (MFR)


File replication enables you to make multiple copies of an RMAN backup. With the Oracle RMAN agent, you can make two, three, or four
copies of a backup by specifying COPIES <n> in the backup command, where <n> is 2, 3, or 4.
NOTE:

If the Oracle RMAN agent is integrated with PowerProtect, the following self-service replication and cloud tiering
operations are disabled:

• Creation of multiple backup copies with the RMAN BACKUP COPIES command.
• Automatic recall of the backup data during restore, when the backup file is in the cloud tier. The PowerProtect
administrator must explicitly recall the backup copy before it can be restored by the DBA.

The PowerProtect Administration and User Guide provides more details about these limitations.
To perform file replication, use a command similar to the one shown as follows. Edit the script command for your environment, specifying
the Data Domain system that is the destination system for the file replication. Specifying COPIES <n> requires an installed Replicator
license on both the source and destination Data Domain systems. Performing a backup by specifying COPIES <n> requires Oracle
Enterprise Edition.
For example, specifying COPIES 2 instructs the Oracle RMAN agent to perform managed file replication (MFR) to the second Data
Domain system. The second Data Domain system name is specified as part of the file name of the second copy, as <destination-system>
in the following command.
The two file names specified in this command must be identical except for the inclusion of <destination-system> in the second name. The
Oracle RMAN agent requires that the file names of the two copies are identical. The underscore character (_) is also required. Omitting
the underscore in the file names results in an error, and the backup fails. Any changes made to the file name formats shown must meet
both of the following requirements:
• The file name formats include the underscore character.
• The file names are identical, except for <destination-system> in the name for the second copy.
The use of Oracle formats such as %U and %c is not supported, as these Oracle formats include the copy number in the generated file
name. As a result, the file name generated for the second copy is different from the file name generated for the first copy.

backup copies 2 database filesperset=1 format '%u_%p', '<destination-system>/%u_%p';

Configuring the Oracle RMAN Agent for Stand-alone Deployment 55


NOTE: Use the lowercase u in '%u_%p'. An uppercase U, while a valid Oracle format, is invalid for the Oracle RMAN
agent and causes the replication to fail.
To use COPIES 2, the value of BACKUP_TAPE_IO_SLAVES must be TRUE, which you can configure as follows:

SQL> show parameter backup_tape

NAME TYPE VALUE


------------------------------------ ----------- ------------------------------
backup_tape_io_slaves boolean FALSE
SQL>

SQL> alter system set backup_tape_io_slaves = true scope=spfile;

System altered.

bounce the oracle instance( shutdown and startup) the database

SQL> show parameter backup_tape

NAME TYPE VALUE


------------------------------------ ----------- ------------------------------
backup_tape_io_slaves boolean TRUE
SQL>
The only difference from performing a second backup to a different BACKUP_HOST is that the data flow for managed file replication is
between the two Data Domain systems. A typical backup sends data between the backup server and a Data Domain system.
To make three or four copies, use a backup command with COPIES 3 or COPIES 4 instead of COPIES 2. The format of the backup
command is as follows:

backup copies <n> database filesperset=1 format '%u_%p', '<destination-system2>/%u_%p',


'<destination-system3>/%u_%p', '<destination-system4>/%u_%p'

Specifying two, three, or four copies creates the additional copies on the second, third, and fourth destination systems, respectively. All
the formats must be identical except for the initial Data Domain system name so that all the file copies are created with the same file
names. Each Data Domain system specified must have a storage unit with the name specified by the STORAGE_UNIT value.
File replication must be performed to a destination storage unit with the same name as the source storage unit. The target Data Domain
systems must have a storage unit that has the same name as the storage unit on the source Data Domain system containing the file being
replicated. The file is replicated to the identically named storage unit on the destination Data Domain systems.
File replication using RMAN requires that both the source Data Domain system and the destination Data Domain systems are connected
to, and accessible from, the RMAN system that performs the backups. The network configuration must enable backups to the source
Data Domain system and to all the destination Data Domain systems. The destination systems must all be accessible from the source
system. When more than two copies are made, the destination systems do not need to be accessible to each other, only to the source
system. Replication does not succeed in configurations where the destination Data Domain system is only connected to the source Data
Domain system through a private network or link.
The following example shows the output of the RMAN list command, which displays the destination and the storage unit associated
with COPIES 2.

RMAN> list backupset 52;

List of Backup Sets


===================

BS Key Type LV Size


------- ---- -- ----------
52 Full 1.62G
List of Datafiles in backup set 52
File LV Type Ckp SCN Ckp Time Name
---- -- ---- ---------- --------- ----
1 Full 4614599 09-MAY-12 /u02/app/oracle/oradata/Demo/system01.dbf
2 Full 4614599 09-MAY-12 /u02/app/oracle/oradata/Demo/sysaux01.dbf
3 Full 4614599 09-MAY-12 /u02/app/oracle/oradata/Demo/undotbs01.dbf
4 Full 4614599 09-MAY-12 /u02/app/oracle/oradata/Demo/users01.dbf
5 Full 4614599 09-MAY-12 /u02/app/oracle/oradata/Demo/example01.dbf

56 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Backup Set Copy #2 of backup set 52
Device Type Elapsed Time Completion Time Compressed Tag
----------- ------------ --------------- ---------- ---
SBT_TAPE 00:00:34 09-MAY-12 NO TAG20120509T101338

List of Backup Pieces for backup set 52 Copy #2


BP Key Pc# Status Media Piece Name
------- --- ----------- ----------------------- ----------
78 1 AVAILABLE Demo dd670-ostqa06.datadomain.com/20nahpei_1

Backup Set Copy #1 of backup set 52


Device Type Elapsed Time Completion Time Compressed Tag
----------- ------------ --------------- ---------- ---
SBT_TAPE 00:00:34 09-MAY-12 NO TAG20120509T101338

List of Backup Pieces for backup set 52 Copy #1


BP Key Pc# Status Media Piece Name
------- --- ----------- ----------------------- ----------
77 1 AVAILABLE Demo 20nahpei_1

RMAN>

Restoring from multiple backup copies


If there are multiple copies of a backup that are generated through MFR, you can perform a restore from any Data Domain system that
contains a copy of the backup. Typically, you perform a restore from the source (local) Data Domain system. In this case, specify this Data
Domain system as the backup host in the restore command.
If this source Data Domain system is unavailable for any reason, you can restore the backup from any of the other available Data Domain
systems. To do this, determine which Data Domain systems are accessible over the network. If COPIES 2 was used, there is only one
other system that can perform the restore, so it must be available. If COPIES 3 or COPIES 4 was used, any currently available system
can perform the restore. If more than one system with the required backup is available, select a system based on the following factors:
• Available bandwidth
• Speed of the connection
• Other performance or logistical considerations
Specify the preferred system as the backup host in the restore command.
In some cases, it is possible that a backup file is unavailable on the specified backup host. In such a case, if another available Data Domain
system has a copy of the backup, RMAN tries to retrieve the file from the other system. This retrieval attempt occurs although this
system was not specified as the backup host.
For example, three copies of a backup were made to ddr-host-1, ddr-host-2, and ddr-host-3. When a restore is required, ddr-host-1 is
down, but both ddr-host-2 and ddr-host-3 are available. If you specify ddr-host-2 as the backup host in the restore command, RMAN
retrieves the backup files from ddr-host-2. If a file cannot be found on ddr-host-2, RMAN tries to retrieve the file from ddr-host-3. If that
retrieval does not succeed, the restore fails.
If you select ddr-host-3 as the backup host, RMAN tries to restore the backup files from ddr-host-3. If a file cannot be found on ddr-
host-3, RMAN tries to retrieve the file from ddr-host-2.
NOTE: If ddr-host-2 is down but ddr-host-1 and ddr-host-3 are available, specifying ddr-host-3 as the backup host
causes the restore to be performed from ddr-host-3. However, if a file is not found on ddr-host-3, RMAN does not try
to find the missing file on ddr-host-1.
The system specified as the backup host must always be available. If the system specified as the backup host is unavailable, the restore
always fails, even if the backup is available from other copies.

Restoring from MTree replicated backups


To enable the restore of an MTree replicated backup, you must register the secondary Data Domain system in the lockbox. Use an RMAN
command as shown in the following example, and edit the command for the environment.
NOTE: The registration of the secondary Data Domain system is required only once. Do not include the registration
command in each restore script. Perform this registration before you perform any restores from the secondary Data
Domain system.
RUN {
ALLOCATE CHANNEL C1 TYPE 'SBT_TAPE' TRACE 5 PARMS 'BLKSIZE=1048576,
SBT_LIBRARY=/home/oracle1/rman_agent_home/lib/libddobk.so,

Configuring the Oracle RMAN Agent for Stand-alone Deployment 57


ENV=(BACKUP_HOST=bu-ddbealin-17.lss.emc.com,
RMAN_AGENT_HOME=/home/oracle1/rman_agent_home)';
send 'set username q_ost password 1X3quest servername
bu-ddbealin-17.lss.emc.com storageunit rman_su';
RELEASE CHANNEL C1;
}
Ensure that you specify the correct values in the RMAN send command for the registration:
• The username value is the DD Boost username on the secondary Data Domain system. The username is case-sensitive, and must
match exactly the value that is set on the secondary Data Domain system.
• The password value is the password that you set for the username. The password is case-sensitive, and must match exactly the
value that is set on the secondary Data Domain system.
• The servername value is the case-sensitive name of the secondary Data Domain system. Specify the same form of the name in this
command as in the RMAN restore script, shown as follows. For example, if you use server1.domain.com in the RMAN restore script,
you must also use server1.domain.com in the send command. Do not use SERVER1.domain.com or server1.
You can specify an IP address if the same IP address is used in the RMAN restore script. You can register multiple forms of the server
name. For example, you can register both server1 and server1.domain.com, and use either of these names in the RMAN restore script.
• The storageunit value is the destination storage unit of the MTree replication on the secondary Data Domain system. The value is
case-sensitive, and must match exactly the value that is set on the secondary Data Domain system.
After the registration is complete, you can perform restores from the secondary Data Domain system. Use an RMAN restore script as
shown in the following example, and edit the command for the environment:
RUN {
ALLOCATE CHANNEL C1 TYPE 'SBT_TAPE' TRACE 5 PARMS 'BLKSIZE=1048576,
SBT_LIBRARY=/home/oracle1/rman_agent_home/lib/libddobk.so,
ENV=(STORAGE_UNIT=rman_su, BACKUP_HOST=bu-ddbealin-17.lss.emc.com,
RMAN_AGENT_HOME=/home/oracle1/rman_agent_home)';
restore database;
RELEASE CHANNEL C1;
}
Ensure that you specify the correct values in the RMAN restore script:
• The STORAGE_UNIT value is the destination storage unit of the MTree replication on the secondary Data Domain system. The value is
case-sensitive, and must match exactly the value that is set on the secondary Data Domain system.
• The BACKUP_HOST value is the case-sensitive name of the secondary Data Domain system. Specify the same form of the name in
this script as in the RMAN registration command. For example, if you use server1.domain.com in the RMAN registration command, you
must also use server1.domain.com in the restore script. Do not use SERVER1.domain.com or server1.
You can specify an IP address if the same IP address is used in the RMAN registration command.
NOTE: For MTree replication, the destination storage unit name on the secondary Data Domain system can be the same
as or different than the source storage unit name on the source Data Domain system.

Specifying subdirectories for Oracle RMAN agent


backups
You can specify one or more subdirectories in the pathname that Oracle RMAN agent uses as the location to store the backup pieces
created during a backup. You must specify the subdirectories in the FORMAT specification in the RMAN backup script. If the specified
subdirectories do not yet exist when the backup starts, the Oracle RMAN agent automatically creates the subdirectories during the
backup to the Data Domain system.
NOTE: When you perform a restore, crosscheck, or delete operation, you do not need to specify any subdirectories in
the RMAN script. The pathname is recorded as part of the backup piece name in the Oracle catalog. When you perform
the operation, Oracle provides the required pathname to the Oracle RMAN agent.
You must use the correct subdirectory naming in the FORMAT specification, depending on whether the backup is performed to a local or
remote Data Domain system:
• For a backup to a local system, use the following types of FORMAT specification:
○ When the pathname includes a single subdirectory:

FORMAT './<directory-name>/%u_%p';

58 Configuring the Oracle RMAN Agent for Stand-alone Deployment


○ When the pathname includes multiple subdirectories:

FORMAT './<directory-name-1>/<directory-name-2>/.../<directory-name-n>/%u_%p';

• For a backup to a remote system, use the following types of FORMAT specification:
○ When the pathname includes a single subdirectory:

FORMAT './<directory-name>/%u_%p', '<destination-system>/./<directory-name>/%u_%p';

○ When the pathname includes multiple subdirectories:

FORMAT './<directory-name-1>/<directory-name-2>/.../<directory-name-n>/%u_%p',
'<destination-system>/./<directory-name-1>/<directory-name-2>/.../<directory-name-n>/%u_
%p';

NOTE: When you specify any subdirectories in a single BACKUP command that is used for a database plus archive log
backup, you must use the FORMAT specification twice: once for the database backup pieces and once for the archive
log backup pieces. The following RMAN script examples include a database plus archive log backup.
The following examples provide sample RMAN scripts with the correct subdirectory naming in the FORMAT specification for local and
remote backups.
Specifying a single subdirectory in the FORMAT specification for a local backup
The following sample RMAN script for a local backup includes a FORMAT specification with a single subdirectory in the backup pathname:
RUN {
ALLOCATE CHANNEL CH1 TYPE 'SBT_TAPE' TRACE 5 PARMS
'BLKSIZE=1048576,
SBT_LIBRARY=/home/oracle1/rman_agent_home/lib/libddobk.so,
ENV=(STORAGE_UNIT=rman_cloud,
BACKUP_HOST=bu-ddbea-lin-16.lss.emc.com,
RMAN_AGENT_HOME=/home/oracle1/rman_agent_home)';
BACKUP DATABASE FORMAT './testdir/%u_%p';
RELEASE CHANNEL CH1;
}
Specifying a subdirectory in the FORMAT specification for a local backup of database plus archive log
The following sample RMAN script for a local backup includes a FORMAT specification with a single subdirectory in the backup pathname.
Because the BACKUP command includes both the database and archivelog options, you must specify the FORMAT twice in this
case:
RUN {
ALLOCATE CHANNEL CH1 TYPE 'SBT_TAPE' TRACE 5 PARMS
'BLKSIZE=1048576,
SBT_LIBRARY=/home/oracle1/rman_agent_home/lib/libddobk.so,
ENV=(STORAGE_UNIT=rman_cloud,
BACKUP_HOST=bu-ddbea-lin-16.lss.emc.com,
RMAN_AGENT_HOME=/home/oracle1/rman_agent_home)';
BACKUP FORMAT './testdir/%u_%p' DATABASE PLUS ARCHIVELOG DELETE INPUT FORMAT './testdir/%u_%p';
RELEASE CHANNEL CH1;
}
Specifying multiple subdirectories in the FORMAT specification for a local backup
The following sample RMAN script for a local backup includes a FORMAT specification with multiple subdirectories in the backup
pathname:
RUN {
ALLOCATE CHANNEL CH1 TYPE 'SBT_TAPE' TRACE 5 PARMS
'BLKSIZE=1048576,
SBT_LIBRARY=/home/oracle1/rman_agent_home/lib/libddobk.so,
ENV=(STORAGE_UNIT=rman_cloud,
BACKUP_HOST=bu-ddbea-lin-16.lss.emc.com,
RMAN_AGENT_HOME=/home/oracle1/rman_agent_home)';
BACKUP TABLESPACE PSAPCERUSR FORMAT './testdir1/testdir2/.../testdir<n>/%u_%p';
RELEASE CHANNEL CH1;
}

Configuring the Oracle RMAN Agent for Stand-alone Deployment 59


Specifying a single subdirectory in the FORMAT specification for a remote backup
The following sample RMAN script for a backup to a remote Data Domain system includes a FORMAT specification with a single
subdirectory in the backup pathname. The two file names specified in the BACKUP COPIES 2 command must be identical except for the
inclusion of <destination-system> in the second name. The underscore character (_) is also required:
RUN {
ALLOCATE CHANNEL CH1 TYPE 'SBT_TAPE' TRACE 5 PARMS
'BLKSIZE=1048576,
SBT_LIBRARY=/home/oracle1/rman_agent_home/lib/libddobk.so,
ENV=(STORAGE_UNIT=rman_cloud,
BACKUP_HOST=bu-ddbea-lin-16.lss.emc.com,
RMAN_AGENT_HOME=/home/oracle1/rman_agent_home)';
BACKUP COPIES 2 DATABASE FORMAT './testdir1/%u_%p', '<destination-system>/./testdir1/%u_%p';
RELEASE CHANNEL CH1;
}
Specifying multiple subdirectories in the FORMAT specification for a remote backup
The following sample RMAN script for a backup to a remote Data Domain system includes a FORMAT specification with multiple
subdirectories in the backup pathname. The two file names specified in the BACKUP COPIES 2 command must be identical except for
the inclusion of <destination-system> in the second name. The underscore character (_) is also required:
RUN {
ALLOCATE CHANNEL CH1 TYPE 'SBT_TAPE' TRACE 5 PARMS
'BLKSIZE=1048576,
SBT_LIBRARY=/home/oracle1/rman_agent_home/lib/libddobk.so,
ENV=(STORAGE_UNIT=rman_cloud,
BACKUP_HOST=bu-ddbea-lin-16.lss.emc.com,
RMAN_AGENT_HOME=/home/oracle1/rman_agent_home)';
BACKUP COPIES 2 DATABASE FORMAT './testdir1/testdir2/.../testdir<n>/%u_%p', '<destination-
system>/./testdir1/testdir2/.../testdir<n>/%u_%p';
RELEASE CHANNEL CH1;
}

Performing backups and restores of Oracle CDBs


and PDBs
Oracle 12c introduced support for a multitenant database that allows a single container database (CDB) to include multiple user-created
pluggable databases (PDBs). You can perform backups and restores of a whole CDB or individual PDBs. No additional configuration steps
are needed in the Oracle RMAN agent to support the environment.
It is recommended that you perform regular backups of the whole CDB to ensure that all PDBs and archived logs are backed up. You can
recover the whole CDB or individual PDBs to any point-in-time from a CDB backup. The Oracle documentation provides details.

Performing DD Boost compressed restores


Oracle RMAN agent 4.5 introduced support of DD Boost compressed restores. A compressed restore uses less bandwidth by restoring
the backed-up data in a compressed form from the Data Domain system to the application host.
A compressed restore can be beneficial in a constrained bandwidth environment or a cloud environment, but can impact the restore
performance due to the usage of compression resources on the Data Domain system and application host. By default, the compression of
restores is disabled.
Configure a compressed restore of an Oracle RMAN agent backup by setting the DDBOOST_COMPRESSED_RESTORE parameter to the
value TRUE in the SBT_PARMS or ENV section of the RMAN restore script.
For example, the following RMAN restore script includes the parameter setting:
RUN {
ALLOCATE CHANNEL CH1 TYPE 'SBT_TAPE' TRACE 5 PARMS
'BLKSIZE=1048576,
SBT_LIBRARY=C:\Users\Administrator\AppData\Local\RMANAgent\bin\libDDobk.dll,
ENV=(STORAGE_UNIT=ddbea,
BACKUP_HOST=bu-dbe4500.lss.emc.com,
RMAN_AGENT_HOME=C:\Users\Administrator\AppData\Local\RMANAgent,
DDBOOST_COMPRESSED_RESTORE=TRUE)';
RESTORE DATABASE;
RECOVER DATABASE;

60 Configuring the Oracle RMAN Agent for Stand-alone Deployment


RELEASE CHANNEL CH1;
}
NOTE:

When the DDBOOST_COMPRESSED_RESTORE parameter is not set to TRUE, the Oracle RMAN agent performs an
uncompressed restore of the backed-up data from the Data Domain system.

Display and deletion of backups


When the Oracle catalog records are removed for some backups that were performed with the Oracle RMAN agent but the backups still
remain on the Data Domain system, those backups become orphaned backups. You can delete such orphaned backups with the ddutil
program that is installed with the Oracle RMAN agent software.
NOTE:

The ddutil program deletes backup files on the Data Domain system but does not delete any information on the
database server. Backups are normally deleted by using the RMAN DELETE command, which deletes both the backup on
the Data Domain system and the corresponding RMAN catalog record.

The ddutil program user must have permissions to the lockbox as described in Registering each Data Domain system
on page 45. The program uses the DD Boost library for operations, and does not require you to mount the storage unit.
The ddutil program is installed in the bin directory, created by the Oracle RMAN agent installer. The program performs deletions of
individual backup files or groups of backup files, as specified.
You can perform any of the following operations, based on the ddutil command and options that you specify on the command line:
• Display information about backup files at the individual file level, directory level, or storage unit level.
• Delete the backup files at the individual file level or directory level.
• Prune (delete) backup files that were created or modified during a specified time interval.
You must run the ddutil command on the command line with the required options. The -z <hostname>:<storage_unit> option is the
only mandatory option, and specifies the credentials that the Oracle RMAN agent requires for lockbox access during the display, delete,
and prune operations.
NOTE: You must run the ddutil command from the original installation location or set the RMAN_AGENT_HOME
environment variable to enable the dependent libraries and lockbox to be found.
The following topics provide details about how to use the ddutil command and options to perform the display, delete, and prune
operations.

Using the ddutil command to display and delete backups


An Oracle DBA user can run the ddutil command with the appropriate options to perform the following operations:
• Display information about the installed version of the Oracle RMAN agent:

ddutil -i

For example:

ddutil -i
RMAN Agent Version: 19.4.0.0(21)

• Display information about the specified backup files and directories:

ddutil [-f] -z <hostname>:<storage_unit> [-F {asc|desc} | -T {asc|desc}] [-b <start_time>]


[-e <end_time>] [-R] [-t] [-D <debug_level>] [<pathname1> [<pathname2>]...[<pathname><n>]]

NOTE: The default operation of the ddutil command is the display of backup information. If you run the ddutil
command with no options other than the mandatory -z option, the command displays all the backup files that are
located directly under the storage unit.
Using the ddutil command to display backup information on page 64 provides details.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 61


• Delete the specified backup files and directories:

ddutil -d -z <hostname>:<storage_unit> [-c] [-x] [-D <debug_level>] [<pathname1>


[<pathname2>]...[<pathname><n>]]

Using the ddutil command to delete backups on page 66 provides details.


• Prune (delete) the backup files and directories within a save time range:

ddutil -k -z <hostname>:<storage_unit> [-b <start_time>] [-e <end_time>] [-c] [-R] [-x] [-


D <debug_level>] [<pathname1> [<pathname2>]...[<pathname><n>]]

Using the ddutil command to prune backups based on age on page 66 provides details.
Options enclosed in brackets ([ ]) are optional. The following table describes the ddutil command options.

Table 8. The ddutil command options for backup display and deletion
Option Description
-b <start_time> Optional. Specifies the start of a time range, in a date and time format. Date and time format
used with the ddutil command options on page 64 provides details about the supported date
and time formats for <start_time>.

Without this option, the earliest backup time is used by default for the start of the time range.

NOTE: The operation terminates with an error if the <start_time> value is later
than the <end_time> value that is specified with the -e option.

-c Optional. Specifies to suppress prompting during a delete or prune operation. With this option,
the program proceeds to delete or prune the specified backup files without issuing any user
prompts.
-d Required for a delete operation. Specifies to delete the specified backup files and directories
from the Data Domain system.

-D <debug_level> Optional. Generates debugging information during the operation, where <debug_level> is an
integer from 0 to 9. This option is used to troubleshoot operational issues.

This option causes the ddutil command to print the debugging information to stderr and to
the operational log file. The higher the integer value, the more log information is produced. The
operational log file also contains the normal operational messages that are printed to stdout.

The operational log file, ddutil_<timestamp>.log, resides in the log subdirectory of the
installation location. For example, the operational log file name has the format ddutil_Wed
May 17 21:49:08 2017.log.

-e <end_time> Optional. Specifies the end of a time range, in a date and time format. Date and time format
used with the ddutil command options on page 64 provides details about the supported date
and time formats for <end_time>.

The option setting -e now specifies the current time, which is the default time value.

NOTE: The operation terminates with an error if the <end_time> value is earlier
than the <start_time> value that is specified with the -b option.

-f Optional. Specifies to display information about the specified backup files and directories that
were created or modified within the specified time range on the Data Domain system. This
display operation is the default operation of the ddutil command.

-F {asc|desc} Optional. Specifies to list the backup files in either ascending or descending alphabetical order:
• The -F asc option displays the files in ascending alphabetical order, based on the file
pathnames.
• The -F desc option displays the files in descending alphabetical order, based on the file
pathnames.

62 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Table 8. The ddutil command options for backup display and deletion (continued)
Option Description

You must specify the -f and -z options with the -F asc or -F desc option. You can
optionally specify the -b, -e, -R, -t, and <pathname><n> options with the -F asc or -F
desc option.

NOTE: The -F and -T options are mutually exclusive. You can use either option
but not both in the same ddutil command.

-k Required for a prune operation. Specifies to prune (delete) the specified backup files that were
created or modified within the specified time range on the Data Domain system.
-R Optional. Specifies to perform the operation on the backup files in every subdirectory.
-t Optional. Specifies to include the cloud tier information in the backup file and directory
information that a display operation produces.
-T {asc|desc} Optional. Specifies to list the backup files in either ascending or descending time order:
• The -T asc option displays the files in ascending time order, from the oldest backup to
the newest backup.
• The -T desc option displays the files in descending time order, from the newest backup
to the oldest backup.

You must specify the -f and -z options with the -T asc or -T desc option. You can
optionally specify the -b, -e, -R, -t, and <pathname><n> options with the -T asc or -T
desc option.

NOTE: The -T and -F options are mutually exclusive. You can use either option
but not both in the same ddutil command.

-x Optional. Specifies to delete all the empty directories during a delete or prune operation.

-z <hostname>:<storage_unit> Mandatory. Specifies the hostname of the Data Domain system, followed by a colon, a forward
slash (/), and the storage unit name. For example:

-z dd_host1:/dd_storage_unit1

NOTE: The hostname can be a DFC server name if you must run the ddutil
command over Fibre Channel.

<pathname1> Optional. Specifies the pathnames of the files or directories for display or deletion. For each
<pathname2>...<pathname><n> specified directory, the operation is performed on all the files in the directory. When -R is
included, the operation processes all the subdirectories of each directory. Without -R, the
operation does not process any subdirectories.

The following guidelines apply to the pathnames in a ddutil command:

• The pathnames must be the last options on the command line. No other types of options,
such as -R or -c, can appear after the pathnames.
• When no pathnames are specified, the operation occurs only at the level of the storage
unit root directory.
• When a pathname starts with a forward slash (/), the storage unit name must appear after
the slash.
• When a pathname does not start with a slash (/), the pathname is assumed to be located
directly under the storage unit.
For example, when the storage unit is named su1, the pathnames /su1/dir1 and dir1
both specify the directory dir1 under the storage unit.

The wildcard character * is supported in pathnames, and represents any number of


unspecified characters.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 63


Date and time format used with the ddutil command options
You can use specific date and time formats with the options -b <start_time> and -e <end_time> in the ddutil command. The
following date and time formats are valid:
• Time of day—A time of day is in the form hh[:mm[:ss]] (or hhmm) [meridian] [zone]. If you do not specify a meridian (am or pm), a
24-hour clock is used. You can specify a time of day as just hh followed by a meridian. If you do not specify a timezone (for example,
GMT), then the current timezone is used, as determined by the second parameter, now.
• Date—A date is a specific month and day, and possibly a year. The acceptable formats are mm/dd[/yy] and month_name dd[, yy]. If
omitted, the year defaults to the current year. If you specify a year as a number in the range 70 and 99, 1900 is added. If a year is in
the range 00 and 30, 2000 is added. The treatment of other years less than 100 is undefined. If a number is not followed by a day or
relative time unit, the number is interpreted as a year if a time_of_day, month_name, and dd have already been specified; otherwise, it
will be treated as a time_of_day.
• Day—A day of the week can be specified. The current day is used if appropriate. A day can be preceded by a number, indicating which
instance of that day is preferred; the default is 1. Negative numbers indicate times past. Some symbolic numbers are accepted: last,
next, and the ordinals first through twelfth (second is ambiguous, and is not accepted as an ordinal number). The symbolic number
next is equivalent to 2; thus, next monday does not refer to the coming Monday, but refers to the one a week later.
• relative time—Specifications relative to the current time can be used. The format is [number] unit. Acceptable units are decade, year,
quarter, month, fortnight, week, day, hour, minute, and second.
Most common abbreviations for days, months, and so on are acceptable, including an uppercase or lowercase first letter and three-letter
abbreviations, with or without a trailing period. Units, such as weeks, can be specified as singular or plural. Timezone and meridian values
can be uppercase or lowercase, with or without periods.
The actual date is formed as follows. First, any absolute date and/or time is processed and converted. Using that time as the base, day-of-
week specifications are added. Last, relative specifications are used. If a date or day is specified, and no absolute or relative time is given,
midnight is used. Finally, a correction is applied so that the correct hour of the day is produced after allowing for daylight savings time
differences.

Using the ddutil command to display backup information


You can run the following ddutil command to display information about the backup files and directories:

ddutil [-f] -z <hostname>:<storage_unit> [-F {asc|desc} | -T {asc|desc}] [-b <start_time>] [-


e <end_time>] [-R] [-t] [-D <debug_level>] [<pathname1> [<pathname2>]...[<pathname><n>]]

Table 8. The ddutil command options for backup display and deletion on page 62 provides details about the command options.
Typically, you run this operation to prepare for a delete or prune operation with the ddutil command. You can compare the displayed
backup information with details in the database backup catalog and determine which backup files to delete or prune.
The ddutil -f <options> command output includes one row for each backup file and directory that was found, where the row
contains the file or directory name and the backup size and time.
The default operation of the ddutil command is the display of backup information. If you run the command with no pathnames and no
options other than the -z option, the command displays all the backup files that are located directly under the storage unit. The following
commands display the same output:

ddutil -z <hostname>:<storage_unit>
ddutil -f -z <hostname>:<storage_unit>

The ddutil command ignores all subdirectories unless you specify the -R option. For example, the following command displays all the
backup files and directories on the storage unit su1, including the files in all the subdirectories:

ddutil -f -z host1:/su1 -R

Type Perm Size Time Path


---------------------------------------------------------------------------------
dir 777 489 Wed May 3 12:15:12 2017 (1493828112) /su1
file 644 682098688 Wed May 3 12:12:47 2017 (1493827967) /su1/6rs3aer4_1
file 644 3181641728 Wed May 3 12:14:35 2017 (1493828075) /su1/6ts3aet5_1_1
file 644 775946240 Wed May 3 12:14:53 2017 (1493828093) /su1/6us3aev7_1_1
file 644 690225152 Wed May 3 12:15:07 2017 (1493828107) /su1/6vs3aevm_1_1
file 644 18350080 Wed May 3 12:12:56 2017 (1493827976) /su1/c-4088691966-20170503-00
file 644 18350080 Wed May 3 12:15:12 2017 (1493828112) /su1/c-4088691966-20170503-01

64 Configuring the Oracle RMAN Agent for Stand-alone Deployment


To display the backup files in specific directories, include the directory pathnames on the command line. For example, the following
command displays the backup files in the directories /su1/dir1 and /su1/dir2:

ddutil -f -z host1:/su1 dir1 dir2

To display the backup files that were created after March 1, use the -b Mar 1 option. For example:

ddutil -f -z host1:/su1 -b Mar 1 -R

To display the backup files in ascending alphabetical order according to the file pathnames, use the -F asc option. For example, the
following command displays the backup files in the /xapprman storage unit in ascending alphabetical order:

ddutil -f -F asc -z blrv033a154.lss.emc.com:/xapprman

Type Perm Size Time Path


-----------------------------------------------------------------------------------------
dir 777 1118 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman
file 644 1213988864 Mon Feb 18 16:27:42 2019 (1550487462) /xapprman/02tq68jn_1_1
file 644 601620480 Mon Feb 18 16:27:55 2019 (1550487475) /xapprman/03tq68kh_1_1
dir 744 101 Tue Feb 12 14:36:43 2019 (1549962403) /xapprman/ABC
file 644 11534336 Mon Feb 25 15:52:20 2019 (1551090140) /xapprman/
c-1944822367-20190225-01
dir 744 219 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman/ecdm
dir 744 489 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman/shrads
dir 755 101 Thu Nov 22 16:35:00 2018 (1542884700) /xapprman/xyz
To display the backup files in descending alphabetical order according to the file pathnames, use the -F desc option. For example, the
following command displays the backup files in the /xapprman storage unit in descending alphabetical order:

ddutil -f -F desc -z blrv033a154.lss.emc.com:/xapprman

Type Perm Size Time Path


-----------------------------------------------------------------------------------------
dir 755 101 Thu Nov 22 16:35:00 2018 (1542884700) /xapprman/xyz
dir 744 489 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman/shrads
dir 744 219 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman/ecdm
file 644 11534336 Mon Feb 25 15:52:20 2019 (1551090140) /xapprman/
c-1944822367-20190225-01
dir 744 101 Tue Feb 12 14:36:43 2019 (1549962403) /xapprman/ABC
file 644 601620480 Mon Feb 18 16:27:55 2019 (1550487475) /xapprman/03tq68kh_1_1
file 644 1213988864 Mon Feb 18 16:27:42 2019 (1550487462) /xapprman/02tq68jn_1_1
dir 777 1118 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman
To display the backup files in ascending time order, use the -T asc option. For example, the following command displays the backup files
in the /xapprman storage unit in ascending time order, from the oldest backup to the newest backup:

ddutil -f -T asc -z blrv033a154.lss.emc.com:/xapprman

Type Perm Size Time Path


-----------------------------------------------------------------------------------------
dir 755 101 Thu Nov 22 16:35:00 2018 (1542884700) /xapprman/xyz
dir 744 101 Tue Feb 12 14:36:43 2019 (1549962403) /xapprman/ABC
file 644 1213988864 Mon Feb 18 16:27:42 2019 (1550487462) /xapprman/02tq68jn_1_1
file 644 601620480 Mon Feb 18 16:27:55 2019 (1550487475) /xapprman/03tq68kh_1_1
file 644 11534336 Mon Feb 25 15:52:20 2019 (1551090140) /xapprman/
c-1944822367-20190225-01
dir 777 1118 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman
dir 744 219 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman/ecdm
dir 744 489 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman/shrads
To display the backup files in descending time order, use the -T desc option. For example, the following command displays the backup
files in the /xapprman storage unit in descending time order, from the newest backup ot the oldest backup:

ddutil -f -T desc -z blrv033a154.lss.emc.com:/xapprman

Type Perm Size Time Path


-----------------------------------------------------------------------------------------
dir 777 1118 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman
dir 744 219 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman/ecdm
dir 744 489 Mon Feb 25 15:52:51 2019 (1551090171) /xapprman/shrads

Configuring the Oracle RMAN Agent for Stand-alone Deployment 65


file 644 11534336 Mon Feb 25 15:52:20 2019 (1551090140) /xapprman/
c-1944822367-20190225-01
file 644 601620480 Mon Feb 18 16:27:55 2019 (1550487475) /xapprman/03tq68kh_1_1
file 644 1213988864 Mon Feb 18 16:27:42 2019 (1550487462) /xapprman/02tq68jn_1_1
dir 744 101 Tue Feb 12 14:36:43 2019 (1549962403) /xapprman/ABC
dir 755 101 Thu Nov 22 16:35:00 2018 (1542884700) /xapprman/xyz

Using the ddutil command to delete backups


You can run the following ddutil command to delete the specified backup files and directories:

ddutil -d -z <hostname>:<storage_unit> [-c] [-x] [-D <debug_level>] [<pathname1>


[<pathname2>]...[<pathname><n>]]

Table 8. The ddutil command options for backup display and deletion on page 62 provides details about the command options.
The -d option specifies to delete from the Data Domain system any backup files and directories that are specified on the command line.
When you specify a directory, the command also deletes any subdirectories in that directory.
By default, the ddutil -d <options> command prompts you before deleting any files or directories. The -c option specifies to
perform the deletions without prompting.
When the -x option is specified, the ddutil command also deletes any empty directories that it finds. Without the -x option, the
directories are not deleted.
CAUTION: Use the ddutil -d <options> command with caution. The deletion of backup files and directories cannot
be undone.
To delete specific backup files, run the following command:

ddutil -d -z <hostame>:/<storage_unit> <file_pathname1> <file_pathname2> ...

To delete specific backup directories, run the following command:

ddutil -d -x -z <hostame>:/<storage_unit> <directory_pathname1> <directory_pathname2> ...

To delete both backup files and directories, run the following command:

ddutil -d -x -z <hostame>:/<storage_unit> <file_pathname1> <file_pathname2> ...


<directory_pathname1> <directory_pathname2> ...

Using the ddutil command to prune backups based on age


Run the following ddutil command to prune (delete) the backup files in the specified pathnames that were created (or later modified)
during the time range specified by the -b and -e options:

ddutil -k -z <hostname>:<storage_unit> [-b <start_time>] [-e <end_time>] [-c] [-R] [-x] [-D
<debug_level>] [<pathname1> [<pathname2>]...[<pathname><n>]]

Table 8. The ddutil command options for backup display and deletion on page 62 provides details about the command options.
The -k option specifies to delete from the Data Domain system the backup files based on their age:
• If a specified pathname is a file, the file is deleted if it meets the time criteria.
• If a specified pathname is a directory, all the files in the directory are deleted if they meet the time criteria.
• If the -b and -e options are omitted, the files in the specified pathnames are deleted, without considering a time range.
CAUTION:

Use the ddutil -k <options> command with caution. After you delete certain backup files, you might be unable to
restore data from a backup. Therefore, improper file deletion with the ddutil command can lead to failed restores and
data loss.

The deletion of backup files and directories cannot be undone.

66 Configuring the Oracle RMAN Agent for Stand-alone Deployment


When the -x option is specified, the ddutil command also deletes any empty directories that it finds. Without the -x option, the
directories are not deleted.
By default, the ddutil command prompts you before deleting any files. The command prompts for every file to be deleted, but does not
prompt for the removal of empty directories. The -c option specifies to perform the deletions without prompting.
The ddutil command ignores all subdirectories unless you specify the -R option. Without the -R option, empty subdirectories are not
deleted; only the current directory is deleted if it is empty of all files and subdirectories after the prune operation.
Both of the following example commands prune all the backup files and empty directories that are older than 30 days under dir1/
subdir1 on the storage unit su1. The commands also prune the directory dir1/subdir1 itself:

ddutil -k -z host1:/su1 -e "-30 days" -R -x dir1/subdir1

ddutil -k -z host1:/su1 -e "now-30 days" -R -x dir1/subdir1

Oracle Incremental Merge operations


Oracle RMAN agent 19.2 introduced support for Oracle Incremental Merge on Linux for both stand-alone and Oracle RAC systems,
leveraging the RMAN feature known as Oracle incrementally updated backups. Oracle incrementally updated backups enable you to create
a full image copy backup of a database every day for the cost of an incremental backup, while providing the recovery benefits of image
copy backups.
NOTE: Oracle Incremental Merge is the Dell EMC term for the group of Oracle RMAN agent features that are
implemented around Oracle incrementally updated backups.
The following topics describe the supported Oracle Incremental Merge features, the required installation and configuration procedures,
and how to perform the backups, restores, and other supported operations with the Oracle RMAN agent.

Overview of Oracle Incremental Merge features


When you first run an Oracle Incremental Merge backup of a database to a Data Domain storage unit, a full image copy backup is
performed to begin the cycle of incremental updates. The second and subsequent runs produce level 1 incremental backups of the
database. After each incremental backup, the changed blocks are applied to the existing full backup to create an up-to-date synthetic full
backup. Being an image copy, the synthetic full backup is easier to restore than a traditional RMAN backup.
Traditional RMAN backups, as performed by Oracle RMAN agent prior to version 19.2, use the Oracle SBT library to create backup sets.
Oracle Incremental Merge backups use file system calls to create the Oracle image backups as exact copies of datafiles, which can be
restored and brought online quickly.
Oracle Incremental Merge operations with the Oracle RMAN agent provide the following benefits:
• Preservation of past backups
On a Data Domain storage unit, copies of files can be created almost instantly, and the copies use little space because they are
deduplicated. The Oracle RMAN agent performs the following steps during an Oracle Incremental Merge backup:
1. Performs an Oracle incrementally updated backup.
2. Fast copies the backup from an MTree or directory to a new location on the same Data Domain system.
NOTE: Because the fast copy operation does not include any physical data movement, the operation is completed
in minutes regardless of the size of the file, MTree, or directory.
3. Catalogs the backup in Oracle RMAN.
The next subsequent backup overwrites the backup in the original location on the storage unit but not the backup copy in the new
location. Therefore, a copy of the previous backup is preserved, registered in RMAN and ready to restore.
• Automated mount and unmount of Data Domain storage units
Before an Oracle Incremental Merge backup or restore, the Oracle RMAN agent can automatically mount the Data Domain storage
unit. The Oracle RMAN agent can also automatically unmount the storage unit after the operation. Limiting the mount times during
backups and restores can reduce the risk of backup data theft or attack.
• Setting of retention locks
Oracle Incremental Merge operations leverage the Data Domain retention lock feature. A retention lock prevents the backup files on a
storage unit from being deleted or modified until a specified retention period has passed. Retention locks protect the backups from the
same external threats as automated mount and unmount operations, and also prevent the damage of backup files locally. Before you
can delete or modify the backup files, you must remove the retention lock.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 67


NOTE: You must not set any type of Oracle retention policy on Oracle Incremental Merge backups, such as a
redundancy based or recovery window based policy.
Oracle Incremental Merge operations require the installation of Data Domain BoostFS on the application host, to provide a standard file
system mount point to the application. With direct access to the BoostFS mount point, the application can leverage the storage and
network efficiencies of the DD Boost protocol for backups and restores.
NOTE: An Oracle Incremental Merge backup of a pfile based Oracle database is not supported. You can create an spfile
from the pfile and then perform the Oracle Incremental Merge backup.
Oracle Incremental Merge supports the following operations:
• Full backups—A full backup creates a full copy of the database plus archive logs, and stores the copy on the Data Domain storage
unit. The full copy is used with an incremental backup to create a new synthetic full backup. Backups are protected by a Data Domain
retention lock.
• Incremental backups—An incremental backup backs up the changed data blocks, which are applied to the previous full backup to
create a new synthetic full backup. This synthetic full backup is stored in a new location and then cataloged and protected by a Data
Domain retention lock.
• Archive log backups—The Oracle database archive logs are backed up during the full and incremental backups. The Oracle
Incremental Merge feature provides an option to back up only the archive logs. The archive log backups are protected by a Data
Domain retention lock.
• Control file backups—The control file is backed up with the full, incremental, and archive log backups. The Oracle Incremental Merge
feature provides an option to back up only the control file. The control file backups are protected by a Data Domain retention lock.
• Cleanup operations—The Oracle Incremental Merge feature provides an option to perform a cleanup operation that removes the
copies of any failed backups to free up space on the Data Domain system.
• Restore operations—You can restore the RMAN backups through RMAN scripts that you run through the Oracle Incremental Merge
binary.
• Mount operations—An Oracle Incremental Merge backup performs open and write operations to a local disk or NFS mount. The
storage unit is mounted by using a Data Domain BoostFS FUSE mount operation, and backups are performed on the mounted storage
unit.
• Unmount operations—An Oracle Incremental Merge operation unmounts the storage unit from the local mount path by using a Data
Domain BoostFS FUSE mount operation.
• Live mount operations—A live mount operation is a live migration of the database by using the image-based backup copies.
• Proxy restore operations—A proxy restore operation restores a backup to a new host by using the image-based backup copies.

Installation requirements for Oracle Incremental Merge


Ensure that you complete the following installation procedures and then the configuration procedures in the next topic before you perform
any Oracle Incremental Merge operations.

Steps
1. Ensure that you have completed the installation of the Oracle RMAN agent software on Linux according to the procedures outlined in
this chapter.
The following Oracle RMAN agent files are installed for the Oracle Incremental Merge operations:
• ddbmoim binary in directory $RMAN_AGENT_HOME/bin
• rman_agent_oim.cfg configuration file template in directory $RMAN_AGENT_HOME/config

2. Ensure that you meet the Data Domain BoostFS requirements as described in the latest version of the Dell EMC Data Domain
BoostFS Configuration Guide, available on the Support website at https://support.emc.com.
3. Download the Data Domain BoostFS software package from the Support website at https://support.emc.com to a temporary local
directory.
4. Uncompress the downloaded software file by running the following command:

$ tar -vxf <BoostFS_package_name>.tar

5. Install the Data Domain BoostFS software by running the following command as the root user:

# rpm -ivh <BoostFS_package_name>.rpm

6. Create a storage unit on the Data Domain system to be used for Oracle Incremental Merge backups.

68 Configuring the Oracle RMAN Agent for Stand-alone Deployment


NOTE: Before you run the Oracle Incremental Merge backups for the first time, ensure that you create a Data
Domain storage unit.

7. Create a mount point on the Oracle host, and assign valid permissions similar to an Oracle user on the host.
8. Enable the retention lock feature on the Data Domain storage unit by running the following type of command as the root user. This
example command sets a maximum retention period of 90 days for the MTree /data/col1/oim:

# mtree retention-lock set max-retention-period 90days mtree /data/col1/oim

9. Verify that the retention lock is enabled by running the following type of command as the root user:

# mtree list /data/col1/oim

Configuration requirements for Oracle Incremental Merge


Before you perform any Oracle Incremental Merge operations, complete the configuration procedures as described in the following topics.
You must set the required parameters for Oracle Incremental Merge operations, either through the ddbmoim command options or
through the parameter settings in the configuration file. You must also register the Data Domain Boost credentials and Data Domain
BoostFS credentials in the lockbox.
NOTE: Prior to performing the configuration procedures, ensure that you have met the installation requirements as
described in the preceding topic.

Setting the configuration file parameters


To meet the configuration requirements, you can set the parameters in the Oracle Incremental Merge configuration file. Customize the
parameter settings in the configuration file template rman_agent_oim.cfg, which is stored in the $RMAN_AGENT_HOME/config
directory by the Oracle RMAN agent installation on Linux.
The uninstall of the product software removes the original configuration file template. To create the Oracle Incremental Merge
configuration file, it is recommended that you copy and rename the configuration file template, either in the same directory or a different
directory.
NOTE:

Each parameter in the configuration file corresponds to a command-line option of the ddbmoim command. You run the
ddbmoim command to perform many of the Oracle Incremental Merge operations. The command-line options take
precedence over the configuration file parameters.

As an alternative to setting the parameters in the configuration file, you can specify the appropriate command-line
options when you run the ddbmoim command. Performing the Oracle Incremental Merge operations on page 76
provides details about the ddbmoim command and its options.

The Oracle Incremental Merge configuration file contains two types of sections in which you set the parameters, the general section and
the database-specific sections:
• The general section of the configuration file begins with the [GENERAL] heading. You can set the following parameters in the general
section:
BOOSTFS_INSTALL_DIR
CLIENT
DEBUG_LEVEL
RMAN_AGENT_HOME
NOTE: Instead of setting these parameters in the general section of the configuration file, you can specify the
corresponding command-line options when you run the ddbmoim command. Performing the Oracle Incremental
Merge operations on page 76 provides details about the ddbmoim command and its options.

For example, the following general section of the configuration file shows the parameter settings. Table 9. Configuration file
parameters for Oracle Incremental Merge on page 71 provides details about the parameters that you can set in the configuration file.

##############################################################################
# General Parameters
##############################################################################
[GENERAL]

Configuring the Oracle RMAN Agent for Stand-alone Deployment 69


BOOSTFS_INSTALL_DIR = /opt/emc/boostfs/
CLIENT = ClientHostName
DEBUG_LEVEL = 3
RMAN_AGENT_HOME = /home/oracle/opt/dpsapps/rmanagent/
• Each database-specific section of the configuration begins with the [SID_<name>] heading. You must add a separate database-
specific section in the configuration file for each database. Replace <name> in SID_<name> with the Oracle SID of the database. In an
Oracle RAC environment, replace <name> with the local instance name of the database. After the [SID_<name>] heading, add the
settings for the following parameters as needed for the particular database:
BACKUP_HOST
BACKUP_PATH
DELETE_ARCHIVELOG
DELETE_ARCHIVELOG_NUM_DAYS
FORCE_LIVEMOUNT_CLEANUP
MOUNT_PATH
NFS_MOUNT
OIM_TAG
OPERATION
ORACLE_BASE_PATH
ORACLE_HOME
ORACLE_VERSION_11G
PARALLELISM
RETENTION
RMAN_CATALOG_SERVICE
RMAN_CATALOG_USER
SCRIPT_PATH
STORAGE_UNIT
SYSBACKUP
TEMP_DATABASE_PATH
TEMP_SNAPSHOT_PATH
TNS_ADMIN
NOTE: Instead of setting these parameters in the database-specific section of the configuration file, you can specify
the corresponding command-line options when you run the ddbmoim command. Performing the Oracle Incremental
Merge operations on page 76 provides details about the ddbmoim command and its options.

For example, the following database-specific section of the configuration file shows the parameter settings for the database with
Oracle SID orcl. Table 9. Configuration file parameters for Oracle Incremental Merge on page 71 provides details about the
parameters that you can set in the configuration file.

##############################################################################
# Oracle Parameters
# There can be repetitive sections of Oracle parameters. The Oracle database
# to which the parameters belong is described in the section name: SID_name.
# The name here must be replaced by the SID of the database.
# For RAC systems, the name should be the local instance name of the
# database.
##############################################################################
[SID_orcl]
BACKUP_HOST = DataDomainServerName
DELETE_ARCHIVELOG = TRUE
DELETE_ARCHIVELOG_NUM_DAYS = 3
MOUNT_PATH = /MountPath
OIM_TAG = INCR_MERGE
OPERATION = full
ORACLE_HOME = /oracle/product/12.2.0.1/db_1
PARALLELISM = 4
RETENTION = 10 day
# RMAN_CATALOG_SERVICE =
# RMAN_CATALOG_USER =
# SCRIPT_PATH =
STORAGE_UNIT = StorageUnit
SYSBACKUP = FALSE
# TNS_ADMIN =
The following table describes all the configuration parameters that you can set in the Oracle Incremental Merge configuration file. To set a
parameter in the configuration file, such as BACKUP_HOST, remove the # symbol at the start of the parameter line and add the parameter
value after the equal sign (=).

70 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Table 9. Configuration file parameters for Oracle Incremental Merge
Parameter Description Default and valid values
BACKUP_HOST Mandatory in [SID_<name>] section. • Undefined (default).
Specifies the hostname of the Data Domain • Valid hostname of the Data Domain server.
server to use for backups.

BACKUP_PATH Mandatory in [SID_<name>] section for a live • Undefined (default).


mount or proxy restore operation that uses • Valid directory pathname of the
the ddbmoim command. incremental or full backup.
Specifies the directory pathname of the
incremental or full backup to be restored.

BOOSTFS_INSTALL_DIR Mandatory in [GENERAL] section. • Undefined (default).


Specifies the installation directory of the Data • Valid complete pathname of the Data
Domain BoostFS plug-in. Domain BoostFS installation directory.

CLIENT Mandatory in [GENERAL] section. • Undefined (default).


Specifies the hostname of the local client to • Valid hostname of the local client.
use to store the backups on the Data Domain
system.

NOTE: Set this parameter to the same


value for each node in an Oracle RAC
environment.

DEBUG_LEVEL Optional in [GENERAL] section. • 0 (default) = Debug messages are not


generated.
Specifies the level of debug messages that the
Oracle Incremental Merge operation • 1 to 9 = Debug messages are written to
generates. the debug log file. The level of detail in the
generated debug messages increases with
the debug level. The debug log file name is
ddbmoim_<operation_type>.*.*.log, for
example,
ddbmoim_full.14928.1567760357.log.

DELETE_ARCHIVELOG Optional in [SID_<name>] section. • FALSE (default) = The archive log is not
deleted.
Specifies whether to delete the archive log
after it is backed up. • TRUE = The archive log is deleted.

DELETE_ARCHIVELOG_ Optional in [SID_<name>] section. • Undefined (default). The archive log is not
NUM_DAYS deleted, unless DELETE_ARCHIVELOG is
Specifies to delete the archive log when it is
older than the specified number of days. set to TRUE.
• Integer number of days. The archive log is
deleted after the number of days.

FORCE_LIVEMOUNT_ Optional in [SID_<name>] section. • FALSE (default) = A force cleanup


CLEANUP operation is not performed.
Specifies whether to perform a force cleanup
operation to remove a live mounted database • TRUE = A force cleanup operation is
after a live mount restore that uses the performed.
ddbmoim command.

You can perform this force cleanup after a


previous live mount cleanup (performed
without this setting) failed to remove a live
mounted database.
MOUNT_PATH Mandatory in [SID_<name>] section. • Undefined (default).
• Valid mount path of Data Domain BoostFS.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 71


Table 9. Configuration file parameters for Oracle Incremental Merge (continued)
Parameter Description Default and valid values

Specifies the Data Domain BoostFS mount


path on which the MTree is mounted.

NOTE: The Oracle user must have


permissions for the read, write, and
execute operations on the mount
path. The mount path must be the
same for all operations. Do not change
the mount path once it is set.

NFS_MOUNT Optional in [SID_<name>] section. • TRUE (default) = Use an NFS mount for
the live mount or proxy restore.
Specifies whether to use an NSF mount or a
BoostFS mount for a live mount or proxy • FALSE = Use a BoostFS mount for the live
restore with the ddbmoim command. mount or proxy restore.

OIM_TAG Mandatory in [SID_<name>] section. • Undefined (default).


Specifies the tag that is applied to the backup • Tag that is applied to the backup copies,
copies. for example, INCR_MERGE.

NOTE: The backup tag is used when


the incrementally updated backups
are applied to full backups, to identify
which incremental backups apply to
which working image copies. The
backup tag must be the same for the
full and incremental backups.

OPERATION Mandatory in [SID_<name>] section. • full = Creates a full backup copy of the
database, archive logs, and control file.
Specifies the type of Oracle Incremental
Merge operation that is performed. • arch = Backs up the archive logs and
control file.
• cleanup = Removes the copies of any
failed backups.
• ctl = Backs up the control file only.
• incr = Backs up the changed data blocks,
archive logs, and control file.
• livemount = Performs a live mount restore
that uses the ddbmoim command.
• livemount-cleanup = Removes the live
mounted database after a live mount
restore that uses the ddbmoim command.
• mount = Mounts the Data Domain storage
unit on the mount path specified by
MOUNT_PATH by using a BoostFS FUSE
mount operation.
• proxy-restore = Performs a proxy restore
that uses the ddbmoim command.
• restore = Restores the backup by using
the RMAN restore script specified by
SCRIPT_PATH.
• unmount = Unmounts the Data Domain
storage unit by using a BoostFS FUSE
mount operation.

72 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Table 9. Configuration file parameters for Oracle Incremental Merge (continued)
Parameter Description Default and valid values
ORACLE_BASE_PATH Mandatory in [SID_<name>] section for a live • Undefined (default).
mount or proxy restore operation that uses • Valid base pathname of the Oracle
the ddbmoim command. installation directory.
Specifies the base pathname of the Oracle
installation directory.

ORACLE_HOME Mandatory in [SID_<name>] section. • Undefined (default).


Specifies the pathname of the Oracle • Valid complete pathname of the Oracle
installation directory. installation directory.

ORACLE_VERSION_11G Mandatory in [SID_<name>] section when the • FALSE (default) = Oracle database is not
Oracle database is version 11. version 11.
Specifies whether the Oracle database is • TRUE = Oracle database is version 11.
version 11.

NOTE: Ensure that this parameter is


set to TRUE before you perform an
Oracle Incremental Merge operation
with an Oracle 11 database.

PARALLELISM Optional in [SID_<name>] section. • 4 (default).


Specifies the number of channels that RMAN • Integer number of channels.
allocates in parallel for the backup.

RETENTION Optional in [SID_<name>] section. • Undefined (default).


Specifies the retention policy as the length of • Integer number and one of the following
time that RMAN retains the backup copies. values, surrounded by double quotes:
○ decade
A retention lock is applied for a backup when
the storage unit is retention enabled and this ○ year
parameter is set. ○ quarter
○ month
NOTE: Do not set any type of Oracle ○ fortnight
retention policy, such as a redundancy ○ week
based or recovery window based
○ day
policy. You must use the ddutil
○ hour
commands for backup deletion, as ○ minute
described in Using the ddutil
○ min
command to list and delete the
○ seconds
backups on page 84.
○ sec
For example: RETENTION = "4 month".
NOTE: The minimum setting is "12
hour". The maximum setting is "70
year".

RMAN_AGENT_HOME Mandatory in [GENERAL] section. • $HOME/opt/dpsapps/rmanagent


(default).
Specifies the installation directory of the
Oracle RMAN agent. • Valid complete pathname of the Oracle
RMAN agent installation directory.

RMAN_CATALOG_SERVICE Optional in [SID_<name>] section. • Undefined (default).


Specifies the Net service or Easy Connect • Valid Net service or Easy Connect name of
name of the RMAN catalog database. the RMAN catalog database.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 73


Table 9. Configuration file parameters for Oracle Incremental Merge (continued)
Parameter Description Default and valid values

To ensure that the specified name is correct,


run the following command at the command
line:

rman catalog
<RMAN_catalog_username>/
<password>@<RMAN_catalog_servi
ce_name>

RMAN_CATALOG_USER Mandatory in [SID_<name>] section when the • Undefined (default).


RMAN catalog database is used and • Valid username of the RMAN catalog
RMAN_CATALOG_SERVICE is set. database.
Specifies the username of the RMAN catalog
database.

SCRIPT_PATH Mandatory in [SID_<name>] section for a • Undefined (default).


restore operation. • Valid complete pathname of the restore
Specifies the pathname of the restore script. script.

SET_NEW_DBNAME Mandatory in [SID_<name>] section for a live • Undefined (default).


mount or proxy restore to a new database • Valid new database name for the live
name. mount or proxy restore operation.
Specifies a new database name for a live
mount or proxy restore that uses the
ddbmoim command.

STORAGE_UNIT Mandatory in [SID_<name>] section. • Undefined (default).


Specifies the name of the storage unit or a • Valid directory name of the storage unit on
top-level directory within the storage unit on the Data Domain system, without the /
the Data Domain system. data/col1 prefix. The specified name is
case-sensitive.

SYSBACKUP Optional in [SID_<name>] section. • FALSE (default) = RMAN is connected by


using SYSDBA.
Specifies whether to use SYSBACKUP or
SYSDBA for the RMAN connection. • TRUE = RMAN is connected by using
SYSBACKUP.

TEMP_DATABASE_PATH Mandatory in [SID_<name>] section for a live • Undefined (default).


mount or proxy restore that uses the • Valid pathname of a temporary directory.
ddbmoim command.

Specifies the pathname of a temporary


directory that will be used during the live
mount or proxy restore.

TEMP_SNAPSHOT_PATH Mandatory in [SID_<name>] section for a • Undefined (default).


force cleanup operation to be performed after • Valid pathname of the temporary snapshot
a live mount restore that uses the ddbmoim directory that was used during the live
command. mount restore.
Specifies the pathname of the temporary
snapshot directory that was used during the
live mount restore.

TNS_ADMIN Optional in [SID_<name>] section. • Undefined (default).


Specifies the directory pathname of the • Valid complete pathname of the directory
Oracle Net configuration files. that contains the Oracle Net configuration

74 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Table 9. Configuration file parameters for Oracle Incremental Merge (continued)
Parameter Description Default and valid values

files. This value must the same as the


Oracle parameter TNS_ADMIN setting.

Registering the lockbox credentials


To meet the configuration requirements, you must also run the ddutil -C command to register the Data Domain Boost credentials in
the BoostFS lockbox. This registration task is required only once for each separate storage unit to be used on the same Data Domain
system. Do not run the registration command for each backup.
NOTE: If the lockbox does not exist when you run the ddutil -C command, the command creates the lockbox in the
default directory.
The type of ddutil -C command that you must run depends on whether you have previously registered the Data Domain Boost
credentials in the lockbox:
• If you have not previously registered the Data Domain Boost credentials for the Data Domain system, run either of the following
commands:
○ To specify the Data Domain server, storage unit, and DD Boost user on the command line, run the following command. The
command prompts for only the user password:

ddutil -C -a USER_TYPE=DD_BOOST_USER -a BOOSTFS=TRUE -a


DD_SERVER_NAME=<Data_Domain_server_name> -a DD_STORAGE_UNIT=<storage_unit_name> -a
USERNAME=<username> -a VERIFY_CREDENTIAL=TRUE

Password: <password>
Re-enter password: <password>
Successfully set the DD Boost FS credentials in the lockbox.
Successfully set the DD Boost credentials in the lockbox.
○ To specify the minimum options on the command line, run the following command. The command prompts for the Data Domain
server, storage unit, DD Boost user, and password:

ddutil -C -a USER_TYPE=DD_BOOST_USER -a BOOSTFS=TRUE

Data Domain server name: <Data_Domain_server_name>


Data Domain Storage Unit name: <storage_unit_name>
DD Boost username: <username>
Password: <password>
Re-enter password: <password>
Successfully set the DD Boost FS credentials in the lockbox.
Successfully set the DD Boost credentials in the lockbox.
• If you have previously registered the Data Domain Boost credentials for the Data Domain system, run either of the following
commands:
○ To specify the Data Domain server and storage unit on the command line, run the following command:

ddutil -C -a USER_TYPE=DD_BOOST_USER -a BOOSTFS=TRUE -a BOOSTFS_LOCKBOX_UPDATE=TRUE -a


DD_SERVER_NAME=<Data_Domain_server_name> -a DD_STORAGE_UNIT=<storage_unit_name> -a
VERIFY_CREDENTIAL=TRUE

Successfully set the DD Boost FS credentials in the lockbox.


Successfully set the DD Boost credentials in the lockbox.
○ To specify the minimum options on the command line, run the following command. The command prompts for the Data Domain
server and storage unit:

ddutil -C -a USER_TYPE=DD_BOOST_USER -a BOOSTFS=TRUE -a BOOSTFS_LOCKBOX_UPDATE=TRUE

Data Domain server name: <Data_Domain_server_name>


Data Domain Storage Unit name: <storage_unit_name>
Successfully set the DD Boost FS credentials in the lockbox.
Successfully set the DD Boost credentials in the lockbox.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 75


• If the RMAN catalog is configured, run the following command to register the catalog user and password in the lockbox:

ddutil -C -a USER_TYPE=DATABASE_ADMIN -a DATABASE_SIDS=<RMAN_catalog_service_name> -a


USERNAME=<RMAN_catalog_username>

For example:

ddutil -C -a USER_TYPE=DATABASE_ADMIN -a DATABASE_SIDS=SHC -a USERNAME=sys


Password:
Re-enter password:
Successfully set the Oracle database administrator credentials in the lockbox.

Performing the Oracle Incremental Merge operations


You can run the ddbmoim command to perform the Oracle Incremental Merge mount, unmount, backup, restore, and cleanup operations.
In an Oracle RAC environment, you can run the command on any Oracle database RAC node. You must run the ddutil command to list
and delete the backups. You can run the live mount and proxy restore operations by using either the ddbmoim command or other
commands.

Using the ddbmoim command for mount, unmount, backup, cleanup,


and restore operations
You must run the ddbmoim command with appropriate options as the Oracle user on Linux. The option --dbname <database_name> is
mandatory, where <database_name> is the Oracle SID of the database. In an Oracle RAC environment, replace <database_name> with
the local instance name of the database.
If you set any parameters in the Oracle Incremental Merge configuration file, you must include the -z <configuration_file_path> option on
the ddbmoim command line; otherwise, you can omit the -z <configuration_file_path> option. For every other option, you can either
specify the option on the command line or set the corresponding parameter setting in the Oracle Incremental Merge configuration file. The
operation being performed determines which other options or parameters are mandatory.
NOTE: The command-line options take precedence over the parameter settings in the configuration file. Setting the
configuration file parameters on page 69 provides details about the configuration file parameters.
The ddbmoim command options in curly braces ({ }) are mandatory. The command options in brackets ([]) are optional:

ddbmoim {--dbname <database_name>} {-c <client_hostname>} {-d <Data_Domain_server_name>} [-D


<debug_level>] {-m <mount_path>} {-o {full|incr|arch|ctl|livemount|livemount-cleanup|mount|
unmount|proxy-restore|restore|cleanup}} {-s <storage_unit_name>} {-t <backup_tag>} [-z
<configuration_file_path>] {-a BACKUP_PATH=<dir_path>} {-a BOOSTFS_INSTALL_DIR=<dir_path>} [-
a DELETE_ARCHIVELOG={FALSE|TRUE}] [-a DELETE_ARCHIVELOG_NUM_DAYS=<number_of_days>] [-a
FORCE_LIVEMOUNT_CLEANUP={FALSE|TRUE}] [-a NFS_MOUNT={FALSE|TRUE}] [-a
ORACLE_BASE_PATH=<dir_path>] {-a ORACLE_HOME=<pathname>} [-a ORACLE_VERSION_11G={FALSE|TRUE}]
[-a PARALLELISM=<number>] [-a RETENTION=<value>] {-a RMAN_AGENT_HOME=<dir_path>} [-a
RMAN_CATALOG_SERVICE=<service_name>] [-a RMAN_CATALOG_USER=<username>] [-a
SCRIPT_PATH=<script_path>] [-a SET_NEW_DBNAME=<new_database_name>] [-a SYSBACKUP={FALSE|
TRUE}] [-a TEMP_DATABASE_PATH=<dir_path>] [-a TEMP_SNAPSHOT_PATH=<dir_path>] [-a
TNS_ADMIN=<dir_path>]

The following table describes the ddbmoim command options and the corresponding parameters that you can set in the configuration file.
To obtain a list of all the available command options, run the command ddbmoim --help or ddbmoim -h.
Examples of ddbmoim commands for Oracle Incremental Merge operations on page 83 provides more information about ddbmoim
commands for the supported Oracle Incremental Merge operations.

Table 10. The ddbmoim command options for Oracle Incremental Merge operations
Command option Description Default and valid values
-c <client_hostname> Mandatory if you do not set the CLIENT Values of <client_hostname>:
parameter in the configuration file.
• Undefined (default).
Specifies the hostname of the local client to • Valid hostname of the local client.
use to store the backups on the Data
Domain system.

76 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Table 10. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values

NOTE: Use the same client name


setting for each node in an Oracle
RAC environment.

CLIENT is the corresponding parameter in


the configuration file.

-d <Data_Domain_server_name> Mandatory if you do not set the Values of


BACKUP_HOST parameter in the <Data_Domain_server_hostname>:
configuration file.
• Undefined (default).
Specifies the hostname of the Data Domain • Valid hostname of the Data Domain
server to use for backups. server.

BACKUP_HOST is the corresponding


parameter in the configuration file.

-D <debug_level> Optional. Values of <debug_level>:

Specifies the level of debug messages that • 0 (default) = Debug messages are not
the Oracle Incremental Merge operation generated.
generates. • 1 to 9 = Debug messages are written to
the debug log file. The level of detail in
DEBUG_LEVEL is the corresponding the generated debug messages
parameter in the configuration file. increases with the debug level. The
debug log file name is
ddbmoim_<operation_type>.*.*.log, for
example,
ddbmoim_full.14928.1567760357.log.

-m <mount_path> Mandatory if you do not set the Values of <mount_path>:


MOUNT_PATH parameter in the
• Undefined (default).
configuration file.
• Valid mount path of Data Domain
Specifies the Data Domain BoostFS mount BoostFS.
path on which the MTree is mounted.

NOTE: The Oracle user must have


permissions for the read, write, and
execute operations on the mount
path. The mount path must be the
same for all operations. Do not
change the mount path once it is
set.

MOUNT_PATH is the corresponding


parameter in the configuration file.

-o [full|incr|arch|ctl|livemount| Mandatory if you do not set the • full = Creates a full backup copy of the
livemount-cleanup|mount|unmount| OPERATION parameter in the configuration database, archive logs, and control file.
proxy-restore|restore|cleanup] file. • arch = Backs up the archive logs and
Specifies the type of Oracle Incremental control file.
Merge operation that is performed. • cleanup = Removes the copies of any
failed backups.
OPERATION is the corresponding • ctl = Backs up the control file only.
parameter in the configuration file. • incr = Backs up the changed data
blocks, archive logs, and control file.
• livemount = Performs a live mount
restore that uses the ddbmoim
command.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 77


Table 10. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values

• livemount-cleanup = Removes the live


mounted database after a live mount
restore that uses the ddbmoim
command.
• mount = Mounts the Data Domain
storage unit on the mount path
specified by the -m option or
MOUNT_PATH parameter, by using a
BoostFS FUSE mount operation.
• proxy-restore = Performs a proxy
restore that uses the ddbmoim
command.
• restore = Restores the backup by using
the RMAN restore script specified by
the -a SCRIPT_PATH option or
SCRIPT_PATH parameter.
• unmount = Unmounts the Data Domain
storage unit by using a BoostFS FUSE
mount operation.

-s <storage_unit_name> Mandatory if you do not set the Values of <storage_unit_name>:


STORAGE_UNIT parameter in the
• Undefined (default).
configuration file.
• Valid directory name of the storage unit
Specifies the name of the storage unit or a on the Data Domain system, without
top-level directory within the storage unit the /data/col1 prefix. The name is
on the Data Domain system. case-sensitive.

STORAGE_UNIT is the corresponding


parameter in the configuration file.

-t <backup_tag> Mandatory if you do not set the OIM_TAG Values of <backup_tag>:


parameter in the configuration file.
• Undefined (default).
Specifies the tag that is applied to the • Tag that is applied to the backup copies,
backup copies. for example, INCR_MERGE.

NOTE: The backup tag is used when


the incrementally updated backups
are applied to full backups, to
identify which incremental backups
apply to which working image
copies. The backup tag must be the
same for the full and incremental
backups.

OIM_TAG is the corresponding parameter


in the configuration file.

-z <configuration_file_path> Mandatory if you set any parameters in the Values of <configuration_file_path>:


configuration file as described in Setting the
• Undefined (default).
configuration file parameters on page 69.
• Valid complete pathname of the Oracle
Specifies the pathname of the configuration Incremental Merge configuration file.
file that contains the parameter settings for
the Oracle Incremental Merge operations.

NOTE: If you do not set any


parameters in a configuration file,
you can omit this option.

78 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Table 10. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values
-a BACKUP_PATH=<dir_path> Mandatory if you do not set the Values of <dir_path>:
BACKUP_PATH parameter in the
• Undefined (default).
configuration file for a live mount or proxy
• Valid directory pathname of the
restore that uses the ddbmoim command.
incremental or full backup.
Specifies the directory pathname of the
incremental or full backup to be restored.

BACKUP_PATH is the corresponding


parameter in the configuration file.

-a BOOSTFS_INSTALL_DIR= Mandatory if you do not set the Values of <dir_path>:


<dir_path> BOOSTFS_INSTALL_DIR parameter in
• Undefined (default).
the configuration file.
• Valid complete pathname of the Data
Specifies the installation directory of the Domain BoostFS installation directory.
Data Domain BoostFS plug-in.

BOOSTFS_INSTALL_DIR is the
corresponding parameter in the
configuration file.

-a DELETE_ARCHIVELOG={FALSE| Optional. • FALSE (default) = The archive log is not


TRUE} deleted.
Specifies whether to delete the archive log
after it is backed up. • TRUE = The archive log is deleted.

DELETE_ARCHIVELOG is the
corresponding parameter in the
configuration file.

-a Optional. Values of <number_of_days>:


DELETE_ARCHIVELOG_NUM_DAYS=<nu
mber_of_days> Specifies to delete the archive log when it is • Undefined (default). The archive log is
older than the specified number of days. not deleted, unless the -a
DELETE_ARCHIVELOG option or
DELETE_ARCHIVELOG_NUM_DAYS is the DELETE_ARCHIVELOG_NUM_DAYS
corresponding parameter in the parameter is set to TRUE.
configuration file. • Integer number of days. The archive log
is deleted after the number of days.

-a FORCE_LIVEMOUNT_CLEANUP= Optional. • FALSE (default) = A force cleanup


{FALSE|TRUE} operation is not performed.
Specifies whether to perform a force
cleanup operation to remove a live mounted • TRUE = A force cleanup operation is
database after a live mount restore that performed.
uses the ddbmoim command.

You can perform this force cleanup after a


previous live mount cleanup (performed
without this setting) failed to remove a live
mounted database.
FORCE_LIVEMOUNT_CLEANUP is the
corresponding parameter in the
configuration file.

-a NFS_MOUNT={FALSE|TRUE} Optional. • TRUE (default) = Use an NFS mount


for the live mount or proxy restore.
Specifies whether to use an NFS mount or
a BoostFS mount for a live mount or proxy • FALSE = Use a BoostFS mount for the
restore with the ddbmoim command. live mount or proxy restore.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 79


Table 10. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values

NSF_MOUNT is the corresponding


parameter in the configuration file.

-a ORACLE_BASE_PATH= Mandatory if you do not set the Values of <dir_path>:


<dir_path> ORACLE_BASE_PATH parameter in the
• Undefined (default).
configuration file for a live mount or proxy
• Valid base pathname of the Oracle
restore that uses the ddbmoim command.
installation directory.
Specifies the base pathname of the Oracle
installation directory.

ORACLE_BASE_PATH is the corresponding


parameter in the configuration file.

-a ORACLE_HOME=<pathname> Mandatory if you do not set the Values of <pathname>:


ORACLE_HOME parameter in the
• Undefined (default).
configuration file.
• Valid complete pathname of the Oracle
Specifies the pathname of the Oracle installation directory.
installation directory.

ORACLE_HOME is the corresponding


parameter in the configuration file.

-a ORACLE_VERSION_11G= Mandatory if you do not set • FALSE (default) = Oracle database is


{FALSE|TRUE} ORACLE_VERSION_11G to TRUE in the not version 11.
configuration file when the Oracle database • TRUE = Oracle database is version 11.
is version 11.

Specifies whether the Oracle database is


version 11.

NOTE: Ensure that this option is


set to TRUE before you perform an
Oracle Incremental Merge
operation with an Oracle 11
database.

ORACLE_BASE_PATH is the corresponding


parameter in the configuration file.

-a PARALLELISM=<number> Optional. Values of <number>:

Specifies the number of channels that • 4 (default).


RMAN allocates in parallel for the backup. • Integer number of channels.

PARALLELISM is the corresponding


parameter in the configuration file.

-a RETENTION=<value> Optional. Values of <value> :

Specifies the retention policy as the length • Undefined (default).


of time that RMAN retains the backup • Integer number plus one of the
copies. following values, surrounded by double
quotes:
A retention lock is applied for a backup
when the storage unit is retention enabled ○ decade
and this option is specified. ○ year
○ quarter
NOTE: Do not set any type of
○ month
Oracle retention policy, such as
○ fortnight
redundancy based or recovery
window based. You must use the

80 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Table 10. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values

ddutil commands for backup ○ week


deletion, as described in Using the ○ day
ddutil command to list and delete ○ hour
the backups on page 84. ○ minute
RETENTION is the corresponding ○ min
parameter in the configuration file. ○ seconds
○ sec
For example: -a RETENTION="4 month".
NOTE: The minimum setting is "12
hour". The maximum setting is "70
year".

-a RMAN_AGENT_HOME=<dir_path> Mandatory if you do not set the Values of <dir_path> :


RMAN_AGENT_HOME parameter in the
• $HOME/opt/dpsapps/rmanagent
configuration file.
(default).
Specifies the installation directory of the • Valid complete pathname of the Oracle
Oracle RMAN agent. RMAN agent installation directory.

RMAN_AGENT_HOME is the corresponding


parameter in the configuration file.

-a RMAN_CATALOG_SERVICE= Optional. Values of <service_name> :


<service_name>
Specifies the Net service or Easy Connect • Undefined (default).
name of the RMAN catalog database. • Valid Net service or Easy Connect name
of the RMAN catalog database.
To ensure that the specified name is
correct, run the following command at the
command line:

rman catalog
<RMAN_catalog_username>/
<password>@<RMAN_catalog_ser
vice_name>

RMAN_CATALOG_SERVICE is the
corresponding parameter in the
configuration file.

-a RMAN_CATALOG_USER= Mandatory if you do not set the Values of <username>:


<username> RMAN_CATALOG_USER parameter but the
• Undefined (default).
RMAN catalog database is used and either
• Valid username of the RMAN catalog
the -a RMAN_CATALOG_SERVICE option
database.
is specified or the
RMAN_CATALOG_SERVICE parameter is
set.

Specifies the username of the RMAN


catalog database.

RMAN_CATALOG_USER is the
corresponding parameter in the
configuration file.

-a SCRIPT_PATH=<script_path> Mandatory for a restore if you do not set Values of <script_path>:


the SCRIPT_PATH parameter in the
• Undefined (default).
configuration file.
• Valid complete pathname of the restore
Specifies the pathname of the restore script.
script.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 81


Table 10. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values

SCRIPT_PATH is the corresponding


parameter in the configuration file.

-a SET_NEW_DBNAME= Mandatory for a live mount or proxy restore Values of <new_database_name>:


<new_database_name> to a new database name.
• Undefined (default).
Specifies the new database name for the • Valid new database name for the live
live mount or proxy restore. mount or proxy restore operation.

NOTE: If you do not specify the


new database name, then the live
mount or proxy restore operation is
performed with the same backed-
up database name.

SET_NEW_DBNAME is the corresponding


parameter in the configuration file.

-a SYSBACKUP={FALSE|TRUE} Optional. Specifies whether to use • FALSE (default) = RMAN is connected


SYSBACKUP or SYSDBA for the RMAN by using SYSDBA.
connection. • TRUE = RMAN is connected by using
SYSBACKUP is the corresponding SYSBACKUP.
parameter in the configuration file.

-a TEMP_DATABASE_PATH= Mandatory if you do not set Values of <dir_path>:


<dir_path> TEMP_DATABASE_PATH in the
• Undefined (default).
configuration file for a live mount or proxy
• Valid pathname of a temporary
restore operation that uses the ddbmoim
directory.
command.

Specifies the pathname of a temporary


directory that will be used during the live
mount or proxy restore.

TEMP_DATABASE_PATH is the
corresponding parameter in the
configuration file.

-a TEMP_SNAPSHOT_PATH= Mandatory if you do not set Values of <dir_path>:


<dir_path> TEMP_SNAPSHOT_PATH in the
• Undefined (default).
configuration file for a force cleanup
• Valid pathname of the temporary
operation to be performed after a live
snapshot directory that was used during
mount restore that uses the ddbmoim
the live mount restore.
command.

Specifies the pathname of the temporary


snapshot directory that was used during
the live mount restore.

TEMP_SNAPSHOT_PATH is the
corresponding parameter in the
configuration file.

-a TNS_ADMIN=<dir_path> Optional. Values of <dir_path>:

Specifies the directory pathname of the • Undefined (default).


Oracle Net configuration files. • Valid complete pathname of the
directory that contains the Oracle Net
TNS_ADMIN is the corresponding configuration files. This value must the
parameter in the configuration file. same as the Oracle parameter
TNS_ADMIN setting.

82 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Examples of ddbmoim commands for Oracle Incremental Merge
operations
This topic includes examples of the ddbmoim commands for the mount, unmount, backup, cleanup, and restore operations.
NOTE:

For every ddbmoim command option except --dbname <database_name> and -z <configuration_file_path>, you can set
the corresponding parameter in the configuration file instead of specifying the option on the command line. For
example, if you use all the possible parameter settings instead of command options, then you can run the following
minimal command:

ddbmoim --dbname <database_name> -z <configuration_file_path>

The following topics provide examples of ddbmoim commands for the live mount restores and the restores to a proxy host:
• Performing an automated live mount restore by using a BoostFS mount on page 87
• Performing an automated live mount restore by using an NFS mount on page 88
• Performing an automated proxy host restore by using a BoostFS mount on page 95
• Performing an automated proxy host restore by using an NFS mount on page 96
Review the following information about ddbmoim commands for Oracle Incremental Merge operations:
• Mount operation—The following example ddbmoim command performs a mount operation:

ddbmoim --dbname orcl -o mount -m /MountPath -a BOOSTFS_INSTALL_DIR=/opt/emc/boostfs -a


ORACLE_HOME=/oracle/product/12.2.0.1/db_1 -a RMAN_AGENT_HOME=/home/oracle/opt/dpsapps/
rmanagent -c ClientName -d DataDomainServerName -s StorageUnit -t INCR_MERGE

• Unmount operation—The following example ddbmoim command performs an unmount operation:

ddbmoim --dbname orcl -o unmount -m /MountPath -a BOOSTFS_INSTALL_DIR=/opt/emc/boostfs -a


ORACLE_HOME=/oracle/product/12.2.0.1/db_1 -a RMAN_AGENT_HOME=/home/oracle/opt/dpsapps/
rmanagent -c ClientName -d DataDomainServerName -s StorageUnit

• Full backup—You must create a full backup before any other type of backup. A full backup creates a full copy of the database in the
working directory, /<mount_path>/<hostname>/<database_SID>/full/datafile on the Data Domain storage unit. This working copy is
backed up and cataloged in the directory /<mount_path>/<hostname>/<database_SID>/full/datafile.OIM_TAG<timestamp>. The
backup is retention locked as required, and the status is updated in the tag file. Every full backup cleans up the working directory and
creates a fresh copy of the datafiles.
The following example ddbmoim command performs a full backup:

ddbmoim --dbname orcl -o full -m /MountPath -a BOOSTFS_INSTALL_DIR=/opt/emc/boostfs -a


ORACLE_HOME=/oracle/product/12.2.0.1/db_1 -a RETENTION="10 day" -a RMAN_AGENT_HOME=/home/
oracle/opt/dpsapps/rmanagent -c ClientName -d DataDomainServerName -s StorageUnit -t
INCR_MERGE

• Incremental backup—You can only perform an incremental backup after a successful full backup. Incremental backup pieces are
copied to the directory /<mount_path>/<hostname>/<database_SID>/incr on the Data Domain storage unit. These pieces are
applied to the full backup in the working directory, and a backup of the working directory is created in the directory /<mount_path>/
<hostname>/<database_SID>/full/datafile.OIM_TAG<timestamp>. The backup is retention locked as required, and the status is
updated in the tag file.
The following example ddbmoim command performs an incremental backup:

ddbmoim --dbname orcl -o incr -m /MountPath -a BOOSTFS_INSTALL_DIR=/opt/emc/boostfs -a


ORACLE_HOME=/oracle/product/12.2.0.1/db_1 -a RETENTION="10 day" -a RMAN_AGENT_HOME=/home/
oracle/opt/dpsapps/rmanagent -c ClientName -d DataDomainServerName -s StorageUnit -t
INCR_MERGE

• Archive log backup—An archive log backup is stored in the directory /<mount_path>/<hostname>/<database_SID>/archivelogs on
the Data Domain storage unit. The backup copy of the archive log is retention locked as required.
The following example ddbmoim command performs an archive log backup:

ddbmoim --dbname orcl -o arch -m /MountPath -a BOOSTFS_INSTALL_DIR=/opt/emc/boostfs -a


ORACLE_HOME=/oracle/product/12.2.0.1/db_1 -a RETENTION="10 day" -a RMAN_AGENT_HOME=/home/

Configuring the Oracle RMAN Agent for Stand-alone Deployment 83


oracle/opt/dpsapps/rmanagent -c ClientName -d DataDomainServerName -s StorageUnit -t
INCR_MERGE

• Control file backup—A control file backup is stored in the directory /<mount_path>/<hostname>/<database_SID>/controlfile on the
Data Domain storage unit. The backup copy of the control file is retention locked as required.
The following example ddbmoim command performs a control file backup:

ddbmoim --dbname orcl -o ctl -m /MountPath -a BOOSTFS_INSTALL_DIR=/opt/emc/boostfs -a


ORACLE_HOME=/oracle/product/12.2.0.1/db_1 -a RETENTION="10 day" -a RMAN_AGENT_HOME=/home/
oracle/opt/dpsapps/rmanagent -c ClientName -d DataDomainServerName -s StorageUnit -t
INCR_MERGE

• Cleanup operation—The following example ddbmoim command performs a cleanup operation:

ddbmoim --dbname orcl -o cleanup -m /MountPath -a BOOSTFS_INSTALL_DIR=/opt/emc/boostfs -a


ORACLE_HOME=/oracle/product/12.2.0.1/db_1 -a RMAN_AGENT_HOME=/home/oracle/opt/dpsapps/
rmanagent -c ClientName -d DataDomainServerName -s StorageUnit -t INCR_MERGE

• The following example ddbmoim command performs a restore operation:

ddbmoim --dbname orcl -o restore -m /MountPath -a BOOSTFS_INSTALL_DIR=/opt/emc/boostfs -a


ORACLE_HOME=/oracle/product/12.2.0.1/db_1 -a RMAN_AGENT_HOME=/home/oracle/opt/dpsapps/
rmanagent -a SCRIPT_PATH=/opt/restore/oim_restore_script -c ClientName -d
DataDomainServerName -s StorageUnit -t INCR_MERGE

An Oracle Incremental Merge restore operation involves a sequence of procedural steps as described in Performing the restore
operations with RMAN scripts on page 86.

Using the ddutil command to list and delete the backups


You must run the ddutil command with the appropriate command options to list and delete the Oracle Incremental Merge backups.
You can run the following ddutil command with the -n list_dbid option as introduced in version 19.4 to obtain the database ID for
a specified database name (SID) on the Oracle host:

ddutil -O oim -n list_dbid -a DB_HOSTNAME=<Oracle_hostname> -a DB_NAME=<SID> -z


<Data_Domain_hostname_or_IP>:/<storage_unit>

For example:

ddutil -O oim -n list_dbid -a DB_HOSTNAME=BLRV033A022 -a DB_NAME=orcl19 -z 10.31.140.154:/oim


mount: Mounting 10.31.140.154:oim on /home/oracle/opt/dpsapps/rmanagent/tmp/1582200784

Database Name | Database ID


-------------------------------|------------------------------
orcl19 | 333709292

You can then use the database ID obtained from the ddutil -O oim -n list_dbid command in the ddutil commands that you
run to list and delete the Oracle Incremental Merge backups.
The following ddutil command lists the information about the full, archive log, or control file backups that are stored on the specified
Data Domain storage unit:

ddutil -O oim -n {full|arch|ctl|tagfile} [-b "<start_time>"] [-e "<end_time>"] -f [-l] -z


<Data_Domain_hostname_or_IP>:/<storage_unit> <Oracle_host>/<database_ID>

NOTE: The -l option lists the details of the available files.

For example:
• The following example ddutil command lists the available full backups:

ddutil -O oim -n full -f -z 10.31.140.154:/xapprman orcl/1542418608

mount: Mounting 10.31.140.154:xapprman on /home/oracle/opt/dpsapps/rmanagent/tmp/1567997099


Type Perm Size Time Path
---------------------------------------------------------------------------------------------
-----------------------

84 Configuring the Oracle RMAN Agent for Stand-alone Deployment


dir 770 827 Tue Sep 3 20:05:51 2019 (1567521351) /xapprman/orcl/1542418608/full/
datafile.INCR_MERGE09032019131727
dir 770 827 Tue Sep 3 20:00:42 2019 (1567521042) /xapprman/orcl/1542418608/full/
datafile.INCR_MERGE09032019131217
dir 770 827 Tue Sep 3 14:41:24 2019 (1567501884) /xapprman/orcl/1542418608/full/
datafile.INCR_MERGE09032019075300
dir 770 827 Tue Sep 3 14:28:29 2019 (1567501109) /xapprman/orcl/1542418608/full/
datafile.INCR_MERGE09032019074006
• The following example ddutil command lists the details of the available files in the full backups:

ddutil -O oim -n full -f -l -z 10.31.140.154:/xapprman orcl/1542418608

mount: Mounting 10.31.140.154:xapprman on /home/oracle/opt/dpsapps/rmanagent/tmp/1567997130

NAME : INCR_MERGE09032019131727
DBID : 1542418608
MOUNT PATH : /boostfs
EXPIRATION : Wed Sep 4 13:18:11 2019
CONTROL FILE : /xapprman/orcl/1542418608/full/datafile.INCR_MERGE09032019131727/
CONTROL_FILE.ctl
SP FILE : /xapprman/orcl/1542418608/full/datafile.INCR_MERGE09032019131727/
SP_FILE.spfile

Type Perm Size Time Path


---------------------------------------------------------------------------------------------
-----------------------
dir 770 827 Tue Sep 3 20:05:51 2019 (1567521351) /xapprman/orcl/1542418608/full/
datafile.INCR_MERGE09032019131727
file 640 5251072 Tue Sep 3 20:05:15 2019 (1567521315) /xapprman/orcl/1542418608/full/
datafile.INCR_MERGE09032019131727/data_D-ORCL_I-1542418608_TSUSERS_FNO-7_49uaqkra_20190903
:
:
• The following example ddutil command lists the full backups in the specified time range:

ddutil -O oim -n full -b "Sep 11" -e "Sep 13" -f -z 10.31.140.154:/xapprman orcl/1542915199

• The following example ddutil command lists the available archive log backups:

ddutil -O oim -n arch -f -z 10.31.140.154:/xapprman orcl/1542418608

• The following example ddutil command lists the archive log backups in the specified time range:

ddutil -O oim -n arch -b "Sep 3 14:25:28 2019" -e "Sep 3 20:05:50 2019" -f -z


10.31.140.154:/xapprman orcl/1542418608

• The following example ddutil command lists the available control file backups:

ddutil -O oim -n ctl -c -z 10.31.140.154:/xapprman orcl/1542418608

• The following example ddutil command lists the available full backup summary:

ddutil -O oim -n tagfile -f -z 10.31.140.154:/xapprman orcl/1542418608

The following ddutil command deletes the Oracle Incremental Merge backup files that are stored on the specified Data Domain storage
unit:

ddutil -O oim -n {full|arch|ctl} [-b "<start_time>"] [-e "<end_time>"] [-c] -d -z


<Data_Domain_hostname_or_IP>:/<storage_unit> <Oracle_host>/<database_ID>

NOTE:

Use only the ddutil command to delete the Oracle Incremental Merge backups. Do not use the RMAN delete
command or crosscheck command with Oracle Incremental Merge backups.

Use the -c option for a forced deletion. If you do not use the -c option, the delete operation prompts for confirmation
before deleting the backups.
For example:

Configuring the Oracle RMAN Agent for Stand-alone Deployment 85


• The following example ddutil command deletes the full backups:

ddutil -O oim -n full -d -z 10.31.140.154:/xapprman orcl/1542418608

• The following example ddutil command deletes the full backups in the specified time range:

ddutil -O oim -n full -b "Sep 11" -e "Sep 13" -d -z 10.31.140.154:/xapprman orcl/1542915199

• The following example ddutil command deletes the archive log backups:

ddutil -O oim -n arch -c -d -z 10.31.140.154:/xapprman orcl/1542418608

• The following example ddutil command deletes the archive log backups in the specified time range:

ddutil -O oim -n arch -b "Sep 11" -e "Sep 13" -c -d -z 10.31.140.154:/xapprman orcl/


1542915199

Performing the restore operations with RMAN scripts


To enable an Oracle Incremental Merge restore of a database backup, create separate RMAN scripts to restore the control file and
database. After ensuring that the required configurations are completed, run the appropriate ddbmoim commands with the RMAN scripts
to restore the control file and then restore the database.
Perform the following steps to complete an Oracle Incremental Merge restore of a database backup.
1. Log in to RMAN on the host where you will restore the control file and datafiles of the database. To determine the control file from the
RMAN catalog, run the following type of command:

RMAN> LIST COPY OF CONTROLFILE TAG TESTDB09192019150043;

List of Control File Copies


===========================
Key S Completion Time Ckp SCN Ckp Time
---- - --------------- ------- ---------------
2402 A 19-SEP-19 3768293 19-SEP-19
Name: /oraclemount/testdb_30/2800932625/full/datafile.testdb09192019150043/CONTROL_FILE.ctl
Tag: TESTDB09192019150043

2. Start the database in the nomount state:

RMAN> startup nomount;

3. Create an RMAN script to restore the control file. An example RMAN script is as follows:
connect target "/";
set dbid=2800932625;
run
{ ALLOCATE CHANNEL CH0 DEVICE TYPE DISK;
restore controlfile from "/oraclemount/testdb_30/2800932625/full/
datafile.testdb09192019150043/CONTROL_FILE.ctl";
RELEASE CHANNEL CH0;
}
4. Ensure that the required configurations are completed, as described in the preceding topics. For example, include the following
parameter settings in the configuration file:
OPERATION = restore
SCRIPT_PATH = <restore_script_pathname>
5. Run the appropriate ddbmoim command to perform the control file restore. For example, with all the parameters set in the
configuration file, run the following command:

ddbmoim --dbname orcl -z /home/oracle/opt/dpsapps/rmanagent/config/rman_agent_oim.cfg

6. Determine the latest SCN of the datafiles. For example:

RMAN> select current_scn from v$database;

CURRENT_SCN

-----------

86 Configuring the Oracle RMAN Agent for Stand-alone Deployment


3512754
7. Create an RMAN script to restore the database. An example RMAN script is as follows:
connect target /
run {
ALLOCATE CHANNEL CH0 DEVICE TYPE DISK;
ALLOCATE CHANNEL CH1 DEVICE TYPE DISK;
ALLOCATE CHANNEL CH2 DEVICE TYPE DISK;
ALLOCATE CHANNEL CH3 DEVICE TYPE DISK;
set until scn 3512754;
restore database;
recover database;
}
alter database open resetlogs;
8. Ensure that the required configurations are completed. For example, include the following parameter settings in the configuration file:
OPERATION = restore
SCRIPT_PATH = <restore_script_pathname>
9. Run the appropriate ddbmoim command to perform the database restore. For example, with all the parameters set in the
configuration file, run the following command:

ddbmoim --dbname orcl -z /home/oracle/opt/dpsapps/rmanagent/config/rman_agent_oim.cfg

Performing the live mount restore operations


You can perform a live mount restore through either an automated method that uses the ddbmoim command or a manual method that
uses a series of manual steps (without the ddbmoim command). Oracle RMAN agent 19.3 introduced the automated method with the
ddbmoim command. Both the automated and manual methods can use either a BoostFS mount or an NFS mount.
The following topics describe all the supported methods of live mount restores.
NOTE:

For a live mount restore, ensure that the Oracle username, group ID, and user ID are the same on both the production
host and the new host.

A live mount restore with the ddbmoim command applies to either the same-named database or a different-named
database. A manual live mount operation, as introduced with Oracle RMAN agent 19.2, also applies to either the same-
named database or a different-named database.

When you perform a live mount restore with ASM enabled source database backups, the restored database is converted
to a stand-alone database that is created using a pfile of the database instance.

Performing an automated live mount restore by using a BoostFS mount


You can perform the following steps for an automated live mount restore that uses the ddbmoim command with a BoostFS mount.
1. Ensure that the target system (where the database will be live mounted) does not have the same database name or database ID as
the source database backups.
2. Specify the required parameter settings for the automated live mount restore through either of the following methods:
• Set the parameters in the configuration file, as described in Setting the configuration file parameters on page 69.
or
• Set the parameters with the ddbmoim command-line options, as described in Using the ddbmoim command for mount, unmount,
backup, cleanup, and restore operations on page 76.
You run the ddbmoim command in step 3.
For example, the configuration file includes the following parameter settings for the automated live mount restore, where orcl is the
Oracle SID of the database. The NFS_MOUNT setting of FALSE specifies a BoostFS mount:
[SID_orcl]
BACKUP_HOST = 10.31.140.154
DELETE_ARCHIVELOG = TRUE
DELETE_ARCHIVELOG_NUM_DAYS = 1
MOUNT_PATH = /oraclemount
STORAGE_UNIT = oim
OIM_TAG = TEST_2
OPERATION = livemount

Configuring the Oracle RMAN Agent for Stand-alone Deployment 87


ORACLE_HOME = /u01/app/oracle/product/19.0.0/dbhome_1
# PARALLELISM =
# RETENTION =
# RMAN_CATALOG_SERVICE =
# RMAN_CATALOG_USER =
# SCRIPT_PATH =
# SYSBACKUP =
# TNS_ADMIN =
NFS_MOUNT = FALSE
BACKUP_PATH = /oim/orcl_streams/1269163748/full/datafile.stream11122019151615
TEMP_DATABASE_PATH = /home/oracle/test1
ORACLE_BASE_PATH = /u01/app/oracle
# TEMP_SNAPSHOT_PATH =
# FORCE_LIVEMOUNT_CLEANUP =
# ORACLE_VERSION_11G =
3. To perform the automated live mount restore, run the ddbmoim command with the appropriate command options. For example:

ddbmoim --dbname orcl -z /opt/dpsapps/rmanagent/config/rman_agent_oim.cfg

Performing Oracle Incremental Merge operation.


Starting BoostFS mount operation.
Running the mount command. Mountpath: /oraclemount
BoostFS mount operation completed successfully.
Creating a temp livemount directory '/oim/orcl_streams/1269163748/restore/
orcl_streams_orcl_11132019141557' of backup directory '/oim/orcl_streams/1269163748/full/
datafile.stream11122019151615'.
Building the livemount repository in temp path completed successfully.
Live mount restore directory creation completed successfully
Starting PFile restore from SPFile '/oraclemount/orcl_streams/1269163748/restore/
orcl_streams_orcl_11132019141557/SP_FILE.spfile'.
PFile restored successfully to '/home/oracle/test1/orcl/initorcl.ora'.
Starting control file restore /oraclemount/orcl_streams/1269163748/restore/
orcl_streams_orcl_11132019141557/CONTROL_FILE.ctl.
Control file '/oraclemount/orcl_streams/1269163748/restore/orcl_streams_orcl_11132019141557/
CONTROL_FILE.ctl' restored successfully.
Database 'orcl' Mounted successfully.
Starting database 'orcl' open operation
Database 'orcl' opened successfully.
LiveMount of database 'orcl' done successfully.
Oracle Incremental Merge operation completed successfully.
NOTE: To perform the automated live mount restore to a different-named database, ensure that you specify the
SET_NEW_DBNAME parameter in the configuration file or use the -a SET_NEW_DBNAME=<new_database_name>
option on the ddbmoim command line.
4. When the database is open, export the particular table from the temporary live mounted database and then import it to the required
database. For example, export TEST_TABLE from the orcl database and import to the BOOST database:
• Export command:

ORACLE_SID=orcl exp file=test.dmp tables=test_table rows=y

• Import command:

ORACLE_SID=BOOST imp file=test.dmp full=y

5. To remove the live mounted database, perform a cleanup operation with the ddbmoim command as described in Performing a cleanup
of the live mount restored database on page 90.

Performing an automated live mount restore by using an NFS mount


You can perform the following steps for an automated live mount restore that uses the ddbmoim command with an NFS mount.
1. Ensure that the target system (where the database will be live mounted) does not have the same database name or database ID as
the source database backups.
2. Specify the required parameter settings for the automated live mount restore through either of the following methods:
• Set the parameters in the configuration file, as described in Setting the configuration file parameters on page 69.
or
• Set the parameters with the ddbmoim command-line options, as described in Using the ddbmoim command for mount, unmount,
backup, cleanup, and restore operations on page 76.

88 Configuring the Oracle RMAN Agent for Stand-alone Deployment


You run the ddbmoim command in step 5.
For example, the configuration file includes the following parameter settings for the automated live mount restore, where orcl is the
Oracle SID of the database. The NFS_MOUNT setting of TRUE specifies an NFS mount:
[SID_orcl]
BACKUP_HOST = 10.31.140.154
DELETE_ARCHIVELOG = TRUE
DELETE_ARCHIVELOG_NUM_DAYS = 1
MOUNT_PATH = /oraclemount
STORAGE_UNIT = oim
OIM_TAG = TEST_2
OPERATION = livemount
ORACLE_HOME = /u01/app/oracle/product/19.0.0/dbhome_1
# PARALLELISM =
# RETENTION =
# RMAN_CATALOG_SERVICE =
# RMAN_CATALOG_USER =
# SCRIPT_PATH =
# SYSBACKUP =
# TNS_ADMIN =
NFS_MOUNT = TRUE
BACKUP_PATH = /oim/orcl_streams/1269163748/full/datafile.stream11122019151615
TEMP_DATABASE_PATH = /home/oracle/test1
ORACLE_BASE_PATH = /u01/app/oracle
# TEMP_SNAPSHOT_PATH =
# FORCE_LIVEMOUNT_CLEANUP =
# ORACLE_VERSION_11G =
3. Create an NFS share for the Data Domain storage unit.
NOTE: An NFS share will be created automatically if it does not exist. Ensure that the Data Domain user has limited
administrative access.
4. Edit the /etc/fstab file, and add the appropriate entry. For example:

10.31.140.154:/data/col1/harboostfs /home/oracle/boostfs nfs rw,user,noauto 0 0

In this example, the values in the entry are as follows:


• 10.31.140.154 is the Data Domain IP address.
• /data/col1/harboostfs is the Data Domain storage unit pathname.
• /home/oracle/boostfs is the mount path on which the storage unit must be mounted.
• nfs is the file system type.
• rw,user,noauto are the mount options.
5. To perform the automated live mount restore, run the ddbmoim command with the appropriate command options. For example:

ddbmoim --dbname orcl -z /opt/dpsapps/rmanagent/config/rman_agent_oim.cfg

Performing Oracle Incremental Merge operation.


NFS mount of backup device is in progress
NFS mount of backup device is complete
Running the mount command. Mountpath: /oraclemount
BoostFS mount operation completed successfully.
Creating a temp livemount directory '/oim/orcl_streams/1269163748/restore/
orcl_streams_orcl_11132019141557' of backup directory '/oim/orcl_streams/1269163748/full/
datafile.stream11122019151615'.
Building the livemount repository in temp path completed successfully.
Live mount restore directory creation completed successfully
Starting PFile restore from SPFile '/oraclemount/orcl_streams/1269163748/restore/
orcl_streams_orcl_11132019141557/SP_FILE.spfile'.
PFile restored successfully to '/home/oracle/test1/orcl/initorcl.ora'.
Starting control file restore /oraclemount/orcl_streams/1269163748/restore/
orcl_streams_orcl_11132019141557/CONTROL_FILE.ctl.
Control file '/oraclemount/orcl_streams/1269163748/restore/orcl_streams_orcl_11132019141557/
CONTROL_FILE.ctl' restored successfully.
Database 'orcl' Mounted successfully.
Starting database 'orcl' open operation
Database 'orcl' opened successfully.
LiveMount of database 'orcl' done successfully.
Oracle Incremental Merge operation completed successfully.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 89


NOTE: To perform the automated live mount restore to a different-named database, ensure that you specify the
SET_NEW_DBNAME parameter in the configuration file or use the -a SET_NEW_DBNAME=<new_database_name>
option on the ddbmoim command line.
6. When the database is open, export the particular table from the temporary live mounted database and then import it to the required
database. For example, export TEST_TABLE from the orcl database and import to the BOOST database:
• Export command:

ORACLE_SID=orcl exp file=test.dmp tables=test_table rows=y

• Import command:

ORACLE_SID=BOOST imp file=test.dmp full=y

7. To remove the live mounted database, perform a cleanup operation with the ddbmoim command as described in Performing a cleanup
of the live mount restored database on page 90.

Performing a cleanup of the live mount restored database


You can perform the following steps for a cleanup operation with the ddbmoim command, which removes the live mounted database
after an automated live mount restore.
1. Specify the same parameter settings as described in the preceding topics for the automated live mount restores, except change the
operation type. Set the operation type through either the OPERATION=livemount-cleanup parameter setting or the -o
livemount-cleanup option of the ddbmoim command.
NOTE:

If you performed the live mount to a different-named database, change the SID name in the [SID_<name>] heading
at the start of the database-specific section of configuration file. Change <name> to the new database name. For
example:
##############################################################################
[SID_orcl2]
BACKUP_HOST = DataDomainServerName
:
2. To perform the cleanup, run the ddbmoim command with the appropriate command options. For example:

ddbmoim --dbname orcl -o livemount-cleanup -z /opt/dpsapps/rmanagent/config/


rman_agent_oim.cfg

Performing Oracle Incremental Merge operation.


Shutting down temp database for cleanup orcl.
Temp database orcl shut down successfully.
Starting the BoostFS unmount operation.
BoostFS unmount operation completed successfully.
Oracle Incremental Merge operation completed successfully.
NOTE:

For the cleanup of a live mount restored database with a new database name, specify the new database name with
the --dbname command option on the ddbmoim command line. For example:

ddbmoim --dbname orcl2 -o livemount-cleanup -z /opt/dpsapps/rmanagent/config/


rman_agent_oim.cfg

3. If the cleanup operation in step 2 fails, you can perform a force cleanup operation:
a. Keep the same parameter settings as used for the cleanup in step 2, but specify the force cleanup by adding either the
FORCE_LIVEMOUNT_CLEANUP=TRUE parameter setting or the -a FORCE_LIVEMOUNT_CLEANUP=TRUE option of the
ddbmoim command.
b. Run the ddbmoim command with the appropriate command options. For example:

ddbmoim --dbname orcl -o livemount-cleanup -a FORCE_LIVEMOUNT_CLEANUP=TRUE -z /opt/


dpsapps/rmanagent/config/rman_agent_oim.cfg

90 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Performing a manual live mount restore by using a BoostFS mount
You can perform the following steps to complete a manual live mount restore (without the ddbmoim command) by using a BoostFS
mount.
1. Mount the Data Domain storage unit by using a BoostFS mount.
2. Fast copy the snapshot backups to copy the correct datafiles. For example:

[oracle@blrv027a080 datafile.OIM_INCR_MERGE08122019103055]$ ssh [email protected]


filesys fastcopy source /data/col1/oim/navneet/3249522768/full/
datafile.OIM_INCR_MERGE08122019103055 destination /data/col1/oim/navneet/3249522768/full/
TEST
Data Domain OS
Password:
Fastcopy status: fastcopy /data/col1/oim/navneet/3249522768/full/
datafile.OIM_INCR_MERGE08122019103055 to /data/col1/oim/navneet/3249522768/full/TEST:
copied 16 files, 1 directory in 0.01 seconds

[oracle@blrv027a080 datafile.OIM_INCR_MERGE08122019103055]$ ls -l /oimmount/navneet/


3249522768/full/TEST
total 275060
-rw-r-----. 1 100 ftp 18464768 Aug 12 02:34 CONTROL_FILE.ctl
-rw-r-----. 1 100 ftp 513810432 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
SYSAUX_FNO-12_jdu90ur2_20190812
-rw-r-----. 1 100 ftp 1174413312 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
SYSAUX_FNO-3_j9u90uqr_20190812
-rw-r-----. 1 100 ftp 513810432 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
SYSAUX_FNO-7_jbu90uqr_20190812
-rw-r-----. 1 100 ftp 513810432 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
SYSAUX_FNO-9_jcu90uqr_20190812
-rw-r-----. 1 100 ftp 262152192 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
SYSTEM_FNO-11_jgu90ur5_20190812
-rw-r-----. 1 100 ftp 849354752 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
SYSTEM_FNO-1_jau90uqr_20190812
-rw-r-----. 1 100 ftp 262152192 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
SYSTEM_FNO-5_jeu90ur2_20190812
-rw-r-----. 1 100 ftp 262152192 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
SYSTEM_FNO-8_jfu90ur2_20190812
-rw-r-----. 1 100 ftp 10493952 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
TEMP01_FNO-14_jiu90ur5_20190812
-rw-r-----. 1 100 ftp 110108672 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
UNDOTBS1_FNO-4_jhu90ur5_20190812
-rw-r-----. 1 100 ftp 5251072 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
USERS_FNO-10_jku90ur6_20190812
-rw-r-----. 1 100 ftp 5251072 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
USERS_FNO-13_jlu90ur6_20190812
-rw-r-----. 1 100 ftp 5251072 Aug 12 02:34 data_D-NEWDB_I-3249522768_TS-
USERS_FNO-6_jju90ur5_20190812
-rw-r-----. 1 100 ftp 98304 Aug 12 02:34 SP_FILE.spfile
-rw-r--r--. 1 100 ftp 151 Aug 12 02:35 tags.json

3. Create the init<SID>.ora file. For example, the file contains the following lines. For a PDB database, add the line
*.enable_pluggable_database=TRUE:

cat /tmp/TEST/initTEST.ora
#
# Init.ora file with minimum parameters to start up TEST
#
*.db_block_size=8192
*.db_domain=''
*.db_name='TEST'
*.control_files='/tmp/TEST/TEST_control01.ctl'
*.audit_file_dest='/tmp/TEST/'
*.audit_trail='db'
*.db_create_file_dest='/tmp/TEST/'
*.db_recovery_file_dest='/tmp/TEST/'
*.diagnostic_dest='/tmp/TEST/'
*.db_recovery_file_dest_size=8589934592
*._allow_resetlogs_corruption=TRUE
*._allow_error_simulation=TRUE
*.enable_pluggable_database=TRUE

Configuring the Oracle RMAN Agent for Stand-alone Deployment 91


*.remote_login_passwordfile='EXCLUSIVE'
*.compatible='12.1.0.2.0'

NOTE: Change the value 12.1.0.2.0 as required in the last line of the init<SID>.ora parameter file. The version
must be compatible with the snapshot Data Domain backup image copies.
4. Set the SID to the new database, for example, TEST:

oracle@blrv027a080 ~]$ ORACLE_SID=TEST sqlplus / as


sysdba

SQL*Plus: Release 12.1.0.2.0 Production on Sun Jan 20 20:34:53 2019 Copyright (c) 1982,
2014, Oracle.
All rights reserved. Connected to an idle instance.

5. Start and mount the database, and create the control file. For example, the control file contains the following lines:

SQL> startup nomount pfile=/tmp/TEST/initTEST.ora


ORACLE instance started.

cat /tmp/TEST/controlfile.ctl
CREATE CONTROLFILE REUSE SET DATABASE "TEST" RESETLOGS NOARCHIVELOG
MAXLOGFILES 16
MAXLOGMEMBERS 3
MAXDATAFILES 512
MAXINSTANCES 8
MAXLOGHISTORY 292
LOGFILE
GROUP 1 '/tmp/TEST/TEST_redo01.log' SIZE 5M BLOCKSIZE 512 reuse,
GROUP 2 '/tmp/TEST/TEST_redo02.log' SIZE 5M BLOCKSIZE 512 reuse,
GROUP 3 '/tmp/TEST/TEST_redo03.log' SIZE 5M BLOCKSIZE 512 reuse
DATAFILE
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-DUMMY1_FNO-18_c1ubcbiu_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-DUMMY_FNO-17_c0ubcbis_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSAUX_FNO-10_bmubcbhe_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSAUX_FNO-14_bnubcbhe_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSAUX_FNO-3_bkubcbhe_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSAUX_FNO-6_boubcbi9_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSTEM_FNO-13_brubcbij_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSTEM_FNO-1_blubcbhe_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSTEM_FNO-5_bsubcbij_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSTEM_FNO-9_bqubcbia_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-UNDOTBS1_FNO-11_buubcbir_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-UNDOTBS1_FNO-15_bvubcbir_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-UNDOTBS1_FNO-4_bpubcbia_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-UNDOTBS1_FNO-8_btubcbin_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-USERS_FNO-12_c3ubcbiv_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-USERS_FNO-16_c4ubcbiv_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-USERS_FNO-7_c2ubcbiv_20190910';

6. When the control file is created, open the database with resetlogs:

alter database open resetlogs

7. Verify the tables.

92 Configuring the Oracle RMAN Agent for Stand-alone Deployment


For example, two databases are running with the TEST instance live mounted on /oimmount (Data Domain). The copy of the
database is at the second backup. The TEST_TABLE is intact and can be exported and imported back to the BOOST databases. On
completion, the TEST Oracle instance is shut down and the snapshot is removed.
8. Export TEST_TABLE from the TEST database, import to the BOOST database, and clean up. For example:

[oracle@blrv027a080 ~]$ ORACLE_SID=TEST exp file=test.dmp tables=test_table rows=y


ORACLE_SID=BOOST imp file=test.dmp full=y

Performing a manual live mount restore by using an NFS mount


You can perform the following steps to complete a manual live mount restore (without the ddbmoim command) by using an NFS mount.
1. Create the NFS share for the Data Domain storage unit.
2. Edit the /etc/fstab file, and add the appropriate entry. For example:
10.31.140.154:/data/col1/harboostfs /home/oracle/boostfs nfs rw,user,noauto 0 0
In this example, the values in the entry are as follows:
• 10.31.140.154 is the Data Domain IP address.
• /data/col1/harboostfs is the Data Domain storage unit pathname.
• /home/oracle/boostfs is the mount path on which the storage unit needs to be mounted.
• nfs is the file system type.
• rw,user,noauto are the mount options.
3. Mount the mount path directory by using the mount system call. For example:

mount /home/oracle/boostfs

4. To complete the live mount restore on the local host, perform the following steps:
a. Create a temporary snapshot restore directory in Data Domain, and fast copy the snapshot datafiles from the datafile directory to
the snapshot restore directory. For example:

ssh [email protected] filesys fastcopy source /data/col1/harboostfs/rmanagent/


1538675391/full/datafile.INCR_MERGE09102019004954 destination /data/col1/harboostfs/
rmanagent/1538675391/full/SNAPSHOT-RESTORE

b. Export the temporary ORACLE_SID to the temporary database name. For example:

export ORACLE_SID=TEST

c. Create a directory in /tmp with the exported database name, and create the init<SID>.ora parameter file. For example, the
file contains the following lines. For a PDB database, add the line *.enable_pluggable_database=TRUE:

cat /tmp/TEST/initTEST.ora
#
# Init.ora file with minimum parameters to start up TEST
#
*.db_block_size=8192
*.db_domain=''
*.db_name='TEST'
*.control_files='/tmp/TEST/TEST_control01.ctl'
*.audit_file_dest='/tmp/TEST/'
*.audit_trail='db'
*.db_create_file_dest='/tmp/TEST/'
*.db_recovery_file_dest='/tmp/TEST/'
*.diagnostic_dest='/tmp/TEST/'
*.db_recovery_file_dest_size=8589934592
*._allow_resetlogs_corruption=TRUE
*._allow_error_simulation=TRUE
*.enable_pluggable_database=TRUE
*.remote_login_passwordfile='EXCLUSIVE'
*.compatible='12.1.0.2.0'

NOTE: Change the value 12.1.0.2.0 as required in the last line of the init<SID>.ora parameter file. The version
must be compatible with the snapshot Data Domain backup image copies.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 93


d. Create a control file with the datafiles of the snapshot restore directory. For example, the control file contains the following lines:

cat /tmp/TEST/controlfile.ctl
CREATE CONTROLFILE REUSE SET DATABASE "TEST" RESETLOGS NOARCHIVELOG
MAXLOGFILES 16
MAXLOGMEMBERS 3
MAXDATAFILES 512
MAXINSTANCES 8
MAXLOGHISTORY 292
LOGFILE
GROUP 1 '/tmp/TEST/TEST_redo01.log' SIZE 5M BLOCKSIZE 512 reuse,
GROUP 2 '/tmp/TEST/TEST_redo02.log' SIZE 5M BLOCKSIZE 512 reuse,
GROUP 3 '/tmp/TEST/TEST_redo03.log' SIZE 5M BLOCKSIZE 512 reuse
DATAFILE
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-DUMMY1_FNO-18_c1ubcbiu_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-DUMMY_FNO-17_c0ubcbis_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSAUX_FNO-10_bmubcbhe_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSAUX_FNO-14_bnubcbhe_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSAUX_FNO-3_bkubcbhe_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSAUX_FNO-6_boubcbi9_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSTEM_FNO-13_brubcbij_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSTEM_FNO-1_blubcbhe_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSTEM_FNO-5_bsubcbij_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-SYSTEM_FNO-9_bqubcbia_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-UNDOTBS1_FNO-11_buubcbir_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-UNDOTBS1_FNO-15_bvubcbir_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-UNDOTBS1_FNO-4_bpubcbia_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-UNDOTBS1_FNO-8_btubcbin_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-USERS_FNO-12_c3ubcbiv_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-USERS_FNO-16_c4ubcbiv_20190910',
'/home/oracle/boostfs/rmanagent/1538675391/full/SNAPSHOT-RESTORE/data_D-
ORCL_I-1538675391_TS-USERS_FNO-7_c2ubcbiv_20190910';

e. Log in to the sqlplus, and start the database with the created init<SID>.ora file in the nomount state. For example:

startup nomount pfile=/tmp/TEST/initTEST.ora

f. Run the control file script from sqlplus. For example:

@/tmp/TEST/controlfile.ctl

g. When the control file is created, open the database with resetlogs:

alter database open resetlogs

h. When the database is open, export the particular table from the temporary created database and then import to the original
database. For example:
• Export command: ORACLE_SID=TEST exp file=test.dmp tables= test_table rows=y
• Import command: ORACLE_SID=BOOST imp file=test.dmp full=y

94 Configuring the Oracle RMAN Agent for Stand-alone Deployment


Performing the restore operations to a proxy host
You can perform a restore operation to a proxy host through either an automated method that uses the ddbmoim command or a manual
method that uses a series of manual steps (without the ddbmoim command). Oracle RMAN agent 19.3 introduced the automated
method with the ddbmoim command. The automated method can use either a BoostFS mount or an NFS mount.
The following topics describe all the supported methods of proxy host restores.
NOTE:

For a proxy host restore, ensure that the database version, Oracle username, group ID, and user ID are the same on both
the production host and proxy host.

A proxy host restore with the ddbmoim command applies to either the same-named database or a different-named
database. A manual proxy host restore operation, as introduced with Oracle RMAN agent 19.2, also applies to either the
same-named database or a different-named database.

When you perform a proxy host restore with ASM enabled source database backups, the restored database is converted
to a stand-alone database that is created using a pfile of the database instance.

If you need to perform backups of a proxy host restored database using the Oracle Incremental Merge solution, then
create an spfile from the pfile and restart the database using the spfile.

Performing an automated proxy host restore by using a BoostFS mount


You can perform the following steps for an automated proxy host restore that uses the ddbmoim command with a BoostFS mount.
1. Specify the required parameter settings for the automated proxy host restore through either of the following methods:
• Set the parameters in the configuration file, as described in Setting the configuration file parameters on page 69.
or
• Set the parameters with the ddbmoim command-line options, as described in Using the ddbmoim command for mount, unmount,
backup, cleanup, and restore operations on page 76.
You run the ddbmoim command in step 2.
For example, the configuration file includes the following parameter settings for the automated proxy host restore, where orcl is the
Oracle SID of the database. The NFS_MOUNT setting of FALSE specifies a BoostFS mount:
[SID_orcl]
BACKUP_HOST = 10.31.140.154
DELETE_ARCHIVELOG = TRUE
DELETE_ARCHIVELOG_NUM_DAYS = 1
MOUNT_PATH = /oraclemount
STORAGE_UNIT = oim
OIM_TAG = TEST_2
OPERATION = proxy-restore
ORACLE_HOME = /u01/app/oracle/product/19.0.0/dbhome_1
# PARALLELISM =
# RETENTION =
# RMAN_CATALOG_SERVICE =
# RMAN_CATALOG_USER =
# SCRIPT_PATH =
# SYSBACKUP =
# TNS_ADMIN =
NFS_MOUNT = FALSE
BACKUP_PATH = /oim/orcl_streams/1269163748/full/datafile.stream11122019151615
TEMP_DATABASE_PATH = /home/oracle/test1
ORACLE_BASE_PATH = /u01/app/oracle
# TEMP_SNAPSHOT_PATH =
# FORCE_LIVEMOUNT_CLEANUP =
# ORACLE_VERSION_11G =
2. To perform the automated proxy host restore, run the ddbmoim command with the appropriate command options. For example:

ddbmoim --dbname orcl -z /opt/dpsapps/rmanagent/config/rman_agent_oim.cfg

Performing Oracle Incremental Merge operation.


Starting BoostFS mount operation.
Running the mount command. Mountpath: /oraclemount
BoostFS mount operation completed successfully.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 95


Creating a temp livemount directory '/oim/orcl_streams/1269163748/restore/
orcl_streams_orcl_11142019192907' of backup directory '/oim/orcl_streams/1269163748/full/
datafile.stream11122019151615'.
Building the livemount repository in temp path completed successfully.
Live mount restore directory creation completed successfully
Starting PFile restore from SPFile '/oraclemount/orcl_streams/1269163748/restore/
orcl_streams_orcl_11142019192907/SP_FILE.spfile'.
PFile restored successfully to '/home/oracle/test1/orcl/initorcl.ora'.
Starting control file restore /oraclemount/orcl_streams/1269163748/restore/
orcl_streams_orcl_11142019192907/CONTROL_FILE.ctl.
Control file '/oraclemount/orcl_streams/1269163748/restore/orcl_streams_orcl_11142019192907/
CONTROL_FILE.ctl' restored successfully.
Database 'orcl' Mounted successfully.
Starting database 'orcl' open operation
Database 'orcl' opened successfully.
Proxy Restore of database 'orcl' done successfully.
Starting the BoostFS unmount operation.
BoostFS unmount operation completed successfully.
Oracle Incremental Merge operation completed successfully.
NOTE: To perform the automated proxy host restore to a different-named database, ensure that you specify the
SET_NEW_DBNAME parameter in the configuration file or use the -a SET_NEW_DBNAME=<new_database_name>
option on the ddbmoim command line.

Performing an automated proxy host restore by using an NFS mount


You can perform the following steps for an automated proxy host restore that uses the ddbmoim command with an NFS mount.
1. Specify the required parameter settings for the automated proxy host restore through either of the following methods:
• Set the parameters in the configuration file, as described in Setting the configuration file parameters on page 69.
or
• Set the parameters with the ddbmoim command-line options, as described in Using the ddbmoim command for mount, unmount,
backup, cleanup, and restore operations on page 76.
You run the ddbmoim command in step 4.
For example, the configuration file includes the following parameter settings for the automated proxy host restore, where orcl is the
Oracle SID of the database. The NFS_MOUNT setting of TRUE specifies an NSF mount:
[SID_orcl]
BACKUP_HOST = 10.31.140.154
DELETE_ARCHIVELOG = TRUE
DELETE_ARCHIVELOG_NUM_DAYS = 1
MOUNT_PATH = /oraclemount
STORAGE_UNIT = oim
OIM_TAG = TEST_2
OPERATION = proxy-restore
ORACLE_HOME = /u01/app/oracle/product/19.0.0/dbhome_1
# PARALLELISM =
# RETENTION =
# RMAN_CATALOG_SERVICE =
# RMAN_CATALOG_USER =
# SCRIPT_PATH =
# SYSBACKUP =
# TNS_ADMIN =
NFS_MOUNT = TRUE
BACKUP_PATH = /oim/orcl_streams/1269163748/full/datafile.stream11122019151615
TEMP_DATABASE_PATH = /home/oracle/test1
ORACLE_BASE_PATH = /u01/app/oracle
# TEMP_SNAPSHOT_PATH =
# FORCE_LIVEMOUNT_CLEANUP =
# ORACLE_VERSION_11G =
2. Create an NFS share for the Data Domain storage unit.
3. Edit the /etc/fstab file, and add the appropriate entry. For example:

10.31.140.154:/data/col1/harboostfs /home/oracle/boostfs nfs rw,user,noauto 0 0

In this example, the values in the entry are as follows:


• 10.31.140.154 is the Data Domain IP address.

96 Configuring the Oracle RMAN Agent for Stand-alone Deployment


• /data/col1/harboostfs is the Data Domain storage unit pathname.
• /home/oracle/boostfs is the mount path on which the storage unit must be mounted.
• nfs is the file system type.
• rw,user,noauto are the mount options.
4. To perform the automated proxy host restore, run the ddbmoim command with the appropriate command options. For example:

ddbmoim --dbname orcl -z /opt/dpsapps/rmanagent/config/rman_agent_oim.cfg

Performing Oracle Incremental Merge operation.


NFS mount of backup device is in progress
NFS mount of backup device is complete
Creating a temp livemount directory '/oim/orcl_streams/1269163748/restore/
orcl_streams_orcl_11142019200006' of backup directory '/oim/orcl_streams/1269163748/full/
datafile.stream11112019171120'.
Building the livemount repository in temp path completed successfully.
Live mount restore directory creation completed successfully
Starting PFile restore from SPFile '/oraclemount/orcl_streams/1269163748/restore/
orcl_streams_orcl_11142019200006/SP_FILE.spfile'.
PFile restored successfully to '/home/oracle/test1/orcl/initorcl.ora'.
Starting control file restore /oraclemount/orcl_streams/1269163748/restore/
orcl_streams_orcl_11142019200006/CONTROL_FILE.ctl.
Control file '/oraclemount/orcl_streams/1269163748/restore/orcl_streams_orcl_11142019200006/
CONTROL_FILE.ctl' restored successfully.
Database 'orcl' Mounted successfully.
Starting database 'orcl' open operation
Database 'orcl' opened successfully.
Proxy Restore of database 'orcl' done successfully.
NFS unmount of backup device is in progress
NFS unmount of backup device is complete
Oracle Incremental Merge operation completed successfully.
NOTE: To perform the automated proxy host restore to a different-named database, ensure that you specify the
SET_NEW_DBNAME parameter in the configuration file or use the -a SET_NEW_DBNAME=<new_database_name>
option on the ddbmoim command line.

Performing a manual proxy host restore


To perform a database restore to a proxy host by using the manual method, you must make local copies from the specified snapshot Data
Domain image copies and then restore the database to the given point.
The following example shows the series of commands to run in RMAN for a manual restore operation to a proxy host.
1. Specify the production host database ID:

set dbid 1538675391;

2. Start the database:

startup force nomount;

3. Restore the spfile to the proxy host directory $ORACLE_HOME/dbs from the snapshot Data Domain image spfile:

restore spfile to "/home/oracle/app/oracle18/product/18.0.0/dbhome_1/dbs/spfileorcl.ora"


from "/home/oracle/boostfs/rmanagent/1538675391/full/datafile.INCR_MERGE09112019043255/
SP_FILE.spfile";

4. Create the pfile in the proxy host directory $ORACLE_HOME/dbs from the created spfile of the proxy host:

create pfile='/home/oracle/app/oracle18/product/18.0.0/dbhome_1/dbs/initorcl.ora' from


spfile='/home/oracle/app/oracle18/product/18.0.0/dbhome_1/dbs/spfileorcl.ora';

5. Restore the control file from the snapshot Data Domain image control file copy to the default directory $ORACLE_HOME/dbs:

restore controlfile from "/home/oracle/boostfs/rmanagent/1538675391/full/


datafile.INCR_MERGE09112019043255/CONTROL_FILE.ctl";
create spfile from memory;
shutdown abort;
startup nomount;
alter system set db_name='orcl' scope=spfile;

Configuring the Oracle RMAN Agent for Stand-alone Deployment 97


6. Run the following command for a PDB database:

alter system set "enable_pluggable_database"= TRUE SCOPE = SPFILE;

7. Shut down and restart the database:

shutdown abort;
startup nomount;
alter database mount;

8. Restore the database:


NOTE:

When the production host datafile path does not exist on the proxy host, provide the new database path with the
set newname command and datafile format. During the database restore, the local copies are created from the
snapshot Data Domain image copies.

When you run the set newname command, you must also run the switch datafile all command to switch all
the datafiles to the new database format that is provided by the set newname command.

run {
set newname for database to '/home/oracle/app/oracle18/oradata/ORCL/%N_%f.dbf';
restore database;
switch datafile all;
}

9. Run the database recovery preview and record the fuzziness SCN number:

recover database preview;

10. Run the database recovery and specify the recorded fuzziness SCN number, xxxxx:

recover database until scn xxxxx;

11. When the production host redo log path does not exist on the proxy host, rename the redo log files to the new database path on the
proxy host:

select member from v$logfile;


alter database rename file '/u01/app/oracle/oradata/ORCL/redo01.log' to '/home/oracle/app/
oracle18/oradata/ORCL/redo01.log';
alter database rename file '/u01/app/oracle/oradata/ORCL/redo02.log' to '/home/oracle/app/
oracle18/oradata/ORCL/redo02.log';
alter database rename file '/u01/app/oracle/oradata/ORCL/redo03.log' to '/home/oracle/app/
oracle18/oradata/ORCL/redo03.log';
alter database open resetlogs;

Configuring the use of Data Domain Cloud Tier for


data movement to the cloud
You can configure the Oracle RMAN agent to use the Data Domain Cloud Tier for the movement of backup data to the cloud and the
subsequent recall of the backup data from the cloud.
Data Domain (DD) Cloud Tier is a native feature of DD OS 6.0 and later for data movement from the active tier to low-cost, high-capacity
object storage in the public, private, or hybrid cloud for long-term retention. The Oracle RMAN agent 4.0 introduced support of the DD
Cloud Tier for movement of DD Boost backup data to the cloud, which frees up space on the Data Domain system (active tier).
NOTE:

If the Oracle RMAN agent is integrated with PowerProtect, the following self-service replication and cloud tiering
operations are disabled:

• Creation of multiple backup copies with the RMAN BACKUP COPIES command.
• Automatic recall of the backup data during restore, when the backup file is in the cloud tier. The PowerProtect
administrator must explicitly recall the backup copy before it can be restored by the DBA.

98 Configuring the Oracle RMAN Agent for Stand-alone Deployment


The PowerProtect Administration and User Guide provides more details about these limitations.
You must set up a DD Cloud Tier policy, also known as a data movement policy, for each MTree or storage unit that the Oracle RMAN
agent uses for data movement to the cloud.
After you have set up the data movement policies, you can configure and perform the following operations:
• Movement of backup data from the Data Domain system to the cloud.
• Recall of backup data from the cloud to the Data Domain system.
The following topics describe how to set up the required DD Cloud Tier policies to enable the data movement to the cloud and how to
perform the data recall from the cloud.

Setting up the data movement to the cloud


The Oracle RMAN agent moves the backup data from the active tier to the cloud according to the DD Cloud Tier policy. To enable the
data movement to the cloud, you must set up the required policy for each MTree or storage unit.

About this task


DD Cloud Tier provides two types of data movement policy, the application-based policy and the age-based policy. The Oracle RMAN
agent supports only the age-based policy. A file is moved from the active tier to the cloud tier based on the date that it was last modified.
For data integrity, the entire file is moved at this time. The aged-based policy can specify the file age threshold, the age range for the files
to be moved, and the destination. For example, files older than 1 month and younger than 3 months can be moved to the cloud.
Set the age-based data movement policy on a per-MTree basis on the Data Domain system by using the Data Domain Data Management
console, as described in the Data Domain Operating System Administration Guide. For example, the following procedure adds a data
movement policy to an MTree.
NOTE: Data movement can be initiated manually or automatically by using the policy schedule. Once the policy is set up,
the backup files on the Data Domain system are automatically moved to the cloud according to the schedule, and no
manual intervention is required. You can also initiate the data movement manually from the Data Domain Data
Management console.

Steps
1. Select Data Management > MTree.
2. In the top panel, select the MTree to which you want to add a data movement policy.
3. Click the Summary tab.
4. Under Data Movement Policy, click Add.

The Add Data Movement Policy dialog box appears:


5. For File Age in Days, set the file age threshold (Older than) and optionally the age range (Younger than).
NOTE: The minimum number of days for Older than is 14. Files moved to the cloud tier cannot be accessed directly
and must be recalled to the active tier before you can access them. Select the age threshold value as appropriate to
minimize or avoid the need to access a file that is moved to the cloud tier.

6. For Destination, specify the destination cloud unit.


7. Click Add.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 99


Performing the data recall from the cloud
After the backup data has been moved to the cloud through the DD Cloud Tier policies, the data can be recalled from the cloud
automatically or manually. By default, the Oracle RMAN agent automatically recalls data from the cloud to the Data Domain system as
required to complete a restore operation. You can also recall the backup files manually, prior to a restore operation.
During a restore operation, if a backup file is requested and not in the active tier, the Oracle RMAN agent automatically recalls the file from
the cloud. The Oracle RMAN agent waits for the file to become available before continuing the restore. The time taken by the recall
process depends on the file size and the speed of the network between the cloud and the Data Domain system.
As an alternative, to avoid waiting a long time for the recall of files during a restore, you can recall files manually prior to a restore by
running the following RMAN command:

RESTORE ... PREVIEW RECALL

This command produces the following results:


1. RMAN generates a list of the files that are required for the restore.
2. RMAN sends the list of files to the Oracle RMAN agent.
3. The Oracle RMAN agent recalls all the backup pieces from the list that are in the cloud tier.
If a file from the list is already in the active tier, the Oracle RMAN agent performs no action related to the file.

RMAN crosscheck and deletion of backup data in the cloud


An RMAN crosscheck or deletion operates on a backup piece file that is created by the Oracle RMAN agent, whether the file exists on the
Data Domain system (active tier) or in the cloud tier.
The RMAN crosscheck command checks whether a backup piece file exists on the backup media and updates the file information
accordingly in the RMAN catalog. For a backup piece file created by the Oracle RMAN agent, the crosscheck command reports the file
as AVAILABLE when the file exists on the Data Domain system or in the cloud. The crosscheck command does not recall a file that
exists in the cloud; the file remains in the cloud after the crosscheck operation.
An RMAN deletion removes a backup piece file, regardless of the file location. The RMAN deletion removes the file, whether it exists on
the Data Domain system or in the cloud. If the backup piece file exists in the cloud, it is removed from the cloud and can no longer be
recalled from the cloud.

Usage limits on Data Domain resources


The Data Domain administrator can use the Data Domain OS commands or the Data Domain Administration GUI to set limits on capacity
or streams usage:
• Capacity refers to the amount of hard drive capacity that the Oracle RMAN agent uses on the Data Domain host.
NOTE: Capacity limits are based on the used logical space. Logical space depends on how much data is written to a
storage unit before deduplication. Logical capacity is the size of the uncompressed data. For example, when a 1 GB
file is written twice to the same storage unit that was initially empty, then the storage unit has a logical size of 2 GB
but a physical size of 1 GB.
• Streams refers to the number of DD Boost streams that the Oracle RMAN agent uses to read data from a storage unit or write data
to a storage unit on the Data Domain host.
The Data Domain OS supports soft limits and hard limits on capacity or streams usage:
• When a soft limit is exceeded, the Data Domain host generates an alert, and if a tenant-unit notification list is configured, sends an
email to the addresses on the list. An application can continue to use more of the limited resource after a soft limit is exceeded.
• When a hard limit is exceeded, an application cannot use any more of the limited resource.
The Data Domain documentation provides details on the Data Domain versions that support the soft and hard limits for capacity or
streams.
The Data Domain administrator can create a separate storage unit for each Oracle RMAN agent host or for a set of hosts that will be
limited.
For example, to limit the storage unit capacity used by each Oracle RMAN agent host, where there are 10 Oracle RMAN agent hosts, the
Data Domain administrator must create at least 10 storage units. If the Data Domain administrator creates fewer storage units, you must
group the Oracle RMAN agent hosts and assign each group of hosts to a storage unit. In this case, you cannot limit the amount of storage

100 Configuring the Oracle RMAN Agent for Stand-alone Deployment


that will be consumed by each host. One of the Oracle RMAN agent hosts could consume 100% of a storage unit resource. The resources
are consumed on a first come, first served basis.

Oracle RMAN agent operations with Data Domain usage


limits on capacity
At the start of a backup, the Oracle RMAN agent cannot determine how much capacity will be required for the backup. The Oracle RMAN
agent always tries to perform a requested backup when the destination device has any available space or storage capacity.
A capacity limit can be set on a storage unit. When the capacity soft limit is exceeded during a backup, alerts appear in the Current
Alerts pane in the Data Domain Administration GUI.
If the storage unit is part of a tenant-unit with a notification list, the Data Domain host sends an email to the addresses on the list. The
Data Domain administrator and the Oracle RMAN agent user should be included in the list.
The backup or restore operation continues without any adverse impact when the capacity soft limit is exceeded. The Oracle RMAN agent
does not generate any warning or error message in its log file or operational output.
When the capacity hard limit of a storage unit is exceeded during a backup, the Oracle RMAN agent terminates the backup and generates
a message to inform the user about the lack of space on the storage unit.

Oracle RMAN agent operations with Data Domain usage


limits on streams
When the stream soft limit is exceeded during a backup and the storage unit is part of a tenant-unit with a notification list, the Data
Domain host sends an email to the addresses on the list. The Data Domain administrator and the Oracle RMAN agent user should be
included in the list.
Alerts appear in the Current Alerts pane in the Data Domain Administration GUI when the soft limit is exceeded, whether or not the
storage unit is part of a tenant-unit.
The backup or restore operation continues without any adverse impact when the stream soft limit is exceeded. The Oracle RMAN agent
does not generate any warning or error message in its log file or operational output.
When the stream hard limit is exceeded during an operation, the Oracle RMAN agent terminates the operation with a message to inform
the user that a higher streams limit is required. The method for displaying and logging messages is Oracle-specific.

Configuring usage limits on Data Domain resources


You must complete the required procedures on the Data Domain host to configure the capacity or streams usage limits for the Oracle
RMAN agent. The following topics provide the configuration details. Additional following topics provide guidelines and best practices
related to the capacity or streams usage limits on Oracle systems.

Configuring usage quota on Data Domain capacity


To configure a capacity usage quota for the Oracle RMAN agent, the Data Domain administrator must set the hard capacity limit for the
storage unit that the Oracle RMAN agent uses for backups.

Steps
1. Determine which Oracle RMAN agent hosts will use the storage unit.
2. Determine how much capacity to allow for the storage unit.
3. Create the storage unit, and then set the capacity quota in the GUI or the CLI command. The Data Domain documentation provides
more details.
4. Provide the Oracle RMAN agent users with the DD hostname, storage unit name, username, and password of the storage unit to be
used for backups.
The Data Domain administrator can also set the soft capacity quota for the storage unit, which triggers alerts and notifications but
does not limit the capacity usage.
The Data Domain administrator can use the Data Domain OS commands or the Data Domain Administration GUI to add or modify the
capacity quota of storage units. The Data Domain documentation provides more details.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 101


CAUTION: Use caution when decreasing a capacity quota. When a storage unit is almost full and the capacity quota
is decreased, the next backup might fail. Notify the Oracle RMAN agent users when a capacity quota is decreased so
that the users can evaluate the potential impact on backups.

Configuring usage limits on Data Domain streams


A storage unit can have soft and hard limits for streams. Soft limits can be set both individually for read, write, and replication streams, and
collectively for the total number of all types of streams. A hard limit can be set only for the total number of all types of streams.

About this task


To configure a streams usage limit for a storage unit, the Data Domain administrator must set the hard limit for the storage unit that the
Oracle RMAN agent uses for backups.

Steps
1. Determine which Oracle RMAN agent hosts will use the storage unit.
2. Determine how many backup and restore streams to allow for the storage unit.
3. Create the storage unit. You can set the streams limit as part of the ddboost storage-unit create command or (after the
storage unit is created) with the ddboost storage-unit modify command. The Data Domain documentation provides more
details.
NOTE: A streams limit cannot be set in the Data Domain Administration GUI.

4. Provide the Oracle RMAN agent users with the DD hostname, storage unit name, username, and password of the storage unit to be
used for backups.
The Data Domain administrator can also set soft limits for the storage unit, which trigger alerts and notifications but do not limit the
number of streams used.
The Data Domain administrator can use the ddboost storage-unit modify command to modify the streams limits of storage
units. The Data Domain documentation provides more details.
CAUTION: Use caution when setting a streams hard limit. Setting the streams limit to a low value can impact the
backup and restore performance. Decreasing a streams limit can cause a restore to fail. Notify the Oracle RMAN
agent users when a streams limit is decreased so that the users can evaluate the potential impact on backups.

Estimating the Data Domain resource usage on Oracle


systems
The following topics provide additional guidelines and best practices related to the Data Domain resource usage for Oracle systems.

Capacity usage on Oracle systems


If the storage capacity of the Data Domain system is exceeded, the backup operation fails. The Oracle RMAN agent generates the
following type of error message in the operational log:
SBT-10156 2017-04-24 12:12:18 PM sbtwrite2: ddp_write returned error 5194. Unable to write to a
file due to reaching the hard quota limit.

Streams usage on Oracle systems


NOTE: The streams usage varies, depending on the number and type of parallel operations that are performed at a given
time. This topic provides typical numbers for the streams usage of a single operation. To determine more exact
numbers, you must monitor the number of streams that the storage units use over a period of time.
The number of streams that RMAN typically uses for backups, restores, and maintenance operations (such as crosscheck) corresponds to
the number of used channels plus 1.
If the Data Domain system runs out of streams during a backup, the RMAN channel fails with the following type of error message in the
operational log:

102 Configuring the Oracle RMAN Agent for Stand-alone Deployment


SBT-10156 2017-04-24 12:12:18 PM sbtwrite2: ddp_write returned error 5519. Unable to write to a
file because the streams limit was exceeded.
The backup continues and succeeds because RMAN reassigns the backup job to other channels:
RMAN-03009: failure of backup command on CH5 channel at 04/24/2017 16:38:20 ORA-19502: write
error on file "CER4_1sr1pqjo_1_1", block number 33 (block size=8192)
ORA-27030: skgfwrt: sbtwrite2 returned error ORA-19511: Error received from media manager
layer, error text: asdf_output_section1() failed xdr=0x0xb8183f8: bp=0x0xc19c538:
send_len=262144: type=12800: fhand=0x0xc17e688: wrapper=0x(nil): directp=0x0x7f268ad9e000
(1:4:22)
channel CH5 disabled, job failed on it will be run on another channel
If the Data Domain system runs out of streams during a restore, the RMAN channel fails with the following type of error message in the
operational log:
SBT-10156 2017-04-24 12:12:18 PM sbtread2: ddp_read returned error 5519. Unable to read from a
file because the streams limit was exceeded.

Configuring the Oracle RMAN Agent for Stand-alone Deployment 103


5
Data Domain System Administration
NOTE: This chapter applies only to stand-alone deployments on Data Domain systems. For information about
PowerProtect Data Manager and PowerProtect X400 deployments, refer to the PowerProtect Data Manager and
PowerProtect X400 documentation.

Topics:
• Restricting DD Boost access to specific database servers
• File replication version compatibility
• Modifying an interface group

Restricting DD Boost access to specific database


servers
By default, when the DD Boost service is enabled on a Data Domain system, the service is accessible to all database servers. However,
you can use the ddboost access command to override this default, and restrict access to a limited set of database servers.
The following example commands remove the default access permission for all servers and then add new access permissions for two
specific database servers, databaseserver1.datadomain.com and databaseserver2.datadomain.com:

ddboost disable
ddboost access del clients *
ddboost access add clients databaseserver1.datadomain.com databaseserver2.datadomain.com
ddboost enable

These commands establish a set of access controls that enables DD Boost access only to the two specified database servers,
databaseserver1.datadomain.com and databaseserver2.datadomain.com.
If no specific access controls are established, running the ddboost enable command configures the default access control, which
allows all the hosts to access the DD Boost service. However, if there are any access control entries already established, running the
ddboost enable command does not modify the access control list, thus enabling the access controls that are already established.
NOTE:

• Ensure that no backup jobs are running to the Data Domain system when you change the access control. Run the
ddboost disable command to prevent operations while access is changed. Disabling DD Boost disables data
access to all the database servers.
• Specify only a fully qualified domain name, IP address, or resolvable DNS name for the client when you modify the
client access control list.
• If the username is changed or deleted, the change in access rights does not affect any current operations. For
example, deleting the current clients from the DD Boost access list by running the ddboost access del clients
command does not stop a file backup that is already in progress. All operations in progress will continue. The change
in access rights does not cause existing operations to fail.
• Run the ddboost enable command to re-enable DD Boost and enable RMAN operations after changing the access,
which are now subject to the changed access rights.
• When access control is changed on a Data Domain system for a connected RMAN application, RMAN is still able to
perform according to the access rights established at the first connection. The first connection is when the first
RMAN command was invoked by using the Oracle RMAN agent. The next time RMAN is stopped and restarted, the
new access rights are used.

104 Data Domain System Administration


File replication version compatibility
The Data Domain policy of upgrade compatibility for file replication is as follows:
• All the maintenance and patch versions within a family are backward compatible. A family is identified by the first two digits of the
release number, such as 5.1. For example, 5.1.0.0, 5.1.0.2, 5.1.1.0, and 5.1.2.0 are backward compatible.
• File replication is backward compatible across two consecutive release families, such as 5.1 and 5.2.
• File replication over WAN should use the Data Domain ddboost file-replication option to adjust for low bandwidth and long
latency.

Modifying an interface group


About this task
After the interface group is set up, you can add or delete interfaces from the group. The following example shows how to remove an
interface from the configured interface group on the Data Domain system.

Steps
1. Ensure that no jobs are active from RMAN to the Data Domain system on the interface that you wish to remove from the group. You
can do this from the Data Domain system by checking the status of existing connections in the interface group, by running the
following command:

# ddboost show connections

2. Remove the interface from the group on Data Domain system:

# ddboost ifgroup del default 192.168.1.3

After this, the interface 192.168.1.3 is released from the group and is no longer used by the DD Boost storage server for any jobs from
the database servers.
NOTE: Removing the interface registered with RMAN makes the Data Domain system inaccessible to the database
servers. The configuration of the ifgroup on the Data Domain system is not deleted.
To make any changes to any interface that is added to the interface group on the Data Domain system at the network layer, remove
the interface from the group and add it back.
If you make changes by running the net command to modify the interfaces, such as enabling an interface that is configured for
ifgroup, then run the ddboost show connections command to update the load balancing view. This updating enables the
ifgroup to use the interface. show connections on page 118 provides more information.

Removing the advanced load balancing and link failover


configuration
About this task
The following example shows how to remove a configured interface group on the Data Domain system.

Steps
1. Ensure that no jobs are active from RMAN to the Data Domain system. You can do this from the Data Domain system by checking the
status of existing connections in the interface group, by running the following command:

# ddboost show connections

show connections on page 118 provides information about sample output.

2. Ensure that there are no pending jobs from any of the connected database servers to this system.

Data Domain System Administration 105


3. Disable the feature on the Data Domain system:

# ddboost ifgroup disable default

4. Reset the interface group:

# ddboost ifgroup default reset

Results
All the interfaces are released from the group.

106 Data Domain System Administration


6
Troubleshooting
Topics:
• Troubleshooting overview
• Investigating problems
• Oracle limitations
• Reporting problems
• Data Domain system settings for file replication
• Lockbox troubleshooting information
• Failure to load the media management library

Troubleshooting overview
This chapter provides basic troubleshooting tips that can enable you to resolve issues with the product. For issues that cannot be
resolved, contact the contracted support providers.
For more information, see the Data Domain Knowledge Base, which is available at https://support.emc.com.

Investigating problems
NOTE: This topic applies only to Data Domain systems, not PowerProtect Data Manager or PowerProtect X400
systems.
When you investigate a problem, be aware that the DD Boost software has components on both a Data Domain system and an RMAN
system. The two environments must be compatible. The following troubleshooting considerations apply to both systems:
• Supported configurations
Ensure that you have a supported configuration as specified in the eLab Navigator at https://elabnavigator.emc.com/eln/
modernHomeDataProtection. A supported configuration can become unsupported if any component changes.
• Authorization failures
If you encounter authorization failures, ensure that all the systems have correct access credentials for the other systems.

Oracle limitations
Many RMAN functions require specific editions of Oracle. For example, using COPIES 2 or parallelism requires the Enterprise Edition. For
a complete list, refer to the Oracle documentation at http://oracle.su/docs/11g/license.112/e10594/editions.htm.com.
RMAN has numerous restrictions and limitations on how backups can be performed and what can be backed up. The Oracle RMAN agent
can only do backup and restore operations that RMAN supports. For example, control file autobackups are never multiplexed. This means
that if COPIES 2 is used to create a replica of a backup, the control files do not get replicated to the second (destination) Data Domain
system. Using the INCLUDE CURRENT CONTROLFILE option in the backup statement is one possible solution; this includes a copy of
the current control file in a backup piece.

Reporting problems
When reporting a problem to Technical Support, always include the following information:
• The sbtio.log file, which is critical for analysis.
• Output of the RMAN command show all.
• All the RMAN commands that you used.
If possible, delete the sbtio.log file, re-create the problem in as few steps as possible, then capture the sbtio.log file to send with
your problem report. Set the TRACE level to 5 with the CONFIGURE CHANNEL command when you try to re-create the problem.

Troubleshooting 107
RMAN determines where the sbtio.log file is located. The sbtio.log file is usually located in the directory defined by the
user_dump_dest initialization variable or in the $ORACLE_HOME/rdbms/log directory. If all else fails, go to the $ORACLE_HOME
directory and run a find command to locate the file.

Data Domain system settings for file replication


NOTE: This topic applies only to Data Domain systems, not PowerProtect Data Manager or PowerProtect X400
systems.
For all DD OS versions, the replication throttle command controls replication. Setting the throttle too low can lead to file
replication problems. The Data Domain Operating System Administration Guide provides information about using the replication
throttle command to display or control the throttle settings.

Lockbox troubleshooting information


NOTE: This topic does not apply to PowerProtect Data Manager or PowerProtect X400 deployments.

The ddboost.config file is the lockbox file for Oracle RMAN agent. The file contains the saved username/password pairs for the Data
Domain systems that you use. If you connect to system ddr-system as user ddr-user with password user-password, there is a
corresponding entry in the file. The entry specifies that connections to ddr-system are made by using username ddr-user with password
user-password. The lockbox file is encrypted and maintained with the RSA lockbox libraries, which are installed as part of the Oracle
RMAN agent, and hence some of the error strings returned in sbtio.log refer to lockbox.
If you change the hostname of the Data Domain system without changing the hostname in all the scripts and so on, then attempts to
connect to ddr-system fail because there is no host with the specified hostname. If you use the new hostname in all scripts, you can add a
new username-password entry for that hostname to the ddboost.config file. Registering each Data Domain system on page 45
provides instructions.
The ddboost.config file is located in the $RMAN_AGENT_HOME/config directory (Linux or UNIX) or in the %RMAN_AGENT_HOME%
\config directory (Windows).
You cannot reference a lockbox except from the database server where the lockbox was created, unless at the time you created the
lockbox, you set it up to be accessible from multiple servers. Registering a Data Domain system for shared lockbox access on page 48
provides more information.
If you uninstall the boost library, check to see that the old ddboost.config files are deleted. There are four files:
• ddboost.config
• ddboost.config.bak
• ddboost.config.FCD
• ddboost.config.bak.FCD
Deleting the ddboost.config files never causes a problem because the entries will be re-created on demand if you re-run the RMAN
commands that register the Data Domain systems.
Starting with Oracle RMAN agent 4.6, if you want to use an existing lockbox in a non-default directory, you must properly upgrade the
lockbox. Otherwise, any subsequent backup, restore, or query operations fail with one of the following types of error messages:
SBT-5047 08/18/17 09:32:40 error 7501: dd_rman_get_user_info: Unable to open config file '/home/
oracle/opt/dpsapps/rmanagent/config/ddboost.config'. Error: The Lockbox is corrupt and failed
to load.
SBT-5047 08/18/17 09:32:40 error 7501: dd_rman_get_user_info: Unable to open config file
'/u01/app/oracle/product/10.2.0/db_1/config/ddboost.config'. Error: Lockbox tampering was
detected, so it cannot be read.
To use an existing lockbox in a non-default directory, ensure that you perform one of the following upgrade procedures:
• Run the following ddutil -U command to upgrade the lockbox and then copy the existing lockbox files to the default directory,
$RMAN_AGENT_HOME/config or %RMAN_AGENT_HOME%\config. The command must include the complete pathname of the
non-default directory. For example:

ddutil -U -a LOCKBOX_IMPORT=TRUE -a LOCKBOX_PATH=<non-default_lockbox_directory_pathname>


cp <non-default_lockbox_directory_pathname>/ddboost.config* $RMAN_AGENT_HOME/config

108 Troubleshooting
• Copy the existing lockbox files from the non-default directory to the default directory, $RMAN_AGENT_HOME/config or
%RMAN_AGENT_HOME%\config, and then run the following ddutil -U command to upgrade the lockbox:

ddutil -U -a LOCKBOX_IMPORT=TRUE

Failure to load the media management library


About this task
After installation and configuration of the Oracle RMAN agent is completed, attempts to use the Oracle RMAN agent sometimes result in
RMAN failures with the RMAN error message Failed to load Media Management Library as shown in the following RMAN
error report:
RMAN-00571: =====================================
RMAN-00569: ===ERROR MESSAGE STACK FOLLOWS======
RMAN-00571: =====================================
==========================================
RMAN-03009: failure of allocate command on dd0 channel at 01/07/2013 13:40:36
ORA-19554: error allocating device, device type: SBT_TAPE, device name:
ORA-27211: Failed to load Media Management Library
This error usually occurs in an AIX or Linux environment. The error message indicates that RMAN is unable to locate one of the required
libraries, either libddobk.so or libDDBoost.so or another library that is used by these libraries.
The ddutil program can also fail due to an inability to load the required dependent libraries. If this occurs, ensure that the ddutil
program is running from the installation directory of the Oracle RMAN agent. Alternatively, set the RMAN_AGENT_HOME environment
variable to enable the dependent libraries to be found.
If you encounter the preceding RMAN error message in the environment, you can use the following steps to help find the source of the
problem and correct it.

Steps
1. Check that the libddobk.so library pathname was specified correctly in the RMAN configuration command.
Configuring the software on Linux and UNIX systems on page 41 or Configuring the software on Windows systems on page 45
provides more information. If the pathname is not correct, the libddobk.so library cannot be found. Check that libddobk.so
exists in the specified directory and that the directory and library file have appropriate access for the user.
2. Check that the home directory of the Oracle RMAN agent was specified correctly in the RMAN configuration command.
Configuring the software on Linux and UNIX systems on page 41 or Configuring the software on Windows systems on page 45
provides more information. If the directory is not correct, the libDDBoost.so library cannot be found. Check that the lib
subdirectory exists in the home directory of the Oracle RMAN agent, the libDDboost.so library exists in this directory, and the
directory and library file have appropriate access for the user.
3. Run the ldd command on the libddobk.so library to ensure that the libraries that it uses can be found, as shown in the following
example:

Troubleshooting 109
7
Using DD Boost Commands
NOTE: This chapter applies only to Data Domain systems, not PowerProtect X400 systems. For information about the
commands and configuration on PowerProtect X400 integrated storage, refer to the PowerProtect X400
documentation.

Topics:
• DD Boost command summary
• The ddboost command options

DD Boost command summary


The topics in this chapter describe how to use the ddboost command with the following options.

Table 11. Summary of DD Boost commands


access Manage the DD Boost access for clients. access on page 110
clients Enable the encrypted backups and restores over the LAN, and specify the clients on page 111
encryption strength.
destroy Delete all the storage units and their contents from the Data Domain system. destroy on page 111
disable Disable DD Boost. disable on page 111
enable Enable DD Boost. enable on page 111
fc Add or modify the DD Boost over Fibre Channel devices. fc on page 112
file-replication Set, reset, or display the status of the low-bandwidth optimization or encryption file-replication on
option for file replication. Show or reset statistics, history, and performance. page 112
ifgroup For advanced load balancing and link failover, manage the interface group (IP ifgroup on page 115
addresses) on a Data Domain private network that processes the data transfer.
option Set, reset, or display the status of the distributed segment processing feature. option on page 116
reset Delete the DD Boost user, and reset the statistics. Clear all the job connection reset on page 117
counters shown in the output of the ddboost show connections command
in the event that the network connection is lost.
set user-name Set the DD Boost username when DD Boost is enabled. set user-name on
page 117
show Display the DD Boost connections, DD Boost histogram, or statistics. show on page 118
status Show whether DD Boost is enabled or disabled. status on page 119
storage-unit Create and delete a storage unit, or list the storage units and files in a storage unit. storage-unit on page
119

The ddboost command options


The following topics provide details about the purpose of each ddboost command option.

access
Use this command option to manage the DD Boost access for clients.

110 Using DD Boost Commands


ddboost access add clients
ddboost access add clients client-list

Use this command to add clients to the DD Boost access list.

ddboost access delete clients


ddboost access del clients client-list

Use this command to delete clients from the DD Boost access list.

ddboost access reset


ddboost access reset

Use this command to reset the DD Boost client access list to the factory default.

ddboost access show


ddboost access show

Use this command to display the DD Boost client access list.

clients
ddboost clients add <client-list> [encryption-strength {medium | high}]

Administrators use this command to enable encrypted backup and restore over LAN, and specify the encryption strength on a specified
client or group of clients.

destroy
ddboost destroy

Administrators use this command to delete all the storage units and their contents from the Data Domain system. The command
permanently removes all the data (files) contained in the storage units.
You must also manually remove (expire) the corresponding catalog entries.

disable
ddboost disable

Administrators use this command to disable DD Boost for the Data Domain system.

enable
ddboost enable

Administrators use this command to enable DD Boost for the Data Domain system.
Whenever the user, user ID (UID), or group ID (GID) changes, the Data Domain system updates all the files and storage units the next
time that the ddboost enable command is issued.

Using DD Boost Commands 111


fc
The Data Domain Operating System Command Reference Guide provides a full list of ddboost fc commands.

fc group add
ddboost fc group add groupname initiator "initiator_names"

Administrators use this command to grant access to these DD Boost over Fibre Channel devices through an initiator, by adding the
initiator to a ddboost-type scsitarget access group.

fc group modify
ddboost fc group modify groupname device-set count count

Administrators use this command to control the number of DD Boost over Fibre Channel devices advertised to the initiator by configuring
the device-set of the scsitarget access group. The maximum number of supported DD Boost over Fibre Channel devices per Data Domain
system is 64.

file-replication
file-replication option reset
ddboost file-replication option reset {low-bw-optim | encryption}

Administrators use this command to reset the low-bandwidth optimization or encryption to its default value, which is disabled.

file-replication option set


ddboost file-replication option set encryption {enabled | disabled}
ddboost file-replication option set low-bw-optim {enabled | disabled}

This command must be run on both Data Domain systems, the source system and the destination target system. Only an administrator
can specify these options.
Encryption must be enabled on both the source and destination systems.
Low-bandwidth optimization, which is disabled by default, is designed for use on networks with less than 6 Mbps aggregate bandwidth.
Do not use this option if the maximum file system write performance is required.
After you enable low-bandwidth optimization on both systems, both systems must undergo a full cleaning cycle to prepare the existing
data. Run the following command on the source and destination systems:

filesys clean start

The amount of time used by the cleaning cycle depends on the amount of data currently on the Data Domain system.

file-replication option show


ddboost file-replication option show [low-bw-optim | encryption]

Use this command to show whether low-bandwidth optimization and/or encryption is enabled or disabled for file replication.

file-replication reset stats


ddboost file-replication reset stats

Administrators use this command to reset the file-replication statistics when DD Boost is enabled.

112 Using DD Boost Commands


file-replication show active
ddboost file-replication show active

Use this command to display the status of a DD Boost file-replication transfer to a Data Domain system. Prior to DD OS 5.1, this command
only showed the status of DD Boost file-replication transfers outbound from a Data Domain system. With DD OS 5.1, this command also
shows the status of DD Boost file-replication transfers inbound to a Data Domain system.
The low-bandwidth optimization status output indicates either that it is enabled and running, or that it is enabled but there is a
configuration mismatch.

file-replication show detailed-file-history


ddboost file-replication show detailed-file-history [duration duration{day | hr}]

Use this command to display the file-replication history over time. The output is organized by file; it is not cumulative data. You must
specify a duration.
The data for each file name is organized by date, time, and direction (outbound or inbound). Values are given in KB for pre-compressed,
post-filtered, post-low-bw-option, post-compressed, and network data. The last value is an error code; 0 indicates that no error occurred.
The following example provides a description of each column:
• Date: 2010/06/16
• Time: 07:48:22
• Direction: Outbound
• File name: /data/col1/x-ddp1/PEOST_00000001:0000000000:BEOST:4:0::
• Pre-compressed: 3,765,837
• Post-filtered: 30,802
• Post-low-bw-optim: 30,802
• Post-compressed: 17,423
• Network: 65,550
• Error code: 0

file-replication show detailed-history


ddboost file-replication show detailed-history [duration duration{day | hr}] [interval
interval{hr}]

Use this command to display the file-replication history over time. A cumulative history is displayed, as opposed to a view by file name. You
must specify a duration.
Data is organized by date, time, and direction (outbound or inbound). Cumulative values are given in KB for pre-compressed, post-filtered,
post-low-bw-option, post-compressed, and network data. The last value is an error code; 0 indicates no error occurred.

file-replication show file-history


ddboost file-replication show file-history [duration duration{day | hr}]

Use this command to display the data transfer history for inbound and outbound traffic on each file in Data Domain system’s backup
directory for a given duration at a specified interval. The following example shows the inbound and outbound traffic by date and time:
• Amount of pre-compressed data in KB
• Amount of post-compressed data in KB
• Network transfer data in KB
• Low-bandwidth optimization factor
• Number of errors

Using DD Boost Commands 113


Table 12. Inbound and outbound file transfer
Date Time Direction Filename Pre-Comp Post-Comp Network Low-bw- Errors
(KB) (KB) (KB) optim
2009/08/31 15:13:09 Inbound /backup/ 47,738 26,634 27,527 1.32 0
source.tar

2009/08/31 15:13:09 Outbound /backup/ 14,327 8,638 9,034 1.21 0


destin.tar

file-replication show history


ddboost file-replication show history [duration duration{day | hr}] [interval interval{hr}]

Use this command to display the data transfer history between the source and destination (target) Data Domain systems. The following
information is shown for inbound and outbound traffic for a given duration at a specified interval:
• Amount of pre-compressed data in KB
• Amount of post-compressed data in KB
• Network transfer data in KB
• Low-bandwidth optimization factor
• Number of errors

Table 13. Inbound and outbound data transfer


Date Time Direction Pre-Comp Post- Network (KB) Low-bw- Errors
(KB) Comp optim
(KB)
2010/08/31 11:14 Inbound 47,738 26,634 27,527 1.32 0

2010/08/31 11:14:09 Outbound 14,327 8,638 9,034 1.21 0

file-replication show performance


ddboost file-replication show performance [interval sec] [count count]

Use this command to display in real time, for a given duration at a specified interval, the amount of pre-compressed outbound and inbound
data versus the actual network throughput, or post-compressed data.
04/30 11:14:16
Outbound Inbound
Pre-comp Network Pre-comp Network
(KB/s) (KB/s) (KB/s) (KB/s)
--------- --------- --------- ---------
0 0 1644 325
0 0 2901 470
0 0 2430 458
0 0 14390 300
0 0 0 70
0 0 2308 446
0 0 2814 552
0 0 3010 529

file-replication show stats


ddboost file-replication show stats

Use this command to monitor outbound and inbound traffic on a Data Domain system during replication. The compression ratio increases
when low-bandwidth optimization is enabled.
Direction: Outbound
Network bytes sent: 88,383,976
Pre-compressed bytes sent: 436,874,240
Bytes after filtering: 153,080,417

114 Using DD Boost Commands


Bytes after low-bw-optim: 145,547,868
Bytes after local compression: 83,628,271
Compression ratio: 4.9

Direction: Inbound
Network bytes received: 88,383,976
Pre-compressed bytes received: 436,874,240
Bytes after filtering: 153,080,417
Bytes after low-bw-optim: 145,547,868
Bytes after local compression: 83,628,271
Compression ratio: 4.9

ifgroup
The ifgroup option specifies an interface group.

ifgroup add interface


ddboost ifgroup add interface group-name {interface ipaddr | client host}

Use this command to add an interface, client, or both to the group-name or default group. Prior to adding an interface, you must create
the group-name unless the group name is the default group.
NOTE: The group-name “default” is created during an upgrade of a fresh install and is always used if group-name is not
specified.
Additionally, the IP address must be configured on the Data Domain system and its interface must be enabled. You can add public or
private IP addresses for data transfer connections. After adding an IP address as an interface, you must enable advanced load balancing
and link failover.
The Data Domain Operating System Administration Guide provides more information about interface groups.

ifgroup create group-name


ddboost ifgroup create group-name

Use this command to create a group with the name group-name for the interface. You can use the command option on a single node and
on a master node in a Global Deduplication Array (GDA).
The group-name can contain the characters ^, [0-9, a-z, A-Z],* $, underscore(_), and hyphen (-). Hostnames and fully qualified
hostnames can be used. You can specify wildcard hostnames, as indicated by an asterisk (*). Reserved group names that cannot be used
are: default, all, none.

ifgroup del interface


ddboost ifgroup del group-name {interface ipaddr | client host}

Use this command to remove an interface, client, or both from the group-name or default group. Deleting the last IP address interface
disables the ifgroup. If this is the case, you have the option of terminating this command option.

ifgroup destroy group-name


ddboost ifgroup destroy group-name

Use this command to destroy the group name. Only empty groups can be destroyed. Interfaces or clients cannot be destroyed, but can be
removed sequentially or by using the command option ddboost ifgroup reset group-name.

NOTE: The group-name default cannot be destroyed.

ifgroup disable group-name


ddboost ifgroup disable group-name

Using DD Boost Commands 115


Use this command to disable a specific group by entering the group-name. If group-name is not specified, the command applies to the
default group.

ifgroup enable group-name


ddboost ifgroup enable group-name

Use this command to enable the group specified by group-name. If group-name is not specified, the command enables the default group.

ddboost ifgroup rename


ddboost ifgroup rename source-group-name destination-group-name

Use this command to rename the ifgroup source-group-name to destination-group-name. This command option does not require disabling
of the group.

ifgroup reset group-name


ddboost ifgroup reset group-name

Use this command to reset the group specified by group-name. If group-name is not specified, the command disables the default group.

ifgroup show config


ddboost ifgroup show config {interfaces | clients | groups | all} group-name

Use this command to display the selected configuration options. If no selection is made, all the information about the specified group-
name is displayed.
If group-name is not specified, all the information about the default group is displayed. Specify the all option to view the configuration
options of all the groups. All users can specify this command option.

ifgroup status group-name


ddboost ifgroup status group-name

Use this command to display the status of link aggregation, as enabled or disabled. The status is displayed for all the groups unless group-
name is specified. All users can specify this command option.

option
option reset distributed-segment processing
ddboost option reset distributed-segment processing

Administrators use this command to reset the distributed segment processing to the default option, which is enabled.

option set distributed-segment processing


ddboost option set distributed-segment-processing {enabled | disabled}

Administrators use this command to enable or disable the distributed segment processing feature on the DD OS. By default, it is enabled
for DD OS 5.1. If this feature presents any problem for a database server, use this command to disable the feature on the Data Domain
system.
Distributed segment processing is supported only if the feature is enabled on the Data Domain system.
NOTE:

• Distributed segment processing is enabled by default in DD OS 5.1.

116 Using DD Boost Commands


• If a system is upgraded from DD OS 4.9 to DD OS 5.0 and the boost option was disabled before the upgrade, then
the distributed-segment-processing option is disabled after the upgrade.

option show distributed-segment processing


ddboost option show distributed-segment-processing

Use this command to show whether the distributed segment processing option is enabled or disabled.

option reset virtual-synthetics


ddboost option reset virtual-synthetics

Use this command to reset the virtual synthetics to the default option, which is disabled. Virtual synthetics is supported on single-node
configurations and DD Extended Retention systems only.

option set virtual-synthetics {enabled | disabled}


ddboost option set virtual-synthetics {enabled | disabled}

Use this command to enable or disable the virtual synthetics feature on the DD OS. Virtual synthetics is supported on single-node
configurations and DD Extended Retention systems only.

option show virtual-synthetics


ddboost option show [virtual-synthetics]

Use this command to display the status of the virtual synthetics, as enabled or disabled. All users can run this command.

reset
reset stats
ddboost reset stats

Administrators use this command for either of the following purposes:


• To reset all the statistics when DD Boost is enabled.
• As a network recovery procedure to clear job connections after the network connection has been lost.

reset user-name
ddboost reset user-name username

Use this command to delete and reset the DD Boost username.

NOTE: This command is deprecated. It is recommended that you use the ddboost user unassign command instead.

set user-name
ddboost set user-name user-name

Use this command to set the DD Boost username when DD Boost is enabled.

Using DD Boost Commands 117


show
show connections
ddboost show connections

Use this command to display the following information:


• Number of active clients, and for each active client:
○ Client’s name.
○ Whether or not the client is idle (yes/no).
○ Number of installed CPUs.
○ Amount of memory in MiB.
○ Version number of Installed Oracle RMAN agent.
○ Name and version of the operating system.
○ Oracle version number.
○ RMAN version number.
• Number of connections that a system uses for DD Boost, and whether these connections are spread across interfaces by using
advanced load balancing and link failover. The following sample shows the output for client connections.
• Number of connections used for a given group, even when the interface has been removed from the ifgroup.
• Overview of interfaces available for DD Boost.

show histogram
ddboost show histogram

Use this command to display a DD Boost histogram for the Data Domain system.

Table 14. Output definitions for DD Boost histogram


OPER Name of the operation request sent from a DD Boost client to the Data Domain system.
mean Mathematical mean time for completion of the operations, in milliseconds (ms).
std-dev Standard deviation for the time to complete operations, derived from the mean time, in ms.
<1ms Number of operations that took less than 1 ms.
<5ms Number of operations that took between 1 ms and 5 ms.
<10ms Number of operations that took between 5 ms and 10 ms.
<100ms Number of operations that took between 10 ms and 100 ms.
<1s Number of operations that took between 100 ms and 1 second.
<10s Number of operations that took between 1 second and 10 seconds.
>10s Number of operations that took more than 10 seconds.
total Total time taken for a single operation, in ms.
max Maximum time taken for a single operation, in ms.
min Minimum time taken for a single operation, in ms.

show stats
ddboost show stats [interval seconds] [count count]

Use this command to display the output of the previous show stats command, the number of bytes written to and read from files
contained in storage units, and the number of files created and deleted from storage units. The number of errors encountered for each
operation is also displayed. Optionally, you can display the statistics for a specific number of seconds. The count displays the number of
lines equal to the count value.

118 Using DD Boost Commands


If distributed segment processing is enabled, the number of bytes transferred through distributed segment processing and the amount of
compression achieved is displayed.

show user-name
ddboost show user-name

Use this command to display the default DD Boost user if one is configured, or otherwise display that there is no default user.

NOTE: This command is deprecated. It is recommended that you use the ddboost user show command instead.

status
ddboost status

Use this command to determine whether DD Boost is enabled or disabled.

storage-unit
storage-unit create
ddboost storage-unit create storage_unit_name [quota-soft-limit n {MiB|GiB|TiB|PiB}] [quota-
hard-limit n {MiB|GiB|TiB|PiB}]

Use this command to create a storage unit and set limits. The mtree command description in the Data Domain Operating System
Command Reference Guide provides details on quota limits. If the quota feature is not enabled, the quota is created but a message
appears stating that the feature is disabled and limits are not enforced, as shown in Example 2. The quota command description in the
Data Domain Operating System Command Reference Guide provides details.
Quotas can cause OpenStorage backup applications to report non-intuitive sizes and capacities. The Knowledge Base article 85210,
available on the Support portal, provides details.

Example 1
ddboost storage-unit create SU_1 quota-soft-limit 793 GiB quota-hard-limit 1078 GiB

Created storage-unit SU_1


quota-soft-limit: 793 GiB, quota-hard-limit: 1078 GiB

Example 2
ddboost storage-unit create SU_2 quota-soft-limit 1586 GiB

** Quota is disabled. Quota limits are not enforced.


Created storage-unit SU_2
quota-soft-limit: 1586 GiB, quota-hard-limit: N/A

storage-unit delete
ddboost storage-unit delete storage-unit-name

Administrators use this command to delete a specified storage unit and all of its contents. You must also manually remove (expire) the
corresponding catalog entries.

storage-unit show
ddboost storage-unit show [compression] [storage-unit-name]

Using DD Boost Commands 119


Use this command to display the names of all the storage units or, optionally, the names of all the files in a specified storage unit.
To display the compression for all the storage units (the original byte size, global compression, and local compression for all storage units),
use the compression option.

NOTE: To interrupt the output of this command, press Ctrl+C.

120 Using DD Boost Commands


A
Installation and Configuration Checklist
Topics:
• Configure the Data Domain system
• Download and install the Oracle RMAN agent
• Configure RMAN for the environment
• Test the installation by using sbttest (optional)
• Backup examples

Configure the Data Domain system


About this task
Configuring the Data Domain System for Stand-alone Oracle RMAN Agent Deployments on page 24 provides details about the following
steps.

Steps
1. Add the DD Boost license.
2. Establish the server name, username, and password for the Data Domain system.
NOTE: The server name, username, and password must exactly match what is used in the send command of Step 2
in Configure RMAN for the environment on page 121.

3. Enable DD Boost.
4. Create a logical storage unit, as described in Creating storage units on page 26.
5. Enable the distributed segment processing.
6. Check the connectivity. (Can I ping the DDR server name from the backup server?) Ensure that the firewall is not blocking ports.

Download and install the Oracle RMAN agent


About this task
Configuring the Oracle RMAN Agent for Stand-alone Deployment on page 35 provides details about the following steps.

Steps
1. Download the Oracle RMAN agent software.
2. Complete the software installation and setup procedures.

Configure RMAN for the environment


About this task
Configuring the Oracle RMAN Agent for Stand-alone Deployment on page 35 provides details about the following steps.

Steps
1. Run the command CONFIGURE CHANNEL DEVICE TYPE 'SBT_TAPE'.
Configuring the software on Linux and UNIX systems on page 41 or Configuring the software on Windows systems on page 45 provide
more information. Ensure that the PARMS option is set correctly.

Installation and Configuration Checklist 121


2. Run the command ALLOCATE CHANNEL.
Registering each Data Domain system on page 45 provides more information. Set the library, and run the send command to set the
server name, username, and password. The server name, username, and password must match exactly what is used in step 2 in
Configure the Data Domain system on page 121.

3. Run the command CONFIGURE DEFAULT DEVICE TYPE 'SBT_TAPE'.


Registering each Data Domain system on page 45 provides more information.

Test the installation by using sbttest (optional)


Oracle provides the sbttest command as a diagnostic tool. Before you run sbttest with the Oracle RMAN agent, set the following
system environment variables by using the same values as required for the PARMS option in step 1 of Configure RMAN for the
environment on page 121:
• ORACLE_HOME
• RMAN_AGENT_HOME
• BACKUP_HOST
• STORAGE_UNIT

Linux example
export ORACLE_HOME=/oracle_home
export BACKUP_HOST=MyDDR
export STORAGE_UNIT=MyStorageUnitName
sbttest MyFileName -trace MyTraceFileName -libname <ddboost_directory>/lib/libddobk.so

Backup examples
RMAN> backup copies 2 database format '%u_%p', '<destination_system>/%u_%p' filesperset=1;

RMAN> backup database format '%u_%p';

122 Installation and Configuration Checklist


B
Performing a Backup with Oracle Enterprise
Manager
Topics:
• Example screens

Example screens

Figure 9. Login window

Figure 10. Database instance page

Performing a Backup with Oracle Enterprise Manager 123


Figure 11. Processing page

Figure 12. Schedule Customized Backup: Options page

Figure 13. Schedule Customized Backup: Schedule page

124 Performing a Backup with Oracle Enterprise Manager


Figure 14. Schedule Customized Backup: Review page

Figure 15. Execution page

Performing a Backup with Oracle Enterprise Manager 125


C
Installing and Configuring the Oracle RMAN
Agent
Topics:
• Installation and configuration examples

Installation and configuration examples


Extraction of Oracle RMAN agent software package
The following command and output provide an example of the software extraction for the Oracle RMAN agent on Linux. You must run the
tar -xvf <file_name> command to extract the Oracle RMAN agent files from the tar file.

tar -vxf ddrman194_linux_x86_64.tar


./
./readme.txt
./license.txt
./libddobk.so
./ddutil
./install.sh
./uninstall.sh
./libLockbox.so
./libEnshroud-OpenSSL.so
./libDDBoost.so
./rman_agent.cfg
./ddbmcon
./ddbmoim
./libddboravalidate.so
./libssl.so.1.0.0
./libcrypto.so.1.0.0
./libddvdisk.so
./adm-agent-19.4.0.rpm

Oracle RMAN agent installation


The following command and output provide an example of the Oracle RMAN agent installation, in which the install.sh script guides
the user through the process. The directory RMAN_AGENT_HOME:/home/oracle1/rman_agent_home has been selected. The
Oracle RMAN agent is being installed for the first time on the system, which has no previous installations of pre-19.4 Oracle RMAN agent
software.

./install.sh
Do you want to install under the default installation directory /home/oracle/opt/dpsapps/
rmanagent? (y or n)
y
The lib directory /home/oracle/opt/dpsapps/rmanagent/lib is created.
The config directory /home/oracle/opt/dpsapps/rmanagent/config is created.
The bin directory /home/oracle/opt/dpsapps/rmanagent/bin is created.
The log directory /home/oracle/opt/dpsapps/rmanagent/logs is created.
The breadcrumbs directory /home/oracle/opt/dpsapps/rmanagent/breadcrumbs is created.
Installing the Oracle RMAN agent.
Copying the lockbox libraries to /home/oracle/opt/dpsapps/rmanagent/lib/.
Copying libddobk.so to /home/oracle/opt/dpsapps/rmanagent/lib/.
Copying libDDBoost.so to /home/oracle/opt/dpsapps/rmanagent/lib/.
Copying ddutil to /home/oracle/opt/dpsapps/rmanagent/bin/.
Copying the dependency libraries to /home/oracle/opt/dpsapps/rmanagent/lib/.

126 Installing and Configuring the Oracle RMAN Agent


Copying the configuration file to /home/oracle/opt/dpsapps/rmanagent/config/.
Copying the ddbmcon program to /home/oracle/opt/dpsapps/rmanagent/bin/.
Creating the lockbox.
Successfully installed the Oracle RMAN agent.
Environment variable ORACLE_HOME is not defined.
Installation is completed.

Oracle RMAN agent installed files


The following command and output provide an example of the Oracle RMAN agent files that were installed:
• The shared library libddobk.so and its dependent libraries were installed under the $RMAN_AGENT_HOME/lib directory.
• The ddutil binary was installed under the $RMAN_AGENT_HOME/bin directory.
• The config directory was created for the lockbox.

NOTE: Currently, there is no lockbox because this is a new installation.


• The logs directory was created for the ddutil program logs.

/opt/dpsapps/rmanagent> ls -alR
.:
total 28
drwxr-xr-x 7 oracle oradba 4096 2018-02-01 12:00 .
drwxr-xr-x 3 oracle oradba 4096 2018-02-01 12:00 ..
drwxrwxrwx 2 oracle oradba 4096 2018-02-01 12:00 bin
drwxrwxrwx 2 oracle oradba 4096 2018-02-01 12:00 breadcrumbs
drwxrwxrwx 2 oracle oradba 4096 2018-02-01 12:00 config
drwxrwxrwx 2 oracle oradba 4096 2018-02-01 12:00 lib
drwxrwxrwx 2 oracle oradba 4096 2018-02-01 12:00 logs

./bin:
total 23836
drwxrwxrwx 2 oracle oradba 4096 2018-02-01 12:00 .
drwxr-xr-x 7 oracle oradba 4096 2018-02-01 12:00 ..
-rwxr-xr-x 1 oracle oradba 22697509 2018-02-01 12:00 ddbmcon
-rwxr-xr-x 1 oracle oradba 1666061 2018-02-01 12:00 ddutil

./breadcrumbs:
total 8
drwxrwxrwx 2 oracle oradba 4096 2018-02-01 12:00 .
drwxr-xr-x 7 oracle oradba 4096 2018-02-01 12:00 ..

./config:
total 20
drwxrwxrwx 2 oracle oradba 4096 2018-02-01 12:00 .
drwxr-xr-x 7 oracle oradba 4096 2018-02-01 12:00 ..
-rw-rw-r-- 1 oracle oradba 3334 2018-02-01 12:00 ddboost.config
-rw-rw-r-- 1 oracle oradba 4 2018-02-01 12:00 ddboost.config.FCD
-r-xr-xr-x 1 oracle oradba 1947 2018-02-01 12:00 rman_agent.cfg

./lib:
total 27500
drwxrwxrwx 2 oracle oradba 4096 2018-02-01 12:00 .
drwxr-xr-x 7 oracle oradba 4096 2018-02-01 12:00 ..
-rwxr-xr-x 1 oracle oradba 2998084 2018-02-01 12:00 libcrypto.so.1.0.0
-rwxr-xr-x 1 oracle oradba 3520368 2018-02-01 12:00 libDDBoost.so
-rwxr-xr-x 1 oracle oradba 6713824 2018-02-01 12:00 libddboravalidate.so
-rwxr-xr-x 1 oracle oradba 1690051 2018-02-01 12:00 libddobk.so
-rwxr-xr-x 1 oracle oradba 9965056 2018-02-01 12:00 libddvdisk.so
-rwxr-xr-x 1 oracle oradba 2498081 2018-02-01 12:00 libEnshroud-OpenSSL.so
-rwxr-xr-x 1 oracle oradba 206659 2018-02-01 12:00 libLockbox.so
-rwxr-xr-x 1 oracle oradba 495171 2018-02-01 12:00 libssl.so.1.0.0

./logs:
total 8
drwxrwxrwx 2 oracle oradba 4096 2018-02-01 12:00 .
drwxr-xr-x 7 oracle oradba 4096 2018-02-01 12:00 ..

Installing and Configuring the Oracle RMAN Agent 127


Registration of the Data Domain user
The following commands and output provide an example registration of a Data Domain user with the Data Domain server. This example
shows the registration of the Data Domain user q_ost with password 4U2build to enable access to the storage unit rman_oracle on the
Data Domain server test-data-domain.emc.com. The registration is required for each separate storage unit that is used with the
same Oracle host and Data Domain system.

RMAN> connect target *


2>
3> RUN {
4> ALLOCATE CHANNEL CH1 TYPE 'SBT_TAPE' TRACE 5 PARMS
5> 'BLKSIZE=1048576,
6> SBT_LIBRARY=/home/oracle/opt/dpsapps/rmanagent/lib/libddobk.so,
7> ENV=(BACKUP_HOST=test-data-domain.emc.com,
8> RMAN_AGENT_HOME=/home/oracle/opt/dpsapps/rmanagent/)';
9> send 'set username qa_ost password 4U2build servername test-data-domain.emc.com
storageunit rman_oracle';
10> RELEASE CHANNEL CH1;
11> }
12>
13>
14>
connected to target database: orcl (DBID=1040017416)

using target database control file instead of recovery catalog


allocated channel: CH1
channel CH1: SID=25 device type=SBT_TAPE
channel CH1: Data Domain Boost API

sent command to channel: CH1

released channel: CH1

Recovery Manager complete.

Oracle RMAN agent lockbox files


The following command and output provide an example of the lockbox files that were created after the registration.

~/opt/dpsapps/rmanagent/config> ls -al
total 20
drwxrwxrwx 2 oracle oradba 4096 2018-02-01 12:00 .
drwxr-xr-x 7 oracle oradba 4096 2018-02-01 12:00 ..
-rw-rw-r-- 1 oracle oradba 3334 2018-02-01 12:00 ddboost.config
-rw-rw-r-- 1 oracle oradba 4 2018-02-01 12:00 ddboost.config.FCD
-r-xr-xr-x 1 oracle oradba 1947 2018-02-01 12:00 rman_agent.cfg

Oracle RMAN agent channel configuration and backup


The following commands and output provide an example of the channel configuration that is required to run backups and a subsequent
backup operation.

Recovery Manager: Release 11.2.0.1.0 - Production on Thu Feb 1 13:03:53 2018

Copyright (c) 1982, 2009, Oracle and/or its affiliates. All rights reserved.

RMAN> connect target *


2> connect catalog *
3>
4> RUN {
5> ALLOCATE CHANNEL CH1 TYPE 'SBT_TAPE' TRACE 5 PARMS
6> 'BLKSIZE=1048576, SBT_LIBRARY=/home/oracle/opt/dpsapps/rmanagent/lib/libddobk.so,
ENV=(STORAGE_UNIT=rman_agent, BACKUP_HOST=test-data-domain.emc.com, RMAN_AGENT_HOME=/home/
oracle/opt/dpsapps/rmanagent/)';
7> BACKUP FORMAT './rman/%U_%p_%t' DATABASE;
8> RELEASE CHANNEL CH1;

128 Installing and Configuring the Oracle RMAN Agent


9> }
10>
connected to target database: orcl (DBID=1040017416)

connected to recovery catalog database

allocated channel: CH1


channel CH1: SID=58 device type=SBT_TAPE
channel CH1: Data Domain Boost API

Starting backup at 01-FEB-18


channel CH1: starting full datafile backup set
channel CH1: specifying datafile(s) in backup set
input datafile file number=00001 name=/mnt/oracle/orcl/system_1/system.data1
input datafile file number=00006 name=/mnt/oracle/orcl/system_1/system.data2
input datafile file number=00002 name=/mnt/oracle/orcl/system_1/sysaux.dbf
input datafile file number=00003 name=/mnt/oracle/orcl/undo_1/undo.data1
input datafile file number=00005 name=/mnt/oracle/orcl/system_1/cattbs.dbf
input datafile file number=00004 name=/mnt/oracle/orcl/orcl/orcl.data1
channel CH1: starting piece 1 at 01-FEB-18
channel CH1: finished piece 1 at 01-FEB-18
piece handle=./rman/lgsq4uhs_1_1_1_966949436 tag=TAG20180201T130356 comment=API Version
2.0,MMS Version 19.3.0.0
channel CH1: backup set complete, elapsed time: 00:00:03
Finished backup at 01-FEB-18

Starting Control File Autobackup at 01-FEB-18


piece handle=c-1040017416-20180201-07 comment=API Version 2.0,MMS Version 19.3.0.0
Finished Control File Autobackup at 01-FEB-18

released channel: CH1

Recovery Manager complete.

Installing and Configuring the Oracle RMAN Agent 129


D
Oracle RMAN Agent Command Reference
Topics:
• The ddbmoim command and options
• The ddutil command and options

The ddbmoim command and options


You can run the ddbmoim command with the appropriate command options as the Oracle user on Linux to perform the mount, unmount,
backup, cleanup, and restore operations for Oracle Incremental Merge backups. The option --dbname <database_name> is mandatory,
where <database_name> is the Oracle SID of the database. In an Oracle RAC environment, replace <database_name> with the local
instance name of the database.
If you set any parameters in the Oracle Incremental Merge configuration file, you must include the -z <configuration_file_path> option on
the ddbmoim command line; otherwise, you can omit the -z <configuration_file_path> option. For every other option, you can either
specify the option on the command line or set the corresponding parameter setting in the Oracle Incremental Merge configuration file. The
operation being performed determines which other options or parameters are mandatory.
NOTE: The command-line options take precedence over the parameter settings in the configuration file. Setting the
configuration file parameters on page 69 provides details about the configuration file parameters.
The ddbmoim command options in curly braces ({ }) are mandatory. The command options in brackets ([]) are optional:

ddbmoim {--dbname <database_name>} {-c <client_hostname>} {-d <Data_Domain_server_name>} [-D


<debug_level>] {-m <mount_path>} {-o {full|incr|arch|ctl|livemount|livemount-cleanup|mount|
unmount|proxy-restore|restore|cleanup}} {-s <storage_unit_name>} {-t <backup_tag>} [-z
<configuration_file_path>] {-a BACKUP_PATH=<dir_path>} {-a BOOSTFS_INSTALL_DIR=<dir_path>} [-
a DELETE_ARCHIVELOG={FALSE|TRUE}] [-a DELETE_ARCHIVELOG_NUM_DAYS=<number_of_days>] [-a
FORCE_LIVEMOUNT_CLEANUP={FALSE|TRUE}] [-a NFS_MOUNT={FALSE|TRUE}] [-a
ORACLE_BASE_PATH=<dir_path>] {-a ORACLE_HOME=<pathname>} [-a ORACLE_VERSION_11G={FALSE|TRUE}]
[-a PARALLELISM=<number>] [-a RETENTION=<value>] {-a RMAN_AGENT_HOME=<dir_path>} [-a
RMAN_CATALOG_SERVICE=<service_name>] [-a RMAN_CATALOG_USER=<username>] [-a
SCRIPT_PATH=<script_path>] [-a SET_NEW_DBNAME=<new_database_name>] [-a SYSBACKUP={FALSE|
TRUE}] [-a TEMP_DATABASE_PATH=<dir_path>] [-a TEMP_SNAPSHOT_PATH=<dir_path>] [-a
TNS_ADMIN=<dir_path>]

The following table describes the ddbmoim command options and the corresponding parameters that you can set in the configuration file.
To obtain a list of all the available command options, run the command ddbmoim --help or ddbmoim -h.
Examples of ddbmoim commands for Oracle Incremental Merge operations on page 83 provides more information about ddbmoim
commands for the supported Oracle Incremental Merge operations.

Table 15. The ddbmoim command options for Oracle Incremental Merge operations
Command option Description Default and valid values
-c <client_hostname> Mandatory if you do not set the CLIENT Values of <client_hostname>:
parameter in the configuration file.
• Undefined (default).
Specifies the hostname of the local client to • Valid hostname of the local client.
use to store the backups on the Data
Domain system.

NOTE: Use the same client name


setting for each node in an Oracle
RAC environment.

CLIENT is the corresponding parameter in


the configuration file.

130 Oracle RMAN Agent Command Reference


Table 15. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values
-d <Data_Domain_server_name> Mandatory if you do not set the Values of
BACKUP_HOST parameter in the <Data_Domain_server_hostname>:
configuration file.
• Undefined (default).
Specifies the hostname of the Data Domain • Valid hostname of the Data Domain
server to use for backups. server.

BACKUP_HOST is the corresponding


parameter in the configuration file.

-D <debug_level> Optional. Values of <debug_level>:

Specifies the level of debug messages that • 0 (default) = Debug messages are not
the Oracle Incremental Merge operation generated.
generates. • 1 to 9 = Debug messages are written to
the debug log file. The level of detail in
DEBUG_LEVEL is the corresponding the generated debug messages
parameter in the configuration file. increases with the debug level. The
debug log file name is
ddbmoim_<operation_type>.*.*.log, for
example,
ddbmoim_full.14928.1567760357.log.

-m <mount_path> Mandatory if you do not set the Values of <mount_path>:


MOUNT_PATH parameter in the
• Undefined (default).
configuration file.
• Valid mount path of Data Domain
Specifies the Data Domain BoostFS mount BoostFS.
path on which the MTree is mounted.

NOTE: The Oracle user must have


permissions for the read, write, and
execute operations on the mount
path. The mount path must be the
same for all operations. Do not
change the mount path once it is
set.

MOUNT_PATH is the corresponding


parameter in the configuration file.

-o [full|incr|arch|ctl|livemount| Mandatory if you do not set the • full = Creates a full backup copy of the
livemount-cleanup|mount|unmount| OPERATION parameter in the configuration database, archive logs, and control file.
proxy-restore|restore|cleanup] file. • arch = Backs up the archive logs and
Specifies the type of Oracle Incremental control file.
Merge operation that is performed. • cleanup = Removes the copies of any
failed backups.
OPERATION is the corresponding • ctl = Backs up the control file only.
parameter in the configuration file. • incr = Backs up the changed data
blocks, archive logs, and control file.
• livemount = Performs a live mount
restore that uses the ddbmoim
command.
• livemount-cleanup = Removes the live
mounted database after a live mount
restore that uses the ddbmoim
command.
• mount = Mounts the Data Domain
storage unit on the mount path
specified by the -m option or

Oracle RMAN Agent Command Reference 131


Table 15. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values

MOUNT_PATH parameter, by using a


BoostFS FUSE mount operation.
• proxy-restore = Performs a proxy
restore that uses the ddbmoim
command.
• restore = Restores the backup by using
the RMAN restore script specified by
the -a SCRIPT_PATH option or
SCRIPT_PATH parameter.
• unmount = Unmounts the Data Domain
storage unit by using a BoostFS FUSE
mount operation.

-s <storage_unit_name> Mandatory if you do not set the Values of <storage_unit_name>:


STORAGE_UNIT parameter in the
• Undefined (default).
configuration file.
• Valid directory name of the storage unit
Specifies the name of the storage unit or a on the Data Domain system, without
top-level directory within the storage unit the /data/col1 prefix. The name is
on the Data Domain system. case-sensitive.

STORAGE_UNIT is the corresponding


parameter in the configuration file.

-t <backup_tag> Mandatory if you do not set the OIM_TAG Values of <backup_tag>:


parameter in the configuration file.
• Undefined (default).
Specifies the tag that is applied to the • Tag that is applied to the backup copies,
backup copies. for example, INCR_MERGE.

NOTE: The backup tag is used when


the incrementally updated backups
are applied to full backups, to
identify which incremental backups
apply to which working image
copies. The backup tag must be the
same for the full and incremental
backups.

OIM_TAG is the corresponding parameter


in the configuration file.

-z <configuration_file_path> Mandatory if you set any parameters in the Values of <configuration_file_path>:


configuration file as described in Setting the
• Undefined (default).
configuration file parameters on page 69.
• Valid complete pathname of the Oracle
Specifies the pathname of the configuration Incremental Merge configuration file.
file that contains the parameter settings for
the Oracle Incremental Merge operations.

NOTE: If you do not set any


parameters in a configuration file,
you can omit this option.

-a BACKUP_PATH=<dir_path> Mandatory if you do not set the Values of <dir_path>:


BACKUP_PATH parameter in the
• Undefined (default).
configuration file for a live mount or proxy
• Valid directory pathname of the
restore that uses the ddbmoim command.
incremental or full backup.
Specifies the directory pathname of the
incremental or full backup to be restored.

132 Oracle RMAN Agent Command Reference


Table 15. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values

BACKUP_PATH is the corresponding


parameter in the configuration file.

-a BOOSTFS_INSTALL_DIR= Mandatory if you do not set the Values of <dir_path>:


<dir_path> BOOSTFS_INSTALL_DIR parameter in
• Undefined (default).
the configuration file.
• Valid complete pathname of the Data
Specifies the installation directory of the Domain BoostFS installation directory.
Data Domain BoostFS plug-in.

BOOSTFS_INSTALL_DIR is the
corresponding parameter in the
configuration file.

-a DELETE_ARCHIVELOG={FALSE| Optional. • FALSE (default) = The archive log is not


TRUE} deleted.
Specifies whether to delete the archive log
after it is backed up. • TRUE = The archive log is deleted.

DELETE_ARCHIVELOG is the
corresponding parameter in the
configuration file.

-a Optional. Values of <number_of_days>:


DELETE_ARCHIVELOG_NUM_DAYS=<nu
mber_of_days> Specifies to delete the archive log when it is • Undefined (default). The archive log is
older than the specified number of days. not deleted, unless the -a
DELETE_ARCHIVELOG option or
DELETE_ARCHIVELOG_NUM_DAYS is the DELETE_ARCHIVELOG_NUM_DAYS
corresponding parameter in the parameter is set to TRUE.
configuration file. • Integer number of days. The archive log
is deleted after the number of days.

-a NFS_MOUNT={FALSE|TRUE} Optional. • TRUE (default) = Use an NFS mount


for the live mount or proxy restore.
Specifies whether to use an NFS mount or
a BoostFS mount for a live mount or proxy • FALSE = Use a BoostFS mount for the
restore with the ddbmoim command. live mount or proxy restore.

NSF_MOUNT is the corresponding


parameter in the configuration file.

-a ORACLE_BASE_PATH= Mandatory if you do not set the Values of <dir_path>:


<dir_path> ORACLE_BASE_PATH parameter in the
• Undefined (default).
configuration file for a live mount or proxy
• Valid base pathname of the Oracle
restore that uses the ddbmoim command.
installation directory.
Specifies the base pathname of the Oracle
installation directory.

ORACLE_BASE_PATH is the corresponding


parameter in the configuration file.

-a ORACLE_HOME=<pathname> Mandatory if you do not set the Values of <pathname>:


ORACLE_HOME parameter in the
• Undefined (default).
configuration file.
• Valid complete pathname of the Oracle
Specifies the pathname of the Oracle installation directory.
installation directory.

ORACLE_HOME is the corresponding


parameter in the configuration file.

Oracle RMAN Agent Command Reference 133


Table 15. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values
-a ORACLE_VERSION_11G= Mandatory if you do not set • FALSE (default) = Oracle database is
{FALSE|TRUE} ORACLE_VERSION_11G to TRUE in the not version 11.
configuration file when the Oracle database • TRUE = Oracle database is version 11.
is version 11.

Specifies whether the Oracle database is


version 11.

NOTE: Ensure that this option is


set to TRUE before you perform an
Oracle Incremental Merge
operation with an Oracle 11
database.

ORACLE_BASE_PATH is the corresponding


parameter in the configuration file.

-a PARALLELISM=<number> Optional. Values of <number>:

Specifies the number of channels that • 4 (default).


RMAN allocates in parallel for the backup. • Integer number of channels.

PARALLELISM is the corresponding


parameter in the configuration file.

-a RETENTION=<value> Optional. Values of <value> :

Specifies the retention policy as the length • Undefined (default).


of time that RMAN retains the backup • Integer number plus one of the
copies. following values, surrounded by double
quotes:
A retention lock is applied for a backup
when the storage unit is retention enabled ○ decade
and this option is specified. ○ year
○ quarter
NOTE: Do not set any type of
○ month
Oracle retention policy, such as
○ fortnight
redundancy based or recovery
○ week
window based. You must use the
○ day
ddutil commands for backup
○ hour
deletion, as described in Using the
○ minute
ddutil command to list and delete
○ min
the backups on page 84.
○ seconds
RETENTION is the corresponding ○ sec
parameter in the configuration file.
For example: -a RETENTION="4 month".
NOTE: The minimum setting is "12
hour". The maximum setting is "70
year".

-a RMAN_AGENT_HOME=<dir_path> Mandatory if you do not set the Values of <dir_path> :


RMAN_AGENT_HOME parameter in the
• $HOME/opt/dpsapps/rmanagent
configuration file.
(default).
Specifies the installation directory of the • Valid complete pathname of the Oracle
Oracle RMAN agent. RMAN agent installation directory.

RMAN_AGENT_HOME is the corresponding


parameter in the configuration file.

-a RMAN_CATALOG_SERVICE= Optional. Values of <service_name> :


<service_name>

134 Oracle RMAN Agent Command Reference


Table 15. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values

Specifies the Net service or Easy Connect • Undefined (default).


name of the RMAN catalog database. • Valid Net service or Easy Connect name
of the RMAN catalog database.
To ensure that the specified name is
correct, run the following command at the
command line:

rman catalog
<RMAN_catalog_username>/
<password>@<RMAN_catalog_ser
vice_name>

RMAN_CATALOG_SERVICE is the
corresponding parameter in the
configuration file.

-a RMAN_CATALOG_USER= Mandatory if you do not set the Values of <username>:


<username> RMAN_CATALOG_USER parameter but the
• Undefined (default).
RMAN catalog database is used and either
• Valid username of the RMAN catalog
the -a RMAN_CATALOG_SERVICE option
database.
is specified or the
RMAN_CATALOG_SERVICE parameter is
set.

Specifies the username of the RMAN


catalog database.

RMAN_CATALOG_USER is the
corresponding parameter in the
configuration file.

-a SCRIPT_PATH=<script_path> Mandatory for a restore if you do not set Values of <script_path>:


the SCRIPT_PATH parameter in the
• Undefined (default).
configuration file.
• Valid complete pathname of the restore
Specifies the pathname of the restore script.
script.

SCRIPT_PATH is the corresponding


parameter in the configuration file.

-a SET_NEW_DBNAME= Mandatory for a live mount or proxy restore Values of <new_database_name>:


<new_database_name> to a new database name.
• Undefined (default).
Specifies the new database name for the • Valid new database name for the live
live mount or proxy restore. mount or proxy restore operation.

NOTE: If you do not specify the


new database name, then the live
mount or proxy restore operation is
performed with the same backed-
up database name.

SET_NEW_DBNAME is the corresponding


parameter in the configuration file.

-a SYSBACKUP={FALSE|TRUE} Optional. Specifies whether to use • FALSE (default) = RMAN is connected


SYSBACKUP or SYSDBA for the RMAN by using SYSDBA.
connection. • TRUE = RMAN is connected by using
SYSBACKUP is the corresponding SYSBACKUP.
parameter in the configuration file.

Oracle RMAN Agent Command Reference 135


Table 15. The ddbmoim command options for Oracle Incremental Merge operations (continued)
Command option Description Default and valid values
-a TEMP_DATABASE_PATH= Mandatory if you do not set Values of <dir_path>:
<dir_path> TEMP_DATABASE_PATH in the
• Undefined (default).
configuration file for a live mount or proxy
• Valid pathname of a temporary
restore operation that uses the ddbmoim
directory.
command.

Specifies the pathname of a temporary


directory that will be used during the live
mount or proxy restore.

TEMP_DATABASE_PATH is the
corresponding parameter in the
configuration file.

-a TEMP_SNAPSHOT_PATH= Mandatory if you do not set Values of <dir_path>:


<dir_path> TEMP_SNAPSHOT_PATH in the
• Undefined (default).
configuration file for a force cleanup
• Valid pathname of the temporary
operation to be performed after a live
snapshot directory that was used during
mount restore that uses the ddbmoim
the live mount restore.
command.

Specifies the pathname of the temporary


snapshot directory that was used during
the live mount restore.

TEMP_SNAPSHOT_PATH is the
corresponding parameter in the
configuration file.

-a TNS_ADMIN=<dir_path> Optional. Values of <dir_path>:

Specifies the directory pathname of the • Undefined (default).


Oracle Net configuration files. • Valid complete pathname of the
directory that contains the Oracle Net
TNS_ADMIN is the corresponding configuration files. This value must the
parameter in the configuration file. same as the Oracle parameter
TNS_ADMIN setting.

The ddutil command and options


You can use the ddutil command with appropriate command options to display information about Oracle RMAN agent and the backups
that Oracle RMAN agent performs. You can also use the ddutil command to delete and prune the Oracle RMAN agent backups, and
perform specific upgrade and registration operations.
For PowerProtect Data Manager operations with Oracle RMAN agent, the root user can run the ddutil -v command to verify the
connectivity from the ddbmcon program to the Oracle database.
You can use the ddutil command for the following purposes:
• Display information about the Oracle RMAN agent.
• Display the database ID for a specified database name for Oracle Incremental Merge backups.
• Display information about Oracle RMAN agent backups, including Oracle Incremental Merge backups.
• Delete the specified Oracle RMAN agent backups, including Oracle Incremental Merge backups.
• Upgrade the lockbox.
• Register a Data Domain system.
• Verify the connectivity from the ddbmcon program to the Oracle database.
An Oracle DBA user can run the ddutil command with appropriate options to perform the following display, delete, and prune
operations. The ddutil options enclosed in brackets ([ ]) are optional:

136 Oracle RMAN Agent Command Reference


• Display information about the installed version of the Oracle RMAN agent:

ddutil -i

• Display the database ID for a specified database name (SID) for Oracle Incremental Merge backups:

ddutil -O oim -n list_dbid -a DB_HOSTNAME=<Oracle_hostname> -a DB_NAME=<SID> -z


<Data_Domain_hostname_or_IP>:/<storage_unit>

NOTE: Use the database ID obtained from the ddutil -O oim -n list_dbid command in other ddutil -O oim
commands that you run to list and delete the Oracle Incremental Merge backups.
• Display information about Oracle RMAN agent backup files (not for Oracle Incremental Merge backups) at the individual file level,
directory level, or storage unit level:

ddutil [-f] -z <hostname>:<storage_unit> [-F {asc|desc} | -T {asc|desc}] [-b <start_time>]


[-e <end_time>] [-R] [-t] [-D <debug_level>] [<pathname1> [<pathname2>]...[<pathname><n>]]

NOTE: The default operation of the ddutil command is the display of backup information. If you run the ddutil
command with no options other than the mandatory -z option, the command displays all the backup files that are
located directly under the storage unit.
• Delete the specified Oracle RMAN agent backup files and directories (not for Oracle Incremental Merge backups):

ddutil -d -z <hostname>:<storage_unit> [-c] [-x] [-D <debug_level>] [<pathname1>


[<pathname2>]...[<pathname><n>]]

• Prune (delete) the Oracle RMAN agent backup files and directories within a save time range (not for Oracle Incremental Merge
backups):

ddutil -k -z <hostname>:<storage_unit> [-b <start_time>] [-e <end_time>] [-c] [-R] [-x] [-


D <debug_level>] [<pathname1> [<pathname2>]...[<pathname><n>]]

• Display information about Oracle Incremental Merge backups at the full, archive log, or control file level that are stored on the specified
Data Domain storage unit:

ddutil -O oim -n {full|arch|ctl|tagfile} [-b "<start_time>"] [-e "<end_time>"] -f [-l] -z


<Data_Domain_hostname_or_IP>:/<storage_unit> <Oracle_host>/<database_ID>

NOTE: The -l option lists the details of the available files.


• Delete the specified Oracle Incremental Merge backup files that are stored on the specified Data Domain storage unit:

ddutil -O oim -n {full|arch|ctl} [-b "<start_time>"] [-e "<end_time>"] [-c] -d -z


<Data_Domain_hostname_or_IP>:/<storage_unit> <Oracle_host>/<database_ID>

NOTE:

Use only the ddutil command to delete the Oracle Incremental Merge backups. Do not use the RMAN delete
command or crosscheck command with Oracle Incremental Merge backups.

Use the -c option for a forced deletion. If you do not use the -c option, the delete operation prompts for
confirmation before deleting the backups.
The ddutil program deletes backup files on the Data Domain system but does not delete any information on the database server. The
RMAN DELETE command deletes both the backup on the Data Domain system and the corresponding RMAN catalog record.
The ddutil program user must have permissions to the lockbox as described in Registering each Data Domain system on page 45. The
program uses the DD Boost library for operations, and does not require you to mount the storage unit.
You must run the ddutil command from the original installation location or set the RMAN_AGENT_HOME environment variable to
enable the dependent libraries and lockbox to be found.
As the root user, you can also run the ddutil -v command to verify the connectivity from the ddbmcon program to the Oracle
database, as required for the PowerProtect Data Manager operations with Oracle RMAN agent:

ddutil -v {system|asset|rman}

The following table describes the ddutil command options.

Oracle RMAN Agent Command Reference 137


Table 16. The ddutil command options
Option Description
-b <start_time> Optional. Specifies the start of a time range, in a date and time format. Date and time format
used with the ddutil command options on page 64 provides details about the supported date
and time formats for <start_time>.

Without this option, the earliest backup time is used by default for the start of the time range.

NOTE: The operation terminates with an error if the <start_time> value is later
than the <end_time> value that is specified with the -e option.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -b <start_time> option.

Using the ddutil command to list and delete the backups on page 84 provides examples for
Oracle Incremental Merge backups.

-c Optional. Specifies to suppress prompting during a delete or prune operation. With this option,
the program proceeds to delete or prune the specified backup files without issuing any user
prompts.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -c option.

Using the ddutil command to list and delete the backups on page 84 provides examples for
Oracle Incremental Merge backups.

-C Optional. Specifies to register a Data Domain system with the appropriate lockbox. You must
use specific -a options with the -C option, as described in the following topics:
• Registering a standard Data Domain system on page 45
• Registering a Data Domain system with DD Boost over Fibre Channel on page 47
• Registering the lockbox credentials on page 75

-d Required for a delete operation. Specifies to delete the specified backup files and directories
from the Data Domain system.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -d option.

Using the ddutil command to list and delete the backups on page 84 provides examples for
Oracle Incremental Merge backups.

-D <debug_level> Optional. Generates debugging information during the ddutil command operations, where
<debug_level> is an integer from 0 to 9. This option is used to troubleshoot operational issues.

This option causes the ddutil command to print the debugging information to stderr and to
the operational log file. The higher the integer value, the more log information is produced. The
operational log file also contains the normal operational messages that are printed to stdout.

The operational log file, ddutil_<timestamp>.log, resides in the log subdirectory of the
installation location. For example, the operational log file name has the format ddutil_Wed
May 17 21:49:08 2017.log.

-e <end_time> Optional. Specifies the end of a time range, in a date and time format. Date and time format
used with the ddutil command options on page 64 provides details about the supported date
and time formats for <end_time>.

The option setting -e now specifies the current time, which is the default time value.

NOTE: The operation terminates with an error if the <end_time> value is earlier
than the <start_time> value that is specified with the -b option.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -e <end_time> option.

138 Oracle RMAN Agent Command Reference


Table 16. The ddutil command options (continued)
Option Description

Using the ddutil command to list and delete the backups on page 84 provides examples for
Oracle Incremental Merge backups.

-f Optional. Specifies to display information about the specified backup files and directories that
were created or modified within the specified time range on the Data Domain system. This
display operation is the default operation of the ddutil command.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -f option.

Using the ddutil command to list and delete the backups on page 84 provides examples for
Oracle Incremental Merge backups.

-F {asc|desc} Optional. Specifies to list the backup files in either ascending or descending alphabetical order:
• The -F asc option displays the files in ascending alphabetical order, based on the file
pathnames.
• The -F desc option displays the files in descending alphabetical order, based on the file
pathnames.

You must specify the -f and -z options with the -F asc or -F desc option. You can
optionally specify the -b, -e, -R, -t, and <pathname><n> options with the -F asc or -F
desc option.

NOTE: The -F and -T options are mutually exclusive. You can use either option
but not both in the same ddutil command.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -F {asc|desc} option.

-H Optional. Specifies to register a Data Domain system for shared lockbox access.

Registering a Data Domain system for shared lockbox access on page 48 provides examples of
using the ddutil command with the -H option.

-i Optional. Displays information about the installed version of the Oracle RMAN agent. For
example:

ddutil -i
RMAN Agent Version: 19.4.0.0(21)

-k Mandatory for a prune operation. Specifies to prune (delete) the specified backup files that
were created or modified within the specified time range on the Data Domain system.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -k option.

-O oim Mandatory for Oracle Incremental Merge backup operations. Specifies to display information
about the specified Oracle Incremental Merge backups or delete the specified backups,
depending on the other command options on the ddutil -O oim command line:
• To display the database ID for a specified database name (SID), use the added options -n
list_dbid, -a DB_HOSTNAME, -a DB_NAME, and -z.
• To display the information about full, archive log, or control file backups that are stored on
the specified Data Domain storage unit, use the added options -f, -n {full|arch|ctl|
tagfile}, and -z. The -b "<start_time>", -e "<end_time>", and -l options
are optional. Use the -l option to list the details of the available files.
• To delete the specified backup files that are stored on the specified Data Domain storage
unit, used the added options -d, -n {full|arch|ctl}, and -z. The -b
"<start_time>", -e "<end_time>", and -c options are optional. Use the -c option
for a forced deletion without prompting.

Oracle RMAN Agent Command Reference 139


Table 16. The ddutil command options (continued)
Option Description
Using the ddutil command to list and delete the backups on page 84 provides examples of the
different ddutil -O oim commands for Oracle Incremental Merge backup operations.

-R Optional. Specifies to perform the operation on the backup files in every subdirectory.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -R option.

-t Optional. Specifies to include the cloud tier information in the backup file and directory
information that a display operation produces.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -t option.

-T {asc|desc} Optional. Specifies to list the backup files in either ascending or descending time order:
• The -T asc option displays the files in ascending time order, from the oldest backup to
the newest backup.
• The -T desc option displays the files in descending time order, from the newest backup
to the oldest backup.

You must specify the -f and -z options with the -T asc or -T desc option. You can
optionally specify the -b, -e, -R, -t, and <pathname><n> options with the -T asc or -T
desc option.

NOTE: The -T and -F options are mutually exclusive. You can use either option
but not both in the same ddutil command.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -T {asc|desc} option.

-U Mandatory for upgrading the lockbox. After the Oracle RMAN agent installation, if you want to
use an existing lockbox in a non-default directory, you must upgrade the lockbox through
either of the following procedures:
• Run the following ddutil -U command to upgrade the lockbox and then copy the
existing lockbox files to the default directory, $RMAN_AGENT_HOME/config. The
command must include the complete pathname of the non-default directory. For example:

ddutil -U -a LOCKBOX_IMPORT=TRUE -a LOCKBOX_PATH=<non-


default_lockbox_directory_pathname>
cp <non-default_lockbox_directory_pathname>/ddboost.config*
$RMAN_AGENT_HOME/config

• Copy the existing lockbox files from the non-default directory to the default directory,
$RMAN_AGENT_HOME/config, and then run the following ddutil -U command to
upgrade the lockbox:

ddutil -U -a LOCKBOX_IMPORT=TRUE

CAUTION: If you do not run the appropriate ddutil -U command to upgrade the
existing lockbox, any subsequent backup, restore, and query operations will fail
with an error message.

-v Optional. Specifies to test the connectivity to the Oracle database as required for the
PowerProtect Data Manager operations with Oracle RMAN agent. The root user must run the
ddutil -v command with the added option system, asset, or rman:
• The ddutil -v system command performs system verification, which verifies the
connectivity to the Oracle instances.
• The ddutil -v asset command performs asset verification, which verifies the ability
to read the Oracle database objects.

140 Oracle RMAN Agent Command Reference


Table 16. The ddutil command options (continued)
Option Description

• The ddutil -v rman command performs RMAN verification, required only if you use an
RMAN catalog. The command tests whether the ddbmcon program can connect to the
target database and catalog database through an RMAN script, as required to perform an
active deletion of Oracle backups.
The PowerProtect Data Manager for Oracle RMAN Agent User Guide provides information
about the PowerProtect Data Manager operations with Oracle RMAN agent.
-x Optional. Specifies to delete all the empty directories during a delete or prune operation.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -x option.

-z <hostname>:<storage_unit> Mandatory for display, delete, and prune operations. Specifies the hostname of the Data
Domain system, followed by a colon, a forward slash (/), and the storage unit name. For
example:

-z dd_host1:/dd_storage_unit1

NOTE: The hostname can be a DFC server name if you must run the ddutil
command over Fibre Channel.

Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the -z <hostname>:<storage_unit> option.

Using the ddutil command to list and delete the backups on page 84 provides examples for
Oracle Incremental Merge backups.

<pathname1> Optional. Specifies the pathnames of the files or directories for display or deletion. For each
<pathname2>...<pathname><n> specified directory, the operation is performed on all the files in the directory. When -R is
included, the operation processes all the subdirectories of each directory. Without -R, the
operation does not process any subdirectories.

The following guidelines apply to the pathnames in a ddutil command:

• The pathnames must be the last options on the command line. No other types of options,
such as -R or -c, can appear after the pathnames.
• When no pathnames are specified, the operation occurs only at the level of the storage
unit root directory.
• When a pathname starts with a forward slash (/), the storage unit name must appear after
the slash.
• When a pathname does not start with a slash (/), the pathname is assumed to be located
directly under the storage unit.
For example, when the storage unit is named su1, the pathnames /su1/dir1 and dir1
both specify the directory dir1 under the storage unit.

The wildcard character * is supported in pathnames, and represents any number of


unspecified characters.
Subtopics under Display and deletion of backups on page 61 provide examples of using the
ddutil command with the <pathname1> <pathname2>...<pathname><n> option.

Oracle RMAN Agent Command Reference 141

You might also like