File: //opt/OV/man/man1/ovappinstance.1
.\"Generated by nroff_template.wdt (12-Sep-06). Do NOT edit this output file. Instead, edit the source FM+SGML file.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH ovappinstance "" "" ""
.ds )H Hewlett-Packard Company
.ds ]L
.ds ]W June 2007
.SH NAME
ovappinstance - return configuration parameters for application instances.
.SH "SYNOPSIS"
.PP
ovappinstance -h | -help
.PP
ovappinstance -v | -version
.PP
ovappinstance -i | -instance <\fIinstance\fR> {-st | -state} | {-h | -host} [-an | -appNamespace <\fIappNamespace\fR>]
.PP
ovappinstance -is | -instances [-an | -appNamespace <\fIappNamespace\fR>]
.PP
ovappinstance -ai | -activeInstances [-an | -appNamespace <\fIappNamespace\fR> ]
.PP
ovappinstance -vc | -verifyConfig
.SH "DESCRIPTION"
.LP
The ovappinstance command reads and displays the information contained in the APM XML configuration files. For information about the parameters you can use with the ovappinstance command, see "Parameters": for information about the options you can use with the ovappinstance command parameters, see "Options".
.Sh "Parameters"
.LP
The ovappinstance command recognizes the following parameters:
.TP
-h | -help
Displays the command parameters and options.
.TP
-v | -version
Displays the version of the command.
.TP
-i | -instance <\fIinstance\fR>
Returns information about the specified application instance.
.TP
-is | -instances
Returns information about all application instances found.
.TP
-ai | -activeInstances
Returns information about all application instances found to be up and running.
.TP
-vc | -verifyConfig
Check s and report on the validity of the APM XML configuration file(s).
.Sh "Options"
.LP
You can use the following options with the ovappinstance command parameters:
.TP
-st | -state
Displays the outage state of the instance specified in <\fIinstance\fR>.
.TP
-h | -host
Get either the virtual IP address of the instance <\fIinstance\fR>. Alternatively, if the command is executed on a node, which is not configured as part of a high-availability cluster, get the FQDN or IP address of the local host.
.TP
-an | -appNamespace
Specify the name of the application namespace, whose information you want to display.
.Sh "Return Codes"
.LP
ovappinstance issues the following return codes:
.LP
\fI0\fR
.LP
\fIAll steps were completed successfully.\fR
.LP
\fI1\fR
.LP
\fIOne or more steps failed.\fR
.SH "EXAMPLES"
.LP
The following examples show how to use the ovappinstance command.
.TP 3
\(bu
To display a list of all application instances for a given application namespace:
ovappinstance -instances -appNamespace <\fIappNamespace\fR>
.TP
\(bu
To display a list of all application instances which are active (or running) in a given application namespace:
ovappinstance -activeInstances -appNamespace <\fIappNamespace\fR>
.LP
.SH "AUTHOR"
.LP
ovappinstance was developed by Hewlett-Packard Company.
.SH "SEE ALSO"
.LP
ovclusterinfo, ovconfpar, ovpolicy.