9
Oracle Connection Manager Parameters (cman.ora)

This chapter provides a complete listing of the cman.ora file configuration parameters.

This chapter contains these topics:

• Overview of Oracle Connection Manager Configuration File
• Oracle Connection Manager Parameters

Overview of Oracle Connection Manager Configuration File

Oracle Connection Manager configuration, stored in the cman.ora file, consists of the following elements:

• Listening protocol addresses of the CMGW process (gateway process) and the CMADMIN process (administrative process)
• Access control parameters
• Control parameters

By default, the cman.ora file is located in the $ORACLE_HOME/network/admin directory on UNIX operating systems and in the ORACLE_HOME\network\admin directory on Windows NT. cman.ora can also be stored the following locations:

• The directory specified by the TNS_ADMIN environment variable or registry value
• On UNIX operating systems, the global configuration directory. For example, on Sun SPARC Solaris, this directory is /var/opt/oracle.

  See Also: Oracle operating system-specific documentation

Figure 9-1 shows an example cman.ora file.

Figure 9-1 Example cman.ora File

 CMAN=
 (ADDRESS=(PROTOCOL=tcp)(HOST=proxysvr)(PORT=1630))
 (ADDRESS=(PROTOCOL=tcps)(HOST=144.25.22.217)(PORT=2484))
CMAN_ADMIN=
 (ADDRESS=(PROTOCOL=tcp)(HOST=proxysvr)(PORT=1830))
CMAN_RULES=
 (RULE=(SRC=206.62.226.32/27)(DST=sales-server)(SRV=*)(ACT=accept)))
CMAN_PROFILE=
  (PARAMETER_LIST= 
 (LOG_LEVEL=2)
 (TRACING=on))

Oracle Connection Manager Parameters

This section lists and describes the cman.ora file parameters. Configuration parameters fall into the following categories:

• Listening Endpoint List
• Route List
• Parameter List

Listening Endpoint List

CMAN

Purpose

Use the parameter CMAN to specify the protocol addresses of the CMGW process.

Default

CMAN=(ADDRESS=(PROTOCOL=tcp)(HOST=local_host)(PORT=1630))

Syntax

CMAN=
  ([ADDRESS_LIST= ]
    (ADDRESS= ...)
   [(ADDRESS= ...)]) 

CMAN_ADMIN

Purpose

Use the parameter CMAN_ADMIN to specify the protocol addresses of the Oracle Connection Manager CMADMIN process.

Default

CMAN_ADMIN=(ADDRESS=(PROTOCOL=tcp)(HOST=anyhost)(PORT=1830))

Syntax

CMAN_ADMIN=
 ([ADDRESS_LIST= ]
    (ADDRESS= ...)
   [(ADDRESS= ...)])

Route List

CMAN_RULES

Purpose

Use the parameter CMAN_RULES to specify an access control rule list to filter incoming connections. A rule list specifies which connections are accepted, rejected, or dropped.

Syntax

CMAN_RULES=
 (RULE_LIST=
   (RULE=
    (SRC=host)
    (DST=host)
    (SRV=service_name|sid)
    (ACT=accept|reject))
    [(RULE= ...)])

Subparameters

The RULE parameter filters a connection or group of connections using the following subparameters:

SRC: Specify the source host name or IP address in dot notation of the client.

DST: Specify the destination server host name or IP address in dot notation of the database server.

SRV: Specify database service name of the Oracle9i or Oracle8i database (obtained from the SERVICE_NAME parameter in the initialization parameter file) or Oracle System Identifier (SID) value of the pre-release 8.1 database (obtained from the ORACLE_SID environment variable or registry value).

ACT: Specify to accept to accept incoming request or reject to reject incoming requests.

Usage Notes

• If no rules are specified, all connections are accepted.
• For rejected connections, Oracle Connection Manager displays an error message. For dropped connections, it displays no message.
• The wildcard for host name is an asterisk (*). In the case of an IP address (d.d.d.d), you can wildcard the individual d's with this character.
• If client's connect descriptors contains both SID and SERVICE_NAME parameters, then both names requested need to be permitted by the rules respectively in order for the client's access to be allowed.

Example

CMAN_RULES=
 (RULE_LIST=
   (RULE=
    (SRC=client1-pc)
    (DST=sales-server)
    (SRV=sales.us.acme.com)
    (ACT=reject))
   (RULE=
    (SRC=144.25.23.45)
    (DST=144.25.187.200)
    (SRV=db1)
    (ACT=accept)))

Parameter List

CMAN_PROFILE

Purpose

Use the parameter CMAN_PROFILE to specify the set attributes for an Oracle Connection Manager. To override a parameter's default setting, enter the parameter and its nondefault value in the PARAMETER_LIST.

Default Parameters

ANSWER_TIMEOUT=0

AUTHENTICATION_LEVEL=0

LOG_LEVEL=0

MAX_FREELIST_BUFFERS=0

MAXIMUM_CONNECT_DATA=1024

MAXIMUM_RELAYS=128

RELAY_STATISTICS=NO

REMOTE_ADMIN=NO

SHOW_TNS_INFO=NO

TRACE_DIRECTORY=The $ORACLE_HOME/network/trace directory on UNIX operating systems and the ORACLE_HOME\network\trace directory on Windows NT

TRACE_FILELEN=unlimited

TRACE_FILENO=1

TRACE_TIMESTAMP=ON

TRACING=NO

USE_ASYNC_CALL=YES

Allowed Values of Parameters

ANSWER_TIMEOUT=[0 to n]

AUTHENTICATION_LEVEL=[0 | 1]

LOG_LEVEL=[0-4]

MAXIMUM_CONNECT_DATA=[257 to 4096]

MAX_FREELIST_BUFFERS=[0 to 10240]

MAXIMUM_RELAYS=[1 to 2048]

RELAY_STATISTICS=[YES | TRUE | ON | 1 | NO | FALSE | OFF | 0]

REMOTE_ADMIN=[YES | TRUE | ON | 1 | NO | FALSE | OFF | 0]

SHOW_TNS_INFO=[YES | TRUE | ON | 1 | NO | FALSE | OFF | 0]

TRACE_DIRECTORY=directory

TRACE_FILELEN=size of file in kilobytes

TRACE_FILENO=[1 to 8]

TRACE_TIMESTAMP=[YES | TRUE | ON | 1 | NO | FALSE | OFF | 0]

TRACING=[YES | TRUE | ON | 1 | NO | FALSE | OFF | 0]

USE_ASYNC_CALL=[YES | TRUE | ON | 1 | NO | FALSE | OFF | 0]

Example

CMAN_PROFILE=
   (PARAMETER_LIST= 
      (MAXIMUM_RELAYS=512)
      (LOG_LEVEL=1)
      (RELAY_STATISTICS=YES)
      (REMOTE_ADMIN=YES)
      (SHOW_TNS_INFO=YES) 
      (USE_ASYNC_CALL=YES)             
      (AUTHENTICATION_LEVEL=0)
      (TRACING=YES)
      (TRACE_TIMESTAMP=YES)
      (TRACE_FILELEN=100)
      (TRACE_FILENO=2))

ANSWER_TIMEOUT

Use the parameter ANSWER_TIMEOUT to determine the time, in seconds, that Oracle Connection Manager uses to time out the protocol handshake associated with an incoming connection request

The parameter accepts a range of 0 to n.

AUTHENTICATION_LEVEL

Use the parameter AUTHENTICATIOIN_LEVEL to specify the level of security. This parameter accepts the following values:

• 1 to instruct Oracle Connection Manager to reject connect requests that are not using Secure Network Services (SNS). SNS is part of the Oracle Advanced Security.
• 0 (default) to instruct Oracle Connection Manager not to check for SNS between the client and server

LOG_LEVEL

The LOG_LEVEL parameter specifies the level of logging performed by Oracle Connection Manager. This parameter accepts four log levels, ranging from 0 to 4:

• 0 (default) for no logging
• 1 for basic reporting
• 2 for RULE_LIST matching lookup reporting
• 3 for relay blocking reporting
• 4 for relay I/O counts reporting

The CMGW process creates a log file called cman_pid.log, and the CMADMIN process creates a log file called cmadm_pid.log. The log files are located in the $ORACLE_HOME/network/log directory on UNIX operating systems and the ORACLE_HOME\network\log directory on Windows NT.

MAX_FREELIST_BUFFERS

The MAX_FREELIST_BUFFERS parameter specifies the maximum number of buffers that Transparent Network Substrate (TNS) keeps in its freelist for later reuse instead of returning them to the operating system after a relay gets closed.

The parameter accepts a range of 0 to 10240.

MAXIMUM_CONNECT_DATA

Use the parameter MAXIMUM_CONNECT_DATA to limit the connect data string length of the incoming connection requests.

The parameter accepts a range of 257 to 4096.

MAXIMUM_RELAYS

Use the parameter MAXIMUM_RELAYS to specify the maximum number of concurrent connections supported.

The parameter accepts a range of 1 to 2048.

RELAY_STATISTICS

Use the parameter RELAY_STATISTICS to specify whether or not I/O statistics are recorded. This parameter accepts the following values:

• yes to instruct Oracle Connection Manager to maintain statistics pertaining to relay I/O activities, such as:
  • Number of inbound (IN) bytes
  • Number of outbound (OUT) bytes
  • Number of IN packets
  • Number of OUT packets

  This information is stored in the cman_pid.log file.

• no to record no I/O statistics

REMOTE_ADMIN

Use the parameter REMOTE_ADMIN to specify whether or not remote access to an Oracle Connection Manager is allowed. This parameter accepts the following values:

• yes to allow access from a remote Oracle Connection Manager Control utility session to Oracle Connection Manager
• no to allow only access to the local Oracle Connection Manager. This value prevents a user running a remote Oracle Connection Manager Control utility session access to Oracle Connection Manager.

  See Also: "Distributed Operations" for configuration details

SHOW_TNS_INFO

Use the parameter SHOW_TNS_INFO to specify whether or not TNS information is to be recorded. This parameter accepts the following values:

• yes to instruct Oracle Connection Manager to include TNS information in the cman_pid.log file
• no to instruct Oracle Connection Manager to not include TNS events in the log file

TRACING

Use the parameter TRACING to specify whether or not tracing is enabled for the Oracle Connection Manager. This parameter accepts the following values:

• yes to enable tracing for Oracle Connection Manager. The CMGW process creates a trace file called cman_pid.trc, and the CMADMIN process creates a trace file called cmadm_pid.trc.
• no to disable tracing

TRACE_DIRECTORY

Use the parameter TRACE_DIRECTORY to specify the destination directory for the trace files. You must set this parameter to a nondefault location if you plan to use the TRACE_FILELEN or TRACE_TIMESTAMP parameters.

TRACE_FILELEN

Use the parameter TRACE_FILEN to specify the size of the trace file in kilobytes (KB). When the size is met, the trace information is written to the next file. The number of files is specified with the TRACE_FILENO parameter.

Note: This parameter requires a nondefault trace directory be specified with the TRACE_DIRECTORY parameter.

TRACE_FILENO

Use the parameter TRACE_FILENO to specify the number of trace files for Oracle Connection Manager tracing. When this parameter is set along with the TRACE_FILELEN parameter, trace files are used in a cyclical fashion. The first file is filled first, then the second file, and so on. When the last file has been filled, the first file is reused, and so on.

The trace file names are distinguished from one another by their sequence number. For example, if this parameter is set to 3, the CMGW gateway trace files would be named cman1_pid.trc, cman2_pid.trc and cman3_pid.trc and the CMADMIN administrative trace files would be named cmadm1_pid.trc, cmadm2_pid.trc and cmadm3_pid.trc.

In addition, trace events in the trace files are preceded by the sequence number of the file.

TRACE_TIMESTAMP

Use the parameter TRACE_TIMESTAMP to add a time stamp in the form of dd-mon-yyyy hh:mi:ss:mil to every trace event in the trace file.

Note: This parameter requires a nondefault trace directory be specified with the TRACE_DIRECTORY parameter.

USE_ASYNC_CALL

Use the parameter USE_ASYNC_CALL to specify whether or not Oracle Connection Manager is to use asynchronous functions while in the answering or calling phase of establishing an Oracle Net connection. This parameter accepts the following values:

• yes to instruct Oracle Connection to use all asynchronous functions
• no to instruct Oracle Connection Manager not to use asynchronous functions