.\"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 OVC 1 "" "" ""
.ds )H Hewlett-Packard Company
.ds ]L
.ds ]W June 2007
.SH NAME
ovc - perform actions on local components
.SH "SYNOPSIS"

.PP
ovc  -h|-help 

.PP
ovc  -start [\fI<target> ... \fR] [-boot]{[-async]|[-verbose]} 

.PP
ovc  -stop [\fI<target> ... \fR][-nostart]{[-async]| [-verbose]} 

.PP
ovc  -restart [\fI<target> ... \fR] 

.PP
ovc  -kill [-verbose] 

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

.PP
ovc  -notify \fI<event>\fR [\fI<target> ...\fR] [-value \fI<value>\fR] 

.PP
ovc  -version 

.SH "DESCRIPTION"

.LP
ovc controls the starting and stopping, event notification, and status reporting of all components registered with the HP OpenView Control service.

.LP
A component can be a server process belonging to any of the products such as HP OpenView Operations (OVO) for Linux, 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 providing HP OpenView with configuration and process information about the component. For more information about registration, \fIovcreg\fR.

.LP
A target can be either a component or a group of components, defined as a category. The ovc command first tries to initiate action on the category specified in target. If the category called \fItarget\fR is not found, ovc then tries the individual component called \fItarget\fR. Note that a category name must not match any component name.

.LP
The HP OpenView Control daemon or service automatically restarts any component that terminates unexpectedly if the \fIAutoRestart\fR option in the registration file of the component is set to \fItrue\fR. If the HP OpenView Control daemon or service is stopped using the -kill option, all registered components are stopped, too.

.Sh "Parameters"

.LP
ovc recognizes the following options:

.TP
-h|-help

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

.TP
-start [\fI<target> ... \fR] [-boot]{[-async]|[verbose]}

Starts the selected components. \fI<target>\fR specifies a component or category. If \fI<target>\fR is not used, all components are started. If -boot is used, only components that start at boot time are started. 

The -async option starts the components asynchr- -onously. If you use the -verbose option, ovc command displays the progress of the command execution. You can use the -async or the -verbose option, but you must not include these options together in a command.

.TP
-stop [\fI<target> ... \fR] [-nostart]{[-async]|[verbose]}

Stops the selected components. \fI<target>\fR specifies a component or category. If \fI<target>\fR is not used, all components are stopped \fIexcept\fR components, which belong to the CORE component group. If you specify the -nostart option and if the control daemon is not running, the command does not perform any action. If you do not specify the -nostart option, the ovc -stop command starts the control daemon and ovbbccb components if these components are not running. The -async option starts the components asynchronously. If you use the -verbose option, the ovc command displays the progress of the command execution. You can use the -async or the -verbose option, but you must not include these options together in a command.

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

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

.TP
-kill [ -verbose]

Stops all components registered with the HP OpenView Control service. The -async option starts the components asynchronously. If you use the -verbose option, the ovc command displays the progress of the command execution.

.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. You can specify the <value> to the component that generates the event (event generator) and sends the event-related information to all components that request the event information (event subscribers). If target 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 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 ovc

.SH "AUTHOR"

.LP
ovc 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
62

The UNIX daemon or Windows service is not running.

.TP
63

The Control daemon is being initialized.

.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 ovc command and some of its options to control and display important information about registered components.

.TP 3
\(bu 
To start the component registered as opcle:

ovc -start opcle

Before opcle itself starts, all the components that opcle depends on are started.
.LP

.LP
\fITo start the component registered as opcle and display the progress of the command execution:\fR

ovc -start opcle -verbose

Before opcle itself starts, all the components that opcle depends on are started.

.TP
\(bu 
To print the status of all registered components:

ovc -status

.TP
\(bu 
To stop the component registered as opcle:

ovc -stop opcle -verbose

Before opcle itself stops, all the components that depend on opcle are stopped. This command starts the control daemon and ovbbccb components if these components are not running.
.LP

.LP
\fITo stop the component registered as opcle using the ovc -stop[<target>...] -nostart option:\fR

ovc -stop opcle -nostart

Before opcle itself stops, all the components that depend on opcle  are stopped. This command does not perform any action if the control daemon is not running.

.TP
\(bu 
To send the event RECONFIGURE to all running components:

ovc -notify RECONFIGURE

.TP
\(bu 
To start all components (and their dependents) belonging to category SERVER and AGENT. 

ovc -start SERVER AGENT

.TP
\(bu 
To print the status of the component opcle and display the registration details: 

ovc -status opcle -level 2
.LP

.SH "SEE ALSO"

.LP
ovcreg