HP XP7 Replication Manager Application Agent CLI Reference Guide (TK981-96014, May 2014)
Table Of Contents
- Application Agent CLI Reference Guide
- Preface
- 1 Extended commands
- Overview of extended commands
- Before reading the extended command descriptions
- Extended command specifications (File system backups)
- Extended command specifications (Common commands)
- EX_DRM_BACKUPID_SET (Generates a backup ID file)
- EX_DRM_CG_DEF_CHECK (Checks the contents of a copy-group list file)
- EX_DRM_DB_EXPORT (Exports backup information to a file)
- EX_DRM_DB_IMPORT (Imports backup information from a file)
- EX_DRM_FTP_GET (Acquires a backup information file from the backup server)
- EX_DRM_FTP_PUT (Transfers a backup information file to the backup server)
- EX_DRM_HOST_DEF_CHECK (Checks the contents of a host environment settings file)
- EX_DRM_RESYNC (Resynchronizes a copy group)
- Extended command specifications (Tape-related commands)
- Extended command specifications (SQL Server database backups)
- EX_DRM_SQL_BACKUP (Backs up an SQL Server database)
- EX_DRM_SQL_DEF_CHECK (Checks the contents of an operation definition file and automatically creates a temporary directory)
- EX_DRM_SQL_RESTORE (Restores an SQL Server database backup to the primary volume)
- EX_DRM_SQL_TLOG_BACKUP (Backs up the transaction log of the SQL Server)
- EX_DRM_SQLFILE_EXTRACT (Deploys SQL Server metafiles to the folder to be backed up to a tape device)
- EX_DRM_SQLFILE_PACK (Saves SQL Server metafiles)
- Extended command specifications (Exchange database backups)
- EX_DRM_EXG_BACKUP (Backs up an Exchange database)
- EX_DRM_EXG_DEF_CHECK (Checks the contents of an operation definition file and automatically creates a temporary directory)
- EX_DRM_EXG_RESTORE (Restores an Exchange database backup to the primary volume)
- EX_DRM_EXG_VERIFY (Verifies the consistency of an Exchange database)
- 2 Basic commands
- List of basic commands
- Before reading the basic command descriptions
- Basic command specifications (File system backups)
- Basic command specifications (Common commands)
- drmappcat (Views catalog information on a host)
- drmcgctl (Locks or unlocks a copy group)
- drmclusinit (Registers the parameters for the cluster software)
- drmdbexport (Exports backup information to a file)
- drmdbimport (Imports backup information from a file)
- drmdevctl (Conceals and reveals a physical volume)
- drmhostinfo (Displays host information)
- drmresync (Resynchronizes copy groups)
- Basic command specifications (Tape-related commands)
- drmmediabackup (Backs up data from a secondary volume to a tape device)
- drmmediarestore (Restores data from a tape device to a secondary volume)
- drmmount (Mounts a secondary volume)
- drmtapecat (Displays or deletes backup information in a backup catalog)
- drmtapeinit (Registers parameters for a backup management product)
- drmumount (Unmounts secondary volumes)
- Basic command specifications (Utility commands)
- Basic command specifications (SQL Server database backups)
- drmsqlbackup (Backs up an SQL Server database to a secondary volume)
- drmsqlcat (Displays backup information for an SQL Server database)
- drmsqldisplay (Displays or updates information for an SQL Server database)
- drmsqlinit (Registers parameters for SQL Server)
- drmsqllogbackup (Backs up the transaction log of an SQL Server)
- drmsqlrecover (Recovers restored SQL Server databases)
- drmsqlrecovertool (Recovers restored SQL Server databases via a GUI)
- drmsqlrestore (Restores SQL Server databases from backups to a primary volume)
- Basic command specifications (Exchange database backups)
- drmexgbackup (Backs up an Exchange database)
- drmexgcat (Displays backup information for an Exchange database)
- drmexgdisplay (Displays or updates information for an Exchange database)
- drmexgrestore (Restores an Exchange database backup to the primary volume)
- drmexgverify (Verifies the consistency of an Exchange database)
- 3 Support and other resources
- Index
If you omit this option, the extended command terminates with an error without mounting if the following
condition also holds: the copy group name, LDEV number, and SERIAL number of the primary volume,
which were obtained when the file server or database server was backed up, do not match the
information on the file server or database server.
Specify this option when you need to forcibly mount a secondary volume using only the copy group
name of the primary volume as a key. Examples include cases when the secondary volume is to be
replaced because of a failure or other reason, or when an LDEV number or SERIAL number was
changed. Data might be lost if you specify this option for a normal backup operation.
-bup_env configuration-definition-file-name
Specify this option if you want to use a startup parameter in a user-created configuration definition
file when backing up to or restoring from a tape device.
If you omit this option, the default configuration definition file is used. As such, you will need to create
the default configuration definition file in advance.
Create the configuration definition file in the same directory as the default configuration definition
file. For further information, see the description of configuration definition file creation in the HP XP7
Replication Manager Application Agent CLI User Guide.
The specified configuration definition file name must fulfill the following requirements:
Maximum number of characters (total length of the directory name and file name): 255 bytes
Available characters: Characters that can be used for file names in Windows
Return Values
0: Normal termination
Any value other than 0: Termination with an error
Conditions Causing an Error
This extended command fails in the following cases:
• An invalid option is specified.
• The system cannot acquire information from the definition file linked to the operation ID.
• The arguments of this extended command include an option of an Application Agent command
that cannot be used for this extended command.
• Information cannot be acquired from the backup ID file.
• A command executed inside the extended command encounters an error.
• The acquisition of the result of a command executed inside the extended command fails.
• Information cannot be acquired from the host environment settings file.
• No storage directory for extended-command temporary files is specified in the operation definition
file.
• The command fails to obtain the name of the directory where dictionary map files are stored.
Examples
• In this example, the extended command is used to back up the secondary volume as a raw device,
based on the settings in the operation definition file operation01:
EX_DRM_TAPE_BACKUP operation01 -exopt -raw
Application Agent CLI Reference Guide 43