Net8 Administrator's Guide
Release 8.1.5

A67440-01

Library

Product

Contents

Index

Prev Next

C
Configuration Parameters

A complete listing of all Net8 configuration parameters is provided for your reference. The following sections appear in this appendix:

Syntax Rules for Configuration Files

The configuration files in a Net8 network consist of parameters which include keyword-value pairs. Keyword-value pairs are surrounded by parentheses:

parameter=(keyword=value)

Some keywords have other keyword-value pairs as their values:

(keyword=
    (keyword=value)
    (keyword=value)
)

For example, the address portion of a local naming configuration file (TNSNAMES.ORA) might include the following lines:

(address=
    (protocol=tcp)
    (host=max)
    (port=1521) 
)

Set up configuration files so that indentation reflects what keyword is the parent or owner of other keyword-value pairs. This format is not required, but it does make the files much easier to read and understand.

Even if you do not choose to indent your files in this way, you must indent a wrapped line by at least one space, or it will be misread as a new parameter. The following layout is acceptable:

(address=(protocol=tcp)
  (host=max)(port=1521))

The following layout is not acceptable:

(address=(protocol=tcp)
(host=max)(port=1521))

Further Syntax Rules for Configuration Files

The following rules apply to the syntax of configuration files:

Network Character Set

The network character set for keyword values consists of the following characters. Connect descriptors must be made up of single-byte characters.

A-Z, a-z

0-9

( ) < > / \

, . : ; ' "=- _

$ + * # & ! % ? @

Within this character set, the following symbols are reserved:

( )=\ " ' #

Reserved symbols are used as delimiters, not as part of a keyword or a value unless the keyword or value is quoted. Either single or double quotes can be used to enclose a value containing reserved symbols. To include a quote within a value that is surrounded by quotes, use different quote types. The backslash (\) is used as an escape character.

A specific example of the use of reserved symbols is a numeric DECnet object within an address. An OBJECT can be a name such as ABC or #123. These would be entered in the form:

(OBJECT=ABC)

or

(OBJECT=\#123)

Because the "#" sign is a reserved symbol, the character must be preceded by a backslash.

The following characters may be used within a connect descriptor, but not in a keyword or value:

<space> <tab> <CR> <newline>

Character Set

The listener name, net service name, and Oracle Connection Manager names are limited to the following character set:

[a...z] [A...Z] [0...9] _

The first character must be an alphabetical character. In general, up to 64 characters is acceptable. A database service name must match the global database name defined by the database administrator, which consists of a database name (originally limited to eight characters), and the database domain. Net service names and global database names are not case sensitive.

ADDRESSes and ADDRESS_LISTs

When a connection is made, the client and the receiver of the request, such as a listener, Oracle Names server, or Oracle Connection Manager, are configured with identical protocol addresses. The purpose of the address is to identify the network address of a network object. The client uses this address to send the connection request to a particular network object location, and the recipient "listens" for requests on this address, and grants a connection based on its address information matching the client information. It is important to install the same protocols for the client and the connection recipient, as well as configure the same address.

Protocol address are comprised of two elements:

ADDRESS  

Purpose:  

Defines a protocol address. This parameter may be embedded under ADDRESS_LIST or DESCRIPTION. A DESCRIPTION is typically only used in a TNSNAMES.ORA or LISTENER.ORA file.

Additional Information: Each protocol has its own required parameters needed in the address, as explained on "Configuring Protocol Addresses".  

Example:  

(address=
 (protocol=tcp)
 (host=sales-pc)
 (port=1521)
)
 
ADDRESS_LIST  

Purpose:  

Defines lists of addresses that share a set of common characteristics.

This parameter may be embedded under DESCRIPTION or DESCRIPTION_LIST. A DESCRIPTION or DESCRIPTION_LIST is typically only used in a TNSNAMES.ORA or LISTENER.ORA file.

Note: If there is only one list in a TNSNAMES.ORA or a LISTENER.ORA file, ADDRESS_LIST is not necessary.  

Example:  

 (address_list=
  (address=
   (protocol=tcp)
   (host=sales-pc)
   (port=1521)
  )  
  (address=
   (protocol=tcp)
   (host=hr-pc)
   (port=1521)
  ) 
 ) 
 (address_list=
  (address=
   (protocol=tcp)
   (host=finance-pc)
   (port=1521)
  )  
  (address=
   (protocol=tcp)
   (host=sales-pc)
   (port=1521)
  ) 
 ) 
 

Profile Parameters (SQLNET.ORA)

The following parameters are available in a profile. Profiles are stored in a configuration file called SQLNET.ORA.SQLNET.ORA is located in $ORACLE_HOME/network/admin on UNIX and ORACLE_HOME\network\admin on Windows platforms.

BEQUEATH_DETACH  

Purpose:  

Turn on/off signal handling in Net8 on UNIX systems.  

Default:  

NO which leaves signal handling on.  

Values:  

  • YES - Turns off signal handling

  • NO - Leaves signal handling on

 

Example:  

bequeath_detach=yes
 

DAEMON.TRACE_DIRECTORY  

Purpose:  

Controls the destination directory of the Oracle Enterprise Manager daemon trace file.  

Default:  

$ORACLE_HOME/network/trace on UNIX platforms and ORACLE_HOME/network/trace on Windows platforms  

Example:  

daemon.trace_directory=/oracle/traces
 

DAEMON.TRACE_LEVEL  

Purpose:  

Turns tracing on/off to a certain specified level for the Oracle Enterprise Manager daemon.  

Default:  

OFF  

Values  

  • OFF - No trace output

  • USER - User trace information

  • ADMIN - Administration trace information

  • SUPPORT - WorldWide Customer Support trace information

 

Example:  

daemon.trace_level=user
 
DAEMON.TRACE_MASK  

Purpose:  

Specifies that only the Oracle Enterprise Manager daemon trace entries are logged into the trace file.  

Default:  

$ORACLE_HOME/network/trace on UNIX platforms and ORACLE_HOME/network/trace on Windows platforms  

Example:  

daemon.trace_mask=(106)
 
DISABLE_OOB  

Purpose:  

Disables out of band breaks.  

Default:  

OFF  

Usage Notes:  

Disable out of band breaks if the underlying transport protocol does not support the feature.  

Example:  

disable_oob=off
 
LOG_DIRECTORY_CLIENT  

Purpose:  

Controls the directory for where the log file is written.  

Default:  

Current directory where executable is started from.  

Example:  

log_directory_client=/oracle/network/log
 
LOG_DIRECTORY_SERVER  

Purpose:  

Controls the directory for where the log file is written.  

Default:  

Current directory where executable is started from.  

Example:  

log_directory_server=/oracle/network/log
 
LOG_FILE_CLIENT  

Purpose:  

Controls the log output file name for an Oracle client.  

Default:  

SQLNET.LOG  

Example:  

log_file_client=client
 
LOG_FILE_SERVER  

Purpose:  

Controls the log output file name for an Oracle server.  

Default:  

SQLNET.LOG  

Example:  

log_file_server=svr.log
 
NAMES.DCE.PREFIX  

Purpose:  

Specifies the DCE cell name (prefix) to use for name lookup.  

Default:  

/.:/subsys/oracle/names
 

Example:  

names.dce.prefix=/.:/subsys/oracle/names
 
NAMES.DEFAULT_DOMAIN  

Purpose:  

Indicates the domain from which the client most often requests names. When this parameter is set, the default domain name will be automatically appended to any unqualified service name. Any name which contains an unescaped dot ('.') will not have the default domain appended. Simple names may be qualified with a trailing dot (for example, 'rootserver.').  

Default:  

NULL  

Example:  

names.default_domain=com
 
NAMES.DIRECTORY_PATH  

Purpose:  

Indicates the order of the naming methods, such as TNSNAMES or Oracle Names, that will be used for client name requests.  

Default:  

TNSNAMES, ONAMES, HOSTNAME  

Values:  

  • TNSNAMES

  • ONAMES

  • HOSTNAME

  • DCE

  • NIS

  • NOVELL

 

Example:  

names.directory_path=(tnsnames, onames)
 
NAMES.INITIAL_RETRY_TIMEOUT  

Purpose:  

Determines how long a client will wait for a response from an Oracle Names server before reiterating the request to the next server in the preferred servers list.  

Default:  

15  

Minimum Value:  

1  

Maximum Value:  

600  

Example:  

names.initial_retry_timeout=20
 
NAMES.MAX_OPEN_CONNECTIONS  

Purpose:  

Determines how many connections an Oracle Names client may have open at one time.  

Default:  

10  

Minimum Value:  

3  

Maximum Value:  

64  

Example:  

names.max_open_connections=3
 
NAMES.MESSAGE_POOL_START_SIZE  

Purpose:  

Determines the initial number of messages allocated in the client's message pool which are used for forwarded message requests.  

Default:  

10  

Minimum Value:  

3  

Maximum Value:  

256  

Example:  

names.message_pool_start_size=10
 
NAMES.NIS.META_MAP  

Purpose:  

Specifies the file to be used to map NIS attributes to an NIS mapname.  

Default:  

SQLNET.MAPS  

Example:  

names.nis.meta_map=sqlnet.maps
 
NAMES.PREFERRED_SERVERS  

Purpose:  

Indicates the name, addresses, and order of Oracle Names servers that will be used for a client's name requests.  

Default:  

None  

Example:  

names.preferred_servers= (address_list=
  (address=(protocol=ipc)(key=n23))
  (address=(protocol=tcp)(host-nineva)(key=1575))
  (address=(protocol=tcp)(host=cicada)(key=1575)))
 
NAMES.REQUEST_RETRIES  

Purpose:  

Specifies the number of times the client should try each server in the list of preferred servers before allowing the operation to fail.  

Default:  

1  

Minimum Value:  

1  

Maximum Value:  

5  

Example:  

names.request_retries=5
 
NAMESCTL.INTERNAL_ENCRYPT_PASSWORD  

Purpose:  

If set to TRUE, NAMESCTL encrypts the password when it is sent to the Oracle Names server.

If set to FALSE, NAMESCTL does not encrypt the password when it is sent to the Oracle Names server. This enables unencrypted passwords to be set in the NAMES.ORA file with the NAMES.PASSWORD parameter.  

Default:  

FALSE  

Values:  

TRUE | FALSE  

Example:  

namesctl.internal_encrypt_password=true
 
NAMESCTL.INTERNAL_USE  

Purpose  

If set to TRUE, NAMESCTL enables a set of internal undocumented commands. All internal commands are preceded by an underscore in order to distinguish them as internal.  

NAMESCTL.NO_INITIAL_SERVER  

Purpose:  

If set to TRUE, NAMESCTL suppresses any error messages when unable to connect to a default Oracle Names server.  

Default:  

FALSE  

Values  

TRUE | FALSE  

Example:  

namesctl.no_initial_server=true
 
NAMESCTL.NOCONFIRM  

Purpose:  

Indicates whether sensitive commands (STOP, RELOAD, RESTART) should be prompted with a confirmation when running the NAMESCTL utility.  

Default:  

OFF  

Values  

ON | OFF  

Example:  

namesctl.noconfirm=on
 
NAMESCTL.SERVER_PASSWORD  

Purpose:  

Indicates the value that matches the configured password set in the NAMES.ORA file with the NAMES.PASSWORD parameter. This eliminates the need to enter the password with the SET PASSWORD command each time you use the NAMESCTL utility to perform secure options, such as STOP, RESTART and RELOAD.  

Example:  

namesctl.server_password=secret
 
NAMESCTL.TRACE_LEVEL  

Purpose:  

Indicates the level at which the NAMESCTL program should be traced.  

Default:  

OFF  

Values:  

OFF, USER, ADMIN, SUPPORT  

Example:  

namesctl.trace_level=admin
 
NAMESCTL.TRACE_FILE  

Purpose:  

Indicates the file in which the NAMESCTL trace output is placed.  

Default:  

NAMESCTL_PID.TRC  

Example:  

namesctl.trace_file=nmsctl
 
NAMESCTL.TRACE_DIRECTORY  

Purpose:  

Indicates the directory where trace output from the NAMESCTL utility is placed.  

Default:  

$ORACLE_HOME/network/trace on UNIX and ORACLE_HOME/network/trace on Windows NT  

Example:  

namesctl.trace_directory=/oracle/trace
 
NAMESCTL.TRACE_UNIQUE  

Purpose:  

Indicates whether a process identifier is appended to the name of each trace file generated, so that several can co-exist.  

Default:  

ON  

Values:  

ON | OFF  

Example:  

namesctl.trace_unique=on
 
OSS.SOURCE.MY_WALLET  

Purpose:  

Enter the location of wallets. Wallets are certificates, keys and trustpoints processed by SSL.  

Default:  

None  

Example:  

oss.source.my_wallet=  
   (source=
      (method=file)
      (method_data=  
        (directory=/home/smalladi/oss)))
 
OSS.SOURCE.LOCATION  

Purpose:  

Defines the method for retrieving encrypted private keys.  

Default:  

None  

Example:  

oss.source.location= 
(source= 
 (method=oracle) 
 (method_data=
    (sqlnet_address=oss)))
 
SQLNET.AUTHENTICATION_SERVICES  

Purpose:  

Enables one or more authentication services. If authentication has been installed, it is recommended that this parameter be set to either NONE or to one of the authentication methods.  

Default:  

None  

Values:  

NONE - the database will use the user name and password to log in

ALL - Enables all authentication methods to be used.

BEQ - always used in conjunction with one or more of the following items:

NDS - use NetWare Directory Services (NDS)

NTS - use Windows NT Native

KERBEROS5 - use Kerberos

SECURID - use SecurID

CYBERSAFE - use Cybersafe

IDENTIX - use Identix

DCEGSSAPI - use DCE GSSAPI

RADIUS - use RADIUS  

Example:  

sqlnet.authentication_services =(beq, kerberos5, cybersafe)
 
SQLNET.AUTHENTICATION_KERBEROS5_SERVICE  

Purpose:  

Defines the name of the service used to obtain a Kerberos service ticket  

Default:  

None  

Example:  

sqlnet.authentication_kerberos5_service= oracle
 
SQLNET.AUTHENTICATION_GSSAPI_SERVICE  

Purpose:  

Defines the CyberSAFE service principal  

SQLNET.CLIENT_REGISTRATION  

Purpose:  

Sets a unique identifier for this client machine. This identifier will be passed to the listener with any connection request and will be included in the Audit Trail. The identifier can be any alphanumeric string up to 128 characters long.  

Default:  

None  

Example:  

sqlnet.client_registration 1432
 
SQLNET.CRYPTO_CHECKSUM_CLIENT  

Purpose:  

Specifies the desired checksum behavior when this client is connecting to a server  

Default:  

ACCEPTED  

Values:  

  • ACCEPTED

  • REJECTED

  • REQUESTED

  • REQUIRED

 

Example:  

sqlnet.crypto_checksum_client=accepted
 
SQLNET.CRYPTO_CHECKSUM_SERVER  

Purpose:  

Specifies the desired checksum behavior when a client is connecting to this server  

Default:  

ACCEPTED  

Values:  

  • ACCEPTED

  • REJECTED

  • REQUESTED

  • REQUIRED

 

Example:  

sqlnet.crypto_checksum_server=accepted
 
SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT  

Purpose:  

Specifies a list of crypto-checksum algorithms this client is allowed to use  

Default:  

MD5  

Values:  

MD5 - RSA Data Security's MD5 algorithm  

Example:  

sqlnet.crypto_checksum_types_client=(md5)
 
SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER  

Purpose:  

Specifies a list of crypto-checksum algorithms this server is allowed to use  

Default:  

MD5  

Values:  

MD5 - RSA Data Security's MD5 algorithm  

Example:  

sqlnet.crypto_checksum_types_server=(md5)
 
SQLNET.CRYPTO_SEED  

Purpose:  

Specifies the characters used when generating cryptographic keys. The more random the characters are, the stronger the keys are. This is required whenever encryption or checksumming is turned on. The string should be 10-70 random characters.  

Default:  

qwertyuiopasdfghjkl;zxcvbnm,.s1  

Example:  

sqlnet.crypto_seed="qwertyuiopasdfghjkl;zxcvbnm,.s1"
 
SQLNET.ENCRYPTION_CLIENT  

Purpose:  

Specifies the desired behavior when this client is connecting to a server  

Default:  

ACCEPTED  

Values:  

  • ACCEPTED

  • REJECTED

  • REQUESTED

  • REQUIRED

 

Example:  

sqlnet.encryption_client=accepted
 
SQLNET.ENCRYPTION_SERVER  

Purpose:  

Specifies the desired behavior when a client is connecting to this server  

Default:  

ACCEPTED  

Values:  

  • ACCEPTED

  • REJECTED

  • REQUESTED

  • REQUIRED

 

Example:  

sqlnet.encryption_server=accepted
 
SQLNET.ENCRYPTION_TYPES_CLIENT  

Purpose:  

Specifies a list of encryption algorithms this client is allowed to use  

Default:  

All algorithms are used if none are specified.  

Values:  

One or more of the following:

RC4_40 - RSA RC4 (40 bit key size) Domestic & International

RC4_56 - RSA RC4 (56 bit key size) Domestic only

RC4_128 - RSA RC4 (128 bit key size) Domestic only

DES - Standard DES (56 bit key size) Domestic only

DES40 - (40 bit key size) Domestic & International  

Example:  

sqlnet.encryption_types_client=(rc4_40)
 
SQLNET.ENCRYPTION_TYPES_SERVER  

Purpose:  

Specifies a list of encryption algorithms this server is allowed to use when acting as a server  

Default:  

All algorithms are used if none are specified.  

Values:  

RC4_40 - RSA RC4 (40 bit key size) Domestic & International

RC4_56 - RSA RC4 (56 bit key size) Domestic only

RC4_128 - RSA RC4 (128 bit key size) Domestic only

DES - Standard DES (56 bit key size) Domestic only

DES40 - (40 bit key size) Domestic & International  

Example:  

sqlnet.encryption_types_server=(rc4_40, des, ...)
 
SQLNET.EXPIRE_TIME  

Purpose:  

Determines time interval to send a probe to verify the session is alive  

Default:  

None  

Minimum Value:  

0 minutes  

Recommended Value:  

10 minutes  

Example:  

sqlnet.expire_time=10
 
SQLNET.IDENTIX_FINGERPRINT_DATABASE  

Purpose:  

Specifies the service name or alias for the authentication fingerprint database  

Default:  

None  

Example:  

sqlnet.identix_fingerprint_database=fingrdb
 
SQLNET.IDENTIX_FINGERPRINT_DATABASE_USER  

Purpose:  

Specifies the well known user name for the fingerprint database  

Default:  

None  

Example:  

sqlnet.identix_fingerprint_database_user=manager
 
SQLNET.IDENTIX_FINGERPRINT_DATABASE_PASSWORD  

Purpose:  

Specifies the well known password for the fingerprint database  

Default:  

None  

Example:  

sqlnet.identix_fingerprint_database_password=password
 
SQLNET.IDENTIX_FINGERPRINT_METHOD  

Purpose:  

Specifies the method name for the fingerprint database. The method name must be ORACLE  

Default:  

None  

Example:  

sqlnet.identix_fingerprint_method=oracle
 
SQLNET.KERBEROS5_CC_NAME  

Purpose:  

Specifies the complete path name to the Kerberos credentials cache file.  

Default:  

/usr/tmp/krbcache on UNIX and c:\tmp\krbcache on Windows platforms  

Example:  

sqlnet.kerberos5_cc_name= /usr/tmp/krbcache
 
SQLNET.KERBEROS5_CLOCKSKEW  

Purpose:  

Specifies how many seconds can pass before a Kerberos credential is considered out of date.  

Default:  

300  

Example:  

sqlnet.kerberos5_clockskew=1200
 
SQLNET.KERBEROS5_CONF  

Purpose:  

Specifies the complete path name to the Kerberos configuration file, which contains the realm for the default KDC and maps realms to KDC hosts.  

Default:  

/krb5/krb.conf on UNIX and c:\krb5\krb.conf on Windows platforms  

Example:  

sqlnet.kerberos5_conf=/krb5/krb.conf
 
SQLNET.KERBEROS5_KEYTAB  

Purpose:  

Specifies the complete path name to the Kerberos principal/secret key mapping file, which is used to extract keys and decrypt incoming authentication information.  

Default:  

/etc/v5srvtab on UNIX and c:\krb5\v5srvtab on Windows platforms  

Example:  

sqlnet.kerberos5_keytab=/etc/v5srvtab
 
SQLNET.KERBEROS5_REALMS  

Purpose:  

Specifies the complete pathname to the Kerberos realm translation file, which provides a mapping from a host name or domain name to a realm.  

Default:  

/krb5/krb.realms on UNIX and c:\krb5\krb.realms on Windows platforms  

Example:  

sqlnet.kerberos5_realms= /krb5/krb.realms
 
SQLNET.RADIUS_ALTERNATE  

Purpose:  

Specifies an alternate RADIUS server used in case the primary server is unavailable. The value can be either the IP address or host name of the server.  

Default:  

None  

Example:  

sqlnet.radius_alternate=radius2
 
SQLNET.RADIUS_ALTERNATE_PORT  

Purpose:  

Listening port of the alternate RADIUS server.  

Default:  

1645  

Example:  

sqlnet.radius_alternate_port= 1667
 
SQLNET.RADIUS_ALTERNATE_RETRIES  

Purpose:  

Times to resend  

Default:  

3  

Example:  

sqlnet.radius_alternate_retries=4
 
SQLNET.RADIUS_AUTHENTICATION_TIMEOUT  

Purpose:  

Time to wait for response.  

Default:  

5 seconds  

Example:  

sqlnet.radius_authenetication_timeout= 10
 
SQLNET.RADIUS_AUTHENTICATION  

Purpose:  

Specifies the location of the primary RADIUS server, either by its host name or IP address.  

Default:  

local host  

Example:  

sqlnet.radius_authenetication= officeacct
 
SQLNET.RADIUS_AUTHENTICATION_INTERFACE  

Purpose:  

Specifies the class containing the user interface used to interact with the user.  

Default:  

DefaultRadiusInterface  

Example:  

sqlnet.radius_authenetication_interface= 
 
SQLNET.RADIUS_AUTHENTICATION_PORT  

Purpose:  

Listening port of the primary RADIUS server.  

Default:  

1645  

Example:  

sqlnet.radius_authenetication_port= 1667
 
SQLNET.RADIUS_AUTHENTICATION_RETRIES  

Purpose:  

Times to resend.  

Default:  

3  

Example:  

sqlnet.radius_authenetication_retries=4
 
SQLNET.RADIUS_AUTHENTICATION_TIMEOUT  

Purpose:  

Time to wait for response.  

Default:  

5 seconds  

Example:  

sqlnet.radius_authenetication_timeout= 10
 
SQLNET.RADIUS_CHALLENGE_RESPONSE  

Purpose:  

Turns challenge response ON or OFF.  

Default:  

OFF  

Values:  

ON | OFF  

Example:  

sqlnet.radius_challenge_response=ON
 
SQLNET.RADIUS_SECRET  

Purpose:  

Specifies the full path to the file containing the RADIUS shared secret.  

Default:  

$ORACLE_HOME/network/security/radius.key on UNIX and ORACLE_HOME/network/security/radius.key on Windows NT  

Example:  

sqlnet.radius_secret= oracle/bin/admin/radiuskey
 
SQLNET.RADIUS_SEND_ACCOUNTING  

Purpose:  

Turns accounting ON and OFF. If enabled, packets will be sent to the active RADIUS server at listening port plus one. The default port is 1646.  

Default:  

OFF  

Values:  

ON | OFF  

Example:  

sqlnet.radius_send_accounting=ON
 
SSL_CLIENT_AUTHENTICATION  

Purpose:  

Controls whether or not a client--in addition to the server--is authenticated using SSL.  

Default:  

TRUE  

Values:  

TRUE | FALSE  

Example:  

ssl_cipher_suite=(ssl_dh_dss_with_des_cdc_sha)
 

SSL_CIPHER_SUITES  

Purpose:  

Controls what combination of encryption and data integrity is used by SSL.  

Default:  

None  

Values:  

For further information about Cipher Suites, see the Oracle Advanced Security Administrator's Guide.  

Example:  

ssl_cipher_suite=(ssl_rsa_with_rc4_138_md5)
 

SSL_VERSION  

Purpose:  

Forces the version of the SSL connection.

Clients and servers must use a compatible version.  

Default:  

UNDETERMINED  

Values:  

UNDETERMINED | 2.0 | 3.0  

Example:  

ssl_version=2.0
 

TNSPING.TRACE_DIRECTORY  

Purpose:  

Controls the destination directory of the trace file.  

Default:  

$ORACLE_HOME/network/trace  

Example:  

tnsping.trace_directory=/oracle/traces
 
TNSPING.TRACE_LEVEL  

Purpose:  

Turns tracing on/off to a certain specified level.  

Default:  

OFF  

Values  

  • OFF - No trace output

  • USER - User-induced error conditions trace information

  • ADMIN - Administration trace information

  • SUPPORT - WorldWide Customer Support trace information

 

Example:  

tnsping.trace_level=admin
 
TRACE_DIRECTORY_CLIENT  

Purpose:  

Controls the destination directory of the trace file.  

Default:  

$ORACLE_HOME/network/trace  

Example:  

trace_directory_client=/oracle/traces
 
TRACE_DIRECTORY_SERVER  

Purpose:  

Controls the destination directory of the trace file.  

Default:  

$ORACLE_HOME/network/trace  

Example:  

trace_directory_server=/oracle/traces
 
TRACE_FILE_CLIENT  

Purpose:  

Controls the name of the client trace file.  

Default:  

SQLNET.TRC  

Example:  

trace_file_client=clientsqlnet.trc
 
TRACE_FILE_SERVER  

Purpose:  

Controls the name of the server trace file.  

Default:  

SVR_PID.TRC  

Example:  

trace_file_server=svrsqlnet.trc
 
TRACE_LEVEL_CLIENT  

Purpose:  

Turns tracing on/off to a certain specified level.  

Default:  

OFF  

Values  

  • OFF - No trace output

  • USER - User trace information

  • ADMIN - Administration trace information

  • SUPPORT - WorldWide Customer Support trace information

 

Example:  

trace_level_client=user
 
TRACE_LEVEL_SERVER  

Purpose:  

Turns tracing on/off to a certain specified level.  

Default:  

OFF  

Values  

  • OFF - No trace output

  • USER - User trace information

  • ADMIN - Administration trace information

  • SUPPORT - WorldWide Customer Support trace information

 

Example:  

trace_level_server=admin
 
TRACE_UNIQUE_CLIENT  

Purpose:  

Used to make each client trace file have a unique name to prevent each trace file from being overwritten with the next occurrence of the client. The PID is attached to the end of the file name.

Determines whether or not a unique trace file is created for each client. The same trace file name is used for every client. If the value is OFF, when a new trace file is created for a client, it overwrites the existing file. If the value is set to ON, a thread identifier is appended to the name of each trace file generated so that several can coexist.

This parameter creates unique trace files named SQLNETTHREAD_ID.TRC.  

Default:  

ON  

Example:  

trace_unique_client=on
 
USE_CMAN  

Purpose:  

When set to TRUE, forces all sessions to go through Oracle Connection Manager to get to the server. If no Oracle Connection Manager addresses are available, connections are routed through any available listener address.

Note: If you are using Oracle Connection Manager with Oracle Names, this option must be set on clients and Oracle Names servers.  

Default:  

FALSE  

Values:  

TRUE | FALSE  

Example:  

use_cman=true
 
USE_DEDICATED_SERVER  

Purpose:  

Forces the listener to spawn a dedicated server process for sessions from this client.  

Default:  

OFF  

Values:  

  • ON - spawn dedicated server processes

  • OFF - hand off to existing server processes

 

Example:  

use_dedicated_server=on
 

Local Naming Parameters (TNSNAMES.ORA)

With the local naming method, net service names are added to the TNSNAMES.ORA file. TNSNAMES.ORA is located in $ORACLE_HOME/network/admin on UNIX and ORACLE_HOME\network\admin on Windows platforms.

A net service name is an alias mapped to a database network address contained in a connect descriptor. A connect descriptor contains the location of the listener through a protocol address and the service name of the database to which to connect. Clients and servers that are clients of other servers use this net service name when making a connection with an application.

General Syntax

The basic syntax for a TNSNAMES.ORA file's is shown in Figure C-1. DESCRIPTION contains the connect descriptor, ADDRESS is the listener address, and CONNECT_DATA contains the database service name.

Figure C-1 General Syntax of TNSNAMES.ORA

net_service_name= 
 (description= 
   (address= (protocol_address_information))
   (connect_data= 
     (service_name=service_name) 
   ) 
 ) 

Multiple Descriptions

A TNSNAMES.ORA file may contain one or more connect descriptors. Each connect descriptor can contain one or more listener addresses. Shown below in Figure C-2 are two connect descriptors with multiple addresses. DESCRIPTION_LIST defines a list of connect descriptors.


Note:

The Net8 Assistant does not support multiple connect descriptors.  


Figure C-2 Multiple Descriptions in TNSNAMES.ORA

net_service_name= 
 (description_list=
  (description= 
   (address= (protocol_address_information))
   (address= (protocol_address_information))
   (address= (protocol_address_information))
   (connect_data= 
     (service_name=service_name) 
   ) 
  ) 
  (description= 
   (address= (protocol_address_information))
   (address= (protocol_address_information))
   (address= (protocol_address_information))
   (connect_data= 
     (service_name=service_name) 
   ) 
  ) 
 )

Multiple Address Lists

The TNSNAMES.ORA also supports multiple list of addresses, each with its own characteristics. In Figure C-3, two address lists are presented. The first address list features client load balancing and no connect-time failover, affecting only those listener ADDRESSes within the ADDRESS_LIST. The second address list features connect-time failover and no client load loading balance, affecting only those listener ADDRESSes within the ADDRESS_LIST. The client will first try either the first or second address at random, then try address three and four sequentially.


Note:

The Net8 Assistant only supports the creation of one address list.  


Figure C-3 Multiple Address Lists in TNSNAMES.ORA

net_service_name= 
 (description= 
  (address_list= 
   (load_balance=on)
   (failover=off)
   (address= (protocol_address_information))
   (address= (protocol_address_information))
  )
  (address_list= 
   (load_balance=off)
   (failover=on)
   (address= (protocol_address_information))
   (address= (protocol_address_information))
  )
  (connect_data=
   (service_name=service_name) 
  )
 )


Note:

Address lists do not have to be embedded in an ADDRESS_LIST if there is only one list, as was the case prior to release 8.1.  


Changed Functionality of Client Load Balancing and DESCRIPTION_LISTs

Prior to release 8.1, DESCRIPTION_LISTs were used for client load balancing of multiple listeners. While client load balancing is still on by default for DESCRIPTION_LISTs, client load balancing can also be explicitly specified for an ADDRESS_LIST or associated with a set of ADDRESSes or set DESCRIPTIONs. Shown in Figure C-4 is a comparison of a TNSNAMES.ORA prior to release 8.1 and for release 8.1, using client load balancing in an Oracle Parallel Sever environment:

Figure C-4 Client Load Balancing for Release 8.1 and Prior to Release 8.1

Client Load Balancing Prior to Release 8.1

Shown below is pre-8.1 release TNSNAMES.ORA file with net service names of OP, OP1 and OP2.

OPS allows a client to randomly choose one of the two instances. OP1 and OP2 allow a client to connect to a specific Oracle Parallel Server instance.

op=
 (description_list =
  (description=
     (address=
       (protocol=tcp) 
       (host=opsnt1) 
       (port=1521))
      (connect_data=(sid=op1)))

   (description=
      (address=
        (protocol=tcp) 
        (host=opsnt2) 
        (port=1521))
       (connect_data=(sid=op2))))
op1=
  (description=
     (address=
       (protocol=tcp) 
       (host=opsnt1) 
       (port=1521))
     (connect_data=(sid=op1)))
op2=
  (description=
     (address=
       (protocol=tcp) 
       (host=opsnt1) 
       (port=1521))
     (connect_data=(sid=op2)))
 

Client Load Balancing in Release 8.1

Shown below is a 8.1 release TNSNAMES.ORA file with net service names of OP, OP1 and OP2.

OP allows a client to randomly to connect to database service OP and choose one of the two instances using multiple ADDRESSes rather than multiple DESCRIPTIONs. OP1 and OP2 allow a client to connect to a specific Oracle Parallel Server instance.

op=
 (description= 
  (load_balance=on)
  (address= 
       (protocol=tcp) 
       (host=opsnt1) 
       (port=1521))
  (address=
        (protocol=tcp) 
        (host=opsnt2) 
        (port=1521))
  (connect_data=
     (service_name=op)))
op1=
  (description=
     (address=
       (protocol=tcp) 
       (host=opsnt1) 
       (port=1521))
     (connect_data=
       (service_name=op)
       (instance_name=op1)))
op2=
  (description=
     (address=
       (protocol=tcp) 
       (host=opsnt2) 
       (port=1521))
     (connect_data=
       (service_name=op)
       (instance_name=op2)))
 

Examples

When a client goes through an Oracle Connection Manager for a connection to a service, the first address (or set of address) is for a client connection to an Oracle Connection Manager and the second address (or set of addresses) is for an Oracle Connection Manager connection to a service using listener.

When the Oracle Connection Manager parameter SOURCE_ROUTE is set to YES, it instructs the client to go through all the addresses listed before connecting.

Shown in Figure C-5 is an example with multiple Oracle Connection Manager addresses:

Figure C-5 Multiple Oracle Connection Manager Addresses TNSNAMES.ORA

sample1=(description= 
         (source_route=yes) 
         (address=(protocol=tcp)(host=host1)(port=1630))    # hop 1 
         (address_list=  
          (failover=on) 
          (load_balance=off)                                # hop 2 
          (address=(protocol=tcp)(host=host2a)(port=1630)) 
          (address=(protocol=tcp)(host=host2b)(port=1630)) 
         ) 
         (address=(protocol=tcp)(host=host3)(port=1521))    # hop 3 
         ) 
         (connect_data=(service_name=sales.acme.com)) 
         )

In the example above:

  1. The client is instructed to connect to an address of the first Oracle Connection Manager, as indicated by:

    (address=(protocol=tcp)(host=host1)(port=1630)
    
    
  2. The first Oracle Connection Manager then connects to another Oracle Connection Manager by first trying the address of one Oracle Connection Manager. If the first address fails, it tries the second address. This is indicated by:

    (address_list=  
      (failover=on) 
      (load_balance=off)                                    # hop 2 
      (address=(protocol=tcp)(host=host2a)(port=1630)) 
      (address=(protocol=tcp)(host=host2b)(port=1630)) 
    
  3. The Oracle Connection Manager then connects to the database service using the following listener address:

    (address=(protocol=tcp)(host=host3)(port=1521))    # hop 3 
    
    

Shown in Figure C-6 is an example of client load balancing among two Oracle Connection Managers and two listener addresses:

Figure C-6 Client Load Balancing in TNSNAMES.ORA

sample2=(description= 
           (load_balance=on) 
           (failover=on) 
           (address_list= 
             (source_route=yes) 
             (address=(protocol=tcp)(host=host1)(port=1630)) 
             (address=(protocol=tcp)(host=host2)(port=1521)) 
           ) 
           (address_list= 
             (source_route=yes) 
             (address=(protocol=tcp)(host=host3)(port=1630)) 
             (address=(protocol=tcp)(host=host4)(port=1521)) 
           ) 
           (connect_data=(service_name=sales.acme.com)) 
         )

In the example above:

  1. The client is instructed to pick an ADDRESS_LIST at random and to failover to the other if the chosen ADDRESS_LIST fails. This is indicated by the LOAD_BALANCE and FAILOVER parameters being set to ON.

  2. When an ADDRESS_LIST is chosen, the client first connects to the Oracle Connection Manager, using the Oracle Connection Manager address indicated for the ADDRESS_LIST.

  3. The Oracle Connection Manager than connects to the database service, using the listener address indicated for the ADDRESS_LIST.

DESCRIPTIONS and DESCRIPTION_LISTs

DESCRIPTION  

Purpose:  

Beginning of a connect descriptor, containing the definition of a database listening address and the service name to which to connect. This parameter may be embedded under a DESCRIPTION_LIST.  

Example:  

net_service_name=
(description =
  (address=...)
  (connect_data=(service_name=sales.com))
 

DESCRIPTION_LIST  

Purpose:  

Defines a list of connect descriptors for a particular net service name.  

Example:  

net_service_name= 
(description_list=
 (description=
  (address=...)
  (connect_data=(service_name=sales.com))
 (description=
  (address=...)
  (connect_data=(service_name=sales2.com))
)
 

ADDRESSes and ADDRESS_LISTs

ADDRESS  

Purpose:  

Defines a listener protocol address. This parameter may be embedded under a ADDRESS_LIST or DESCRIPTION.

Additional Information: See "Configuring Protocol Addresses" for descriptions of the correct parameters to use for each protocol.  

Example:  

net_service_name=
(description= 
  (address =...)
  (address =...)
  )
  (connect_data=(service_name=sales.com))
 
ADDRESS_LIST  

Purpose:  

Defines a list of addresses. If there is only list, ADDRESS_LIST is not necessary. This parameter may be embedded under a DESCRIPTION or DESCRIPTION_LIST.  

Example:  

net_service_name=
(description= 
 (address_list=
  (address =...)
  (address =...)
  )
 )
 (address_list= 
  (load_balance=off)
  (address =...)
  (address =...)
  )
 )
 (connect_data=(service_name=sales.com))
 

Optional Parameters for Lists

FAILOVER  

Purpose:  

When set to ON, instructs Net8 at connect time to fail over to a 
different listener if the first listener fails. It determines how 
many addresses are tried. When set to OFF, instructs Net8 to 
try one address.

This parameter must be embedded under a DESCRIPTION_LIST, DESCRIPTION or ADDRESS_LIST.

Note: This feature will not work if the LISTENER.ORA is configured with static service configuration parameters. See "SID_LIST_listener_name Static Service Section" for further information about these parameters. Static configuration is required for Oracle8i release 8.0 or Oracle7 databases and Oracle Enterprise Manager.  

Default:  

ON for DESCRIPTION_LISTs, DESCRIPTIONs, and ADDRESS_LISTs.  

Values:  

ON | OFF | YES | NO | TRUE | FALSE  

Example:  

net_service_name=
 (description= 
  (failover=on)
  (address =...)
  (address =...)
  )
  (connect_data=(service_name=sales.com))
    
 )
 
LOAD_BALANCE  

Purpose:  

When set to ON, instructs Net8 to progress through the list of listener addresses in a random sequence, balancing the load on the various listeners. When set to OFF, instructs Net8 to try the addresses sequentially until one succeeds.

This parameter must be embedded under a DESCRIPTION_LIST, DESCRIPTION or ADDRESS_LIST.  

Default:  

ON for DESCRIPTION_LISTs  

Values:  

ON | OFF | YES | NO | TRUE | FALSE  

Example:  

net_service_name=
 (description= 
  (load_balance=on)
  (address =...)
  (address =...)
  )
  (connect_data=(service_name=sales.com)) 
 
SOURCE_ROUTE  

Purpose:  

When set to ON or YES, instructs Net8 use each address in order until the destination reached. This parameter is required when reaching the destination requires more than one address stop.

This parameter is required for Oracle Connection Manager. For Oracle Connection Manager, an initial connection from the client to the Oracle Connection Manager is required, and a second connection from the Oracle Connection Manager to the listener is required.

This parameter must be embedded under a DESCRIPTION_LIST, DESCRIPTION or ADDRESS_LIST.  

Default:  

OFF  

Values:  

YES, NO, ON, OFF  

Example:  

net_service_name=
 (description =
  (source_route=yes)
  (address=...)
  (address=...)
  )
  (connect_data=(sid=sales))
 
TYPE_OF_SERVICE  

Purpose:  

Specifies the type of service to use for an Oracle RDB database. It is used by Rdb interface tools. This feature should only be used if the application supports both an Oracle Rdb and Oracle database, and you want the application to randomly choose (load balance). This parameter must be embedded under a DESCRIPTION.  

Example:  

net_service_name=
 (description_list=
  (description=
    (address=...)
    )
    (connect_data= 
     (service_name=generic)
     (rbd_database=[.mf]mf_personal.rdb)
     (global_name=alpha5))
    (type_of_service=rdb_database))
 (description=
   (address=...)
    (connect_data= 
     (service_name=sales))
    (type_of_service=oracle8_database)))
 

CONNECT_DATA Section

CONNECT_DATA  

Purpose:  

Defines the database to which to connect. This parameter must be embedded under a DESCRIPTION.  

Example:  

net_service_name=
 (description= 
  (address =...)
  (address =...)
  )
  (connect_data=(service_name=sales.com))
 

CONNECT_DATA offers the following parameters:

Listener Parameters (LISTENER.ORA)

The following items are available in the network listener configuration file (LISTENER.ORA).

LISTENER.ORA is located in $ORACLE_HOME/network/admin on UNIX and ORACLE_HOME\network\admin on Windows NT.

Listener Address Section

The listener address section of the LISTENER.ORA defines the protocol address(es) of the listener.

DESCRIPTION  

Purpose:  

Defines a listener protocol address, as well as the presentation and session communication layers to use.

Prior to this release, Net8 only supported connections that used the Two-Task Common (TTC) presentation layer and Transparent Network Substrate (TNS) Network session (NS) layer to establish client connections.

In order for clients to connect to the Java option in the database, the presentation layer and session layer support have been expanded. For those clients wishing to connect to the Java option, the General Inter-Orb Protocol (GIOP) presentation layer is used with no session layer.

This parameter may be embedded under a DESCRIPTION_LIST.

It is not necessary to use DESCRIPTIONs if all the protocol addresses specified use TTC and NS.

Additional Information: See "Configuring Java Option Connections" for configuration information.  

Example:  

listener_name =
  (description_list =
    (description =
      (address=
        (protocol=ipc)
        (key=extproc0))
    )
    (description =
      (protocol_stack =
        (presentation=giop)
        (session=raw))
      (address=
        (protocol=tcp)
        (host=sales-pc)
        (port=2481))
  )
 
DESCRIPTION_LIST  

Purpose:  

Defines a list of listener protocol address and protocol stack descriptions.  

Example:  

listener_name =
  (description_list =
    (description =
      (address=
        (protocol=ipc)
        (key=extproc0))
    )
    (description =
      (protocol_stack =
        (presentation=giop)
        (session=raw))
      (address=
        (protocol=tcp)
        (host=sales-pc)
        (port=2481))
  )
 
ADDRESS  

Purpose:  

Defines a listener protocol address. This parameter may be embedded under a ADDRESS_LIST or DESCRIPTION.

Additional Information: See "Configuring Protocol Addresses" for descriptions of the correct parameters to use for each protocol.  

Example:  

listener_name =
      (address=
        (protocol=ipc)
        (key=extproc0))
      (address=
        (protocol=tcp)
        (host=sales-pc)
        (port=2481))
 
ADDRESS_LIST  

Purpose:  

Defines lists of listener protocol addresses. Because there will only be one list of addresses, it is not necessary to use this parameter. By default operation, the Net8 Assistant and Net8 Configuration Assistant create an ADDRESS_LIST each time an address is specified, even though there is only one list. This parameter may be embedded under a DESCRIPTION or DESCRIPTION_LIST.  

Example:  

listener_name =
  (description_list =
    (description =
      (address_list =
         (address=
           (protocol=ipc)
           (key=extproc0))
      )
    )
    (description =
      (protocol_stack =
        (presentation=giop)
        (session=raw)
      )
      (address_list =
         (address=
           (protocol=tcp)
           (host=sales-pc)
           (port=2481))
      )
    )
    (description =
      (address_list =
         (address=
           (protocol=tcp)
           (host=sales-pc)
           (port=1521))
      )
    )
  )
 
PROTOCOL_STACK  

Purpose:  

Prior to this release, Net8 only supported connections that used the Two-Task Common (TTC) presentation layer and Network Session (NS) layer to establish client connections.

For those clients wishing to connect to the Java option, the General Inter-Orb Protocol (GIOP) presentation layer is used with no session layer.

This parameter must be embedded under a DESCRIPTION.

It is not necessary to use PROTOCOL_STACK if the protocol address(es) specified use TTC and NS.

Additional Information: See "Configuring Java Option Connections" for further configuration information.  

Example:  

listener_name =
  (description_list =
    (description =
      (address=
        (protocol=ipc)
        (key=extproc0))
    )
    (description =
      (protocol_stack =
        (presentation=giop)
        (session=raw))
      (address=
        (protocol=tcp)
        (host=sales-pc)
        (port=2481))
  )
 

PRESENTATION  

Purpose:  

Identifies the presentation layer.  

Default:  

TTC  

Values:  

TTC | GIOP

Typical Net8 clients use a presentation layer of Two-Task Common (TTC).

IIOP clients require a presentation layer of GIOP. GIOP is an alias for either oracle.aurora.server.SGiopServer or oracle.aurora.server.GiopServer using TCP/IP or TCP/IP with SSL.

Additional Information: See "Configuring Java Option Connections" for further configuration information.  

Example:  

listener_name =
  (description_list =
    (description =
      (address=
        (protocol=ipc)
        (key=extproc0))
    )
    (description =
      (protocol_stack =
        (presentation=giop)
        (session=raw))
      (address=
        (protocol=tcp)
        (host=sales-pc)
        (port=2481))
  )
 

SESSION  

Purpose:  

Identifies the session layer.  

Default:  

NS  

Values:  

NS | RAW

IIOP clients require no session layer (RAW).

Typical Net8 clients use a session layer of Transparent Network Substrate (TNS) Network Session (NS).  

Example:  

listener_name =
  (description_list =
    (description =
      (address=
        (protocol=ipc)
        (key=extproc0))
    )
    (description =
      (protocol_stack =
        (presentation=giop)
        (session=raw))
      (address=
        (protocol=tcp)
        (host=sales-pc)
        (port=2481))
  )
 

SID_LIST_listener_name Static Service Section

The SID_LIST section of the LISTENER.ORA defines the system identifier (SID) of the database served by the listener. This section is only valid for version 7.x and version 8.0 Oracle databases, as instance information is now automatically registered with the listener. Static configuration is also required for other services, such as external procedures and heterogeneous services, and some management tools, including Oracle Enterprise Manager.


CAUTION:

Implementing connect-time failover does not allow use of static service configuration parameters in the LISTENER.ORA file. However, static configuration is required for Oracle8i release 8.0 or Oracle7 databases and Oracle Enterprise Manager. For further information about statically configuring the listener, see "Configuring a Listener with Service Information".

See the Oracle8i Parallel Server Setup and Configuration Guide for instructions on setting up connect-time failover in an Oracle Enterprise environment.  


sid_list_listener_name=
  (sid_list= 
   (sid_desc=
    (global_dbname=global_database_name)
    (sid_name=sid)
    (oracle_home=oracle_home)
    (prespawn_max=99) 
    (prespawn_list= 
      (prespawn_desc= 
        (protocol=tcp)
        (pool_size=10)
        (timeout=2))
        (prespawn_desc=...))
   (sid_desc=...)
  )


SID_LIST contains the following parameters:

GLOBAL_DBNAME  

Purpose:  

The global database name is the name and domain name of the database, as given in SERVICE_NAMES parameter in the database initialization parameter file (INITSID.ORA). If you want to refer to the database by its global database name on the network, then you must specify that global database name to the listener. This parameter must be embedded under SID_DESC and should match the value of the SERVICE_NAMES parameter.  

Example:  

sid_list_listener_name=
  (sid_list= 
   (sid_desc=
    (global_dbname=oracle.com)
    (sid_name=orcl)
    (oracle_home=/usr/oracle)
   )
  )
 
ORACLE_HOME  

Purpose:  

Identifies the Oracle home location of the database that you are specifying. This parameter must be embedded under SID_DESC.  

Example:  

sid_list_listener_name=
  (sid_list= 
   (sid_desc=
     (sid_name=extproc)
     (oracle_home=/usr/oracle)
     (program=extproc)
   )
  )
 
PROGRAM  

Purpose:  

Identifies the service's executable program name. For example, extproc.exe.  

Example:  

sid_list_listener_name=
  (sid_list= 
   (sid_desc=
     (sid_name=extproc)
     (oracle_home=oracle)
     (program=extproc)
   )
  )
 
SID_NAME  

Purpose:  

Identifies the SID of the database. Its value is operating system specific. This parameter must be embedded under SID_DESC.

This parameter should match the value of the INSTANCE_NAME parameter in the INITSID.ORA file.  

Example:  

sid_list_listener_name=
  (sid_list= 
   (sid_desc=
    (global_dbname=oracle.com)
    (sid_name=orcl)
    (oracle_home=/usr/oracle)
   )
  )
 
SID_LIST  

Purpose:  

Identifies a list of SID descriptions.  

Example:  

sid_list_listener_name=
  (sid_list= 
   (sid_desc=...)
   (sid_desc=...)
  ) 
 
SID_DESC  

Purpose:  

Defines a SID. This parameter may be embedded under SID_LIST.  

Example:  

sid_list_listener_name=
  (sid_list= 
   (sid_desc=...)
   (sid_desc=...)
  ) 
 
PRESPAWN_MAX  

Purpose:  

Specifies the maximum number of prespawned dedicated server processes the listener will create. This number must be at least as many as the sum of the pool size for each protocol. Set this value to a large number so that prespawned dedicated server processes are always available for new connections.This parameter must be embedded under SID_LIST.

Prespawned dedicated servers cannot be configured on Windows NT.  

Example:  

sid_list_listener_name=
  (sid_list= 
   (sid_desc=
    (global_dbname=oracle.com)
    (sid_name=sid)
    (oracle_home=/usr/oracle)
    (prespawn_max=99))
  )
 
PRESPAWN_LIST  

Purpose:  

Specifies a list of prespawnd dedicated server process descriptions. This parameter must be embedded under SID_DESC.  

Example:  

sid_list_listener_name=
  (sid_list= 
   (sid_desc=
    (global_dbname=oracle.com)
    (sid_name=sid)
    (oracle_home=/usr/oracle)
    (prespawn_max=99) 
    (prespawn_list= 
      (prespawn_desc= 
        (protocol=tcp)
        (pool_size=10)
        (timeout=2))
        (prespawn_desc=...)))
   ))
 
PRESPAWN_DESC  

Purpose:  

Defines the protocol on which the listener creates prespawned dedicated server processes, as well as characteristics of the prespawned dedicated server. Each protocol must have its own PRESPAWN_DESC description. This parameter must be embedded under PRESPAWN_LIST.

Additional Information: See "Configuring Prestarted or Prespawned Dedicated Servers" for descriptions of PROTOCOL, POOL_SIZE, and TIMEOUT.  

Example:  

sid_list_listener_name=
  (sid_list= 
   (sid_desc=
    (global_dbname=oracle.com)
    (sid_name=sid)
    (oracle_home=/usr/oracle)
    (prespawn_max=99) 
    (prespawn_list= 
      (prespawn_desc= 
        (protocol=tcp)
        (pool_size=10)
        (timeout=2))
        (prespawn_desc=...)))
   ))
 

Control Parameters

The following parameters control the behavior of the listener:

CONNECT_TIMEOUT_listener_name  

Purpose:  

Determines the amount of time the listener will wait for a valid connection request after a connection has been started.  

Default:  

10 seconds  

Example:  

connect_timeout_listener=12
 

LOG_DIRECTORY_listener_name  

Purpose:  

Controls the destination directory of the log file.  

Default:  

$ORACLE_HOME/network/log on UNIX and $ORACLE_HOME/network/log on Windows NT.  

Example:  

log_directory_listener=/oracle/network/admin/log
 
LOG_FILE_listener_name  

Purpose:  

Sets the name of the log file for the listener.  

Default:  

LISTENER.LOG  

Example:  

log_file_listener=list.log
 

PASSWORDS_listener_name  

Purpose:  

Sets a non-encrypted password for authentication to the Listener Control Utility (LSNRCTL). Allows one or more passwords. If this optional parameter specifies one or more passwords, then the use of one of these passwords is required to perform DBA tasks against the network listener using the LSNRCTL.  

Default:  

oracle  

Example:  

passwords_listener=(oracle8)
 
STARTUP_WAITTIME_listener_name  

Purpose:  

Sets the number of seconds that the network listener sleeps before responding to the first listener control status command.  

Default:  

0 seconds  

Example:  

startup_waittime_listener=5
 

TRACE_DIRECTORY_listener_name  

Purpose:  

Controls the destination directory of the log file.  

Default:  

$ORACLE_HOME/network/trace on UNIX and $ORACLE_HOME/network/trace on Windows NT.  

Example:  

trace_directory_listener=/oracle/network/admin/trace
 

TRACE_FILE_listener_name  

Purpose:  

Sets the name of the trace file for the listener.  

Default:  

LISTENER.TRC  

Example:  

trace_file_listener=list.trc
 

TRACE_LEVEL_listener_name  

Purpose:  

Turns tracing on/off to a certain specified level.  

Default:  

OFF  

Values  

  • OFF - No trace output

  • USER - User trace information

  • ADMIN - Administration trace information

  • SUPPORT - WorldWide Customer Support trace information

 

Example:  

trace_level_listener=admin
 

USE_PLUG_AND_PLAY_listener_name  

Purpose:  

Instructs the listener to find and register database information with an Oracle Names Server.

When a client requests a connection to a server, the Oracle Names server retrieves the necessary information, such as the service name and SID, from the listener.  

Default:  

OFF  

Values:  

ON | OFF  

Example:  

use_plug_and_play=on
 

Oracle Names Parameters (NAMES.ORA)

The following parameters are available in an Oracle Names configuration file (NAMES.ORA). NAMES.ORA is located in $ORACLE_HOME/network/admin on UNIX and ORACLE_HOME\network\admin on Windows NT.

NAMES.ADDRESSES  

Purpose:  

Describes the address on which the Oracle Names server listens. Any valid ADDRESS or ADDRESS_LIST is allowed.

Additional Information: See:

 

Default:  

names.addresses= 
  (address=(protocol=tcp)(host=oranamesrvr0)(port=1575)
 
NAMES.ADMIN_REGION  

Purpose:  

Describes the data source for an administrative region. If set, this parameter defines a database as a repository for information. If this parameter is not set, replication of data between Oracle Names server caches.  

Default:  

NULL  

Example:  

names.admin_region=
   (region=(name=local_region)
   (type=rosdb)
   (userid=names)
   (password=names)
   (description=
     (address=(protocol=tcp)
     (host=nineva)(port=1575)
     )
   )
   (connect_data=
        (service_name=em)
        )
    )
   (version=34619392)
   (refresh=14400)
   (retry=600)
   (expire=259200)
 
NAMES.AUTHORITY_REQUIRED  

Purpose:  

Determines whether system queries require authoritative answers.  

Default:  

FALSE  

Example:  

names.authority_required=true
 
NAMES.CONNECT_TIMEOUT  

Purpose:  

Limits the amounts of time the Oracle Names server will wait for the connection from a client to complete.  

Default:  

3 seconds  

Minimum Value:  

1 second  

Maximum Value:  

600 seconds  

Example:  

names.connect_timeout=8
 
NAMES.AUTO_REFRESH_EXPIRE  

Purpose:  

Specifies the amount of time in seconds the Oracle Names server caches other region's database server addresses which have been obtained through NAMES.DOMAIN.HINTS. At the end of this interval, the Oracle Names server issues a query to the other region database servers to refresh the address.  

Default:  

600 seconds  

Acceptable Values:  

60-1209600 seconds  

Example:  

names.auto_refresh_expire=1200000
 
NAMES.AUTO_REFRESH_RETRY  

Purpose:  

Specifies the interval in seconds that the Oracle Names server will retry when the auto refresh query fails.  

Default:  

180  

Minimum Value:  

60  

Maximum Value  

3600  

Example:  

names.auto_refresh_retry=180
 
NAMES.CACHE_CHECKPOINT_FILE  

Purpose:  

Specifies the name and path of the file to which the Oracle Names server writes its checkpoint file.  

Default:  

$ORACLE_HOME/network/names/ckpcch.ora on UNIX and ORACLE_HOME\network\names\ckpcch.ora on Windows NT.  

Example:  

names.cache_checkpoint_
file=c:\oracle\network\names\cacheck.ora
 
NAMES.CACHE_CHECKPOINT_INTERVAL  

Purpose:  

Indicates the interval at which a Oracle Names server writes a checkpoint of its stored data to the checkpoint file. Each Oracle Names server can periodically write its cached data to a file to protect against startup failures.  

Default:  

0 (disabled)  

Minimum Value:  

10  

Maximum Value:  

259200 (3 days)  

Example:  

names.cache_checkpoint_interval=24
 
NAMES.CONFIG_CHECKPOINT_FILE  

Purpose:  

Specifies the name and path of the file used to checkpoint Oracle Names server configuration settings.  

Default:  

$ORACLE_HOME/network/names/ckcfg.ora on UNIX and ORACLE_HOME\network\names\ckcfg.ora on Windows NT.  

Example:  

names.config_checkpoint_
file=c:\oracle\network\names\configck.ora
 
NAMES.DEFAULT_FORWARDERS  

Purpose:  

Address list of other Oracle Names servers which are used to forward queries.  

Example:  

names.default_forwarders= (forwarder_list=
  (forwarder=(name=rootserv1.com)(address=(protocol=tcp)
      (port=4200)(host=roothost))))
 
NAMES.DEFAULT_FORWARDERS_ONLY  

Purpose:  

When TRUE the Oracle Names server forwards queries only to those Oracle Names servers listed as default forwarders.  

Default:  

FALSE  

Usage Notes:  

If set to FALSE, Oracle Names servers listed as default forwarders will be called before Oracle Names servers found in the cache.  

NAMES.DOMAIN_HINTS  

Purpose:  

Lists the names, addresses and domains of all servers in one or more foreign regions. Enables the Oracle Names server to know about other regions' servers. This includes at least the root region for all servers who are not in the root region. Other regions may be provided as optimization requires.  

Example:  

names.domain_hints=
 (hint_desc=(hint_list=
   (hint=(name=rootserv1.com)
     (address=(protocol=tcp)(host=nineva)(port=4200)
     )
   )
 )
 
NAMES.DOMAINS  

Purpose:  

List of domains in the server's local region, as well as the default time to live (TTL) for data in those domains.  

Example:  

names.domains=
 (domain_list=
    (domain=(name=)(min_ttl=86400))
    (domain=(name=com)(min_ttl=8640))
  )
 
NAMES.FORWARDING_AVAILABLE  

Purpose:  

The Oracle Names server forwards operations to foreign regions if set to ON.  

Default  

ON  

Values:  

ON | OFF  

Example:  

names.forwarding_available=off
 
NAMES.FORWARDING_DESIRED  

Purpose:  

If set to TRUE, then this Oracle Names servers forwards queries.  

Default:  

TRUE  

Values:  

TRUE | FALSE  

Example:  

names.forwarding_desired=true
 
NAMES.KEEP_DB_OPEN  

Purpose:  

Specifies whether or not to attempt to keep the TNS connection to the region database open between operations. If set to FALSE, the connection will be closed after each load, reload or reload-check.  

Default:  

TRUE  

Values:  

TRUE | FALSE  

Example:  

names.keep_db_open=FALSE
 
NAMES.LOG_DIRECTORY  

Purpose:  

Indicates the name of the directory where the log file for Oracle Names server operational events are written.  

Default:  

$ORACLE_HOME/network/log on UNIX and ORACLE_HOME\network\log on Windows NT.  

Example:  

names.log_directory=c:\oracle\network\names
 
NAMES.LOG_FILE  

Purpose:  

Indicates the name of the output file to which Oracle Names server operational events are written. The file name extension is always .LOG. Do not enter an extension for this parameter.  

Default:  

NAMES  

Example:  

names.log_file=onames
 
NAMES.LOG_STATS_INTERVAL  

Purpose:  

Specifies the number of seconds between full statistical dumps in the log file.  

Default:  

0 (0=OFF)  

Minimum Value:  

10 (least possible ON value)  

Maximum Value:  

none  

Example:  

names.log_stats_interval=12
 
NAMES.LOG_UNIQUE  

Purpose:  

If set to TRUE, then the log file name will be unique and not overwrite existing log files.  

Default:  

FALSE  

Values:  

TRUE | FALSE  

Example:  

names.log_unique=true
 
NAMES.MAX_OPEN_CONNECTIONS  

Purpose:  

Specifies the number of connections that the Oracle Names server can have open at any given time. The value is generated as the value 10 or the sum of one connection for listening, five for clients, plus one for each foreign domain defined in the local administrative region, whichever is greater.

The calculated value is acceptable for most installations.  

Default:  

Calculated based on entered data.  

Minimum Value:  

2  

Maximum Value:  

64  

Example:  

names.max_open_connections=52
 
NAMES.MAX_REFORWARDS  

Purpose:  

Specifies the maximum number of times the server attempts to forward an operation.  

Default:  

2  

Minimum Value:  

1  

Maximum Value:  

15  

Example:  

names.max_reforwards=2
 
NAMES.MESSAGE_POOL_START_SIZE  

Purpose:  

Determines the initial number of messages allocated in the server's message pool which are used for incoming or outgoing forwarded messages.  

Default:  

10  

Minimum Value:  

3  

Maximum Value:  

256  

Example:  

names.message_pool_start_size=10
 
NAMES.NO_MODIFY_REQUESTS  

Purpose:  

If set to TRUE, the server refuses any operations which modify the data in its region.  

Default:  

FALSE  

Values:  

TRUE | FALSE  

Example:  

names.no_modify_requests=true
 
NAMES.NO_REGION_DATABASE  

Purpose:  

If set to TRUE, the server does not look for a region database.  

Default:  

FALSE  

Example:  

names.no_region_database=true
 
NAMES.PASSWORD  

Purpose:  

Sets the password for an Oracle Names server, so that certain sensitive operations, such as STOP, RESTART and RELOAD operations in NAMESCTL are secure.

If this parameter is set with the Net8 Assistant, the password is encrypted. A clear-text password may be made manually. If the password is clear-text, ensure the NAMESCTL.INTERNAL_ENCRYPT_PASSWORD parameter is set in the SQLNET.ORA file is set to FALSE.  

Default:  

None  

Example:  

names.password=625926683431aa55
 
NAMES.REGION_CHECKPOINT_FILE  

Purpose:  

Specifies the name and path of the file used to checkpoint region data (for example, domain addresses, database addresses of Oracle Names servers in the local region)  

Default:  

$ORACLE_HOME/network/names/ckpreg.ora on UNIX and ORACLE_HOME\network\names\ckpreg.ora on Windows NT.  

Example:  

names.region_checkpoint_
file=c:\oracle\network\names\regionck.ora
 
NAMES.RESET_STATS_INTERVAL  

Purpose:  

Specifies the number of seconds during which the statistics collected by the Oracle Names servers should accumulate. At the frequency specified, they are reset to zero. The default value of 0 means never reset statistics.  

Default:  

0 (never reset)  

Minimum Value:  

10  

Maximum Value:  

none  

Example:  

names.reset_stats_interval=15
 
NAMES.SAVE_CONFIG_ON_STOP  

Purpose:  

If set to TRUE, the server will save its runtime configuration settings back into NAMES.ORA. Any parameters which were modified through NAMESCTL SET operations will replace prior NAMES.ORA settings.  

Default:  

FALSE  

Example:  

names.save_config_on_stop=FALSE
 
NAMES.SERVER_NAME  

Purpose:  

Each Oracle Names server is uniquely identified by a name. All configuration references to a particular Oracle Names server use this name.  

Default:  

ONAMES_onames_server  

Example:  

names.server_name=namesrv1.us.oracle.com
 
NAMES.TRACE_DIRECTORY  

Purpose:  

Indicates the name of the directory to which trace files from a Oracle Names server trace session are written.  

Default:  

$ORACLE_HOME/network/trace on UNIX and ORACLE_HOME/network/trace on Windows NT.  

Example:  

names.trace_directory=/oracle/network/admin/trace
 
NAMES.TRACE_FILE  

Purpose:  

Indicates the name of the output file from a Oracle Names server trace session. The file name extension is always .TRC.  

Default:  

NAMES  

Example:  

names.trace_file=onames
 
NAMES.TRACE_FUNC  

Purpose:  

Enables internal mechanism to control tracing by function name.  

Default:  

FALSE  

Example:  

names.trace_func=false
 
NAMES.TRACE_LEVEL  

Purpose:  

Indicates the level at which the Oracle Names server is to be traced.  

Default:  

OFF  

Values  

  • OFF - No trace output

  • USER - User trace information

  • ADMIN - Administration trace information

  • SUPPORT - WorldWide Customer Support trace information

 

Example:  

names.trace_level=admin
 
NAMES.TRACE_UNIQUE  

Purpose:  

Indicates whether each trace file has a unique name, allowing multiple trace files to coexist. If the value is set to ON, a process identifier is appended to the name of each trace file generated.  

Default:  

ON  

Values  

ON | OFF  

Example:  

names.trace_unique=on
 

Oracle Connection Manager Parameters (CMAN.ORA)

The following parameters are available in an Oracle Connection Manager configuration file (CMAN.ORA). CMAN.ORA is located in $ORACLE_HOME/network/admin on UNIX and ORACLE_HOME\network\admin on Windows NT.

CMAN  

Purpose:  

Specifies listening addresses for Oracle Connection Manager gateway process, CMGW.  

Default:  

cman=(address=(protocol=tcp)(host=local_host)(port=1630))
 

Syntax:  

cman=
  [(address_list= ]
    (address= ...)
   [(address= ...))] 
 

CMAN_ADMIN  

Purpose:  

Specifies listening addresses for Oracle Connection Manager administrative process, CMADMIN.  

Default:  

cman_admin=(address=(protocol=tcp)(host=anyhost)(port=1830))
 

Syntax:  

  [(address_list= ]
    (address= ...)
   [(address= ...))] 
 

CMAN_PROFILE  

Purpose:  

Sets parameters related to the running of Oracle Connection Manager.  

Default:  

  • ANSWER_TIMEOUT=0

  • AUTHENTICATION_LEVEL=0

  • LOG_LEVEL=0

  • MAX_FREELIST_BUFFERS=2048

  • MAXIMUM_CONNECT_DATA=1024

  • MAXIMUM_RELAYS=128

  • RELAY_STATISTICS=NO

  • SHOW_TNS_INFO=NO

  • TRACE_DIRECTORY=$ORACLE_HOME/network/trace on UNIX and ORACLE_HOME\network\trace on Windows NT

  • TRACING=NO

  • USE_ASYNC_CALL=YES

 

Values:  

  • ANSWER_TIMEOUT=[0 to n]

  • AUTHENTICATION_LEVEL=[0, 1]

  • LOG_LEVEL=[0-4]

  • MAXIMUM_CONNECT_DATA=[257-4096]

  • MAX_FREELIST_BUFFERS=[0-10240]

  • MAXIMUM_RELAYS=[0-2048]

  • RELAY_STATISTICS=[YES,NO]

  • SHOW_TNS_INFO=[YES, NO]

  • TRACE_DIRECTORY=pathname

  • TRACING=[YES, NO]

  • USE_ASYNC_CALL=[YES, NO]

 

Example:  

cman_profile =
   (parameter_list= 
      (maximum_relays=512)
      (log_level=1)
      (tracing=yes)
      (relay_statistics=yes)
      (show_tns_info=yes) 
      (use_async_call=yes)             
      (authentication_level=0)
   )
 

CMAN_PROFILE Parameter   Description  

ANSWER_TIMEOUT  

The number of seconds that Oracle Connection Manager will use to time out the protocol handshake associated with an incoming connection request. The range is 0 to n.  

AUTHENTICATION_LEVEL  

1 instructs the CMAN to reject connect requests that are not using Secure Network Services. Secure Network Services is part of the Oracle Advanced Security option.

0 is the default, which means Secure Network Services is not required  

LOG_LEVEL  

Determines the level of logging performed by the Oracle Connection Manager.

  • default is 0, which means no logging is performed

  • range is 0 to 4:

    level 1 - basic reporting

    level 2 - RULE_LIST matching lookup reporting

    level 3 - relay blocking reporting

    level 4 - relay I/O counts reporting

The CMGW gateway process creates a log file called CMAN_PID.LOG, and the CMADMIN administrative process creates a log file called CMADM_PID.LOG. The log files are located in $ORACLE_HOME/network/log on UNIX and ORACLE_HOME\network\log on Windows NT.  

MAX_FREELIST_BUFFERS  

Determines the maximum number of buffers that TNS will keep in freelist for later user instead of returning them to the operating system after a relay gets closed.The range is 0 to 10240.  

MAXIMUM_CONNECT_DATA  

Limits the connect data string length of the incoming connection requests.

The range is 257-4096.  

MAXIMUM_RELAYS  

Determines the maximum number of concurrent connections Oracle Connection Manager will support. The range is 0 to 2048.  

RELAY_STATISTICS  

YES instructs the CMGW process to maintain statistics pertaining to relay I/O activities, such as:

  • number of IN bytes

  • number of OUT bytes

  • number of IN packets

  • number of OUT packets

This information is stored in the CMAN_PID.LOG file.  

SHOW_TNS_INFO  

YES instructs the CMGW process to include TNS events in the CMAN_PID.LOG file.  

TRACING  

YES enables tracing for the Oracle Connection Manager. The CMGW gateway process creates a trace file called CMAN_PID.TRC, and the CMADMIN administrative process creates a trace file called CMADM_PID.TRC.  

TRACE_DIRECTORY  

Specifies the trace directory.  

USE_ASYNC_CALL  

YES instructs the CMGW process to use all asynchronous functions while in the answering or calling phase of establishing a Net8 connection.

Note: CMGW supports out-of-band breaks, it will forward it on to the server.  

CMAN_RULES  

Purpose:  

Sets the rules for the network access control portion of Oracle Connection Manager.  

Syntax:  

cman_rules=
  (rules_list=
      (rule=(src=hostname)(dst=hostname)(srv= service_name|sid)
      (act=accept)) 
      [(rule= ...)] 
   )
 

Values:  

  • SRC - Source host name or IP address (in dot notation) of session request

  • DST - Destination server host name or IP address (in dot notation)

  • SRV - Database server SID

  • ACT - Accept or Reject incoming requests with the previous characteristics.

 

Usage Notes  

The wildcard for host name is the single character 'x'. In the case of an IP address (d.d.d.d), you may wild card the individual d's with an 'x'.

Note: If client's connect string contain both SID and SERVICE_NAME, 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-pc)(srv=sales.com)(act=reject)) 
   (rule=(src=144.25.23.45)(dst=144.25.187.200)(srv=db1)(act=accept)) 
  (rule=(src=spcstn1)(dst=db2-pc)(srv=db2)(act=accept)) 
 )
 

Protocol-Specific Parameters (PROTOCOL.ORA)

The following parameters in the PROTOCOL.ORA configuration file are applicable to Net8.

protocol.EXCLUDED_NODES  

Purpose:  

Defines which nodes do not have validnode checking.  

Example:  

protocol.excluded_nodes= (hostname | ip_address, hostname | 
ip_address,...)
 

Example:  

tcp.excluded_nodes= (hr.com, 144.25.5.25)
 
protocol.INVITED_NODES  

Purpose:  

Defines which nodes have validnode checking. This list takes precedence over the protocol.EXCLUDED_NODES if both lists are present.  

Syntax:  

protocol.invited_nodes= (hostname | ip_address, hostname | 
ip_address,...)
 

Example:  

tcp.invited_nodes= (sales.com, 144.185.5.73)
 
protocol.VALIDNODE_CHECKING  

Purpose:  

Restricts connection access of clients to destinations with enabling host privilege.  

Default:  

NO  

Values:  

YES | NO  

Example:  

tcp.validnode_checking=yes
 
TCP.NODELAY  

Purpose:  

Specifies no delays in buffer flushing.  

Default:  

NO  

Values:  

YES | NO  

Example:  

tcp.nodelay=yes
 



Prev

Next
Oracle
Copyright © 1999 Oracle Corporation.

All Rights Reserved.

Library

Product

Contents

Index