.\"Generated by nroff_060126.wdt (26-Jan-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 OVRC 1 "" "" ""
.ds )H Hewlett-Packard Company
.ds ]L
.ds ]W June 2007
.SH NAME
ovrc - perform actions on \fIremote\fR components
.SH "SYNOPSIS"

.PP
ovrc  -h|-help 

.PP
ovrc  -host \fI<name_or_ip>\fR [-tid <\fIids\fR>] -start [\fI<target> ... \fR] 

.PP
ovrc  -host <\fIname_or_ip\fR> [-tid <\fIids\fR>] -stop [\fI<target> ... \fR] 

.PP
ovrc  -host <\fIname_or_ip\fR> [-tid <\fIids\fR>] -restart [\fI<target> ... \fR] 

.PP
ovrc  -host <\fIname_or_ip\fR> [-tid <\fIids\fR>] -status [\fI<target> ... \fR] [-level \fI<level>\fR] 

.PP
ovrc  -host <\fIname_or_ip\fR> [-tid <\fIids\fR>] -notify \fI<event>\fR [\fI<target> ...\fR] [-value \fI<value>\fR] 

.PP
ovrc  -version 

.SH "DESCRIPTION"

.LP
ovrc controls the starting, stopping, event notification, and status reporting of all components on remote hosts.

.LP
A component can be a server process belonging to any of the products such as HP OpenView Operations (OVO), OVO agents (for example, the Performance Agent or the Discovery Agent), an event interceptor, or an application delivered by an integrator. Each component must have an associated registration file (see \fIovcreg\fR) providing HP OpenView with configuration and process information about the component. 

.LP
In the -host option, you can specify the fully qualified hostname or IP address of the remote node. If the hostname or IP address is not specified, the requested operation is performed on the local node, where the command is run. 

.LP
To perform an action, a target can be either a component or a group of components, defined as a category. The ovrc command first tries to run the requested operation on the category specified in \fItarget\fR. If the category called \fItarget\fR is not found, ovrc tries to start the individual component \fItarget\fR. A category name must not match any component name. You can also use the -tid option to specify a target ID (CORE ID) of the remote host specified in the -host option. The CORE ID is a unique identification for a node. You can use the CORE ID with the -tid option to make sure that the remote host that receives the request is correct.

.Sh "Parameters"

.LP
ovrc recognizes the following options:

.TP
-h|-help

Displays \fIall\fR available options for the ovrc command.

.TP
-start [\fI<target> ... \fR] 

Starts the selected components. \fI<target>\fR specifies a component or category. If \fI<target>\fR is not used, all components are started.

.TP
-stop [\fI<target> ... \fR]

Stops the selected components. \fI<target>\fR specifies a component or category. If \fI<target>\fR is not used, all components are stopped except components which are CORE processes.

.TP
-restart [\fI<target> ... \fR]

Stops components before they are restarted. Used in conjunction with -start \fI<target>\fR. If \fI<target>\fR is not used, all components are stopped.

.TP
-notify <\fIevent\fR> [<\fItarget\fR> ... ] [-value <\fIvalue\fR>]

Sends notification of an event with the value of \fI<value>\fR to the component or category specified by \fI<target>\fR. If \fI<target>\fR is not used, the event notification is sent to all components. If \fI<value>\fR is not used, only the event notification is sent. 

.TP
-status [\fI<target> ... \fR] [-level \fI<level>\fR]

Reports the status of a component or category specified by \fI<target>\fR. The status report contains the component's label, description, category, process ID, and STATE. Components can be in one of the following state: Stopped (0 in numeric format), Starting , Initializing , Running , Stopping , N/A  or Aborted . If \fI<target>\fR is not specified, the status of \fIall\fR components is returned. \fI<level>\fR specifies the type and quantity of information to display, as follows:

.RS 5
.TP
Level 0
Status of registered components monitored by HP OpenView. 

.TP
Level 1
Status of registered components whether they are monitored by HP OpenView or not. 

.TP
Level 2
Status of registered components and a dump of their registration information. 

.TP
Level 3
ID of core processes. 0 (zero) indicates root, non-zero indicates non-root ownership.

.TP
Level 4
Similar to level 0, but the STATE is reported in numeric format. 

.TP
Level 5
Similar to level 1, but the STATE is reported in numeric format.

.TP
Level 6
Similar to level 0, but the output is not formatted

.TP
Level 7
Similar to level 1, but the output is not formatted
.RS -5

.TP
-version

Prints the version of ovrc.

.SH "AUTHOR"

.LP
ovrc was developed by Hewlett-Packard Company.

.SH "EXIT STATUS"

.LP
The following exit values are returned:

.TP
0

Success

.TP
1

Not defined

.TP
2

Ignored

.TP
64

Generic error

.TP
65

Invalid target

.TP
67

Operation aborted

.TP
69

Missing prerequisite

.TP
70

Authorization error

.TP
71

Operation on prerequisite failed

.TP
73

Invalid event

.SH "EXAMPLES"

.LP
The following examples show how to use the ovrc command and some of its options to control and display important information about registered components.

.TP 3
\(bu 
To display the status of category SERVER on a remote system with the hostname; mach.hp.com:

ovrc -host mach.hp.com -status SERVER

.TP
\(bu 
To stop the component registered as opcle on a local host:

ovrc -stop opcle

Before opcle itself stops, components that depend on opcle are stopped.
.LP

.SH "SEE ALSO"

.LP
ovc, ovcreg