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
Command Modes and Syntax
Distributed Operations
Oracle Connection Manager Control Utility Commands

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.

Command Modes and Syntax

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

cmctl command [argument]

You can choose between two command modes:

Interactive:

Enter cmctl at the command line to obtain the program prompt; then issue the command:
```
cmctl
CMCTL> command
```
One shot:

Enter the entire command from the operating system:
```
cmctl {command} [argument1 . . . argumentN] [-c instance_name] [-p password]
```
Each command issued in this way can have the name of an Oracle Connection Manager and a password appended as arguments. If an Oracle Connection Manager name is not provided, the default instance name is assumed. A password is necessary only if one was set in a previous CMCTL session. Note that an interactive session of Oracle Connection Manager requires that a password be entered only once, at the outset, if one has been set at all.

See Also:
Oracle Database Net Services Administrator's Guide for an overview of the Oracle Connection Manager processes
Batch mode:

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 following format:
```
cmctl @input_file
```

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

Initialization and termination commands such as STARTUP and SHUTDOWN
Alter commands such as SET LOG_LEVEL and SET EVENT
Display commands, such as SHOW STATUS and SHOW RULES
Gateway commands such as SHOW GATEWAYS and RESUME GATEWAYS

Note that while you can use SET commands to dynamically alter configuration parameters, these changes only remain in effect until the Oracle Connection Manager is shut down. You cannot save them to the cman.ora file. The one exception is the Oracle Connection Manager password, which you can save by issuing the command SAVE_PASSWORD.

Distributed Operations

The Oracle Connection Manager Control utility can perform operations on a local or a remote Oracle Connection Manager. Note, however, that an instance must be started locally—that is, on the computer where the instance is located.

To set up one instance of Oracle Connection Manager to remotely administer another:

Configure the tnsnames.ora file on the local computer to include the remote listening address. Assume, for instance, that the local Oracle Connection Manager is called cman1 and that it resides on proxysvr1. Assume, too, that the remote Oracle Connection Manager is called cman2 and that it resides on proxysvr2. The tnsnames.ora file on proxysvr1 would be configured this way:
```
CMAN2=
```

((ADDRESS=(PROTOCOL=tcp)(HOST=proxysvr2)(PORT=1521)))

In the cman.ora file on the remote computer, set the value of the parameter REMOTE_ADMIN to yes as in the following example:
```
CMAN2=
  (CONFIGURATION=
    (ADDRESS=(PROTOCOL=tcp)(host=proxysvr2)(port=1521))
    (PARAMETER_LIST=
```

(REMOTE_ADMIN=YES)))

Oracle Connection Manager Control Utility Commands

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

ADMINISTER

Purpose

Use the ADMINISTER command to choose an instance of Oracle Connection Manager.

Prerequisites

None.

Syntax

From the Oracle Connection Manager Control utility:

CMCTL> ADMINISTER [-c instance_name] using [password]

Arguments

[instance_name]: Specify the instance of Oracle Connection Manager that you would like to administer. Instances are defined in the cman.ora file.

[password]: Specify the password, if any, for this instance of Oracle Connection Manager.

Usage Notes

Issue ADMINISTER only in interactive mode. You cannot issue the command from the operating system.

ADMINISTER enables you to choose an Oracle Connection Manager to administer. To start this Oracle Connection Manager, you must issue .STARTUP

When you omit the instance name from the command, the instance administered defaults to the local instance.

A password is required only if one was provided at install time or during a previous session of the Oracle Connection Manager.

Example

CMCTL> ADMINISTER
Current instance is CMAN_user-sun.us.oracle.com (instance not yet started).
Connections refer to (address=(protocol=tcp)(host=user-sun.us.oracle.com)(port=1630)).
The command completed successfully

CLOSE CONNECTIONS

Purpose

Use the CLOSE CONNECTIONS command to terminate connections, using specific qualifiers to select connections.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl CLOSE CONNECTIONS [in state] [gt time] [from source] [to destination]
[for service] [using gateway_process_id] [connect_identifier_list]
{-c cman_name}{-p password}

From the Oracle Connection Manager Control utility:

CMCTL> CLOSE CONNECTIONS [in state] [gt time] [from source] [to destination] [for service] [using gateway_process_id] [connect_identifier_list]

Arguments

[in state]: Use one of the following values to specify the connection state:

idle—Connections that are inactive in the established state
connecting—Connections that are in the process of connecting
established—Connections that are connected and are transferring data
terminating—Connections that are disconnecting

If no state is specified, CLOSE CONNECTIONS defaults to all possible states. If the time qualifier is included under these conditions, the time specified is the amount of time that has elapsed since a client initiated a connection.

[gt time]: Use the following format to specify connections greater than the time indicated:

gt[hh:mm:]ss

[from source]: Use one of the following formats to specify the source address:

from IP
from hostname
from subnet

[to destination]: Use one of the following formats to specify the destination address:

from IP
from hostname
from subnet

[for service]: Use the following format to request a service:

for service_name

[using gateway_process_id]: Use this format to specify connections that are proxied by the gateway process indicated.

[connect_identifier_list]: Space between multiple connection identifiers in a list.

Usage Notes

Because the CLOSE CONNECTIONS command aborts connections, it might generate error messages on both client and server sides.

The IDLE state qualifier always requires a time qualifier.

Issuing CLOSE CONNECTIONS without an argument closes all connections.

Examples

The following shuts down connections in any state. The elapsed time of the connection must be greater than 1 hour and 30 minutes. The connection source is the specified subnet; the destination, the specified host name.

CMCTL:CMAN_user-sun.us.oracle.com>
CLOSE CONNECTIONS gt 1:30:00 from 206.62.226.32/27 to host1

The following shuts down those connections proxied by gateway process 0 that have been in the idle state more than 30 minutes:

CMCTL:CMAN_user-sun.us.oracle.com> CLOSE idle CONNECTIONS gt 30:00 using 0

The following shuts down connections that are connected to the service sales.us.acme.com:

CMCTL:CMAN_user-sun.us.oracle.com> CLOSE established CONNECTIONS for sales.us.acme.com

EXIT

Purpose

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

Prerequisites

None

Syntax

From the operating system:

cmctl EXIT {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> EXIT

Usage Notes

This command is identical to the QUIT command.

Example

CMCTL:CMAN_user-sun.us.oracle.com> EXIT

HELP

Purpose

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

Prerequisites

None

Syntax

From the operating system:

cmctl HELP [command] {-c instance_name} {-p password}

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:CMAN_user-sun.us.oracle.com> HELP
The following operations are available
An asterisk (*) denotes a modifier or extended command:

administer      close*          exit            reload          
resume*         save_password   set*            show*           
shutdown        sleep           startup         suspend*        
show_version    quit

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 command.EXIT

Example

CMCTL:CMAN_user-sun.us.oracle.com> QUIT

RELOAD

Purpose

Use the RELOAD command to dynamically reread parameters and rules.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl RELOAD {-c instance_name}{-p password}

From the Oracle Connection Manager Control utility:

CMCTL> RELOAD

Usage Notes

Configuration information modified using the command applies only to new connections. Existing connections are unaffected. SETRELOAD, on the other hand, restores configurations set in cman.ora, thereby overriding the SET command.

RELOAD reregisters gateways with the Oracle Connection Manager listener, in the course of which some new connections might be refused.

Example

CMCTL:CMAN_user-sun.us.oracle.com> RELOAD
The command completed successfully

RESUME GATEWAYS

Purpose

Use the RESUME GATEWAYS command to resume gateway processes that have been suspended.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl RESUME GATEWAYS [gateway_process_id]{cman_name}{-p password}

From the Oracle Connection Manager Control utility:

CMCTL> RESUME GATEWAYS [gateway_process_id]

Arguments

[gateway_process_id]: Specify one or more gateway processes to reopen. Space once between entries to specify multiple gateway processes.

Usage Notes

Issuing RESUME GATEWAYS without an argument reopens all gateway processes that have been closed.

Example

CMCTL:CMAN_user-sun.us.oracle.com> RESUME GATEWAYS 1
The command completed successfully

SAVE_PASSWORD

Purpose

Use the SAVE_PASSWORD command to save the current password to cman.ora, the configuration file for Oracle Connection Manager.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SAVE_PASSWORD {-c instance_name}{-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SAVE_PASSWORD

Usage Notes

If you execute this command, the next session of Oracle Connection Manager will start with this password intact.

Example

CMCTL> SAVE_PASSWORD

SET

Purpose

Use the SET command to display a list of parameters that can be modified using this command.

Prerequisites

None

Syntax

From the operating system:

cmctl SET

From the Oracle Connection Manager Control utility:

CMCTL> SET

Example

CMCTL:CMAN_user-sun.us.oracle.com> SET
The following operations are available after set
An asterisk (*) denotes a modifier or extended command:

aso_authentication_filter     outbound_connect_timeout
connection_statistics         password
event                         session_timeout
idle_timeout                  trace_directory
inbound_connect_timeout       trace_level                                                    
log_directory
log_level

SET ASO_AUTHENTICATION_FILTER

Purpose

Use the SET ASO_AUTHENTICATION_FILTER command to indicate whether the client must use Oracle Advanced Security to authenticate.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET ASO_AUTHENTICATION_FILTER {on | off}{-c instance_name}{-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SET ASO_AUTHENTICATION_FILTER {on | off}

Arguments

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

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

Example

CMCTL:CMAN_user-sun.us.oracle.com> set aso_authentication_filter ON
CMAN_user-sun.us.oracle.com parameter aso_authentication_filter set to ON
The command completed successfully

SET CONNECTION_STATISTICS

Purpose

Use the SET CONNECTION_STATISTICS command to specify whether gateway processes collect connection statistics.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET CONNECTION_STATISTICS {yes | no}{-c instance_name}{-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SET CONNECTION_STATISTICS {yes | no}

Arguments

[yes]: Specify to have gateway processes collect connection statistics

[no]: (Default) Specify that gateway processes not collect connection statistics

Usage Notes

If SET CONNECTION_STATISTICS is set to yes, you can obtain statistics by issuing the command SHOW CONNECTIONS.

Example

CMCTL:CMAN_user-sun.us.oracle.com> set connection_statistics ON
CMAN_user-sun.us.oracle.com parameter connection_statistics set to ON
The command completed successfully

SET EVENT

Purpose

Use the SET EVENT command to log information for a particular event.

Syntax

From the operating system:

cmctl SET EVENT event_group [-c instance_name][-p password]

From the Oracle Connection Manager Control utility:

CMCTL> SET EVENT event_group {on | off}

Arguments

[event_group]: Specify one of the following event groups:

init_and_term—initialization and termination
memory_ops—memory operations
conn_hdlg—connection handling
proc_mgmt—process management
reg_and_load—Registration and load update
wake_up—events related to CMADMIN wakeup queue
timer—gateway timeouts
cmd_proc—command processing
relay—events associated with connection control blocks

[on | off]: Specify whether to turn an event group on or off.

Usage Notes

The SET EVENT command accepts only one argument. To log multiple events, you must reissue the command.

Example

CMCTL:CMAN_user-sun.us.oracle.com> set event memory_ops on 
show connections [detail | count] {[in <state>][gt <[[hh:]mm:]ss>]
from <source>][to <destination>][for <service>][using <gw_id>]}
| [<id_list>] - Shows statistics of selected connections
The command completed successfully

SET IDLE_TIMEOUT

Purpose

Use the SET IDLE_TIMEOUT command to specify the amount of time a client can be idle without transmitting data.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET IDLE_TIMEOUT [time] {-c instance_name} {-p password}

From the From the Oracle Connection Manager Control utility:

CMCTL> SET IDLE_TIMEOUT [time]

Arguments

[time]: Specify the idle timeout in seconds. The default is 0, which disables this feature.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SET IDLE_TIMEOUT 30
CMAN_user-sun.us.oracle.com parameter idle_timeout set to 30
The command completed successfully

SET INBOUND_CONNECT_TIMEOUT

Purpose

Use the SET INBOUND_CONNECT_TIMEOUT command to specify the maximum amount of time the Oracle Connection Manager listener will wait for a valid connection request from the client before timing out.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET INBOUND_CONNECT_TIMEOUT {time} {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SET INBOUND_CONNECT_TIMEOUT {time}

Arguments

[time]: Specify the inbound connect timeout in seconds. The default is 60, which disables this feature.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SET INBOUND_CONNECT_TIMEOUT 30
CMAN_user-sun.us.oracle.com parameter inbound_connect_timeout set to 30
The command completed successfully

SET LOG_DIRECTORY

Purpose

Use the SET LOG_DIRECTORY command to designate where the log files for an Oracle Connection Manager are written.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET LOG_DIRECTORY {directory_path} {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SET LOG_DIRECTORY {directory_path}

Arguments

[directory_path]: Specify to indicate the location of the log directory. The default path is as follows:

UNIX:
```
$ORACLE_HOME/network/log directory
```
Windows 2000/NT:
```
ORACLE_HOME\network\log directory
```

Usage Notes

Issue the SHOW PARAMETERS command to determine the location of the log files.

Example

CMCTL:CMAN_user-sun.us.oracle.com>
SET LOG_DIRECTORY /ade/user_cman_test/oracle/network/admin

CMAN_user-sun.us.oracle.com parameter log_directory set to /ade/user
_cman_test/oracle/network/admin

The command completed successfully

SET LOG_LEVEL

Purpose

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

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET LOG_LEVEL {level} {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SET LOG_LEVEL {level}

Arguments

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

off for no logging
user for user log information
admin for administrative log information
support (default) for Oracle Support Services log information

Usage Notes

Choose off to capture a minimum amount of log information. Choose support to capture a maximum amount.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SET LOG_LEVEL SUPPORT
CMAN_user-sun.us.oracle.com parameter log_level set to support
The command completed successfully

SET OUTBOUND_CONNECT_TIMEOUT

Example

Use the SET OUTBOUND_CONNECT_TIMEOUT command to specify the maximum amount of time the Oracle Connection Manager instance will wait for a valid connection with the server before timing out.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET OUTBOUND_CONNECT_TIMEOUT {time} {-c instance_name} {-p password}

From the From the Oracle Connection Manager Control utility:

CMCTL> SET OUTBOUND_CONNECT_TIMEOUT {time}

Arguments

[time]: Specify the outbound connect timeout in seconds. The default is 0.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SET OUTBOUND_CONNECT_TIMEOUT 30
CMAN_user-sun.us.oracle.com parameter outbound_connect_timeout set to 30
The command completed successfully

SET PASSWORD

Purpose

Use the SET PASSWORD command to assign a password to the Oracle Connection Manager instance.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET PASSWORD

From the Oracle Connection Manager Control utility:

CMCTL> SET PASSWORD

Arguments

None.

Usage Notes

This command may be used either to set a password for the first time or to change an existing one.

This command does not save the password to cman.ora. As a result the password is valid only for the current session. To save the password once you have set it, execute the SAVE_PASSWORD command.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SET PASSWORD

Enter Old password: 
Enter New password: 
Reenter New password: 

The command completed successfully

SET SESSION_TIMEOUT

Purpose

Use the SET SESSION_TIMEOUT command to specify the maximum amount of time for a session of Oracle Connection Manager.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET SESSION_TIMEOUT {time} {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SET SESSION_TIMEOUT {time}

Arguments

{time}: Specify the session timeout in seconds. The default is 0, which disables this feature.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SET SESSION_TIMEOUT 60
CMAN_user-sun.us.oracle.com parameter session_timeout set to 60
The command completed successfully

SET TRACE_DIRECTORY

Purpose

Use the SET TRACE_DIRECTORY command to designate where the trace files for an Oracle Connection Manager are written.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET TRACE_DIRECTORY {directory_path} {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SET TRACE_DIRECTORY {directory_path}

Arguments

{directory_path}: Specify to indicate the location of the trace directory. The default path is as follows:

UNIX:
```
$ORACLE_HOME/network/trace
```
Windows 2000/NT:
```
ORACLE_HOME\network\trace
```

Usage Notes

Issue the SHOW PARAMETERS command to determine the location of the trace files.

Example

CMCTL:cman1>SET TRACE_DIRECTORY /ade/mpurayat_newtest/oracle/network/trace
cman1 parameter trace_directory set to /ade/mpurayat_newtest/oracle/network
/trace
The command completed successfully

SET TRACE_LEVEL

Purpose

Use the SET TRACE_LEVEL command to set the trace level for an Oracle Connection Manager.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SET TRACE_LEVEL {level} {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SET TRACE_LEVEL {level}

Arguments

{level}: Specify one of the following log levels:

off (default) for no tracing
user for user trace information
admin for administrative trace information
support for Oracle Support Services trace information

Usage Notes

Choose off to capture a minimum amount of trace information. Choose support to capture a maximum amount.

Issue the SHOW PARAMETERS command to determine the current trace level.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SET TRACE_LEVEL SUPPORT
CMAN_user-sun.us.oracle.com parameter trace_level set to user
The command completed successfully

SHOW

Purpose

Use the SHOW command to display a list of parameters that may be used as arguments for this command. Entering one of these parameters with the command displays the parameter value or values.

Prerequisites

None

Syntax

From the operating system:

cmctl SHOW {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SHOW

Example

CMCTL:CMAN_user-sun.us.oracle.com> SHOW
The following operations are available after show
An asterisk (*) denotes a modifier or extended command:

all             gateways        status
connections     parameters      version
defaults        rules
events          services

SHOW ALL

Purpose

Use the SHOW ALL command to combine and display output from the SHOW PARAMETERS and SHOW RULES commands.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHOW ALL {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SHOW ALL

Example

CMCTL:CMAN_user-sun.us.oracle.com> SHOW ALL
listener_address          | (address=(protocol=tcp)(host=user-sun.us.oracle.com)(port=1630))
aso_authentication_filter |   OFF
connection_statistics     |   OFF
event_group               |   OFF
log_directory             | /ade/user_cman_test/oracle/network/log/
log_level                 | SUPPORT
max_connections           |   256
idle_timeout              |     0
inbound_connect_timeout   |     0
session_timeout           |     0
outbound_connect_timeout  |     0
max_gateway_processes     |    16
min_gateway_processes     |     2
max_cmctl_sessions        |     4
password                  |   OFF
remote_admin              |   OFF
trace_directory           | /ade/user_cman_test/oracle/network/trace/
trace_level               |   OFF
trace_timestamp           |   OFF
trace_filelen             |     0
trace_fileno              |     0
(rule_list=
 (rule=
  (src=*)
  (dst=*)
  (srv=*)
  (act=accept)
 )
)
The command completed successfully

SHOW CONNECTIONS

Purpose

Use the SHOW CONNECTIONS command to display information about specific connections or all connections.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHOW CONNECTIONS [information] [in state] [gt time] [from source]
to destination] [for service] [using gateway_process_id] [connect_identifier_list] 
{-c instance_name}{-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SHOW CONNECTIONS [information][in state] [gt time] [from source]
[to destination] [for service] [using gateway_process_id] [connect_identifier_list]

Arguments

[information]: Use one of the following two values to display information about connections. Information categories include connection ID, source, destination, service, current state, total idle time, and total elapsed time.

count: (default) Displays the total number of connections that meet the criteria specified by the other qualifiers.
detail: Displays all information about connections specified by the other qualifiers.

[in state]: Use one of the following values to specify the connection state:

idle—Connections that are inactive in the established state
connecting—Connections that are in the process of connecting
established—Connections that are connected and are transferring data
terminating—Connections that are disconnecting

If no state is specified, SHOW CONNECTIONS defaults to all possible states. If the time qualifier is included under these conditions, the time specified is the amount of time that has elapsed since a client initiated a connection.

[gt time]: Use the following format to specify connections greater than the time indicated:

gt[hh:mm:]ss

[from source]: Use one of the following formats to specify the source address:

from IP
from hostname
from subnet

[to destination]: Use one of the following formats to specify the destination address:

from IP
from hostname
from subnet

[for service]: Use the following format to request a service:

for service_name

[using gateway_process_id]: Use this format to specify connections that are proxied by the gateway process indicated

using gateway_process_id

[connect_identifier_list]: Space between multiple connection identifiers in a list

Usage Notes

Connections are sorted by gateway process ID and connection identifier, in ascending order.

Issuing SHOW CONNECTIONS without an argument displays all connections.

Examples

The following displays a detailed description of connections in any state. The elapsed time of the connection must be greater than 1 hour and 30 minutes. The connection source is the specified subnet, and the destination the specified host name.

CMCTL> SHOW CONNECTIONS gt 1:30:00 from 206.62.226.32/27 to host1

The following displays the number of connections proxied by cman 0 that have been in the idle state more than 30 minutes:

CMCTL> SHOW idle CONNECTIONS count gt 30:00 using 0

The following displays a detailed description of connections that are connected to the service sales.us.acme.com:

CMCTL> SHOW established CONNECTIONS detail for sales.us.acme.com

SHOW DEFAULTS

Purpose

Use the SHOW DEFAULTS command to display default parameter settings.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHOW DEFAULTS {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SHOW DEFAULTS

Example

CMCTL:CMAN_user-sun.us.oracle.com> SHOW DEFAULTS
listener_address          | (ADDRESS=(PROTOCOL=TCP)(HOST=user-sun.us.oracle.com)(PORT=1521))
aso_authentication_filter |   OFF
connection_statistics     |   OFF
event_group               |   OFF
log_directory             | /ade/user_cman_test/oracle/network/log/
log_level                 | SUPPORT
max_connections           |   256
idle_timeout              |     0
inbound_connect_timeout   |     0
session_timeout           |     0
outbound_connect_timeout  |     0
max_gateway_processes     |    16
min_gateway_processes     |     2
max_cmctl_sessions        |     4
password                  |   OFF
remote_admin              |   OFF
trace_directory           | /ade/user_cman_test/oracle/network/trace/
trace_level               |   OFF
trace_timestamp           |   OFF
trace_filelen             |     0
trace_fileno              |     0
The command completed successfully

SHOW EVENTS

Purpose

Use the SHOW EVENTS command to display the events that are in operation.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHOW EVENTS {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SHOW EVENTS

Example

CMCTL:CMAN_user-sun.us.oracle.com> SHOW EVENTS
Event Groups:
memory_ops
The command completed successfully

SHOW GATEWAYS

Purpose

Use the SHOW GATEWAYS command to display the current status of a specific gateway process or processes. Statistics displayed include number of active connections, number of peak active connections, total number of connections handled, and number of connections refused.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHOW GATEWAYS [  gateway] {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SHOW GATEWAYS [  gateway]

Arguments

[gateway]: Enter the ID of the gateway or gateways whose status you want to display

Issuing SHOW GATEWAYS without an argument displays the status of all gateway processes.

Usage Notes

If you want to display multiple gateways, use a space to separate the ID numbers when entering the command.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SHOW GATEWAYS 1
Gateway ID                     1
Gateway state                  READY
Number of active connections   0
Peak active connections        0
Total connections              0
Total connections refused      0
The command completed successfully

SHOW PARAMETERS

Purpose

Use the SHOW PARAMETERS command to display current parameter settings for an instance.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHOW PARAMETERS {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SHOW PARAMETERS

Usage Notes

Several configuration parameters can be dynamically modified using the SET command; therefore, the information that SHOW PARAMETERS displays might be different from what appears in the cman.ora file.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SHOW PARAMETERS
listener_address          | (address=(protocol=tcp)(host=user-sun.us.oracle.com)(port=1630))
aso_authentication_filter |    ON
connection_statistics     |    ON
event_group               | (memory_ops)
log_directory             | /ade/user_cman_test/oracle/network/log/
log_level                 | SUPPORT
max_connections           |   256
idle_timeout              |     0
inbound_connect_timeout   |     0
session_timeout           |     0
outbound_connect_timeout  |     0
max_gateway_processes     |    16
min_gateway_processes     |     2
max_cmctl_sessions        |     4
password                  |   OFF
remote_admin              |   OFF
trace_directory           | /ade/user_cman_test/oracle/network/trace/
trace_level               | SUPPORT
trace_timestamp           |   OFF
trace_filelen             |     0
trace_fileno              |     0
The command completed successfully

SHOW RULES

Purpose

Use the SHOW RULES command to display the access control list currently used by the instance.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHOW_RULES {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SHOW_RULES

Usage Notes

You can update the rules list by issuing the RELOAD command.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SHOW RULES
Number of filtering rules currently in effect: 4
(rule_list=
  (rule=
    (src=usunnae12)
    (dst=usunnae13)
    (srv=*)
    (act=accept)
    (action_list=(mit=120)(mct=1800)(conn_stats=on)(aut=off))
  )
  (rule=
    (src=usunnae12)
    (dst=usunnae14)
    (srv=service2)
    (act=accept)
  )
  (rule=
    (src=*)
    (dst=usunnae15)
    (srv=*)
    (act=accept)
    (action_list=(mit=120)(mct=3000)(moct=200)(aut=on))
  )

  (rule=
    (src=*)
    (dst=usunnae16)
    (srv=*)
    (act=reject)
    (action_list=(moct=20)(aut=on))
  )

  (rule=
    (src=user-sun.us.oracle.com)
    (dst=user-sun.us.oracle.com)
    (srv=cmon)
    (act=accept)
    (action_list=(mit=100)(mct=1130)(moct=200)(aut=on))
  )
)

SHOW SERVICES

Purpose

Use the SHOW SERVICES command to display comprehensive information about the Oracle Connection Manager instance. The information displayed includes number of handlers for gateway and CMADMIN processes, listening ports of handlers, and number of connections—refused and current.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHOW SERVICES {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SHOW SERVICES

Example

CMCTL:CMAN_user-sun.us.oracle.com> SHOW SERVICES
Services Summary...
Proxy service "cmgw" has 1 instance(s).
  Instance "cman", status READY, has 2 handler(s) for this service...
    Handler(s):
      "cmgw001" established:0 refused:0 current:0 max:256 state:ready
         <machine: user-sun, pid: 29190>
         (ADDRESS=(PROTOCOL=tcp)(HOST=user-sun)(PORT=33175))
      "cmgw000" established:0 refused:0 current:0 max:256 state:ready
         <machine: user-sun, pid: 29188>
         (ADDRESS=(PROTOCOL=tcp)(HOST=user-sun)(PORT=33174))
Service "cmon" has 1 instance(s).
  Instance "cman", status READY, has 1 handler(s) for this service...
    Handler(s):
      "cmon" established:0 refused:0 current:0 max:4 state:ready
         <machine: user-sun, pid: 29184>
         (ADDRESS=(PROTOCOL=tcp)(HOST=user-sun)(PORT=33168))
The command completed successfully

SHOW STATUS

Purpose

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

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHOW STATUS

From the Oracle Connection Manager Control utility:

CMCTL> SHOW STATUS

Example

CMCTL:CMAN_user-sun.us.oracle.com> SHOW STATUS
Status of the Instance
----------------------
Instance name             CMAN_user-sun.us.oracle.com
Version                   CMAN for Solaris: Version 10.1.0.0.0 - Beta
Start date                20-JAN-2003 14:50:35
Uptime                    0 days 1 hr. 25 min. 24 sec
Num of gateways started   2
Average Load level        0
Log Level                 SUPPORT
Trace Level               OFF
Instance Config file      /ade/user_cman_test/oracle/network/admin/cman.ora
Instance Log directory    /ade/user_cman_test/oracle/network/log/
Instance Trace directory  /ade/user_cman_test/oracle/network/trace/
The command completed successfully

SHOW VERSION

Purpose

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

Prerequisites

None

Syntax

From the operating system:

cmctl SHOW VERSION {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SHOW VERSION

Examples

CMCTL:CMAN_user-sun.us.oracle.com> SHOW VERSION
CMAN for Solaris: Version 10.1.0.0.0 - Beta
The command completed successfully

SHUTDOWN

Purpose

Use the SHUTDOWN command to shut down specific gateway processes or the entire Oracle Connection Manager instance.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SHUTDOWN [gateways {gateway}] [normal | abort] {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SHUTDOWN [gateways {gateway}] [normal | abort]

Arguments

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

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

[gateways]: Specify to shut down a specific gateways.

You can specify more than one gateway by inserting a space between them in the command line.

Usage Notes

Issuing SHUTDOWN without an argument shuts down all gateways.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SHUTDOWN GATEWAYS 0
The command completed successfully

STARTUP

Purpose

Use the STARTUP command to start an Oracle Connection Manager.

Prerequisites

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

Syntax

From the operating system:

cmctl STARTUP {-c instance_name} {-p password}

From the Oracle Connection Manager Control utility:

CMCTL> STARTUP

Usage Notes

Before issuing this command, you must issue the ADMINISTER command to choose an instance to start.

Issuing this command starts all three instance components—
the listener, CMADMIN, and the gateway processes.
The command fails if any one of these components is already running.

Example

CMCTL:CMAN_user-sun.us.oracle.com> STARTUP
Starting CMAN instance: CMAN_user-sun.us.oracle.com, please wait...
TNS-04090: *** CMCTL WARNING: No password set in the CMAN instance ***
CMAN for Solaris: Version 10.1.0.0.0 - Beta
Status of the Instance
----------------------
Instance name             CMAN_user-sun.us.oracle.com
Version                   CMAN for Solaris: Version 10.1.0.0.0 - Beta
Start date                20-JAN-2003 19:04:25
Uptime                    0 days 0 hr. 0 min. 3 sec
Num of gateways started   2
Average Load level        0
Log Level                 SUPPORT
Trace Level               OFF
Instance Config file      /ade/user_cman_test/oracle/network/admin/cman.ora
Instance Log directory    /ade/user_cman_test/oracle/network/log/
Instance Trace directory  /ade/user_cman_test/oracle/network/trace/
The command completed successfully

SUSPEND GATEWAY

Purpose

Use the SUSPEND GATEWAY command to choose gateway processes that will no longer accept new client connections.

Prerequisites

Oracle Connection Manager must be running.

Syntax

From the operating system:

cmctl SUSPEND GATEWAY [  gateway_process_id]{-c instance_name}{-p password}

From the Oracle Connection Manager Control utility:

CMCTL> SUSPEND GATEWAY [ gateway_process_id]

Arguments

[gateway_process_id]: Specify the gateway process that will no longer accept new connections. Specify multiple gateway processes by spacing once between entries.

Issuing SUSPEND GATEWAY without an argument suspends all gateway processes.

Usage Notes

Use the RESUME GATEWAYS command to enable gateway processes to accept new connections.

Example

CMCTL:CMAN_user-sun.us.oracle.com> SUSPEND GATEWAY 1
The command completed successfully