opmnctl Commands 4-1
4
opmnctl Commands
This chapter provides an overview of opmnctl commands for Oracle Fusion Middleware components managed by OPMN. It features the following topics:
■
opmnctl
■
opmnctl Command Quick Reference
■
opmnctl Detailed Command Description
4.1 opmnctl
opmnctl is the supported tool for starting and stopping all components in an Oracle instance, with the exception of the Fusion Middleware Control Console. opmnctl
provides a centralized way to control and monitor system components from the command line.
If OPMN is configured to discover other Oracle instances, you can use opmnctl to execute control and monitoring commands across multiple Oracle instances
simultaneously.
The location of the opmnctl script determines which opmnctl commands you can use. The opmnctl command exists in two distinct directory location paths:
■
ORACLE_HOME opmnbinopmnctl: The opmnctl command ORACLE_
HOME opmnbinopmnctl location can only be used to create an Oracle instance
or a component for an Oracle instance on the local system. opmnctl commands generated from this location cannot be used to manage system processes
■
ORACLE_INSTANCE binopmnctl: The other opmnctl command which is
located in the ORACLE_INSTANCEbin directory location provides a per Oracle instance instantiation of opmnctl. The opmnctl command in this location must
be used for managing processes for this Oracle instance and can also be used for creating components for the Oracle instance.
Note: Oracle Fusion Middleware components managed by OPMN
should never be started or stopped manually. Do not use command line scripts or utilities from previous versions of Oracle Fusion
Middleware for starting and stopping system components. Use the Fusion Middleware Control Console and the opmnctl command
line utility to start or stop system components.
4-2 Oracle Fusion Middleware Oracle Process Manager and Notification Server Administrators Guide
4.1.1 opmnctl Syntax
The following command shows an example of the syntax of the opmnctl command: opmnctl [verbose] command [options]
Table 4–1 provides a description about opmnctl syntax.
4.2 opmnctl Command Quick Reference
Example 4–1 lists opmnctl commands for quick reference. You can obtain the same
output information by executing the opmnctl help command.
Example 4–1 opmnctl Commands
opmnctl help usage: opmnctl [verbose] [scope] command [options]
verbose: print detailed execution message if available Permitted scopecommandoptions combinations are:
scope command
options -------
--------- ---------
start - Start opmn
startall - Start opmn all managed processes
stopall - Stop opmn all managed processes
shutdown - Shutdown opmn all managed processes
[scope] startproc [attr=val ..] - Start opmn managed processes
[scope] restartproc [attr=val ..] - Restart opmn managed processes [scope] stopproc
[attr=val ..] - Stop opmn managed processes [scope] reload
- Trigger opmn to reread opmn.xml [scope] status
[options] - Get managed process status
[scope] metric [attr=val ..] - Get DMS metrics for managed processes
[scope] dmsdump [dmsargs]
- Get DMS metrics for opmn [scope] debug
[attr=val ..] - Display opmn server debug information [scope] set
[attr=val ..] - Set opmn log parameters [scope] query
[attr=val] - Query opmn log parameters
launch [attr=val ..] - Launch a configured target process
phantom [attr=val ..] - Register phantom processes
ping [max-retry]
- Ping local opmn validate
[filename] - Validate the given opmn xml file
help - Print brief usage description
usage [command]
- Print detailed usage description createinstance
- Create an Oracle Instance
Note: Oracle recommends starting OPMN as the user that has
installed Oracle Fusion Middleware.
Table 4–1 opmnctl Syntax
Syntax Description
verbose Prints detailed execution message, if available.
command Specifies an opmnctl command. Refer to Example 4–1
for a list of commands. options
Specifies options for the command. Refer to Section 4.3.5.1.1
for a list of command options.
