Oracle9i Net Services Reference Guide Release 1 (9.0.1) Part Number A90155-01 |
|
This chapter describes the commands and associated syntax of the Oracle Connection Manager Control utility.
This chapter contains these 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 [process_type
]
where process_type
is the name of the Oracle Connection Manager process. The choices are as follows:
cman
for both the gateway process, CMGW, and the administrative process, CMADMIN
cm
for the CMGW process
adm
for the CMADMIN process
For example, the following command starts both the CMGW and CMADMIN processes:
CMCTL START cman
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
]
The Oracle Connection Manager Control utility supports several types of commands:
START
SET LOG_LEVEL
STATUS
and
SHOW ADDRESS
EXIT,
QUIT
, and
HELP
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 save these temporary to the
cman.ora
file.
You can use the SHOW
command to display the current value of a configuration setting.
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:
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))
cmctl START cm cmctl START cman
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.
This section lists and describes the Oracle Connection Manager Control utility commands.
Use the ACCEPT_CONNECTIONS
command to enable or disable Oracle Connection Manager to accept new connections.
Oracle Connection Manager must be running.
From the operating system:
cmctl ACCEPT_CONNECTIONS [on | off]
From the Oracle Connection Manager Control utility:
CMCTL> ACCEPT_CONNECTIONS [on | off]
on
(default)--Specify to enable Oracle Connection Manager to accept new connections.
off
--Specify to rejects new connections to Oracle Connection Manager.
If set to off
, existing connections are not affected.
CMCTL> ACCEPT_CONNECTIONS off Profile of the CMAN ----------------------------------------- Current state offline
Use the CLOSE_RELAY
command to enable a connection identified by relay number to be shut down.
Oracle Connection Manager must be running.
From the operating system:
cmctl CLOSE_RELAY [relay_num | ALL]
From the Oracle Connection Manager Control utility:
CMCTL> CLOSE_RELAY [relay_num | ALL]
relay_num
--Specify the relay number of the connection to terminate immediately.
ALL
--Specify to immediately terminate all connections.
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.
CMCTL> CLOSE_RELAY 0 Relay is not active CMCTL> CLOSE_RELAY 0 The command completed successfully
Use the EXIT
command to exit from the Oracle Connection Manager Control utility.
None
From the operating system:
cmctl EXIT
From the Oracle Connection Manager Control utility:
CMCTL> EXIT
This command is identical to QUIT
command.
CMCTL> EXIT
Use the HELP
command to provide a list of Oracle Connection Manager Control utility commands.
None
From the operating system:
cmctl HELP [command
]
From the Oracle Connection Manager Control utility:
CMCTL> HELP [command
]
HELP
, the Oracle Connection Manager Control utility displays information about how to use the command.
HELP
without an argument, the Oracle Connection Manager Control utility displays a list of all commands.
HELP
commands. Commands are shown in the following example output.
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
Use the QUIT
command to exit the Oracle Connection Manager Control utility and return to the operating system prompt.
None
From the operating system:
cmctl QUIT
From the Oracle Connection Manager Control utility:
CMCTL> QUIT
This command is identical to the EXIT
command.
CMCTL> QUIT
Use the SET
command to alter the Oracle Connection Manager's parameter values. Parameter values 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.
None
From the operating system:
cmctl SET [parameter
]
From the Oracle Connection Manager Control utility:
CMCTL> SET [parameter
]
SET
parameters to modify configuration settings. Parameters are shown in the example output.
CMCTL> SET The following operations are available An asterisk (*) denotes a modifier or extended command:authentication_level
displaymode
log_level
relay_statistics
Use the SET
AUTHENTICATION_LEVEL
command to set the level of security for the Oracle Connection Manager.
Oracle Connection Manager must be running.
From the operating system:
cmctl SET AUTHENTICATION_LEVEL [level
]
From the Oracle Connection Manager Control utility:
CMCTL> SET AUTHENTICATION_LEVEL [level
]
Authentication level:
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.
CMCTL> AUTHENTICATION_LEVEL 0 Profile of the CMAN ----------------------------------------- AUTHENTICATION_LEVEL = 0
Use the SET
DISPLAYMODE
command to change the format and level of detail for the START
,
STATS
,
STATUS
,
STOP
, and
VERSION
commands.
None
From the operating system:
cmctl SET DISPLAYMODE [compat | verbose]
From the Oracle Connection Manager Control utility:
CMCTL> SET DISPLAYMODE [compat | verbose]
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.
CMCTL> SET DISPLAYMODE compat Current display mode is COMPATible
Use the SET LOG_LEVEL
command to set the log level for the Oracle Connection Manager.
Oracle Connection Manager must be running.
From the operating system:
cmctl SET LOG_LEVEL [level]
From the Oracle Connection Manager Control utility:
CMCTL> SET LOG_LEVEL [level]
Log level:
0
(default)--no logging
1
--basic reporting
2
--RULE_LIST
matching lookup reporting
3
--relay blocking reporting
4
--relay I/O counts reporting
CMCTL> SET LOG_LEVEL 0 Profile of the CMAN ----------------------------------------- LOG_LEVEL = 0
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 and cman
pid
.log
file on Windows NT:
Oracle Connection Manager must be running.
From the operating system:
cmctl SET RELAY_STATISTICS [on | off]
From the Oracle Connection Manager Control utility:
CMCTL> SET RELAY_STATISTICS [on | off]
on
--Specify to turn statistic collection on.
off
(default)--Specify to turn statistic collection off.
CMCTL> SET RELAY_STATISTICS off Profile of the CMAN ----------------------------------------- RELAY_STATISTICS = no
Use the command SHOW
to provide a list of the configuration commands that can be shown for the Oracle Connection Manager. When you enter a parameter as an argument to SHOW
, the Oracle Connection Manager Control utility displays the current setting of that parameter.
None
From the operating system:
cmctl SHOW [parameter
]
From the Oracle Connection Manager Control utility:
CMCTL> SHOW [parameter
]
SHOW
parameters. Parameters are shown in the following example output.
CMCTL> SHOW The following operations are available An asterisk (*) denotes a modifier or extended command:address
ALL
displaymodeprofile
relayrules
Use the SHOW
ADDRESS
command to lists the protocol address of the Oracle Connection Manager.
None
From the operating system:
cmctl SHOW ADDRESS
From the Oracle Connection Manager Control utility:
CMCTL> SHOW ADDRESS
None
The address is set with the CMAN
parameter in the
cman.ora
file.
CMCTL> SHOW ADDRESS Address List ----------------------------------------- (ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1594)(PORT=1630)(QUEUESIZE=32)) (ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1594)(PORT=1631)(QUEUESIZE=32))
Use the SHOW
ALL
command to display the output for SHOW ADDRESS
,
SHOW PROFILE
, and
SHOW RULES
commands.
None
From the operating system:
cmctl SHOW ALL
From the Oracle Connection Manager Control utility:
CMCTL> SHOW ALL
None
CMCTL> SHOW ALL Address List ----------------------------------------- (ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1594)(PORT=1630)(QUEUESIZE=32)) (ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1594)(PORT=1631)(QUEUESIZE=32)) 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=x)(srv=x)(act=accept)) (rule=(src=sguan-pc)(dst=x)(srv=x)(act=accept))
Use the SHOW
DISPLAYMODE
to show the current display mode used for the START
,
STATS
,
STATUS
,
STOP
, and
VERSION
commands.
From the operating system:
cmctl SHOW DISPLAYMODE
From the Oracle Connection Manager Control utility:
CMCTL> SHOW DISPLAYMODE
CMCTL> SHOW DISPLAYMODE Current display mode is VERBose
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.
From the operating system:
cmctl SHOW PROFILE
From the Oracle Connection Manager Control utility:
CMCTL> SHOW PROFILE
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
Use the SHOW
RELAY
command to display the current status of a selected relay (connection) or all active relays for the Oracle Connection Manager.
Oracle Connection Manager must be running.
From the operating system:
cmctl SHOW RELAY {relay_num | ACTIVE}
From the Oracle Connection Manager Control utility:
CMCTL> SHOW RELAY {relay_num | ACTIVE}
relay_num
--Specify to show the status information for a specific relay.
ACTIVE
--Specify to show the list of active relays.
For active relays, only relay numbers are shown. For a given relay number, the following information is displayed:
CMCTL> SHOW RELAY active Active Relays ----------------------------------------- 0000 0001 CMCTL> SHOW RELAY 0 Relay Information ----------------------------------------- Relay number 0 Start-up time 22-JAN-2000 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
Use the SHOW
RULES
to display the current access rules used by Oracle Connection Manager.
Oracle Connection Manager must be running.
From the operating system:
cmctl SHOW RULES
From the Oracle Connection Manager Control utility:
CMCTL> SHOW RULES
None
Rules are set with the CMAN_RULES
parameter in the
cman.ora
file.
CMCTL> SHOW RULES Rule List ----------------------------------------- (rule=(src=144.25.185.60)(dst=x)(srv=x)(act=accept)) (rule=(src=sguan-pc)(dst=x)(srv=x)(act=accept))
Use the SHUTDOWN
command to shut down the Oracle Connection Manager processes.
None
From the operating system:
cmctl SHUTDOWN [normal | abort] [cman]
From the Oracle Connection Manager Control utility:
CMCTL> SHUTDOWN [normal | abort] [cman]
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.
CMCTL> SHUTDOWN The command completed successfully CMCTL> SHUTDOWN ABORT The command completed successfully
Use the START
command to start Oracle Connection Manager.
An Oracle Connection Manager configured with the same protocol address must not be running.
From the operating system:
cmctl START [cman | cm]
From the Oracle Connection Manager Control utility:
CMCTL> START [cman | cm]
cman
(default)--Specify to start both CMGW and CMADMIN processes.
cm
--Specify to start the CMGW process.
The SET DISPLAYMODE
command changes the format and the level of detail of the output.
compat
mode:
CMCTL> START cman ADMIN Status: (STATUS=(VERSION=9.0.1.0.0)(STARTED=22-JAN-2000 19:34:15)(STATE=RUNNING)) CMAN Status: (STATUS=(VERSION=9.0.1.0.0)(STARTED=22-JAN-2000 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.0.1.0.0 Start-up time 22-APR-2001 19:40:00 Current state RUNNING Starting /vobs/oracle/bin/cmgw: please wait... STATUS of the cman ----------------------------------------- CMAN Version 9.0.1.0.0 Start-up time 22-APR-2001 19:40:02 Current state running
Use the STATS
command to display statistical information for Oracle Connection Manager.
Oracle Connection Manager must be running.
From the operating system:
cmctl STATS [cman | cm]
From the Oracle Connection Manager Control utility:
CMCTL> STATS [cman | cm]
cman
(default)--Specify to display statistics both the CMGW and CMADMIN processes.
cm
--Specify to display status information for the CMGW process.
The following statistics are displayed:
TOTAL_RELAYS
(compat
) | Total number of connections handled
(verbose
)
The total number of connections that Oracle Connection Manager has established since it started
ACTIVE_DELAYS
(compat
) | Number of currently active relays
(verbose
)
The number of currently active connections
MOST_RELAYS
(compat
) | Peak active relays
(verbose
)
The maximum number of concurrent connections that Oracle Connection Manager has ever held since it started
OUT_OF_RELAY
(compat
) | Total refusals due to max_relays exceeded
(verbose
)
The total number of connect request refusals due to out-of-relays since Oracle Connection Manager started.
TOTAL_REFUSED
(compat
) | Total number of connections refused
(verbose
)
The total number of connect request refusals since Oracle Connection Manager started
The SET DISPLAYMODE
command changes the format and the level of detail of the output.
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
Use the STATUS
command to display basic status information, including version, start time, and current statistics.
None
From the operating system:
cmctl STATUS [cman | cm]
From the Oracle Connection Manager Control utility:
CMCTL> STATUS [cman | cm]
cman
(default)--Specify to display status information for both the CMGW and CMADMIN processes.
cm
--Specify to display status information for the CMGW process.
The SET DISPLAYMODE
command changes the format and the level of detail of the output.
compat
mode:
CMCTL> STATUS CMAN Status: (STATUS=(VERSION=9.0.1.0.0)(STARTED=22-JAN-2001 19:34:17)(STATE=running)) ADMIN Status: (STATUS=(VERSION=9.0.1.0.0)(STARTED=22-JAN-2001 19:34:15)(STATE=RUNNING))
verbose
mode:
CMCTL> STATUS STATUS of the cman ----------------------------------------- CMAN Version 9.0.1.0.0 Start-up time 22-APR-2001 19:40:02 Current state running STATUS of the cman_admin ----------------------------------------- ADMIN Version 9.0.1.0.0 Start-up time 22-APR-2001 19:40:00 Current state RUNNING
Use the STOP
command to shut down Oracle Connection Manager immediately.
Oracle Connection Manager must be running.
From the operating system:
cmctl STOP [cman | cm]
From the Oracle Connection Manager Control utility:
CMCTL> STOP [cman | cm]
cman
(default)--Specify to stop both CMGW and CMADMIN processes.
cm
--Specify to stop both CMGW and CMADMIN processes.
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.
compat
mode:
CMCTL> STOP The command completed successfully.
verbose
mode:
CMCTL> STOP
Use the STOPNOW
command to shut down Oracle Connection Manager immediately, closing down all open connections without warning.
Oracle Connection Manager must be running.
From the operating system:
cmctl STOPNOW [cman | cm]
From the Oracle Connection Manager Control utility:
CMCTL> STOPNOW [cman | cm]
cman
(default)--Specify to stop both CMGW and CMADMIN processes.
cm
--Specify to stop both CMGW and CMADMIN processes.
Oracle recommends the SHUTDOWN
command to this command.
CMCTL> STOPNOW
Use the VERSION
command to display the current version and name of the Oracle Connection Manager Control utility.
None
From the operating system:
cmctl VERSION
From the Oracle Connection Manager Control utility:
CMCTL> VERSION
The SET DISPLAYMODE
command changes the format of the output.
compat
mode:
CMCTL> VERSION CMCTL Version 9.0.1.0.0
verbose
mode:
CMCTL> VERSION CMCTL Version 9.0.1.0.0 CMAN Version 9.0.1.0.0
|
![]() Copyright © 1996-2001, Oracle Corporation. All Rights Reserved. |
|