HP Application Recovery Manager Reference Guide
HP Application Recovery Manager
software A.06.10
Command line interface reference
Part number: N/A
First edition: March 2008
Legal and notice information
© Copyright 2006, 2008 Hewlett-Packard Development Company, L.P.
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent
with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and
Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard
commercial license.
The information contained herein is subject to change without notice. The only warranties for HP products
and services are set forth in the express warranty statements accompanying such products and services.
Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for
technical or editorial errors or omissions contained herein.
Intel, Itanium, Pentium, Intel Inside, and the Intel Inside logo are trademarks or registered trademarks of
Intel Corporation or its subsidiaries in the United States and other countries.
Microsoft, Windows, Windows XP, and Windows NT are U.S. registered trademarks of Microsoft
Corporation.
Adobe and Acrobat are trademarks of Adobe Systems Incorporated.
Java is a US trademark of Sun Microsystems, Inc.
Oracle is a registered US trademark of Oracle Corporation, Redwood City, California.
UNIX is a registered trademark of The Open Group.
Contents
Publication history ................................................................ 7
About this guide ................................................................... 9
Reference page organization ................................................................................ 9
Intended audience ............................................................................................. 10
Documentation set ............................................................................................. 10
Guides ...................................................................................................... 10
Online help ................................................................................................ 11
Documentation map .................................................................................... 12
Abbreviations ...................................................................................... 12
Map ................................................................................................... 12
Document conventions and symbols ..................................................................... 13
Reference page conventions ................................................................................ 14
General Information ........................................................................................... 15
HP technical support .......................................................................................... 15
Subscription service ........................................................................................... 16
HP websites ...................................................................................................... 16
Documentation feedback .................................................................................... 16
I Section 9: Introduction ...................................................... 17
omniintro .......................................................................................................... 19
II Section 1: User Commands ............................................... 27
omniabort ........................................................................................................ 29
omnib .............................................................................................................. 31
omnicc ............................................................................................................. 35
omnicellinfo ...................................................................................................... 39
omniclus ........................................................................................................... 43
omnidb ............................................................................................................ 47
omnidbsmis ...................................................................................................... 51
omnidbvss ........................................................................................................ 61
omnidbxp ........................................................................................................ 65
omnir ............................................................................................................... 71
Command line interface reference 3
omnistat ........................................................................................................... 85
omniusers ......................................................................................................... 89
III Section 1M: Administrative Commands .............................. 93
dbtool.pl .......................................................................................................... 95
ob2install ......................................................................................................... 99
omnicheck ...................................................................................................... 103
omnidbcheck .................................................................................................. 107
omnidbinit ...................................................................................................... 111
omnidbutil ...................................................................................................... 113
omnidlc .......................................................................................................... 119
omnihealthcheck ............................................................................................. 125
omniinstlic ...................................................................................................... 127
omnimigrate.pl ................................................................................................ 129
omnirsh .......................................................................................................... 133
omnisetup.sh ................................................................................................... 135
omnisv ........................................................................................................... 139
omnitrig ......................................................................................................... 141
util_cmd ......................................................................................................... 143
util_oracle8.pl ................................................................................................. 147
IV Section 5: Miscellaneous ............................................... 151
omnigui ......................................................................................................... 153
4
Tables
Edition history ................................................................................... 71
Documentation map ......................................................................... 122
Document conventions ...................................................................... 133
Command line interface reference 5
6
Publication history
Guide updates may be issued between editions to correct errors or document product
changes. To ensure that you receive updated or new editions, subscribe to the
appropriate product support service. See your HP sales representative for details.
Table 1 Edition history
ProductGuide editionPart number
October 2006T4395-96007
March 2008N/A
Application Recovery Manager Release
A.06.00
Application Recovery Manager Release
A.06.10
Command line interface reference 7
Publication history8
About this guide
This guide provides information about:
• Application Recovery Manager command line interface commands, their options,
and usage
This reference guide does not describe concepts, the GUI, or provides details about
the integrations.
The HP Application Recovery Manager software command line interface reference
contains the reference pages for Application Recovery Manager A.06.10 commands.
Reference pages are available on UNIX systems as man pages. For more information
about man pages, refer to the man page for man using the command man man.
The command synopsis for every command is also available using the -help option.
For an introduction to Application Recovery Manager A.06.10 commands, refer to
the Section 9: Introduction(9) reference page.
Reference page organization
The reference pages are divided in specialized sections (volumes), based on the
UNIX man page organization. Each reference page belongs to a volume:
Section 1: User Commands Commands, used by the user.
Section 1M: Administrative Commands Commands, used by the administrator.
Section 5: Miscellaneous A variety of information, such as
information about GUI components,
and more.
Section 9: Introduction Introduction to HP Application
Recovery Manager software.
Command line interface reference 9
All commands in a section are sorted by alphabetical order.
Reference pages are often referred by name and section number in the form
pagename(section).
Intended audience
This guide is intended for administrators with knowledge of:
• Basic operating system commands and utilities
• Command prompt/shell concepts and usage
• Application Recovery Manager backup and restore concepts
The reference pages supplement other Application Recovery Manager documentation
and require good overall knowledge of the product.
Documentation set
Other documents and online Help provide related information.
Guides
Application Recovery Manager guides are available in PDF format. Install the PDF
files during the Application Recovery Manager setup procedure by selecting the
English documentation and Help component on Windows or the OB2-DOCS
component on UNIX. Once installed, the guides reside in the AppRM_home\docs
directory on Windows and in the /opt/omni/doc/C/ directory on UNIX.
You can find these documents from the Manuals page of the HP Business Support
Center website:
http://www.hp.com/support/manuals
In the Storage section, click Storage Software and then select your product.
• HP Application Recovery Manager software installation and licensing guide
This guide describes how to install the Application Recovery Manager software,
taking into account the operating system and architecture of your environment.
This guide also gives details on how to upgrade Application Recovery Manager,
as well as how to obtain the proper licenses for your environment.
• HP Application Recovery Manager software concepts guide
About this guide10
This guide describes Application Recovery Manager zero downtime backup and
instant recovery concepts and provides background information on how
Application Recovery Manager works in a zero downtime backup environment.
It is intended to be used with the task-oriented HP Application Recovery Manager
software administrator's guide and the HP Application Recovery Manager software
integration guide.
• HP Application Recovery Manager software administrator's guide
This guide describes how to configure and use the integration of Application
Recovery Manager with HP StorageWorks Enterprise Virtual Array and HP
StorageWorks Disk Array XP. It is intended for backup administrators or operators.
It covers the zero downtime backup and instant recovery.
• HP Application Recovery Manager software integration guide
This guide describes how to configure and use Application Recovery Manager
to perform zero downtime backup and instant recovery of Oracle, SAP R/3
applications. The guide also describes how to configure and use Application
Recovery Manager to perform backup and instant recovery using the Microsoft
Volume Shadow Copy Service.
• HP Application Recovery Manager software product announcements, software
notes, and references
This guide gives a description of new features of HP Application Recovery
Manager software A.06.10. It also provides information on supported
configurations (platforms and online database integrations, ZDB), required patches,
and limitations, as well as known problems and workarounds. An updated version
of the supported configurations is available at http://www.hp.com/support/
manuals
• HP Application Recovery Manager software command line interface reference
This guide describes the Application Recovery Manager Command Line Interface
commands, their options and usage as well as providing some basic command
line examples.
Online help
Application Recovery Manager provides context-sensitive (F1) Help and Help Topics
for Windows and UNIX platforms.
You can access the online help from the top-level directory on the installation CD
without installing Application Recovery Manager:
•
Windows
: Unzip AppRM_help.zip and open AppRM_help.chm.
Command line interface reference 11
•
UNIX
: Unpack the zipped tar file AppRM_help.tar.gz, and access the online
help system through AppRM_help.htm.
Documentation map
Abbreviations
The guide titles are all preceded by the words “HP Application Recovery Manager
software”.
Map
The following table shows where to find information of different kinds. Shaded squares
are a good place to look first.
Table 2 Documentation map
Online
Help
Getting
started
CLI
Integration
Administrator's
Concepts
Product
Installation
guide
announcements
guide
guide
guide
XXXXBackup
reference
Command line
interface reference
About this guide12
XXXConcepts/Techniques
XX
XXXXInstallation
XXXXInstant recovery
XXXLicensing
XXXXXLimitations
XXPlanning strategy
XXXProcedures/Tasks
XXXXRecommendations
XXXXRequirements
Online
Help
Getting
started
CLI
Integration
Administrator's
Concepts
Product
Installation
guide
announcements
XSupport matrices
guide
guide
guide
reference
Supported
configurations
Document conventions and symbols
Table 3 Document conventions
ElementConvention
Cross-reference links and e-mail addressesBlue text: Table 3 on page 13
website addressesBlue, underlined text: http://www.hp.com
Text emphasisItalic text
• File and directory names
• System output
Monospace text
Monospace, italic text
• Code
• Commands, their arguments, and
argument values
• Code variables
• Command variables
X
XXXTroubleshooting
Emphasized monospace texttext
CAUTION:
Indicates that failure to follow directions could result in damage to equipment or data.
Command line interface reference 13
IMPORTANT:
Provides clarifying information or specific instructions.
NOTE:
Provides additional information.
TIP:
Provides helpful hints and shortcuts.
Reference page conventions
All reference pages follow established section formats, but not all sections are present
in each reference (man) page.
NAME Gives the name of the command and a brief
description of the commands purpose.
SYNOPSIS Describes the syntax of the command.
The command line synopsis is formatted in the
following way:
command -option replaceable [-option2
replaceable...] {-option3 | -option4}
Where:
• Italic strings represent variables that should
be replaced by the user with the appropriate
value.
• Square brackets ([]) indicate that the
argument is optional.
• An ellipsis (...) indicates that the previous
argument can be repeated.
About this guide14
DESCRIPTION A more detailed description of the command.
OPTIONS Detailed descriptions for all options.
NOTES Contains important notes.
EXAMPLES Provides examples on command usage.
SEE ALSO Lists man pages, containing related information.
General Information
General information about Application Recovery Manager can be found at http://
www.hp.com/go/apprm.
• Vertical bars (|) between several arguments
indicate that only one argument from the group
can be specified at once.
Groups can be optional (inside square
brackets) or required (inside curly brackets,
{}).
HP technical support
For worldwide technical support information, see the HP support website:
http://www.hp.com/support
Before contacting HP, collect the following information:
• Product model names and numbers
• Technical support registration number (if applicable)
• Product serial numbers
• Error messages
• Operating system type and revision level
• Detailed questions
Command line interface reference 15
Subscription service
HP recommends that you register your product at the Subscriber's Choice for Business
website:
http://www.hp.com/go/e-updates
After registering, you will receive e-mail notification of product enhancements, new
driver versions, firmware updates, and other product resources.
HP websites
For additional information, see the following HP websites:
• http://www.hp.com
• http://www.hp.com/go/software
• http://www.hp.com/service_locator
• http://www.hp.com/support/manuals
• http://www.hp.com/support/downloads
Documentation feedback
HP welcomes your feedback.
To make comments and suggestions about product documentation, please send a
message to AppRM.DocFeedback@hp.com. All submissions become the property of
HP.
About this guide16
Section 9: Introduction
Command line interface reference 17
Section 9: Introduction18
omniintro
introduction to HP Application Recovery Manager software command utilities
omniintro
DESCRIPTION
Application Recovery Manager is a scalable recovery software solution providing
automated backup and recovery of Exchange, SQL, SAP, and Oracle application
data designed to improve application availability with data recovery in minutes.
COMMANDS
User Commands (1):
omniabort
Aborts an active session.
omnib
Backs up filesystems, disk images, SAP R/3 and Oracle databases, and VSS
writers.
omnicc
Handles the Application Recovery Manager licensing, reports the number of
configured and available Application Recovery Manager licenses, installs the
licenses, imports and exports Application Recovery Manager clients, and manages
access to secured clients.
omnicellinfo
Displays configuration information about the Application Recovery Manager
cell.
omniclus
Manages load balancing in a cluster environment in the event of an application
(Application Recovery Manager or other) failover.
omnidb
Queries the Application Recovery Manager internal database (IDB).
omnidbsmis
Executes administrative tasks required for managing the HP StorageWorks
Enterprise Virtual Array (EVA) Command View.
omnidbvss
Command line interface reference 19
Queries the VSS database; manages, browses, and lists the items of the VSS
database.
omnidbxp
Queries the ZDB database (XPDB), manipulates the XP LDEV exclude file, and
configures the HP StorageWorks Disk Array XP command devices usage.
omnidlc
Gathers or deletes Application Recovery Manager debug, log and getinfo files
from the Application Recovery Manager cell.
omnir
Restores filesystems, disk images, and application databases backed up using
Application Recovery Manager.
omnistat
Displays the status of active Application Recovery Manager backup and restore
sessions.
omniusers
Adds or removes Application Recovery Manager users to or from an existing
Application Recovery Manager user group, or lists the configured Application
Recovery Manager users. It enables you to use all GUI functionality on a Cell
Manager platform on which the GUI is not available, using a GUI installed on
another system.
Administrative Commands (1M):
20
dbtool.pl
Backs up and restores the Application Recovery Manager IDB and configuration.
ob2install
Runs remote client installation, uninstallation, or check of a client from the selected
Installation Server. This command is available on UNIX systems only.
omnicheck
Performs a DNS connections check within an Application Recovery Manager
cell and lists Application Recovery Manager patches installed on Application
Recovery Manager clients.
omnidbcheck
Checks the consistency of the Application Recovery Manager internal database
(IDB). It can only be run on the Cell Manager.
omnidbinit
Initializes the Application Recovery Manager internal database (IDB). It can only
be run on the Cell Manager.
omnidbutil
Handles various Application Recovery Manager internal database (IDB)
maintenance tasks. It can only be run on the Cell Manager.
omnidlc
Gathers or deletes Application Recovery Manager debug, log and getinfo files
from the Application Recovery Manager cell.
omnihealthcheck
Checks the status of Application Recovery Manager services and the consistency
of the Application Recovery Manager internal database (IDB). It can only be run
on the Cell Manager.
omniinstlic
Starts the HP OpenView AutoPass utility or synchronizes the Application Recovery
Manager licenses between Application Recovery Manager and HP OpenView
AutoPass.
omnimigrate.pl
Helps you migrate your existing Cell Manager from a PA-RISC architecture based
HP-UX 11.x system to an HP-UX 11.23 system for the Intel Itanium 2 (IA-64)
architecture.
omnirsh
Returns the hostnames of the physical and virtual nodes for the specified cluster
hostname, or returns the cell information stored in the cell_info file on the specified
cluster.
omnisetup.sh
Installs an Application Recovery Manager UNIX Cell Manager, Installation Server,
or client system locally.
omnisv
Starts, stops or displays the status of Application Recovery Manager daemons
(HP-UX Cell Manager) or services (Windows Cell Manager). It can only be run
on the Cell Manager.
omnitrig
Triggers Application Recovery Manager scheduled backups.
util_cmd
Sets, retrieves or lists the parameters stored in the Application Recovery Manager
Oracle and SAP R/3 configuration files.
util_oracle8.pl
Configures an Oracle database and prepares the environment for backup, and
checks the configuration of an Oracle database.
Return Values
Command line interface reference 21
Possible return values for CLI commands are:
1 Program failed, command syntax error.
2 Program failed, invalid argument.
3 Program failed, internal error.
4 Program failed, reason unknown.
Some CLI may return additional error messages. These are described in individual
reference pages.
GRAPHICAL USER INTERFACE COMMAND ON
WINDOWS
manager
GUI command panel
GRAPHICAL USER INTERFACE COMMAND ON
UNIX
xomni
GUI command panel
DIRECTORY STRUCTURE FOR UNIX Cell Manager
/opt/omni Application Recovery Manager home directory
/etc/opt/omni/server
• Directory containing the following configuration directories:
datalists
backup specifications
barlists
database backup specifications
users
user configuration
22
cell
cell configuration
schedules
backup schedules
barschedules
database backup specification schedules
sessions
data about sessions
options
default options
sg
scripts for Service Guard support
/etc/opt/omni/client
• Directory containing the client configuration directories and files
/opt/omni
• Directory containing the following executables directories:
bin
user Application Recovery Manager commands
lbin
ZDB Agent files and some administrative commands
sbin
Cell Manager and Application Recovery Manager internal database (IDB)
administrative commands
/var/opt/omni
• Directory containing the following directories:
/var/opt/omni/log and /var/opt/omni/server/log
log files
/var/opt/omni/tmp
temporary files
/var/opt/omni/server/sessions
data about sessions
/var/opt/omni/server/db40
• Directory containing the following Application Recovery Manager internal
database (IDB) directories:
Command line interface reference 23
/var/opt/omni/server/db40/datafiles
the IDB tablespaces
/var/opt/omni/server/db40/smisdb
the ZDB database (SMISDB)
/var/opt/omni/server/db40/logfiles
the IDB transaction logs and the obdrindex.dat file
/var/opt/omni/server/db40/msg
the Application Recovery Manager session messages
/var/opt/omni/server/db40/xpdb
the ZDB database (XPDB)
/opt/omni/lib
• Directory containing the following directories:
/opt/omni/lib/nls
message catalogs
/opt/omni/lib/man
Application Recovery Manager man pages
/opt/omni/help/C
the Application Recovery Manager help subsystem
DIRECTORY STRUCTURE FOR WINDOWS Cell
Manager
AppRM_home Application Recovery Manager home directory
AppRM_home\Config\server
• Directory containing the following configuration directories:
datalists
backup specifications
barlists
database backup specifications
users
the user configuration
cell
the cell configuration
24
schedules
backup schedules
barschedules
database backup specification schedules
options
default options
sessions
data about sessions
AppRM_home\Config\client
• Directory containing the client configuration directories and files
AppRM_home\bin
• Directory containing Application Recovery Manager commands, message catalogs
and commands for Cell Manager maintenance.
AppRM_home\log and AppRM_home\log\server
• log files
AppRM_home\tmp
• temporary and debug log files
AppRM_home\db40
• the Application Recovery Manager internal database (IDB)
AppRM_home\db40\datafiles
• the IDB tablespaces
AppRM_home\db40\dcbf
• the IDB Detail Catalog binary files (DCBF)
AppRM_home\db40\logfiles
• the IDB transaction logs and the obdrindex.dat file
AppRM_home\db40\meta
• the Serverless Integrations Binary Files (SIBF) part of the IDB
AppRM_home\db40\msg
• the Application Recovery Manager session messages
AppRM_home\db40\smisdb
• the ZDB database (SMISDB)
AppRM_home\db40\xpdb
Command line interface reference 25
• the ZDB database (XPDB)
AppRM_home\db40\vssdb
• the VSS database (VSSDB)
AppRM_home\help
• the Application Recovery Manager help subsystem
SEE ALSO
dbtool(1M), ob2install(1M), omniabort(1), omnib(1), omnicc(1), omnicellinfo(1),
omnicheck(1M), omniclus(1), omnidb(1), omnidbcheck(1M), omnidbinit(1M),
omnidbsmis(1), omnidbvss(1), omnidbxp(1), omnidlc(1M), manager(5), xomni(5),
omnihealthcheck(1M), omniinstlic(1M), omnimigrate.pl(1M), omnidbutil(1M), omnir(1),
omnirsh(1M), omnisetup.sh(1M), omnistat(1), omnisv(1M), omnitrig(1M), omniusers(1),
util_cmd(1M), util_oracle8.pl(1M)
26
Section 1: User Commands
Command line interface reference 27
Section 1: User Commands28
omniabort
aborts an active session.
omniabort
SYNOPSIS
omniabort -version | -help
omniabort -session SessionID
DESCRIPTION
This command aborts an active session, identifying it by the SessionID. A list of
all active sessions and their session IDs is available using the omnistat command.
OPTIONS
-version
Displays the version of the omniabort command.
-help
Displays the usage synopsis for the omniabort command.
-session SessionID
Specifies the SessionID of the session to be aborted. Use the omnistat
command to get the SessionID of the session.
EXAMPLES
To abort a session with the SessionID "R-2008/04/13-12" use:
omniabort -session R-2008/04/13-12
omniabort -sess 12
SEE ALSO
omnistat(1)
Command line interface reference 29
30
Loading...