Oracle® Database Net Services Reference 11g Release 2 (11.2) Part Number E10835-09 |
|
|
PDF · Mobi · ePub |
This chapter describes the commands and associated syntax of the Oracle Connection Manager Control utility.
This chapter contains the following topics:
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 [argument]
You can use Oracle Connection Manager Control utility in command mode, or batch mode.
Using the command mode:
From the Oracle Connection Manager Control utility:
Enter cmctl
at the command line to obtain the program prompt; then issue the command:
cmctl
CMCTL> command
From the operating system:
Enter the entire command from the operating system command prompt:
cmctl [command] [argument1 . . . argumentN] [-c instance_name]
Each command issued in this way can have the name of an Oracle Connection Manager appended as an argument. If an Oracle Connection Manager instance name is not provided, then the default instance name is assumed. The default name is cman_
hostname
. You may be prompted for a password if one was set in a previous CMCTL session. Issuing commands from an Oracle Connection Manager Control utility session of Oracle Connection Manager requires that a password be entered once, at the beginning of the session, if one has been set.
Caution:
There is an option to specify the password on the command line. However, this exposes the password on the screen, and is a potential security risk. Oracle recommends not using the password option (-p
) on the command line.See Also:
Oracle Database Net Services Administrator's Guide for an overview of the Oracle Connection Manager processesUsing the batch mode:
You can combine commands in a standard text file and then run them as a sequence of commands. To run in batch mode, use the following syntax:
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:
You can use SET commands to dynamically alter configuration parameters, the changes only remain in effect until the Oracle Connection Manager is shut down. You cannot save them to thecman.ora
file. The one exception is the Oracle Connection Manager password, which you can save using the command SAVE_PASSWD.This section lists and describes the following commands for the Oracle Connection Manager Control utility:
NETRF858Purpose
To select an Oracle Connection Manager instance.
NETRF859Prerequisites
None
NETRF860Syntax
From the Oracle Connection Manager Control utility:
CMCTL> ADMINISTER [-c] instance_name
NETRF861Arguments
instance_name: The instance of Oracle Connection Manager that you would like to administer. Instances are defined in the cman.ora
file.
NETRF862Usage Notes
You can issue the ADMINISTER
command only within the utility. 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.
Use the -c
option when you want to administer an instance that is not the local instance.
A password is required only if one was provided at installation time or during a previous session of the Oracle Connection Manager.
NETRF863Example
CMCTL> ADMINISTER cman_indl040ad
Enter CMAN password: password
Current instance cman_indl040ad is already started
Connections refer to (address=(protocol=TCP)(host=indl040ad)(port=1560)).
The command completed successfully
NETRF1874Purpose
To terminate connections, using specific qualifiers to select connections.
NETRF1875Prerequisites
Oracle Connection Manager must be running.
NETRF1876Syntax
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]
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]
NETRF1877Arguments
state:
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, then CLOSE CONNECTIONS
defaults to all possible states. If the time qualifier is included under these conditions, then the time specified is the amount of time that has elapsed since a client initiated a connection.
time: The time format. Use the following format to specify connections greater than the time indicated:
gt[
hh
:
mm
:]
ss
source: The source address. Use one of the following formats to specify the source address:
from
IP
from
hostname
from
subnet
destination: The destination address. Use one of the following formats to specify the destination address:
to
IP
to
hostname
to
subnet
service: The service name. Use the service_name
parameter to specify the service, such as sales.us.example.com
.
gateway_process_id: The gateway process identifier is a number. Use this number to specify connections that are proxied by the gateway process indicated. To determine the gateway process identifier, use the Oracle Connection Manager control utility show gateways
command.
connect_identifier_list: The connection identifiers. Use a space between multiple connection identifiers in a list.
NETRF1878Usage Notes
Because the CLOSE
CONNECTIONS
command terminates 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.
NETRF1879Examples
The following example 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, and the destination is the specified host name.
CMCTL> CLOSE CONNECTIONS gt 1:30:00 from 192.168.2.32/27 to host1
The following example shuts down those connections proxied by gateway process 0
that have been in the idle state more than 30 minutes:
CMCTL> CLOSE idle CONNECTIONS gt 30:00 using 0
The following example shuts down connections that are connected to the service sales.us.example.com
:
CMCTL> CLOSE established CONNECTIONS for sales.us.example.com
NETRF870Purpose
To exit from the Oracle Connection Manager Control utility.
NETRF871Prerequisites
None
NETRF872Syntax
From the operating system:
cmctl EXIT [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> EXIT
NETRF873Usage Notes
This command is identical to the QUIT command.
NETRF874Example
CMCTL> EXIT
NETRF875Purpose
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.
NETRF876Prerequisites
None
NETRF877Syntax
From the operating system:
cmctl HELP [command] [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> HELP [command]
NETRF878Arguments
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.
NETRF879Example
CMCTL> HELP The following operations are available An asterisk (*) denotes a modifier or extended command: administer close* exit reload resume* save_passwd set* show* shutdown sleep startup suspend* show_version quit
NETRF880Purpose
To exit the Oracle Connection Manager Control utility and return to the operating system prompt.
NETRF881Prerequisites
None
NETRF882Syntax
From the operating system:
cmctl QUIT
From the Oracle Connection Manager Control utility:
CMCTL> QUIT
NETRF883Usage Notes
This command is identical to the EXIT command.
NETRF884Example
CMCTL> QUIT
NETRF885Purpose
To dynamically reread parameters and rules.
NETRF886Prerequisites
Oracle Connection Manager must be running.
NETRF887Syntax
From the operating system:
cmctl RELOAD [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> RELOAD
NETRF888Usage Notes
Configuration information modified using the RELOAD
command applies only to new connections. Existing connections are unaffected. The SET RELOAD
command restores configurations set in cman.ora
, and override the SET
command.
RELOAD
reregisters gateways with the Oracle Connection Manager listener during which some new connections might be refused until the registration process is complete.
NETRF889Example
CMCTL> RELOAD The command completed successfully
NETRF890Purpose
To resume gateway processes that have been suspended.
NETRF891Prerequisites
Oracle Connection Manager must be running.
NETRF892Syntax
From the operating system:
cmctl RESUME GATEWAYS [gateway_process_id] [cman_name]
From the Oracle Connection Manager Control utility:
CMCTL> RESUME GATEWAYS [gateway_process_id]
NETRF893Arguments
gateway_process_id: One or more gateway processes to reopen. Separate multiple gateway processes using a space between the process identifiers.
NETRF894Usage Notes
Issuing RESUME GATEWAYS
without an argument reopens all gateway processes that have been closed.
NETRF895Example
CMCTL> RESUME GATEWAYS 1 The command completed successfully
NETRF896Purpose
To save the current password to the cman.ora
file, the configuration file for Oracle Connection Manager.
NETRF897Prerequisites
Oracle Connection Manager must be running.
NETRF898Syntax
From the operating system:
cmctl SAVE_PASSWD [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SAVE_PASSWD
NETRF899Usage Notes
If you run this command, then the next session of Oracle Connection Manager will use this password. The password is stored in an encrypted format in the cman.ora
file.
NETRF900Example
CMCTL> SAVE_PASSWD
NETRF901Purpose
To display a list of parameters that can be modified using this command.
NETRF902Prerequisites
None
NETRF903Syntax
From the operating system:
cmctl SET
From the Oracle Connection Manager Control utility:
CMCTL> SET
NETRF904Example
CMCTL> 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
NETRF905Purpose
To indicate whether the client must use Oracle Advanced Security to authenticate.
NETRF906Prerequisites
Oracle Connection Manager must be running.
NETRF907Syntax
From the operating system:
cmctl SET ASO_AUTHENTICATION_FILTER {on | off}[-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SET ASO_AUTHENTICATION_FILTER {on | off}
NETRF908Arguments
on: To reject connections that are not using Secure Network Service (SNS) to perform client authentication. SNS is part of Oracle Advanced Security.
off: To specify whether no authentication is required for client connections. This is the default.
NETRF909Example
CMCTL> set aso_authentication_filter ON CMAN_user.us.example.com parameter aso_authentication_filter set to ON The command completed successfully
NETRF910Purpose
To specify whether gateway processes collect connection statistics.
NETRF911Prerequisites
Oracle Connection Manager must be running.
NETRF912Syntax
From the operating system:
cmctl SET CONNECTION_STATISTICS {yes | no}[-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SET CONNECTION_STATISTICS {yes | no}
NETRF913Arguments
yes: To have gateway processes collect connection statistics.
no: To not have gateway processes collect connection statistics. This is the default.
NETRF914Usage Notes
If SET CONNECTION_STATISTICS
is set to yes
, then you can obtain statistics by issuing the SHOW CONNECTIONS command.
NETRF915Example
CMCTL> set connection_statistics ON CMAN_user.us.example.com parameter connection_statistics set to ON The command completed successfully
NETRF916Purpose
To log information for a particular event.
NETRF917Syntax
From the operating system:
cmctl SET EVENT event_group [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SET EVENT event_group {on | off}
NETRF918Arguments
event_group: Specify one of the following event groups:
init_and_term: Initialization and termination event group.
memory_ops: Memory operations event group.
conn_hdlg: Connection handling event group.
proc_mgmt: Process management event group.
reg_and_load: Registration and load update event group.
wake_up: Events related to CMADMIN wakeup queue event group.
timer: Gateway timeouts event group.
cmd_proc: Command processing event group.
relay: Events associated with connection control blocks event group.
on: To turn an event group on.
off: To turn an event group off.
NETRF919Usage Notes
The SET EVENT
command accepts only one argument. To log multiple events, you must issue the command for each event separately.
NETRF920Example
CMCTL> set event memory_ops off cman11 event memory_ops set to OFF. The command completed successfully
NETRF921Purpose
To specify the amount of time a client can be idle without transmitting data.
NETRF922Prerequisites
Oracle Connection Manager must be running.
NETRF923Syntax
From the operating system:
cmctl SET IDLE_TIMEOUT [time] [-c instance_name]
From the From the Oracle Connection Manager Control utility:
CMCTL> SET IDLE_TIMEOUT [time]
NETRF924Arguments
time: Specify the idle timeout in seconds. The default is 0
, which disables this feature.
NETRF925Example
CMCTL> SET IDLE_TIMEOUT 30 CMAN_user.us.example.com parameter idle_timeout set to 30 The command completed successfully
NETRF926Purpose
To specify the maximum amount of time the Oracle Connection Manager listener waits for a valid connection request from the client before timing out.
NETRF927Prerequisites
Oracle Connection Manager must be running.
NETRF928Syntax
From the operating system:
cmctl SET INBOUND_CONNECT_TIMEOUT [time] [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SET INBOUND_CONNECT_TIMEOUT [time]
NETRF929Arguments
time: The inbound connect timeout in seconds. The default is 0, which disables this feature.
NETRF930Example
CMCTL> SET INBOUND_CONNECT_TIMEOUT 30 CMAN_user.us.example.com parameter inbound_connect_timeout set to 30 The command completed successfully
Note:
This command works only if Automatic Diagnostic Repository (ADR) is not enabled. The default is for ADR to be enabled, and the log directory isORACLE_HOME/log
.NETRF1897Purpose
To designate where the log files for an Oracle Connection Manager are written.
NETRF1898Prerequisites
Oracle Connection Manager must be running.
NETRF1899Syntax
From the operating system:
cmctl SET LOG_DIRECTORY [directory_path] [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SET LOG_DIRECTORY [directory_path]
NETRF1900Arguments
directory_path: The location of the log directory. The default path is as follows:
Linux and UNIX:
ORACLE_HOME/network/log directory
Microsoft Windows:
ORACLE_HOME\network\log directory
NETRF1901Usage Notes
Use the SHOW PARAMETERS command to determine the location of the log files.
NETRF1902Example
CMCTL> SET LOG_DIRECTORY /disk1/user_cman_test/oracle/network/admin CMAN_user.us.example.com parameter log_directory set to /disk1/user _cman_test/oracle/network/admin The command completed successfully
NETRF937Purpose
To set the log level for an Oracle Connection Manager.
NETRF938Prerequisites
Oracle Connection Manager must be running.
NETRF939Syntax
From the operating system:
cmctl SET LOG_LEVEL [level] [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SET LOG_LEVEL [level]
NETRF940Arguments
level: Specify one of the following log levels:
off: No logging.
user: User log information.
admin: Administrative log information.
support: Oracle Support Services log information. This is the default.
NETRF941Usage Notes
Specify off
to capture the minimum amount of log information. Specify support
to capture the maximum amount.
NETRF942Example
CMCTL> SET LOG_LEVEL SUPPORT CMAN_user.us.example.com parameter log_level set to support The command completed successfully
NETRF943Purpose
To specify the maximum amount of time the Oracle Connection Manager instance waits for a valid connection with the server before timing out.
NETRF944Prerequisites
Oracle Connection Manager must be running.
NETRF945Syntax
From the operating system:
cmctl SET OUTBOUND_CONNECT_TIMEOUT [time] [-c instance_name]
From the From the Oracle Connection Manager Control utility:
CMCTL> SET OUTBOUND_CONNECT_TIMEOUT [time]
NETRF946Arguments
time: The outbound connect timeout in seconds. The default is 0
.
NETRF947Example
CMCTL> SET OUTBOUND_CONNECT_TIMEOUT 30 CMAN_user.us.example.com parameter outbound_connect_timeout set to 30 The command completed successfully
NETRF948Purpose
To assign a password to the Oracle Connection Manager instance.
NETRF949Prerequisites
Oracle Connection Manager must be running.
NETRF950Syntax
From the operating system:
cmctl SET PASSWORD
From the Oracle Connection Manager Control utility:
CMCTL> SET PASSWORD
NETRF951Arguments
None.
NETRF952Usage 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 after you have set it, run the SAVE_PASSWD command.
NETRF953Example
CMCTL> SET PASSWORD Enter Old password: old_password Enter New password: new_password Reenter New password: new_password The command completed successfully
NETRF954Purpose
To specify the maximum amount of time for a session of Oracle Connection Manager.
NETRF955Prerequisites
Oracle Connection Manager must be running.
NETRF956Syntax
From the operating system:
cmctl SET SESSION_TIMEOUT [time] [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SET SESSION_TIMEOUT [time]
NETRF957Arguments
time: The session timeout in seconds. The default is 0
, which disables this feature.
NETRF958Example
CMCTL> SET SESSION_TIMEOUT 60 CMAN_user.us.example.com parameter session_timeout set to 60 The command completed successfully
Note:
This command works only if Automatic Diagnostic Repository (ADR) is not enabled. The default is for ADR to be enabled.NETRF1903Purpose
To designate where the trace files for an Oracle Connection Manager are written.
NETRF1904Prerequisites
Oracle Connection Manager must be running.
NETRF1905Syntax
From the operating system:
cmctl SET TRACE_DIRECTORY [directory_path] [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SET TRACE_DIRECTORY [directory_path]
NETRF1906Arguments
directory_path: The location of the trace directory. The default path is ORACLE_HOME/network/trace
.
NETRF1907Usage Notes
Use the SHOW PARAMETERS command to determine the location of the trace files.
NETRF1908Example
CMCTL>SET TRACE_DIRECTORY /disk1/mpurayat_newtest/oracle/network/trace cman1 parameter trace_directory set to /disk1/mpurayat_newtest/oracle/network /trace The command completed successfully
NETRF965Purpose
To set the trace level for an Oracle Connection Manager.
NETRF966Prerequisites
Oracle Connection Manager must be running.
NETRF967Syntax
From the operating system:
cmctl SET TRACE_LEVEL [level] [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SET TRACE_LEVEL [level]
NETRF968Arguments
level: Specify one of the following log levels:
off: No tracing. This is the default.
user: User trace information.
admin: Administrative trace information.
support: Oracle Support Services trace information.
NETRF969Usage Notes
Specify off
to capture the minimum amount of trace information. Specify support
to capture the maximum amount.
Use the SHOW PARAMETERS command to determine the current trace level.
NETRF970Example
CMCTL> SET TRACE_LEVEL SUPPORT CMAN_user.us.example.com parameter trace_level set to user The command completed successfully
NETRF971Purpose
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.
NETRF972Prerequisites
None
NETRF973Syntax
From the operating system:
cmctl SHOW [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SHOW
NETRF974Example
CMCTL> 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
NETRF975Purpose
To combine and display output from the SHOW PARAMETERS
and SHOW RULES
commands.
NETRF976Prerequisites
Oracle Connection Manager must be running.
NETRF977Syntax
From the operating system:
cmctl SHOW ALL [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SHOW ALL
NETRF978Example
CMCTL> SHOW ALL listener_address | (address=(protocol=tcp)(host=users.us.example.com)(port=1630)) aso_authentication_filter | OFF connection_statistics | OFF event_group | OFF log_directory | /disk1/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 trace_directory | /disk1/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
NETRF979Purpose
To display information about specific connections or all connections.
NETRF980Prerequisites
Oracle Connection Manager must be running.
NETRF981Syntax
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]
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]
NETRF982Arguments
information: Specify one of the following values to display information about connections. Information categories include connection ID, source, destination, service, current state, total idle time, and total elapsed time.
count: The total number of connections that meet the criteria specified by the other qualifiers. This is the default.
detail: All information about connections specified by the other qualifiers.
state: Specify 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, then SHOW CONNECTIONS
defaults to all possible states. If the time qualifier is included under these conditions, then the time specified is the amount of time that has elapsed since a client initiated a connection.
time: Use the following format to specify connections greater than the time indicated:
gt[
hh
:
mm
:]
ss
source: Specify one of the following formats to specify the source address:
from
IP
from
hostname
from
subnet
destination: Specify one of the following formats to specify the destination address:
to
IP
to
hostname
to
subnet
service: Use the service_name format to request a service:
gateway_process_id: Use the following format to specify connections that are proxied by the gateway process indicated:
using gateway_process_id
connect_identifier_list: Separate multiple connection identifiers using a space.
NETRF983Usage Notes
Connections are sorted by gateway process ID and connection identifier, in ascending order.
Issuing SHOW CONNECTIONS
without an argument displays all connections.
NETRF984Examples
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 192.168.2.32/27 to host1
The following displays the number of connections proxied by Oracle Connection Manager using the gateway process identifier 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.example.com
:
CMCTL> SHOW established CONNECTIONS detail for sales.us.example.com
NETRF985Purpose
To display default parameter settings.
NETRF986Prerequisites
Oracle Connection Manager must be running.
NETRF987Syntax
From the operating system:
cmctl SHOW DEFAULTS [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SHOW DEFAULTS
NETRF988Example
CMCTL> SHOW DEFAULTS listener_address | (ADDRESS=(PROTOCOL=TCP)(HOST=users.us.example.com)(PORT=1521)) aso_authentication_filter | OFF connection_statistics | OFF event_group | OFF log_directory | /disk1/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 trace_directory | /disk1/user_cman_test/oracle/network/trace/ trace_level | OFF trace_timestamp | OFF trace_filelen | 0 trace_fileno | 0 The command completed successfully
NETRF989Purpose
To display the events that are in operation.
NETRF990Prerequisites
Oracle Connection Manager must be running.
NETRF991Syntax
From the operating system:
cmctl SHOW EVENTS [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SHOW EVENTS
NETRF992Example
CMCTL> SHOW EVENTS Event Groups: memory_ops The command completed successfully
NETRF993Purpose
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.
NETRF994Prerequisites
Oracle Connection Manager must be running.
NETRF995Syntax
From the operating system:
cmctl SHOW GATEWAYS [gateway] [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SHOW GATEWAYS [gateway]
NETRF996Arguments
gateway: The identifier of the gateway or gateways whose status you want to display.
Issuing SHOW GATEWAYS
without an argument displays the status of all gateway processes.
NETRF997Usage Notes
To display multiple gateways, then use a space to separate the identifiers when entering the command.
NETRF998Example
CMCTL> 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
NETRF999Purpose
To display current parameter settings for an instance.
NETRF1000Prerequisites
Oracle Connection Manager must be running.
NETRF1001Syntax
From the operating system:
cmctl SHOW PARAMETERS [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SHOW PARAMETERS
NETRF1002Usage 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.
NETRF1003Example
CMCTL> SHOW PARAMETERS listener_address | (address=(protocol=tcp)(host=users.us.example.com)(port=1630)) aso_authentication_filter | ON connection_statistics | ON event_group | (memory_ops) log_directory | /disk1/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 trace_directory | /disk1/user_cman_test/oracle/network/trace/ trace_level | SUPPORT trace_timestamp | OFF trace_filelen | 0 trace_fileno | 0 The command completed successfully
NETRF1004Purpose
To display the access control list currently used by the instance.
NETRF1005Prerequisites
Oracle Connection Manager must be running.
NETRF1006Syntax
From the operating system:
cmctl SHOW RULES [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SHOW RULES
NETRF1007Usage Notes
You can update the rules list by issuing the RELOAD command.
NETRF1008Example
CMCTL> 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=users.us.example.com) (dst=users.us.example.com) (srv=cmon) (act=accept) (action_list=(mit=100)(mct=1130)(moct=200)(aut=on)) ) )
NETRF1009Purpose
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, both refused and current.
NETRF1010Prerequisites
Oracle Connection Manager must be running.
NETRF1011Syntax
From the operating system:
cmctl SHOW SERVICES [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SHOW SERVICES
NETRF1012Example
CMCTL> 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=users)(PORT=33168)) The command completed successfully
NETRF1013Purpose
To display basic information about the instance, including version, start time, and current statistics.
NETRF1014Prerequisites
Oracle Connection Manager must be running.
NETRF1015Syntax
From the operating system:
cmctl SHOW STATUS
From the Oracle Connection Manager Control utility:
CMCTL> SHOW STATUS
NETRF1016Example
CMCTL> SHOW STATUS Status of the Instance ---------------------- Instance name CMAN_user.us.example.com Version CMAN for Linux: Version 11.2.0.0.0 Start date 20-JAN-2008 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 /disk1/user_cman_test/oracle/network/admin/cman.ora Instance Log directory /disk1/user_cman_test/oracle/network/log/ Instance Trace directory /disk1/user_cman_test/oracle/network/trace/ The command completed successfully
NETRF1017Purpose
To display the current version and name of the Oracle Connection Manager Control utility.
NETRF1018Prerequisites
None
NETRF1019Syntax
From the operating system:
cmctl SHOW VERSION [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SHOW VERSION
NETRF1020Examples
CMCTL> SHOW VERSION CMAN for Linux: Version 11.2.0.0.0 The command completed successfully
NETRF1021Purpose
To shut down specific gateway processes or the entire Oracle Connection Manager instance.
NETRF1022Prerequisites
Oracle Connection Manager must be running.
NETRF1023Syntax
From the operating system:
cmctl SHUTDOWN [gateways gateway] [normal | abort] [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SHUTDOWN [gateways gateway] {normal | abort}
NETRF1024Arguments
gateways: To shut down a specific gateway.
normal: To reject new connections and terminate after existing connections close. This is the default.
abort: To shut down Oracle Connection Manager immediately, and close all open connections.
To specify more than one gateway, separate gateways using a space.
NETRF1025Usage Notes
Issuing SHUTDOWN
without an argument shuts down all gateways.
NETRF1026Example
CMCTL> SHUTDOWN GATEWAYS 0 The command completed successfully
NETRF1027Purpose
To start Oracle Connection Manager.
NETRF1028Prerequisites
Another Oracle Connection Manager configured with the same protocol address must not be running.
NETRF1029Syntax
From the operating system:
cmctl STARTUP [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> STARTUP
NETRF1030Usage Notes
Before issuing this command, you must use the ADMINISTER command to select an instance to start.
Issuing this command starts all instance components, which are the listener, CMADMIN, and the gateway processes. The command fails if any one of these components is already running.
NETRF1031Example
CMCTL> STARTUP Starting CMAN instance: CMAN_user.us.example.com, please wait... TNS-04090: *** CMCTL WARNING: No password set in the CMAN instance *** CMAN for Linux: Version 11.2.0.0.0 Status of the Instance ---------------------- Instance name CMAN_user.us.example.com Version CMAN for Linux: Version 11.2.0.0.0 Start date 20-JAN-2008 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 /disk1/user_cman_test/oracle/network/admin/cman.ora Instance Log directory /disk1/user_cman_test/oracle/network/log/ Instance Trace directory /disk1/user_cman_test/oracle/network/trace/ The command completed successfully
NETRF1032Purpose
To specify which gateway processes that will no longer accept new client connections.
NETRF1033Prerequisites
Oracle Connection Manager must be running.
NETRF1034Syntax
From the operating system:
cmctl SUSPEND GATEWAY [gateway_process_id] [-c instance_name]
From the Oracle Connection Manager Control utility:
CMCTL> SUSPEND GATEWAY [gateway_process_id]
NETRF1035Arguments
gateway_process_id: The gateway process that will no longer accept new connections. Specify multiple gateway processes by putting a space between entries.
Issuing SUSPEND GATEWAY
without an argument suspends all gateway processes.
NETRF1036Usage Notes
Use the RESUME GATEWAYS command to enable gateway processes to accept new connections.
NETRF1037Example
CMCTL> SUSPEND GATEWAY 1 The command completed successfully