AppRM A.06.00: December 2007-3-Hewlett-Packard Company
Document History
Manual 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 1Edition History
Part NumberManual EditionProduct
T4395-96007October 2006Application Recovery
Manager Release
A.06.00
T4395-96007July 2007Application Recovery
Manager Release
A.06.00 with patch
APPRMWIN_00002.
T4395-96007December 2007Application Recovery
Manager Release
A.06.00 with patch
APPRMWIN_00011.
AppRM A.06.00: December 2007 Hewlett-Packard Company-4-
Introduction to HP StorageWorks Application
Recovery Manager Command Line Interface
Reference
The HP StorageWorks Application Recovery Manager Command Line Interface
Reference contains the reference pages for HP StorageWorks Application Recovery
Manager A.06.00 commands.
The command synopsis for every command is also available using the -help option.
For an introduction to Application Recovery Manager A.06.00 commands, refer to the
omniintro(9) reference page.
Reference Page Organization
The reference pages are divided in specialized sections (volumes). 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 StorageWorks Application Recovery
Manager.
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).
Conventions
All reference pages follow established section formats, but not all sections are
present in each reference (man) page.
NAMEGives the name of the command and a brief description of the
commands purpose.
SYNOPSISDescribes the syntax of the command.
The command line synopsis is formatted in the following way:
AppRM A.06.00: December 2007-5-Hewlett-Packard Company
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.
• 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, {}).
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.
AppRM A.06.00: December 2007 Hewlett-Packard Company-6-
Section 9: Introduction
-7-Hewlett-Packard CompanyAppRM A.06.00: December 2007
omniintro (9)
omniintro (9)
NAME
omniintro – introduction to HP StorageWorks Application Recovery Manager
command utilities
DESCRIPTION
HP StorageWorks Application Recovery Manager is an enterprise backup solution
that provides reliable data protection and high accessibility for business data.
Application Recovery Manager provides extensive unattended backups, post-backup
data management and integrations with various databases. For information on
Application Recovery Manager functionality and concepts, refer to the online
documentation.
COMMANDS
User Command-line Commands (1):
omniabort Aborts an active session.
omnib Backs up filesystems and VSS writers.
omnicc Handles the Application Recovery Manager licensing, reports the
number of configured and available Application Recovery Manager
licenses, imports and exports Application Recovery Manager
clients, and manages secured clients.
omnicellinfo Displays configuration information of a cell.
omniclus Manages load balancing in a cluster environment in case of an
application failover.
omnidbQueries the Application Recovery Manager internal database
(IDB).
omnidbsmisSets, updates, deletes, and lists the login information for the
Command View EVA (CV EVA).
omnidbvssQueries the VSS database; manages, browses, and lists the items
of the VSS database.
omnidlcGathers or deletes Application Recovery Manager debug, log and
getinfo files from the Application Recovery Manager cell.
-8-Hewlett-Packard CompanyAppRM A.06.00: December 2007
omniintro (9)
omnirRestores filesystems and VSS writers backed up using Application
Recovery Manager.
omnistatDisplays the status of active backup and restore sessions.
Administrative Command-line Commands (1M):
dbtool.plBacks up and restores the Application Recovery Manager IDB and
configuration.
omnicheckPerforms 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 be run only on the Cell Manager.
omnidbinitInitializes the Application Recovery Manager internal database
(IDB). It can be run only on the Cell Manager.
omnidbutilHandles various Application Recovery Manager internal database
(IDB) maintenance tasks. It can be run only on the Cell Manager.
omnidlcGathers or deletes Application Recovery Manager debug, log and
sysinfo 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 be run only 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.
omnirshReturns 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.
omnisvStarts, stops or displays the status of Application Recovery
Manager services. It can be run only on the Cell Manager.
omnitrig Triggers Application Recovery Manager scheduled backups.
winomnimigrate.pl Helps you migrate your existing Cell Manager from a 32-bit
Windows system to a 64-bit Windows system.
-9-Hewlett-Packard CompanyAppRM A.06.00: December 2007
omniintro (9)
Return Values
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.
The winomnimigrate.pl command returns a different set of errors. See the
winomnimigrate.pl(1m) reference page.
-12-Hewlett-Packard CompanyAppRM A.06.00: December 2007
Section 1: User Commands
-13-Hewlett-Packard CompanyAppRM A.06.00: December 2007
omniabort (1)
omniabort (1)
NAME
omniabort – aborts an active session
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
EXAMPLES
To abort a session with the SessionID "R-2006/04/13-12" use:
omniabort -session R-2006/04/13-12
omniabort -sess 12
SEE ALSO
omnistat(1)
the omnistat command to get the SessionID of the session.
-14-Hewlett-Packard CompanyAppRM A.06.00: December 2007
The omnib command uses a backup specification to back up data objects. The
following Application Recovery Manager functionality is supported:
Session management
Controls the backup sessions. The Session Manager reads the backup specification
or uses the command options to determine what to back up, then initiates the ZDB
Agents for disks which will be used in the session. Once the session has completed,
the Session Manager updates the IDB with the session information.
Backup monitoring
When the backup command is executed, it sends a request (specifying the backup
objects) to the Session Manager. When the Session Manager (SM) accepts the
request, it assigns a unique SessionID to the session. You can use this SessionID to
monitor the progress of the session using the omnistat command. You can also use
the omniabort command to terminate a session.
OPTIONS
-version Displays the version of the omnib command
-15-Hewlett-Packard CompanyAppRM A.06.00: December 2007
omnib (1)
-help Displays the usage synopsis for the omnib command
-restart SessionID Tries to restart a failed session, specified by its sessionID.
-msvssw_list ListName Specifies the name of the MS VSS backup specification
file for the backup. The MS VSS backup specification contains the
MS VSS objects to be backed up.
LIST OPTIONS
-barcmnd Command Specifies the command that will be used instead of the
command specified with exec option in the backup specification.
-barmode VSSMode The available backup modes for VSS Writer objects depend on
the writer: some writers support several modes (for example full
and copy with Microsoft Exchange Server 2003 writer), others
may support only full. See the HP StorageWorks Application Recovery Administrator’s Guide.
-no_monitor By default, the command monitors the session and displays the
status of the session during the session. If this option is used, only
the SessionKey is displayed, and the command is disconnected
from the session.
RETURN VALUES
See the man page omniintro for return values.
Additional return values of the omnib command are:
10 There was an error while backing up some components. All agents
completed successfully.
11 One or more agents failed, or there was a database error.
12 None of the agents completed the operation; session was aborted by
Application Recovery Manager.
13 Session was aborted by user.
EXAMPLES
The following example illustrates how to start a copy backup using an existing VSS
backup specification called “test”.
omnib -msvssw_list test -barmode copy
-16-Hewlett-Packard CompanyAppRM A.06.00: December 2007
SEE ALSO
omnir(1)
omnib (1)
-17-Hewlett-Packard CompanyAppRM A.06.00: December 2007
omnicc (1)
omnicc (1)
NAME
omnicc – reports the number of configured and available Application Recovery
Manager licenses, installs the licenses, imports and exports systems in and out of a
cell, manages access to secured clients.
The omnicc command is used for licensing, importing, and exporting clients, and for
managing secured clients.
OPTIONS
-version Displays the version of the omnicc command.
-help Displays the usage synopsis for the omnicc command.
-check_licenses [-detail] Reports licensing related information from the cell.
-18-Hewlett-Packard CompanyAppRM A.06.00: December 2007
omnicc (1)
If the -detail option is not specified, the command returns
information on whether the Application Recovery Manager
licensing is covered or not.
If the -detail option is specified, a detailed report is produced.
The following information is returned for every license in the cell:
license name, licenses installed, licenses used and licenses
required.
-query Displays information about the number of available licenses.
-import_host ClientName [-virtual] Imports the specified client into a cell.
This allows you to move a client between two cells without
reinstalling the Application Recovery Manager modules.
When you import the next one among multiple network names
(clusters), use the -virtual option. This way you keep Application
Recovery Manager from assigning licenses to all the network
names of the same system.
-import_is ClientName Imports an already installed Installation Server into
the cell.
-update_host ClientName Updates the version information and installed
packages information in the Cell Manager configuration file for the
specified client. Useful when automatic update fails due to any
reason.
-update_all [-force_cs] Updates the version information and installed
packages information in the Cell Manager configuration file for all
clients in the cell. Useful when automatic update fails due to any
reason.
If the -force_cs option is specified, it checks if the clients belong
to the current cell. If not, the command will change the cell to the
current cell.
-export_host ClientName Exports the specified client from the cell. This
enables you to remove a client from the cell without uninstalling
its Application Recovery Manager modules.
-list_authorities ClientName Lists systems from which the specified client
accepts requests on the Application Recovery Manager port (by
default 5555).
-secure_client ClientName Specifies the client to be secured.
-19-Hewlett-Packard CompanyAppRM A.06.00: December 2007
omnicc (1)
-authorities ClientName [ClientName2...] Specifies systems from which
the specified client accepts requests on the Application Recovery
Manager port (by default 5555). Consequently, other computers
will not be able to access this client. For tasks like backup and
restore, starting pre- or post-execution scripts, or importing and
exporting clients, the client checks whether the computer which
triggers one of these tasks via the Application Recovery Manager
port is allowed to do so. This security mechanism instructs the
client to accept such actions only from the systems specified by this
option.
-unsecure_client ClientName Specifies the client from which you want to
remove security. Such a client will enable access to all systems in
the cell.
-install_license password Installs an encrypted Application Recovery
Manager license. The password must be formatted as a single line
and must not contain any embedded carriage returns. The
password must be in quotes. If the password includes also a
description in quotes, the quotes in this description must be
preceded with backslashes.
-password_info Displays information about installed license passwords.
EXAMPLES
To install the zero downtime backup EVA 10TB license key "4TRV E9ES LW3U
YST7 KQZ3 G5NK ABA7 MQDB "EVA 10TB"", where "EVA 10TB" is description,
run:
The omnicellinfo command displays information about data objects, clients,
database, backup specifications and backup specification groups in the cell.
Some options recognized by omnicellinfo are intended primarily for generating
reports by awk/perl scripts. Information produced is formatted in records with a
newline as field separator and a blank line as record separator. Those options are:
-dlinfo, -schinfo, and -allbdf.
OPTIONS
-version Displays the version of the omnicellinfo command.
-help Displays the usage synopsis for the omnicellinfo command.
-group Displays the backup specification groups that contain backup
-object [schedule | no_schedule] Displays information about objects in the
specifications. Note that the backup specification group named
Default is not displayed.
cell. The report shows: Object (object type, client name, and
mountpoint), Label, and Next Scheduled Backup Date. When you
use the schedule option, the report only shows those objects
which are scheduled for backup. When you use the -no_schedule
-21-Hewlett-Packard CompanyAppRM A.06.00: December 2007
omnicellinfo (1)
-db Displays information about the Application Recovery Manager
-cell Displays information about the configured clients in the cell. The
-dlinfo Shows information about backup specifications. For each backup
option, the report only shows those objects which are not scheduled
for backup. By default, all objects (scheduled and unscheduled) are
listed.
internal database (IDB). The database is divided in logical
structures, for each of these structures the report shows: Disk
Space Used, Records Used and Records Total.
report shows for each client: client name, operating system, cell
console version, and GUI version. There is also a short summary
which shows the total number of clients and, if the brief
suboption was not specified, all possible Application Recovery
Manager software components, together with the total number of
every software component in the cell. If the brief suboption was
specified, only the installed Application Recovery Manager
software components together with the total number of every
software component in the cell is listed.
specifications it lists the name of the backup specification, session
owner, pre-exec and post-exec script. Session owner is in format
USER.GROUP@CLIENT.
-schinfo [Backup_Specification | -days NumberDays] Shows
information about backup specification scheduling. If
Backup_Specification and -days option are not specified, the
command displays the next schedule time for each backup
specification. If backup specification is specified the command lists
all schedules in the next year for the specified backup specification.
Option -days can be used to display schedules of all backup
specifications for a specified number of days.
-acl Displays all Application Recovery Manager access permissions
that the user running the command has.
-group Group This option allows you to limit the output of the command to single
backup specification group. The following options support this:
-dlinfo, -schinfo, and -object.
-22-Hewlett-Packard CompanyAppRM A.06.00: December 2007
EXAMPLES
The following example illustrates how the omnicellinfo command works.
1. To list detailed information about the selected objects:
The -noclus option can be specified directly after -clus to prevent loading of the
cluster dynamic library
DESCRIPTION
The omniclus command allows the user to send the Application Recovery Manager
Cell Manager special events that in some way control the behavior of the Cell
Manager and the backup sessions in a cluster environment. omniclus allows balance
loading by offering additional (CLI) control of the Cell Manager in the cluster
environment:
• abort sessions
• temporarily disabling the Cell Manager for backups
Note: that the cluster_name specified with the -clus switch must be a clusteraware Application Recovery Manager Cell Manager.
OPTIONS
-version Displays the version of the omnidb command
-help Displays the usage synopsis for the omniclus command.
-clus cluster_name Specifies the cluster-aware Cell Manager.
-session * | backup_specification Specifies the session(s) to which the
abort message should be sent.
-24-Hewlett-Packard CompanyAppRM A.06.00: December 2007
-abortsess Specifies the abort session command.
-abortid {== | !=} application_id Specifies the application identification.
-inhibit {* | 0 | minutes} Specifies the number of minutes for Cell Manager
NOTE
The command can only be used in the cluster environment.
EXAMPLES
Following example illustrates how the omniclus command works.
The utility will connect to all running sessions and will send them abort
messages. The state of the sessions can be then checked with the Application
Recovery Manager omnistat utility.
omniclus (1)
backup inactivity, where * means forever and 0 means activate
now.
The utility will connect to backup session managers issuing abort messages and
sending them additional information - the backup specification name. Each
backup session manager checks whether the command addresses it and if this is
the case it aborts.
3. Abort sessions (all or specific) with application identifications
This way the user can define groups of sessions and abort only the ones that are
actually related to the application that failed over. For example a backup session
that performs a normal filesystem backup of a remote client is not aborted
because an application server switches, while the application server backup can
be aborted.
4. Temporarily disabling the Application Recovery Manager cell
The following command will inhibit backup sessions for twenty minutes:
omniclus -clus cluster.domain.com -inhibit 20
-25-Hewlett-Packard CompanyAppRM A.06.00: December 2007
omniclus (1)
The following command will inhibit backup sessions forever:
omniclus -clus cluster.domain.com -inhibit *
The following command will re-activate backup sessions immediately:
omniclus -clus cluster.domain.com -inhibit 0
SEE ALSO
omnirsh(1M)
-26-Hewlett-Packard CompanyAppRM A.06.00: December 2007
omnidb (1)
NAME
omnidb – queries the Application Recovery Manager internal database (IDB)