Sending options with the send command

Edit online

Use the Oracle RMAN send command in an RMAN script to pass IBM Storage Protect™ options to the IBM Storage Protect API.

Before you begin

To send options from the IBM Storage Protect to the IBM Storage Protect API, you must specify the send command in an RMAN script.

About this task

Use the send command to set IBM Storage Protect options such as TCPServeradddress and TCPport to the IBM Storage Protect API. You can customize the actions that the script takes without updating the existing Data Protection for Oracle or IBM Storage Protect API options files. Any option that is sent through the send command overrides the option that is specified in the Data Protection for Oracle or IBM Storage Protect API options files.
  • You can specify multiple IBM Storage Protect API options in the same send command.
  • The ENABLELANFREE and DEDUPLICATION options are mutually exclusive. If both options are defined, client-side data deduplication does not occur.
  • The ENABLECLIENTENCRYPTKEY and DEDUPLICATION options are also mutually exclusive. If both options are defined, client-side data deduplication does not occur.
  • You can specify any IBM Storage Protect API option with the send command.

Procedure

Specify the send command in an RMAN script. You can specify one or more IBM Storage Protect options in a send command string. The send command string can contain up to 512 bytes.
To back up an Oracle database to the IBM® Storage Protect server named halley at TCP/IP port 1601, and to enable the cache for client-side data deduplication for only channel t1, specify the following statements in an RMAN script: 
allocate channel t1 type 'SBT_TAPE';
SEND channel 't1' '-TCPSERVER=halley -TCPPORT=1601 -ENABLEDEDUPCACHE=YES';

Results

Data Protection for Oracle passes the command string to the IBM Storage Protect API. The IBM Storage Protect API validates the contents of the string. If an invalid entry is detected, the API issues an ANS****E message to Data Protection for Oracle. The message returns an error condition to Oracle RMAN and stops processing.
You can specify any IBM Storage Protect API option that typically goes into the dsm.opt file and the following client system options (dsm.sys):
  • ENABLECLIENTENCRYPTKEY
  • ENABLELANFREE
  • TCPSERVERADDRESS
  • TCPPORT
  • ASNODENAME
  • FROMNODE
  • FROMOWNER
  • FASTQUERYBACKUP
  • E2AOBJNAME
  • ALLOWWILDCARDCH
  • DEDUPCACHEPATH
  • ENABLEDEDUPCACHE
  • EXCLUDE.ENCRYPT
  • FORCEFAILOVER
  • ENABLEARCHIVERETENTIONPROTECTION