Skip Headers

Oracle9i Net Services Reference Guide
Release 2 (9.2)

Part Number A96581-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Feedback

Go to previous page Go to next page
View PDF

2
Oracle Connection Manager Control Utility

This chapter describes the commands and associated syntax of the Oracle Connection Manager Control utility.

This chapter contains these topics:

Oracle Connection Manager Control Utility Overview

The Oracle Connection Manager Control utility enables you to administer Oracle Connection Managers. You can use its commands to perform basic management functions on one or more Oracle Connection Managers. Additionally, you can view and change parameter settings.

The basic syntax of the Oracle Connection Manager Control utility is as follows:

cmctl command [process_type]

where process_type is the name of the Oracle Connection Manager process. The choices are as follows:

For example, the following command starts both the CMGW and CMADMIN processes:

CMCTL START cman

Note:

In general, Oracle Corporation recommends using cman for commands. Once an Oracle Connection Manager is configured, the CMADMIN administrative process is not needed. If is necessary to reserve resources, you can then use the cm. The CMGW gateway process performs all Oracle Connection Manager basic functions and can run without the CMADMIN process. There is no need for using the adm type.


See Also:

Oracle9i Net Services Administrator's Guide for an overview of the Oracle Connection Manager processes

You can also issue Oracle Connection Manager utility commands at the CMCTL> program prompt. To obtain the prompt, enter cmctl with no arguments at the operating system command line. When you run cmctl, the program is started. You can then enter the necessary commands from the program prompt. The basic syntax of issuing commands from CMCTL> program prompt is as follows:

cmctl
CMCTL> command [process_type]

Note:

You can combine commands in a standard text file, and then run them as a sequence of commands. To execute in batch mode, use the format:

cmctl @file_name

You can use either REM or # to identify comments in the batch script; all other lines are considered commands. Any commands that would typically require confirmation do not require confirmation during batch execution.


The Oracle Connection Manager Control utility supports several types of commands:

SET Commands of the Oracle Connection Manager Control Utility

You can use the SET command to alter parameter values for an Oracle Connection Manager. Parameter values remain in effect until the Oracle Connection Manager is shut down. You cannot permanently save these temporary changes to the cman.ora file.

You can use the SHOW command to display the current value of a configuration setting.

Distributed Operations

The Oracle Connection Manager Control utility can perform operations on a local or a remote Oracle Connection Manager.

To set up a computer to remotely administer an Oracle Connection Manager:

  1. Configure the local computer that runs the Oracle Connection Manager:
    1. Configure a cman.ora file that includes REMOTE_ADMIN=yes in the CMAN_PROFILE section.
      CMAN=
       (ADDRESS=(PROTOCOL=tcp)(HOST=proxysvr)(PORT=1630))
      CMAN_ADMIN=
       (ADDRESS=(PROTOCOL=tcp)(HOST=proxysvr)(PORT=1830))
      CMAN_PROFILE=
        (PARAMETER_LIST=
         (REMOTE_ADMIN=yes)) 
      
      
      
    2. Start the CMGW process. From the operating system, enter either of the following commands:
      cmctl START cm
      cmctl START cman
      
      
  2. Configure the remote computer:
    1. Ensure that Oracle Connection Manager is installed.
    2. Configure a cman.ora file with the same values for the CMAN and CMAN_ADMIN parameters as you did for local Oracle Connection Manager computer. For example:
      CMAN=
       (ADDRESS=(PROTOCOL=tcp)(HOST=proxysvr)(PORT=1630))
      CMAN_ADMIN=
       (ADDRESS=(PROTOCOL=tcp)(HOST=proxysvr)(PORT=1830))
      
      

All commands except START can be issued when an Oracle Connection Manager is administered remotely. The Oracle Connection Manager Control utility can only start the Oracle Connection Manager on the same computer from where the utility is running.

Oracle Connection Manager Control Utility Commands

This section lists and describes the Oracle Connection Manager Control utility commands.


ACCEPT_CONNECTIONS

Purpose

Use the ACCEPT_CONNECTIONS command to enable or disable Oracle Connection Manager to accept new connections.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl ACCEPT_CONNECTIONS [on | off]

From the Oracle Connection Manager Control utility:

CMCTL> ACCEPT_CONNECTIONS [on | off]

Arguments

[on] (default): Specify to enable Oracle Connection Manager to accept new connections.

[off]: Specify to reject new connections to Oracle Connection Manager.

Usage Notes

If set to off, existing connections are not affected.

Example

CMCTL> ACCEPT_CONNECTIONS off
Profile of the CMAN
-----------------------------------------
Current state             offline

CLOSE_RELAY

Purpose

Use the CLOSE_RELAY command to enable a connection identified by relay number to be shut down.


Note:

Use the SHOW RELAY command to obtain the relay numbers for connections.


Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl CLOSE_RELAY [relay_num | ALL]

From the Oracle Connection Manager Control utility:

CMCTL> CLOSE_RELAY [relay_num | ALL]

Arguments

[relay_num]: Specify the relay number of the connection to terminate immediately.

[ALL]: Specify to immediately terminate all connections

Usage Notes

Use this command with caution. From the time that SHOW RELAY command is executed to the time this command is executed, the same relay may have been reused by another connection.

Example

CMCTL> CLOSE_RELAY 0
Relay is not active

CMCTL> CLOSE_RELAY 0
The command completed successfully

EXIT

Purpose

Use the EXIT command to exit from the Oracle Connection Manager Control utility.

Prerequisites

None

Syntax

From the operating system:

cmctl EXIT

From the Oracle Connection Manager Control utility:

CMCTL> EXIT

Usage Notes

This command is identical to QUIT command.

Example

CMCTL> EXIT


HELP

Purpose

Use the command HELP to provide a list of all the Oracle Connection Manager Control utility commands or provide syntax help for a particular Oracle Connection Manager Control utility command.

Prerequisites

None

Syntax

From the operating system:

cmctl HELP [command]

From the Oracle Connection Manager Control utility:

CMCTL> HELP [command]

Arguments

[command]: Specify a HELP command. Commands are shown in the following example output.

When you enter a command as an argument to HELP, the Oracle Connection Manager Control utility displays information about how to use the command. When you enter HELP without an argument, the Oracle Connection Manager Control utility displays a list of all the commands.

Example

CMCTL> HELP
The following operations are available 
An asterisk (*) denotes a modifier or extended command: 
accept_connections     
close_relay 
exit 
quit   
set*   
show*             
shutdown               
start                 
stats                  
status                 
stop                   
stopnow                
version                

QUIT

Purpose

Use the QUIT command to exit the Oracle Connection Manager Control utility and return to the operating system prompt.

Prerequisites

None

Syntax

From the operating system:

cmctl QUIT

From the Oracle Connection Manager Control utility:

CMCTL> QUIT

Usage Notes

This command is identical to the EXIT command.

Example

CMCTL> QUIT


SET

Purpose

Use the SET command to alter the parameter values for the Oracle Connection Manager. Parameter values changes remain in effect until the Oracle Connection Manager is shut down. To make the changes permanent, manually update the parameter settings in the cman.ora file.

Prerequisites

None

Syntax

From the operating system:

cmctl SET [parameter]

From the Oracle Connection Manager Control utility:

CMCTL> SET [parameter]

Arguments

[parameter]: Specify a SET parameter to modify its configuration setting. Parameters are shown in the example output.

When you enter SET without an argument, the Oracle Connection Manager Control utility displays a list of all the parameters.

Example

CMCTL> SET 
The following operations are available 
An asterisk (*) denotes a modifier or extended command: 
authentication_level
displaymode
log_level
relay_statistics


SET AUTHENTICATION_LEVEL

Purpose

Use the SET AUTHENTICATION_LEVEL command to set the level of security for the Oracle Connection Manager.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET AUTHENTICATION_LEVEL [0 | 1]

From the Oracle Connection Manager Control utility:

CMCTL> SET AUTHENTICATION_LEVEL [0 | 1]

Arguments

[0] (default): Specify so that no authentication is required for client connections.

[1]: Specify to reject connections that are not employing Secure Network Service (SNS) to perform client authentication. SNS is part of the Oracle Advanced Security.

Example

CMCTL> SET AUTHENTICATION_LEVEL 0
Profile of the CMAN
-----------------------------------------
AUTHENTICATION_LEVEL   = 0

SET DISPLAYMODE

Purpose

Use the SET DISPLAYMODE command to change the format and level of detail for the START, STATS, STATUS, STOP, and VERSION commands.

Prerequisites:

None

Syntax

From the operating system:

cmctl SET DISPLAYMODE [compat | verbose]

From the Oracle Connection Manager Control utility:

CMCTL> SET DISPLAYMODE [compat | verbose]

Arguments

[compat] (default): Specify to display output that is compatible with older versions of Oracle Connection Manager.

[verbose] (recommended): Specify to display a formatted and descriptive output.

Example:

CMCTL> SET DISPLAYMODE compat
Current display mode is COMPATible

SET LOG_LEVEL

Purpose

Use the SET LOG_LEVEL command to set the log level for the Oracle Connection Manager.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET LOG_LEVEL [level]

From the Oracle Connection Manager Control utility:

CMCTL> SET LOG_LEVEL [level]

Arguments

[level]: Specify one of the following log levels:

Example

CMCTL> SET LOG_LEVEL 0

Profile of the CMAN
-----------------------------------------
LOG_LEVEL              = 0

SET RELAY_STATISTICS

Purpose

Use the SET RELAY_STATISTICS command to turns statistic collection pertaining to the I/O of connections of the Oracle Connection Manager on or off.

When a relay closes and this command is set to on, the following statistics are recorded in the appropriate LOG_RECORD of the cman_pid.log file on UNIX operating systems and cmanpid.log file on Windows NT:

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET RELAY_STATISTICS [on | off]

From the Oracle Connection Manager Control utility:

CMCTL> SET RELAY_STATISTICS [on | off]

Arguments

[on]: Specify to turn statistic collection on.

[off] (default): Specify to turn statistic collection off.

Example

CMCTL> SET RELAY_STATISTICS off

Profile of the CMAN
-----------------------------------------
RELAY_STATISTICS       = no

SHOW

Purpose

Use the SHOW command to view the parameter values for the Oracle Connection Manager.

Prerequisites

None

Syntax

From the operating system:

cmctl SHOW [parameter]

From the Oracle Connection Manager Control utility:

CMCTL> SHOW [parameter]

Arguments

[parameter]: Specify a SHOW parameter to view its configuration setting. Parameters are shown in the example output.

When you enter SHOW without an argument, the Oracle Connection Manager Control utility displays a list of all the parameters.

Example

CMCTL> SHOW 
The following operations are available 
An asterisk (*) denotes a modifier or extended command: 
address
ALL
displaymode
profile
relay
rules


SHOW ADDRESS

Purpose

Use the SHOW ADDRESS command to lists the protocol address of the Oracle Connection Manager.

Prerequisites

None

Syntax

From the operating system:

cmctl SHOW ADDRESS

From the Oracle Connection Manager Control utility:

CMCTL> SHOW ADDRESS

Arguments

None

Usage Notes

The address is set with the CMAN parameter in the cman.ora file.

Example

CMCTL> SHOW ADDRESS

Address List
-----------------------------------------
(ADDRESS=(PROTOCOL=tcp)(HOST=proxysvr)(PORT=1630))

SHOW ALL

Purpose

Use the SHOW ALL command to display the output for SHOW ADDRESS, SHOW PROFILE, and SHOW RULES commands.

Prerequisites

None

Syntax

From the operating system:

cmctl SHOW ALL

From the Oracle Connection Manager Control utility:

CMCTL> SHOW ALL

Arguments

None

Example

CMCTL> SHOW ALL
Address List
-----------------------------------------
(ADDRESS=(PROTOCOL=tcp)(HOST=proxysvr)(PORT=1630))

Profile of the CMAN
-----------------------------------------
MAXIMUM_RELAYS         = 2048
RELAY_STATISTICS       = yes
AUTHENTICATION_LEVEL   = 0
LOG_LEVEL              = 4
ANSWER_TIMEOUT         = 0
MAXIMUM_CONNECT_DATA   = 1024
USE_ASYNC_CALL         = yes
TRACING                = yes
TRACE_DIRECTORY        = default
MAX_FREELIST_BUFFERS   = 0
REMOTE_ADMIN           = no

Rule List
-----------------------------------------
(rule=(src=144.25.185.60)(dst=sales-server)(srv=sales.us.acme.com)(act=accept))
(rule=(src=client-pc)(dst=sales-server)(srv=sales.us.acme.com)(act=accept))


SHOW DISPLAYMODE

Purpose

Use the SHOW DISPLAYMODE to show the current display mode used for the START, STATS, STATUS, STOP, and VERSION commands.

Syntax

From the operating system:

cmctl SHOW DISPLAYMODE

From the Oracle Connection Manager Control utility:

CMCTL> SHOW DISPLAYMODE

Example

CMCTL> SHOW DISPLAYMODE
Current display mode is VERBose

SHOW PROFILE

Purpose

Use the SHOW PROFILE command to display the current parameter settings for the Oracle Connection Manager. Information is obtained from the CMAN_PROFILE parameters in the cman.ora file and any changes made with the SET command.

Syntax

From the operating system:

cmctl SHOW PROFILE

From the Oracle Connection Manager Control utility:

CMCTL> SHOW PROFILE

Example

CMCTL> SHOW PROFILE
Profile of the CMAN
-----------------------------------------
MAXIMUM_RELAYS         = 2048
RELAY_STATISTICS       = yes
AUTHENTICATION_LEVEL   = 0
LOG_LEVEL              = 4
SHOW_TNS_INFO          = yes
ANSWER_TIMEOUT         = 0
MAXIMUM_CONNECT_DATA   = 1024
USE_ASYNC_CALL         = yes
TRACING                = yes
TRACE_DIRECTORY        = default
MAX_FREELIST_BUFFERS   = 0
REMOTE_ADMIN           = no

SHOW RELAY

Purpose

Use the SHOW RELAY command to display the current status of a selected relay (connection) or all active relays for the Oracle Connection Manager.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHOW RELAY {relay_num | ACTIVE}

From the Oracle Connection Manager Control utility:

CMCTL> SHOW RELAY {relay_num | ACTIVE}

Arguments

[relay_num]: Specify to show the status information for a specific relay.

[ACTIVE]: Specify to show the list of active relays.

Usage Notes

For active relays, only relay numbers are shown. For a given relay number, the following information is displayed:

Examples

CMCTL> SHOW RELAY active

Active Relays
-----------------------------------------
0000 0001

CMCTL> SHOW RELAY 0

Relay Information
-----------------------------------------
Relay number              0
Start-up time             22-JAN-2002 19:47:17
Src                       
(ADDRESS=(PROTOCOL=tcp)(HOST=144.25.185.60)(PORT=35279))
Dest                      
(ADDRESS=(PROTOCOL=tcp)(HOST=144.25.185.60)(PORT=1521))
Number of IN bytes        438
Number of IN packets      7
Number of IN DCD probes   0
Number of OUT bytes       364
Number of OUT packets     7
Number of OUT DCD probes  0

SHOW RULES

Purpose

Use the SHOW RULES to display the current access rules used by Oracle Connection Manager.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHOW RULES

From the Oracle Connection Manager Control utility:

CMCTL> SHOW RULES

Arguments:

None

Usage Notes:

Rules are set with the CMAN_RULES parameter in the cman.ora file.

Example

CMCTL> SHOW RULES

Rule List
-----------------------------------------
(rule=(src=144.25.185.60)(dst=sales-server)(srv=sales.us.acme.com)(act=accept))
(rule=(src=client-pc)(dst=sales-server)(srv=sales.us.acme.com)(act=accept))

SHUTDOWN

Purpose

Use the SHUTDOWN command to shut down the Oracle Connection Manager processes.

Prerequisites

None

Syntax

From the operating system:

cmctl SHUTDOWN [normal | abort] [cman]

From the Oracle Connection Manager Control utility:

CMCTL> SHUTDOWN [normal | abort] [cman]

Arguments

[normal] (default): Specify to accept new connections and terminate after all existing connections close.

[abort]: Specify to shut down Oracle Connection Manager immediately, closing down all open connections.

[cman]: Specify to start both CMGW and CMADMIN processes. normal and abort use this argument. Therefore, it is not necessary to explicitly specify it.

Example

CMCTL> SHUTDOWN
The command completed successfully

CMCTL> SHUTDOWN ABORT
The command completed successfully

START

Purpose

Use the START command to start Oracle Connection Manager.

Prerequisites

An Oracle Connection Manager configured with the same protocol address must not be running.

Syntax

From the operating system:

cmctl START [cman | cm]

From the Oracle Connection Manager Control utility:

CMCTL> START [cman | cm]

Arguments

[cman] (default): Specify to start both CMGW and CMADMIN processes.

[cm]: Specify to start the CMGW process.

Usage Notes

The SET DISPLAYMODE command changes the format and the level of detail of the output.

Examples

compat mode:

CMCTL> START cman
ADMIN Status:
(STATUS=(VERSION=9.2.0.2.0)(STARTED=22-JAN-2002 19:34:15)(STATE=RUNNING))
CMAN Status:
(STATUS=(VERSION=9.2.0.2.0)(STARTED=22-JAN-2002 19:34:17)(STATE=running))

verbose mode:

CMCTL> START cman
Starting /vobs/oracle/bin/cmadmin: please wait...
STATUS of the cman_admin
-----------------------------------------
ADMIN Version             9.2.0.2.0
Start-up time             22-JAN-2002 19:40:00
Current state             RUNNING


Starting /vobs/oracle/bin/cmgw: please wait...
STATUS of the cman
-----------------------------------------
CMAN  Version             9.2.0.2.0
Start-up time             22-JAN-2002 19:40:02
Current state             running

STATS

Purpose

Use the STATS command to display statistical information for Oracle Connection Manager.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl STATS [cman | cm]

From the Oracle Connection Manager Control utility:

CMCTL> STATS [cman | cm]

Arguments

[cman] (default): Specify to display statistics both the CMGW and CMADMIN processes.

[cm]: Specify to display status information for the CMGW process.

Usage Notes

The following statistics are displayed:

Usage Notes

The SET DISPLAYMODE command changes the format and the level of detail of the output.

Examples

compat mode:

CMCTL> STATS
CMAN Status:
(STATISTICS=(TOTAL_RELAYS=0)(ACTIVE_RELAYS=0)(MOST_RELAYS=0)(OUT_OF_
RELAY=0)(TOTAL_REFUSED=0))

verbose mode:

CMCTL> STATS
STATISTICS of CMAN
-----------------------------------------
Total number of connections handled               0
Number of currently active relays                 0
Peak active relays                                0
Total refusals due to max_relays exceeded         0
Total number of connections refused               0

STATUS

Purpose

Use the STATUS command to display basic status information, including version, start time, and current statistics.

Prerequisites

None

Syntax

From the operating system:

cmctl STATUS [cman | cm]

From the Oracle Connection Manager Control utility:

CMCTL> STATUS [cman | cm]

Arguments

[cman] (default): Specify to display status information for both the CMGW and CMADMIN processes.

[cm]: Specify to display status information for the CMGW process.

Usage Notes

The SET DISPLAYMODE command changes the format and the level of detail of the output.

Examples

compat mode:

CMCTL> STATUS
CMAN Status:
(STATUS=(VERSION=9.2.0.2.0)(STARTED=22-JAN-2002 19:34:17)(STATE=running))
ADMIN Status:
(STATUS=(VERSION=9.2.0.2.0)(STARTED=22-JAN-2002 19:34:15)(STATE=RUNNING))

verbose mode:

CMCTL> STATUS
STATUS of the cman
-----------------------------------------
CMAN  Version             9.2.0.2.0
Start-up time             22-JAN-2002 19:40:02
Current state             running

STATUS of the cman_admin
-----------------------------------------
ADMIN Version             9.2.0.2.0
Start-up time             22-JAN-2002 19:40:00
Current state             RUNNING

STOP

Purpose

Use the STOP command to shut down Oracle Connection Manager immediately.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl STOP [cman | cm]

From the Oracle Connection Manager Control utility:

CMCTL> STOP [cman | cm]

Arguments

[cman] (default): Specify to stop both CMGW and CMADMIN processes.

[cm]: Specify to stop both CMGW and CMADMIN processes.

Usage Notes

Oracle recommends the SHUTDOWN command to this command.

If you issue a stop command while connections remain active, you are prompted to confirm the stop.

The SET DISPLAYMODE command changes the format and the level of detail of the output.

Examples

compat mode:

CMCTL> STOP
The command completed successfully.

verbose mode:

CMCTL> STOP
The command completed successfully.

STOPNOW

Purpose

Use the STOPNOW command to shut down Oracle Connection Manager immediately, closing down all open connections without warning.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl STOPNOW [cman | cm]

From the Oracle Connection Manager Control utility:

CMCTL> STOPNOW [cman | cm]

Arguments

[cman] (default): Specify to stop both CMGW and CMADMIN processes.

[cm]: Specify to stop both CMGW and CMADMIN processes.

Usage Notes

Oracle recommends the SHUTDOWN command to this command.

Example

CMCTL> STOPNOW


VERSION

Purpose

Use the VERSION command to display the current version and name of the Oracle Connection Manager Control utility.

Prerequisites

None

Syntax

From the operating system:

cmctl VERSION

From the Oracle Connection Manager Control utility:

CMCTL> VERSION

Usage Notes

The SET DISPLAYMODE command changes the format of the output.

Examples

compat mode:

CMCTL> VERSION
CMCTL Version             9.2.0.2.0

verbose mode:

CMCTL> VERSION
CMCTL Version             9.2.0.2.0
CMAN  Version             9.2.0.2.0