Database Net Services Reference

Oracle® Database
Database Net Services Reference
19c
E96314-11
February 2022
Oracle Database Database Net Services Reference, 19c
E96314-11
Copyright © 2002, 2022, Oracle and/or its affiliates.
Primary Author: Binika Kumar
Contributing Authors: Douglas Williams, Prakash Jashnani
Contributors: Abhishek Dadhich, Alan Williams, Anita Patel, Bhaskar Mathur, Ching Tai, Christopher Jones,
David Lin, Feroz Khan, Hector Pujol, Kant Patel, Kevin Neel, Krishna Itikarlapalli, Misaki Miyashita, Norman
Woo, Peter Knaggs, Robert Achacoso, Santanu Datta, Sarma Namuduri, Steve Ding, Thanigai Nallathambi,
Yi Ouyang, Scot McKinley, Sharad Chandran R, Srinivas Pamu, Sweta Mogra, Murali Purayathu,
Saravanakumar Ramasubramanian, Sudeep Reguna
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,
transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is
prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software,
any programs embedded, installed or activated on delivered hardware, and modifications of such programs)
and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end
users are "commercial computer software" or "commercial computer software documentation" pursuant to the
applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use,
reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or
adaptation of i) Oracle programs (including any operating system, integrated software, any programs
embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle
computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the
license contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloud
services are defined by the applicable contract for such services. No other rights are granted to the U.S.
Government.
This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications that
may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you
shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its
safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software or hardware in dangerous applications.
Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates. Other names may be
trademarks of their respective owners.
Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are
used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc,
and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered
trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise
set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be
responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,
products, or services, except as set forth in an applicable agreement between you and Oracle.
Contents
Preface
Audience xiv
Documentation Accessibility xiv
Diversity and Inclusion xiv
Related Documents xv
Conventions xv
Changes in This Release for Oracle Database Net Services Reference

New Features xvi
Deprecated Features xviii
1 Listener Control Utility

1.1 Listener Control Utility Overview 1-1
1.2 SET and SHOW Commands of the Listener Control utility 1-2
1.3 Distributed Operations 1-3
1.4 Oracle Net Listener Security 1-3
1.5 Listener Control Utility Commands 1-3
1.5.1 EXIT 1-5
1.5.2 HELP 1-6
1.5.3 QUIT 1-7
1.5.4 RELOAD 1-7
1.5.5 SAVE_CONFIG 1-8
1.5.6 SERVICES 1-9
1.5.7 SET 1-10
1.5.8 SET CURRENT_LISTENER 1-12
1.5.9 SET DISPLAYMODE 1-12
1.5.10 SET INBOUND_CONNECT_TIMEOUT 1-13
1.5.11 SET LOG_DIRECTORY 1-14
1.5.12 SET LOG_FILE 1-15
1.5.13 SET LOG_STATUS 1-15
1.5.14 SET SAVE_CONFIG_ON_STOP 1-16
iii
1.5.15 SET TRC_DIRECTORY 1-17
1.5.16 SET TRC_FILE 1-18
1.5.17 SET TRC_LEVEL 1-19
1.5.18 SHOW 1-20
1.5.19 SPAWN 1-21
1.5.20 START 1-22
1.5.21 STATUS 1-23
1.5.22 STOP 1-25
1.5.23 TRACE 1-26
1.5.24 VERSION 1-27
2 Oracle Connection Manager Control Utility

2.1 Command Modes and Syntax 2-1
2.2 Oracle Connection Manager Control Utility Overview 2-3
2.3 Oracle Connection Manager Control Utility Commands 2-3
2.3.1 ADMINISTER 2-4
2.3.2 CLOSE CONNECTIONS 2-5
2.3.3 EXIT 2-7
2.3.4 HELP 2-7
2.3.5 QUIT 2-8
2.3.6 RELOAD 2-9
2.3.7 RESUME GATEWAYS 2-9
2.3.8 SAVE_PASSWD 2-10
2.3.9 SET 2-10
2.3.10 SET ASO_AUTHENTICATION_FILTER 2-11
2.3.11 SET CONNECTION_STATISTICS 2-12
2.3.12 SET EVENT 2-12
2.3.13 SET IDLE_TIMEOUT 2-13
2.3.14 SET INBOUND_CONNECT_TIMEOUT 2-14
2.3.15 SET LOG_DIRECTORY 2-14
2.3.16 SET LOG_LEVEL 2-15
2.3.17 SET OUTBOUND_CONNECT_TIMEOUT 2-16
2.3.18 SET PASSWORD 2-16
2.3.19 SET SESSION_TIMEOUT 2-17
2.3.20 SET TRACE_DIRECTORY 2-18
2.3.21 SET TRACE_LEVEL 2-18
2.3.22 SHOW 2-19
2.3.23 SHOW ALL 2-20
2.3.24 SHOW CONNECTIONS 2-21
2.3.25 SHOW DEFAULTS 2-23
iv
2.3.26 SHOW EVENTS 2-24
2.3.27 SHOW GATEWAYS 2-25
2.3.28 SHOW PARAMETERS 2-25
2.3.29 SHOW RULES 2-26
2.3.30 SHOW SERVICES 2-28
2.3.31 SHOW STATUS 2-28
2.3.32 SHOW VERSION 2-29
2.3.33 SHUTDOWN 2-29
2.3.34 STARTUP 2-30
2.3.35 SUSPEND GATEWAY 2-31
3 Syntax Rules for Configuration Files

3.1 Overview of Configuration File Syntax 3-1
3.2 Syntax Rules for Configuration Files 3-2
3.3 Network Character Set for Keywords 3-3
3.4 Character Set for Listener and Net Service Names 3-3
4 Protocol Address Configuration

4.1 Protocol Addresses 4-1
4.1.1 ADDRESS 4-1
4.1.2 ADDRESS_LIST 4-2
4.2 Protocol Parameters 4-2
4.3 Recommended Port Numbers 4-4
4.4 Port Number Limitations 4-4
5 Parameters for the sqlnet.ora File

5.1 Overview of Profile Configuration File 5-1
5.2 sqlnet.ora Profile Parameters 5-2
5.2.1 ACCEPT_MD5_CERTS 5-6
5.2.2 ACCEPT_SHA1_CERTS 5-6
5.2.3 ADD_SSLV3_TO_DEFAULT 5-6
5.2.4 BEQUEATH_DETACH 5-7
5.2.5 DEFAULT_SDU_SIZE 5-7
5.2.6 DISABLE_OOB 5-8
5.2.7 DISABLE_OOB_AUTO 5-8
5.2.8 EXADIRECT_FLOW_CONTROL 5-8
5.2.9 EXADIRECT_RECVPOLL 5-9
5.2.10 HTTPS_SSL_VERSION 5-9
5.2.11 IPC.KEYPATH 5-10
v
5.2.12 NAMES.DEFAULT_DOMAIN 5-10
5.2.13 NAMES.DIRECTORY_PATH 5-10
5.2.14 NAMES.LDAP_AUTHENTICATE_BIND 5-11
5.2.15 NAMES.LDAP_CONN_TIMEOUT 5-11
5.2.16 NAMES.LDAP_PERSISTENT_SESSION 5-12
5.2.17 NAMES.NIS.META_MAP 5-12
5.2.18 RECV_BUF_SIZE 5-13
5.2.19 SDP.PF_INET_SDP 5-13
5.2.20 SEC_USER_AUDIT_ACTION_BANNER 5-14
5.2.21 SEC_USER_UNAUTHORIZED_ACCESS_BANNER 5-14
5.2.22 SEND_BUF_SIZE 5-15
5.2.23 SQLNET.ALLOW_WEAK_CRYPTO 5-15
5.2.24 SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS 5-17
5.2.25 SQLNET.ALLOWED_LOGON_VERSION_CLIENT 5-18
5.2.26 SQLNET.ALLOWED_LOGON_VERSION_SERVER 5-19
5.2.27 SQLNET.AUTHENTICATION_SERVICES 5-25
5.2.28 SQLNET.CLIENT_REGISTRATION 5-26
5.2.29 SQLNET.CLOUD_USER 5-26
5.2.30 SQLNET.COMPRESSION 5-28
5.2.31 SQLNET.COMPRESSION_ACCELERATION 5-28
5.2.32 SQLNET.COMPRESSION_LEVELS 5-29
5.2.33 SQLNET.COMPRESSION_THRESHOLD 5-29
5.2.34 SQLNET.CRYPTO_CHECKSUM_CLIENT 5-29
5.2.35 SQLNET.CRYPTO_CHECKSUM_SERVER 5-30
5.2.36 SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT 5-31
5.2.37 SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER 5-31
5.2.38 SQLNET.DBFW_PUBLIC_KEY 5-32
5.2.39 SQLNET.DOWN_HOSTS_TIMEOUT 5-32
5.2.40 SQLNET.ENCRYPTION_CLIENT 5-33
5.2.41 SQLNET.ENCRYPTION_SERVER 5-34
5.2.42 SQLNET.ENCRYPTION_TYPES_CLIENT 5-34
5.2.43 SQLNET.ENCRYPTION_TYPES_SERVER 5-35
5.2.44 SQLNET.EXPIRE_TIME 5-36
5.2.45 SQLNET.IGNORE_ANO_ENCRYPTION_FOR_TCPS 5-37
5.2.46 SQLNET.INBOUND_CONNECT_TIMEOUT 5-37
5.2.47 SQLNET.FALLBACK_AUTHENTICATION 5-38
5.2.48 SQLNET.KERBEROS5_CC_NAME 5-39
5.2.49 SQLNET.KERBEROS5_CLOCKSKEW 5-39
5.2.50 SQLNET.KERBEROS5_CONF 5-40
5.2.51 SQLNET.KERBEROS5_CONF_LOCATION 5-41
5.2.52 SQLNET.KERBEROS5_KEYTAB 5-41
vi
5.2.53 SQLNET.KERBEROS5_REALMS 5-41
5.2.54 SQLNET.KERBEROS5_REPLAY_CACHE 5-42
5.2.55 SQLNET.OUTBOUND_CONNECT_TIMEOUT 5-42
5.2.56 SQLNET.RADIUS_ALTERNATE 5-43
5.2.57 SQLNET.RADIUS_ALTERNATE_PORT 5-43
5.2.58 SQLNET.RADIUS_ALTERNATE_RETRIES 5-44
5.2.59 SQLNET.RADIUS_AUTHENTICATION 5-44
5.2.60 SQLNET.RADIUS_AUTHENTICATION_INTERFACE 5-45
5.2.61 SQLNET.RADIUS_AUTHENTICATION_PORT 5-45
5.2.62 SQLNET.RADIUS_AUTHENTICATION_RETRIES 5-45
5.2.63 SQLNET.RADIUS_AUTHENTICATION_TIMEOUT 5-46
5.2.64 SQLNET.RADIUS_CHALLENGE_RESPONSE 5-46
5.2.65 SQLNET.RADIUS_SECRET 5-47
5.2.66 SQLNET.RADIUS_SEND_ACCOUNTING 5-47
5.2.67 SQLNET.RECV_TIMEOUT 5-48
5.2.68 SQLNET.SEND_TIMEOUT 5-49
5.2.69 SQLNET.URI 5-50
5.2.70 SQLNET.USE_HTTPS_PROXY 5-50
5.2.71 SQLNET.WALLET_OVERRIDE 5-50
5.2.72 SSL_CERT_REVOCATION 5-51
5.2.73 SSL_CRL_FILE 5-52
5.2.74 SSL_CRL_PATH 5-53
5.2.75 SSL_CIPHER_SUITES 5-53
5.2.76 SSL_EXTENDED_KEY_USAGE 5-54
5.2.77 SSL_SERVER_DN_MATCH 5-55
5.2.78 SSL_VERSION 5-55
5.2.79 TCP.CONNECT_TIMEOUT 5-56
5.2.80 TCP.EXCLUDED_NODES 5-57
5.2.81 TCP.INVITED_NODES 5-57
5.2.82 TCP.NODELAY 5-58
5.2.83 TCP.QUEUESIZE 5-58
5.2.84 TCP.VALIDNODE_CHECKING 5-58
5.2.85 TNSPING.TRACE_DIRECTORY 5-59
5.2.86 TNSPING.TRACE_LEVEL 5-59
5.2.87 TOKEN_AUTH 5-60
5.2.88 TOKEN_LOCATION 5-62
5.2.89 USE_CMAN 5-63
5.2.90 USE_DEDICATED_SERVER 5-64
5.2.91 WALLET_LOCATION 5-64
5.3 ADR Diagnostic Parameters in sqlnet.ora 5-67
5.3.1 About ADR Diagnostic Parameters 5-67
vii
5.3.2 ADR_BASE 5-68
5.3.3 DIAG_ADR_ENABLED 5-68
5.3.4 TRACE_LEVEL_CLIENT 5-69
5.3.5 TRACE_LEVEL_SERVER 5-69
5.3.6 TRACE_TIMESTAMP_CLIENT 5-70
5.3.7 TRACE_TIMESTAMP_SERVER 5-70
5.4 Non-ADR Diagnostic Parameters in sqlnet.ora 5-71
5.4.1 LOG_DIRECTORY_CLIENT 5-71
5.4.2 LOG_DIRECTORY_SERVER 5-72
5.4.3 LOG_FILE_CLIENT 5-72
5.4.4 LOG_FILE_SERVER 5-72
5.4.5 TRACE_DIRECTORY_CLIENT 5-73
5.4.6 TRACE_DIRECTORY_SERVER 5-73
5.4.7 TRACE_FILE_CLIENT 5-74
5.4.8 TRACE_FILE_SERVER 5-74
5.4.9 TRACE_FILEAGE_CLIENT 5-74
5.4.10 TRACE_FILEAGE_SERVER 5-75
5.4.11 TRACE_FILELEN_CLIENT 5-75
5.4.12 TRACE_FILELEN_SERVER 5-75
5.4.13 TRACE_FILENO_CLIENT 5-76
5.4.14 TRACE_FILENO_SERVER 5-76
5.4.15 TRACE_UNIQUE_CLIENT 5-77
6 Local Naming Parameters in the tnsnames.ora File

6.1 Overview of Local Naming Parameters 6-1
6.2 General Syntax of tnsnames.ora 6-2
6.3 Multiple Descriptions in tnsnames.ora 6-2
6.4 Multiple Address Lists in tnsnames.ora 6-3
6.5 Connect-Time Failover and Client Load Balancing with Oracle Connection Managers 6-4
6.6 Connect Descriptor Descriptions 6-5
6.6.1 DESCRIPTION_LIST 6-6
6.6.2 DESCRIPTION 6-6
6.7 Protocol Address Section 6-6
6.7.1 ADDRESS 6-7
6.7.2 HTTPS_PROXY 6-7
6.7.3 HTTPS_PROXY_PORT 6-8
6.7.4 ADDRESS_LIST 6-8
6.8 Optional Parameters for Address Lists 6-9
6.8.1 ENABLE 6-9
6.8.2 FAILOVER 6-10
viii
6.8.3 LOAD_BALANCE 6-11
6.8.5 SDU 6-12
6.8.7 SOURCE_ROUTE 6-14
6.8.8 TYPE_OF_SERVICE 6-15
6.9 Connection Data Section 6-15
6.9.1 COLOCATION_TAG 6-16
6.9.2 CONNECT_DATA 6-16
6.9.3 FAILOVER_MODE 6-17
6.9.4 GLOBAL_NAME 6-18
6.9.5 HS 6-19
6.9.6 INSTANCE_NAME 6-19
6.9.7 KERBEROS5_PRINCIPAL 6-20
6.9.8 RDB_DATABASE 6-21
6.9.9 SHARDING_KEY 6-21
6.9.10 SUPER_SHARDING_KEY 6-22
6.9.11 SERVER 6-23
6.9.12 SERVICE_NAME 6-23
6.10 Security Section 6-24
6.10.1 IGNORE_ANO_ENCRYPTION_FOR_TCPS 6-24
6.10.2 SECURITY 6-25
6.10.3 SSL_SERVER_CERT_DN 6-25
6.10.4 TOKEN_AUTH 6-26
6.10.5 TOKEN_LOCATION 6-28
6.11 Timeout Parameters 6-29
6.11.1 CONNECT_TIMEOUT 6-30
6.11.2 RETRY_COUNT 6-30
6.11.3 RETRY_DELAY 6-31
6.11.4 TRANSPORT_CONNECT_TIMEOUT 6-31
6.11.5 RECV_TIMEOUT 6-32
6.12 Compression Parameters 6-33
6.12.1 COMPRESSION 6-33
6.12.2 COMPRESSION_LEVELS 6-34
7 Oracle Net Listener Parameters in the listener.ora File

7.1 Overview of Oracle Net Listener Configuration File 7-1
7.2 Protocol Address Parameters 7-3
7.2.1 ADDRESS 7-3
7.2.2 DESCRIPTION 7-4
ix
7.2.3 Firewall 7-4
7.2.4 IP 7-4
7.2.5 QUEUESIZE 7-5
7.3 Connection Rate Limiter Parameters 7-7
7.3.1 CONNECTION_RATE_listener_name 7-7
7.3.2 RATE_LIMIT 7-8
7.4 Control Parameters 7-9
7.4.1 ADMIN_RESTRICTIONS_listener_name 7-10
7.4.2 ALLOW_MULTIPLE_REDIRECTS_listener_name 7-11
7.4.3 ENABLE_EXADIRECT_listener_name 7-11
7.4.4 CRS_NOTIFICATION_listener_name 7-12
7.4.5 DEDICATED_THROUGH_BROKER_LISTENER 7-12
7.4.6 DEFAULT_SERVICE_listener_name 7-13
7.4.7 INBOUND_CONNECT_TIMEOUT_listener_name 7-13
7.4.8 LOCAL_REGISTRATION_ADDRESS_listener_name 7-14
7.4.9 MAX_ALL_CONNECTIONS_listener_name 7-14
7.4.10 MAX_REG_CONNECTIONS_listener_name 7-15
7.4.11 REGISTRATION_EXCLUDED_NODES_listener_name 7-15
7.4.12 REGISTRATION_INVITED_NODES_listener_name 7-16
7.4.13 REMOTE_REGISTRATION_ADDRESS_listener_name 7-16
7.4.14 SAVE_CONFIG_ON_STOP_listener_name 7-17
7.4.15 SERVICE_RATE_listener_name 7-17
7.4.16 SSL_CLIENT_AUTHENTICATION 7-18
7.4.17 SSL_VERSION 7-18
7.4.18 SUBSCRIBE_FOR_NODE_DOWN_EVENT_listener_name 7-19
7.4.19 USE_SID_AS_SERVICE_listener_name 7-20
7.4.20 VALID_NODE_CHECKING_REGISTRATION_listener_name 7-20
7.5 ADR Diagnostic Parameters for Oracle Net Listener 7-23
7.5.1 ADR_BASE_listener_name 7-24
7.5.2 DIAG_ADR_ENABLED_listener_name 7-25
7.5.3 LOG_FILE_NUM_listener_name 7-25
7.5.4 LOG_FILE_SIZE_listener_name 7-26
7.5.5 LOGGING_listener_name 7-26
7.5.6 TRACE_LEVEL_listener_name 7-26
7.5.7 TRACE_TIMESTAMP_listener_name 7-27
7.6 Non-ADR Diagnostic Parameters for Oracle Net Listener 7-28
7.6.1 LOG_DIRECTORY_listener_name 7-28
7.6.2 LOG_FILE_listener_name 7-28
x
7.6.3 TRACE_DIRECTORY_listener_name 7-29
7.6.4 TRACE_FILE_listener_name 7-29
7.6.5 TRACE_FILEAGE_listener_name 7-29
7.6.6 TRACE_FILELEN_listener_name 7-30
7.6.7 TRACE_FILENO_listener_name 7-30
7.7 Class of Secure Transports Parameters 7-30
7.7.1 SECURE_REGISTER_listener_name 7-31
7.7.2 Using COST Parameters in Combination 7-32
7.7.3 DYNAMIC_REGISTRATION_listener_name 7-32
7.7.4 SECURE_PROTOCOL_listener_name 7-33
7.7.5 SECURE_CONTROL_listener_name 7-33
8 Oracle Connection Manager Parameters

8.1 Overview of Oracle Connection Manager Configuration File 8-1
8.2 Oracle Connection Manager Parameters 8-3
8.2.1 ADDRESS 8-5
8.2.2 ASO_AUTHENTICATION_FILTER 8-5
8.2.3 COMPRESSION 8-6
8.2.4 COMPRESSION_LEVELS 8-6
8.2.5 COMPRESSION_THRESHOLD 8-6
8.2.6 CONNECTION_STATISTICS 8-7
8.2.7 EVENT_GROUP 8-7
8.2.8 EXPIRE_TIME 8-8
8.2.9 IDLE_TIMEOUT 8-9
8.2.10 INBOUND_CONNECT_TIMEOUT 8-9
8.2.11 LOG_DIRECTORY 8-9
8.2.12 LOG_FILE_NUM 8-9
8.2.13 LOG_FILE_SIZE 8-10
8.2.14 LOG_LEVEL 8-10
8.2.15 MAX_ALL_CONNECTIONS 8-10
8.2.16 MAX_CMCTL_SESSIONS 8-11
8.2.17 MAX_CONNECTIONS 8-11
8.2.18 MAX_GATEWAY_PROCESSES 8-11
8.2.19 MAX_REG_CONNECTIONS 8-12
8.2.20 MIN_GATEWAY_PROCESSES 8-12
8.2.21 OUTBOUND_CONNECT_TIMEOUT 8-12
8.2.22 PASSWORD_instance_name 8-12
8.2.23 REGISTRATION_EXCLUDED_NODES 8-13
8.2.24 REGISTRATION_INVITED_NODES 8-13
8.2.25 RULE 8-14
xi
8.2.26 SDU 8-15
8.2.27 SERVICE_RATE 8-16
8.2.28 SESSION_TIMEOUT 8-16
8.2.29 TRACE_FILE 8-16
8.2.30 TRACE_FILELEN 8-17
8.2.31 TRACE_FILENO 8-17
8.2.32 TRACE_LEVEL 8-17
8.2.33 TRACE_TIMESTAMP 8-17
8.2.34 USE_SID_AS_SERVICE 8-18
8.2.35 VALID_NODE_CHECKING_REGISTRATION 8-18
8.3 Oracle Connection Manager in Traffic Director Mode Parameters 8-21
8.3.1 SERVICE_AFFINITY 8-21
8.3.2 TDM 8-22
8.3.3 TDM_BIND_THREAD 8-22
8.3.4 TDM_DATATYPE_CHECK 8-23
8.3.5 TDM_PRCP_MAX_CALL_WAIT_TIME 8-23
8.3.6 TDM_PRCP_MAX_TXN_CALL_WAIT_TIME 8-24
8.3.7 TDM_SHARED_THREADS_MAX 8-24
8.3.8 TDM_SHARED_THREADS_MIN 8-24
8.3.9 TDM_THREADING_MODE 8-25
8.4 ADR Diagnostic Parameters for Oracle Connection Manager 8-25
8.4.1 ADR_BASE 8-26
8.4.2 DIAG_ADR_ENABLED 8-26
8.4.3 LOG_LEVEL 8-27
8.4.4 TRACE_LEVEL 8-27
8.4.5 TRACE_TIMESTAMP 8-28
8.5 Non-ADR Diagnostic Parameters for Oracle Connection Manager 8-28
8.5.1 LOG_DIRECTORY 8-29
8.5.2 TRACE_DIRECTORY 8-29
8.5.3 TRACE_FILELEN 8-29
8.5.4 TRACE_FILENO 8-30
9 Directory Usage Parameters in the ldap.ora File

9.1 Overview of Directory Server Usage File 9-1
9.2 Directory Usage Parameters 9-1
9.2.1 DEFAULT_ADMIN_CONTEXT 9-2
9.2.2 DIRECTORY_SERVER_TYPE 9-2
9.2.3 DIRECTORY_SERVERS 9-2
xii
Part I Appendices
A Features Not Supported in this Release

A.1 Overview of Unsupported Features A-1
A.1.1 Oracle Net Connection Pooling A-1
A.1.2 Oracle Names A-2
A.1.3 Oracle Net Listener Password A-2
A.2 Unsupported Parameters A-2
A.3 Unsupported Control Utility Commands A-2
A.4 Unsupported or Deprecated Protocols A-3
B Upgrade Considerations for Oracle Net Services

B.1 Anonymous Access to Oracle Internet Directory B-1
C LDAP Schema for Oracle Net Services

C.1 Structural Object Classes C-1
C.2 Attributes C-2
Glossary
Index
xiii
Preface
Preface
Review this publication to obtain a complete listing and description of control utility
commands and configuration file parameters that you can use to manage Oracle Net
Services components.
• Audience
• Documentation Accessibility
• Diversity and Inclusion
• Related Documents
• Conventions
Audience
Oracle Database Net Services Reference is intended for network administrators who
are responsible for configuring and administering network components.
To use this document, you should be familiar with the networking concepts and
configuration tasks described in Oracle Database Net Services Administrator's Guide.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle
Accessibility Program website at http://www.oracle.com/pls/topic/lookup?
ctx=acc&id=docacc.
Access to Oracle Support

Oracle customers that have purchased support have access to electronic support
through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/
lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs
if you are hearing impaired.
Diversity and Inclusion

Oracle is fully committed to diversity and inclusion. Oracle respects and values having
a diverse workforce that increases thought leadership and innovation. As part of our
initiative to build a more inclusive culture that positively impacts our employees,
customers, and partners, we are working to remove insensitive terms from our
products and documentation. We are also mindful of the necessity to maintain
compatibility with our customers' existing technologies and the need to ensure
continuity of service as Oracle's offerings and industry standards evolve. Because of
these technical constraints, our effort to remove insensitive terms is ongoing and will
take time and external cooperation.
xiv
Preface
Related Documents
For additional information, see the following Oracle resources:
• Oracle Database Net Services Administrator's Guide
• Online Help for Oracle Net Services tools and utilities
• Oracle Database 19c documentation set
• Oracle Database Global Data Services Concepts and Administration Guide
A glossary of Oracle Net Services terms is available in Oracle Database Net Services
Administrator's Guide.
Many books in the documentation set use the sample schemas of the seed database, which
is installed by default when you install Oracle. Refer to Oracle Database Sample Schemas for
additional information about how these schemas were created and how you can use them
yourself.
Conventions
The following text conventions are used in this document:
Convention Meaning
boldface Boldface type indicates graphical user interface elements associated with an
action, or terms defined in text or the glossary.
italic Italic type indicates book titles, emphasis, or placeholder variables for which
you supply particular values.
monospace Monospace type indicates commands within a paragraph, URLs, code in
examples, text that appears on the screen, or text that you enter.
xv
Changes in This Release for Oracle

Database Net Services Reference
Review the changes in Oracle Database Net Services Reference for Oracle Database
19c.
• New Features
These are the new features and enhancements available with Oracle Database
19c.
• Deprecated Features
These features are deprecated in this release and may be desupported in a future
release.
New Features
These are the new features and enhancements available with Oracle Database 19c.
Identity and Access Management Integration with Oracle Autonomous Cloud
Databases
Available for Oracle Database release 19.13, Oracle Cloud Infrastructure (OCI) Identity
and Access Management (IAM) users can log in to Oracle Autonomous Database on
Shared Exadata Infrastructure using either database password or token-based
authentication.
An IAM ADMIN user can configure both the authentication and authorization of IAM
users and IAM groups. An IAM user can log in to Oracle Autonomous Cloud
Databases using tools, such as SQL*Plus or SQLcl.
See Oracle Database Security Guide and Oracle Database Net Services
Administrator's Guide.
TOKEN_AUTH and TOKEN_LOCATION Parameters
The sqlnet.ora or tnsnames.ora parameter TOKEN_AUTH allows you to configure IAM
token-based authentication for Oracle Autonomous Cloud Databases.
The sqlnet.ora or tnsnames.ora parameter TOKEN_LOCATION allows you to override
the default directory where the database token and private key files are stored for
authentication. This is an optional parameter.
See TOKEN_AUTH and TOKEN_LOCATION.
One-Way Transport Layer Security (TLS)
This feature allows you to configure one-way TLS (server authentication). With this
method, only the database server authenticates to the client by presenting its
certificate issued by Certificate Authority (CA) and the client verifies whether the
database server certificate is valid.
xvi
An Oracle client wallet with the server certificate is not required if the database server
certificate is signed by a trusted common root certificate that is already installed in the local
system default certificate store.
See Oracle Database Net Services Administrator's Guide.
Security Update for Native Encryption
The following supported algorithms are improved:
• Encryption algorithms: AES128, AES192, and AES256
• Crypto-checksum algorithms: SHA1, SHA256, SHA384, and SHA512
The following algorithms are deprecated:
• Encryption algorithms: DES, DES40, 3DES112, 3DES168, RC4_40, RC4_56, RC4_128, and
RC4_256
• Crypto-checksum algorithm: MD5
To transition your Oracle Database environment to use stronger algorithms, download and
install the patch described in My Oracle Support note 2118136.2.
The new sqlnet.ora parameters SQLNET.ALLOW_WEAK_CRYPTO and
SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS enable you to review the specified encryption and
crypto-checksum algorithms. This ensures that the connection does not encounter
compatibility issues and your configuration uses supported strong algorithms.
See Oracle Database Security Guide.
SQLNET.ALLOW_WEAK_CRYPTO Parameter
Use the SQLNET.ALLOW_WEAK_CRYPTO parameter to configure your client-side network
connection by reviewing the specified encryption and crypto-checksum algorithms.
See SQLNET.ALLOW_WEAK_CRYPTO.
SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS Parameter
Use the SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS parameter to configure your server-side
network connection by reviewing the specified encryption and crypto-checksum algorithms.
See SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS.
COLOCATION_TAG Parameter
The COLOCATION_TAG parameter is an alphanumeric string that you can use with the
CONNECT_DATA parameter of the TNS connect string. When you set the COLOCATION_TAG
parameter, it attempts to route clients with the same COLOCATION_TAG to the same database
instance.
Colocation of sessions on the same instance can help decrease inter-instance
communication and thereby increase performance for workload that benefits from being
executed in the same instance.
See COLOCATION_TAG.
KERBEROS5_PRINCIPAL Parameter
When you configure Kerberos authentication for an Oracle Database client, you can use the
KERBEROS5_PRINCIPAL parameter to specify multiple Kerberos principals with a single Oracle
xvii
Database client. This is an optional parameter. When specified, it is used to verify if

the principal name in the credential cache matches the parameter value.
Use this parameter with the CONNECT_DATA parameter. Alternatively, you can specify
KERBEROS5_CC_NAME in the connect string along with the KERBEROS5_PRINCIPAL
parameter to connect as a different Kerberos principal. Each Kerberos principal must
have a valid credential cache.
See KERBEROS5_PRINCIPAL and SQLNET.KERBEROS5_CC_NAME.
Deprecated Features
These features are deprecated in this release and may be desupported in a future
release.
Deprecation of the SERVICE_NAMES Initialization Parameter
Starting with Oracle Database 19c, customer use of the SERVICE_NAMES parameter is
deprecated. It can be desupported in a future release.
The use of the SERVICE_NAMES parameter is no longer actively supported. It must not
be used for high availability (HA) deployments. It is not supported to use service
names parameter for any HA operations. This restriction includes FAN, load balancing,
FAILOVER_TYPE, FAILOVER_RESTORE, SESSION_STATE_CONSISTENCY, and any other uses.
To manage your services, Oracle recommends that you use the SRVCTL or GDSCTL
command line utilities, or the DBMS_SERVICE package.
Note:
The SERVICE_NAMES parameter that is deprecated is different from the
SERVICE_NAME parameter in Oracle Net connect strings. The SERVICE_NAME
parameter is still valid.
Deprecation of Weak Native Network Encryption and Integrity Algorithms

The DES, DES40, 3DES112, 3DES168, RC4_40, RC4_56, RC4_128, RC4_256, and MD5
algorithms are deprecated in this release.
As a result of this deprecation, Oracle recommends that you review your network
encryption and integrity configuration to check if you have specified any of the
deprecated weak algorithms.
To transition your Oracle Database environment to use stronger algorithms, download
and install the patch described in My Oracle Support note 2118136.2.
Related Topics
• Oracle Database Security Guide
xviii
1
Listener Control Utility
This chapter describes the commands and associated syntax of the Listener Control utility.
The terms "SQL*Net" and "Net Services" are used interchangeably throughout Oracle
documentation and both these terms refer to the same functionality.
• Listener Control Utility Overview

• SET and SHOW Commands of the Listener Control utility
The SET and SHOW commands enable you to alter and view listener configuration
parameters.
• Distributed Operations
The Listener Control utility can perform operations on a local or a remote listener.
• Oracle Net Listener Security
Authentication for listener administration depends on whether you access the listener
locally, or remotely.
• Listener Control Utility Commands
Use the Listener Control utility commands to manage and configure listeners.
1.1 Listener Control Utility Overview

The Listener Control utility enables you to administer listeners. To perform basic management
functions on one or more listeners, you can use the Listener Control utility commands. You
can also view and change parameter settings.
The basic syntax of Listener Control utility commands is as follows:
lsnrctl command listener_name
In the preceding command, listener_name is the name of the listener that you want to
administer. If you do not specify a specific listener in the command string, then the command
is directed to the default listener name, LISTENER.
You can also issue Listener Control utility commands at the LSNRCTL> program prompt. To
obtain the prompt, enter lsnrctl with no arguments at the operating system command line.
When you run lsnrctl, the program is started. You can then enter the necessary commands
from the program prompt. The basic syntax of issuing commands from LSNRCTL> program
prompt is as follows:
lsnrctl
LSNRCTL> command listener_name
You can combine commands in a standard text file, and then run them as a sequence of
commands. To run in batch mode, use the following format:
lsnrctl @file_name
To identify comments in the batch script, you can use either REM or #. All other lines are
considered commands. Any commands that typically require confirmation do not require
confirmation during batch processing.
1-1
Chapter 1
SET and SHOW Commands of the Listener Control utility
For most commands, the Listener Control utility establishes an Oracle Net connection
with the listener that is used to transmit the command. To initiate an Oracle Net
connection to the listener, the Listener Control utility must obtain the protocol
addresses for the named listener or a listener named LISTENER. This is done by
resolving the listener name with one of the following mechanisms:
• listener.ora file in the directory specified by the TNS_ADMIN environment variable.
• listener.ora file in the ORACLE_HOME/network/admin directory.
• Naming method; for example, a tnsnames.ora file.
If none of the preceding mechanisms resolve the listener name, then the Listener
Control utility uses the default listener name LISTENER, resolves the host name IP
address, and uses port 1521.
The Listener Control utility supports the following types of commands:
• Operational commands, such as START, and STOP.
• Modifier commands, such as SET TRC_LEVEL.
• Informational commands, such as STATUS, and SHOW LOG_FILE.
Related Topics
• START
The Listener Control utility command START starts the named listener.
• STOP
The Listener Control utility command STOP stops the named listener.
• SET TRC_LEVEL
The Listener Control utility command SET TRC_LEVEL sets a specific level of tracing
for the listener.
• STATUS
The Listener Control utility command STATUS displays basic status information
about a listener.
1.2 SET and SHOW Commands of the Listener Control

utility
The SET and SHOW commands enable you to alter and view listener configuration
parameters.
You can use the SET command to alter parameter values for a specified listener. You
set the name of the listener to administer using the SET CURRENT_LISTENER command.
Parameter values remain in effect until the listener is shut down. If you want these
settings to persist, then use the SAVE_CONFIG command to save changes to the
listener.ora file. .
You can use the SHOW command to display the current value of a configuration setting.
Related Topics
• SET
The Listener Control utility command SET alters the parameter values for the
listener.
1-2
Chapter 1
Distributed Operations
• SET CURRENT_LISTENER
The Listener Control utility command SET CURRENT_LISTENER sets the name of the
listener that you want to administer.
• SAVE_CONFIG
The Listener Control utility command SAVE_CONFIG save the current configuration state of
the listener to the listener.ora file.
• SHOW
The Listener Control utility command SHOW displays the current parameter values for the
listener.
1.3 Distributed Operations

The Listener Control utility can perform operations on a local or a remote listener.
Set Up a Computer to Remotely Administer a Listener

Ensure that the Listener Control utility (lsnrctl) executable is installed in the
ORACLE_HOME/bin directory. You can resolve the name of the listener that you want to
administer either through a listener.ora file, or by a naming method.
When you administer a listener remotely, you can issue all commands except START.
However, the Listener Control utility can only start the listener on the same computer from
which the utility is running.
When issuing commands, specify the listener name as an argument. If you omit the listener
name in the command, then the listener name set with the command SET CURRENT_LISTENER
is used. If the listener name is not set with that command, then the command is directed to
the default listener name, LISTENER.
Example 1-1 Issuing Commands Using the Listener Control Utility
LSNRCTL> SERVICES lsnr
1.4 Oracle Net Listener Security

Authentication for listener administration depends on whether you access the listener locally,
or remotely.
Local listener administration is secure through local operating system authentication, which
restricts listener administration to the user account that started the listener, or to the super
user. By default, remote listener administration is disabled.
Oracle recommends that you perform listener administration in the default mode, and access
the system remotely using a remote login. When you administer the listener remotely, use
either Oracle Enterprise Manager Cloud Control or Secure Shell (SSH) to access the remote
host.
1.5 Listener Control Utility Commands

Use the Listener Control utility commands to manage and configure listeners.
1-3
Chapter 1
Listener Control Utility Commands
• EXIT
The Listener Control utility command EXIT exits from the Listener Control utility,
and returns you to the operating system prompt.
• HELP
The Listener Control utility command HELP provides a list of all the Listener Control
utility commands, or provides syntax help for a particular Listener Control utility
command.
• QUIT
The Listener Control utility command QUIT exits from the Listener Control utility
and returns you to the operating system prompt.
• RELOAD
The Listener Control utility command RELOAD reloads the listener.ora file, so that
you can add or change statically configured services without stopping the listener.
• SAVE_CONFIG
The Listener Control utility command SAVE_CONFIG save the current configuration
state of the listener to the listener.ora file.
• SERVICES
The Listener Control utility command SERVICES returns detailed information about
the database services, instances, and service handlers to which the listener
forwards client connection requests.
• SET
The Listener Control utility command SET alters the parameter values for the
listener.
• SET DISPLAYMODE
The Listener Control utility command SET DISPLAYMODE
• SET INBOUND_CONNECT_TIMEOUT
The Listener Control utility command SET INBOUND_CONNECT_TIMEOUT specifies the
time, in seconds, for the client to complete its connect request to the listener after
establishing the network connection.
• SET LOG_DIRECTORY
The Listener Control utility command SET LOG_DIRECTORY sets the destination
directory where the listener log file is written.
• SET LOG_FILE
The Listener Control utility command SET LOG_FILE sets the name for the listener
log file.
• SET LOG_STATUS
The Listener Control utility command SET LOG_STATUS turns listener logging on or
off.
• SET SAVE_CONFIG_ON_STOP
The Listener Control utility command SET SAVE_CONFIG_ON_STOP specifies whether
changes made to the parameter values for the listener by the SET command are
saved to the listener.ora file at the time that the listener is stopped with the STOP
command.
1-4
Chapter 1
• SET TRC_DIRECTORY
The Listener Control utility command SET TRC_DIRECTORY sets the destination directory
where the listener trace files are written.
• SET TRC_FILE
The Listener Control utility command SET TRC_FILE sets the name of the listener trace
file.
• SET TRC_LEVEL
The Listener Control utility command SET TRC_LEVEL sets a specific level of tracing for
the listener.
• SHOW
The Listener Control utility command SHOW displays the current parameter values for the
listener.
• SPAWN
The Listener Control utility command SPAWN starts a program stored on the computer
on which the listener is running,and that is listed with an alias in the listener.ora file.
• START
• STATUS
The Listener Control utility command STATUS displays basic status information about a
listener.
• STOP
• TRACE
The Listener Control utility command TRACE sets tracing for the listener.
• VERSION
The Listener Control utility command VERSION displays the current version of the Listener
Control utility.
1.5.1 EXIT
The Listener Control utility command EXIT exits from the Listener Control utility, and returns
you to the operating system prompt.
Purpose
To exit from the Listener Control utility, and return to the operating system prompt.
Prerequisites
None
Syntax
From the Listener Control utility:
LSNRCTL> EXIT
Arguments
None
1-5
Chapter 1
Usage Notes
This command is identical to the QUIT command.
Example
LSNRCTL> EXIT
1.5.2 HELP
The Listener Control utility command HELP provides a list of all the Listener Control
utility commands, or provides syntax help for a particular Listener Control utility
command.
Purpose
To provide a list of all the Listener Control utility commands or provide syntax help for
a particular Listener Control utility command.
Prerequisites
None
Syntax
From the operating system:
lsnrctl HELP command
LSNRCTL> HELP command
Arguments
command: The Listener Control utility command. Commands are shown in the following
example output.
When you enter a command as an argument to HELP, the Listener Control utility
displays information about how to use the command. When you enter HELP without an
argument, the Listener Control utility displays a list of all the commands.
Example
LSNRCTL> HELP
The following operations are available
An asterisk (*) denotes a modifier or extended command:
exit
quit
reload
services
set*
show*
1-6
Chapter 1
spawn
start
status
stop
trace
version
1.5.3 QUIT
The Listener Control utility command QUIT exits from the Listener Control utility and returns
you to the operating system prompt.
Purpose
To exit from the Listener Control utility and return to the operating system prompt.
Prerequisites
None
Syntax
LSNRCTL> QUIT
Arguments
None
Usage Notes
This command is identical to the EXIT command.
Example
LSNRCTL> QUIT
1.5.4 RELOAD
The Listener Control utility command RELOAD reloads the listener.ora file, so that you can
add or change statically configured services without stopping the listener.
Purpose
To reload the listener.ora file. This command enables you to add or change statically
configured services without actually stopping the listener.
When you run this command, the database services, instances, service handlers, and
listening endpoints previously registered dynamically with the listener are unregistered, and
subsequently registered again.
To obtain a lightweight reload without dropping registration, use the option –with_ha. Using
this option ensures that registered services remain available to clients during reload.
1-7
Chapter 1
Prerequisites
None
Syntax
lsnrctl RELOAD [-with_ha] listener_name
LSNRCTL> RELOAD [-with_ha] listener_name
Arguments
listener_name: The listener name, if the default name of LISTENER is not used.
-with_ha: command option used with RELOAD that indicates that the reload of
listener.ora is completed without dropping existing registrations.
Example
LSNRCTL> RELOAD
Connecting to (DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=sales-server)
(PORT=1521)))
The command completed successfully
1.5.5 SAVE_CONFIG
The Listener Control utility command SAVE_CONFIG save the current configuration state
of the listener to the listener.ora file.
Purpose
To save the current configuration state of the listener, including trace level, trace file,
trace directory, and logging to the listener.ora file. Any changes are stored in
listener.ora, preserving formatting, comments, and case as much as possible.
Before modification of the listener.ora file, a backup of the file, called listener.bak,
is created.
Syntax
lsnrctl SAVE_CONFIG listener_name
LSNRCTL> SAVE_CONFIG listener_name
1-8
Chapter 1
Arguments
Usage Notes
This command enables you to save all runtime configuration changes to the listener.ora
file.
Example
LSNRCTL> SAVE_CONFIG listener

(PORT=1521)))
Saved LISTENER configuration parameters.
Listener Parameter File /oracle/network/admin/listener.ora
Old Parameter File /oracle/network/admin/listener.bak
1.5.6 SERVICES
The Listener Control utility command SERVICES returns detailed information about the
database services, instances, and service handlers to which the listener forwards client
connection requests.
Purpose
To obtain detailed information about the database services, instances, and service handlers
(dispatchers and dedicated servers) to which the listener forwards client connection requests.
Prerequisites
None
Syntax
Arguments
lsnrctl SERVICES listener_name
LSNRCTL> SERVICES listener_name
Usage Notes
The SET DISPLAYMODE command changes the format and the detail level of the output.
1-9
Chapter 1
See Also:
Oracle Database Net Services Administrator's Guide for a complete
description of SERVICES output
Example
This example shows SERVICES output in the default display mode. The output shows
the following:
• An instance named sales belonging to two services, sales1.us.example.com and
sales2.us.example.com, with a total of three service handlers.
• Service sales1.us.example.com is handled by one dispatcher only.
• Service sales2.us.example.com is handled by one dispatcher and one dedicated
server, as specified by in the following output.
LSNRCTL> SERVICES
Connecting to (DESCRIPTION=(ADDRESS=(PROTOCOL=ipc)(KEY=net)))
Services Summary...
Service "sales1.us.example.com" has 1 instance(s).
Instance "sales", status READY, has 1 handler(s) for this service...
Handler(s):
"D000" established:0 refused:0 current:0 max:10000 state:ready
DISPATCHER <machine: sales-server, pid: 5696>
(ADDRESS=(PROTOCOL=tcp)(HOST=sales-server)(PORT=53411))
Handler(s):
"DEDICATED" established:0 refused:0 state:ready
LOCAL SERVER
"D001" established:0 refused:0 current:0 max:10000 state:ready
DISPATCHER <machine: sales-server, pid: 5698>
Related Topics
• SET DISPLAYMODE
1.5.7 SET
The Listener Control utility command SET alters the parameter values for the listener.
Purpose
To alter the parameter values for the listener. Parameter value changes remain in
effect until the listener is shut down. To make the changes permanent, use the
SAVE_CONFIG command to save changes to the listener.ora file.
1-10
Chapter 1
Prerequisites
None
Syntax
lsnrctl SET parameter
LSNRCTL> SET parameter
Arguments
parameter: A SET parameter to modify its configuration setting. Parameters are shown in the
example output.
When you enter SET without an argument, the Listener Control utility displays a list of all the
parameters.
Usage Notes
If you are using the SET commands to alter the configuration of a listener other than the
default LISTENER listener, then use the SET CURRENT_LISTENER command to set the name of
the listener to administer.
Example
LSNRCTL> SET
The following operations are available with set.
An asterisk (*) denotes a modifier or extended command.
current_listener
displaymode
inbound_connect_timeout
log_file
log_directory
log_status
rawmode
save_config_on_stop
trc_file
trc_directory
trc_level
Related Topics
• SAVE_CONFIG
1-11
Chapter 1
1.5.8 SET CURRENT_LISTENER

Purpose
To set the name of the listener that you want to administer. After you set the listener
name with this command, you can issue subsequent commands that normally require
listener_name without specifying the listener.
Syntax
LSNRCTL> SET CURRENT_LISTENER listener_name
Arguments
listener_name: The listener name, if you are not using the default name LISTENER.
Usage Notes
When you specify a listener name using SET CURRENT_LISTENER, the Listener Control
utility commands act on the listener name that you specify with this command. You do
not have to continue to specify the name of the listener.
Example
LSNRCTL> SET CURRENT_LISTENER lsnr

Current Listener is lsnr
1.5.9 SET DISPLAYMODE

Purpose
To change the format and level of detail for the SERVICES and STATUS commands.
Syntax
LSNRCTL> SET DISPLAYMODE {compat | normal | verbose | raw}
Arguments
Specify one of the following modes:
compat: Output that is compatible with earlier releases of the listener.
normal: Output that is formatted and descriptive. Oracle recommends this mode.
1-12
Chapter 1
verbose: All data received from the listener in a formatted and descriptive output.
raw: All data received from the listener without any formatting. This argument should be used
only if recommended by Oracle Support Services.
Example
LSNRCTL> SET DISPLAYMODE normal

Service display mode is NORMAL
Related Topics
• SERVICES
• STATUS
listener.
1.5.10 SET INBOUND_CONNECT_TIMEOUT

The Listener Control utility command SET INBOUND_CONNECT_TIMEOUT specifies the time, in
seconds, for the client to complete its connect request to the listener after establishing the
network connection.
Purpose
To specify the time, in seconds, for the client to complete its connect request to the listener
after establishing the network connection.
If the listener does not receive the client request in the time specified, then it terminates the
connection. In addition, the listener logs the IP address of the client and an ORA-12525:TNS:
listener has not received client's request in time allowed error message to the
listener.log file.
See Also:
Oracle Database Net Services Administrator's Guide for additional information
about specifying the time out for client connections
Syntax
LSNRCTL> SET INBOUND_CONNECT_TIMEOUT time
Arguments
time: The time in seconds. Default setting is 60 seconds.
1-13
Chapter 1
Example
LSNRCTL> SET INBOUND_CONNECT_TIMEOUT 2

Connecting to (ADDRESS=(PROTOCOL=TCP)(HOST=sales-server)(PORT=1521))
LISTENER parameter "inbound_connect_timeout" set to 2
The command completed successfully.
1.5.11 SET LOG_DIRECTORY

The Listener Control utility command SET LOG_DIRECTORY sets the destination directory
where the listener log file is written.
Purpose
To set destination directory where the listener log file is written. By default, the log file
is written to the ORACLE_HOME/network/log directory.
Note:
This command works only if Automatic Diagnostic Repository (ADR) is not
enabled. The default is for ADR to be enabled, and to use the log directory
ORACLE_HOME/log/diag/product_type.
Prerequisites
None
Syntax
lsnrctl SET LOG_DIRECTORY directory
LSNRCTL> SET LOG_DIRECTORY directory
Arguments
directory: The directory path of the listener log file.
Example
LSNRCTL> SET LOG_DIRECTORY /usr/oracle/admin

LISTENER parameter "log_directory" set to /usr/oracle/admin
1-14
Chapter 1
1.5.12 SET LOG_FILE

The Listener Control utility command SET LOG_FILE sets the name for the listener log file.
Purpose
To set the name for the listener log file. By default, the log file name is listener.log.
Note:
This command works only if Automatic Diagnostic Repository (ADR) is not enabled.
The default is for ADR to be enabled, and use the log directory
Prerequisites
None
Syntax
lsnrctl SET LOG_FILE file_name
LSNRCTL> SET LOG_FILE file_name
Arguments
file_name: The file name of the listener log.
Example
LSNRCTL> SET LOG_FILE list.log

LISTENER parameter "log_file" set to list.log
1.5.13 SET LOG_STATUS

The Listener Control utility command SET LOG_STATUS turns listener logging on or off.
Purpose
To turn listener logging on or off.
Prerequisites
None
1-15
Chapter 1
Syntax
lsnrctl SET LOG_STATUS {on | off}
LSNRCTL> SET LOG_STATUS {on | off}
Arguments
on: To turn logging on.
off: To turn logging off.
Example
LSNRCTL> SET LOG_STATUS on

LISTENER parameter "log_status" set to ON
1.5.14 SET SAVE_CONFIG_ON_STOP

The Listener Control utility command SET SAVE_CONFIG_ON_STOP specifies whether
changes made to the parameter values for the listener by the SET command are saved
to the listener.ora file at the time that the listener is stopped with the STOP
command.
Purpose
To specify whether changes made to the parameter values for the listener by the SET
command are saved to the listener.ora file at the time that the listener is stopped
with the STOP command.
When changes are saved, the Listener Control utility tries to preserve formatting,
comments, and letter case. Before the command modifies the listener.ora file, it
creates a backup of the file, called listener.bak.
To have all parameters saved immediately, use the SAVE_CONFIG command.
Syntax
lsnrctl SET SAVE_CONFIG_ON_STOP {on | off}
LSNRCTL> SET SAVE_CONFIG_ON_STOP {on | off}
1-16
Chapter 1
Arguments
on: To save configuration to listener.ora.
off: To not save configuration to listener.ora.
Example
LSNRCTL> SET SAVE_CONFIG_ON_STOP on

LISTENER parameter "save_config_on_stop" set to ON
Related Topics
• SET
• STOP
• SAVE_CONFIG
1.5.15 SET TRC_DIRECTORY

The Listener Control utility command SET TRC_DIRECTORY sets the destination directory where
the listener trace files are written.
Purpose
To set the destination directory where the listener trace files are written. By default, the trace
file are written to the ORACLE_HOME/network/trace directory.
Note:
This command works only if Automatic Diagnostic Repository (ADR) is not enabled.
The default is for ADR to be enabled, and use the log directory
Prerequisites
None
Syntax
lsnrctl SET TRC_DIRECTORY directory
1-17
Chapter 1
LSNRCTL> SET TRC_DIRECTORY directory
Arguments
directory: The directory path of the listener trace files.
Example
LSNRCTL> SET TRC_DIRECTORY /usr/oracle/admin

LISTENER parameter "trc_directory" set to /usr/oracle/admin
1.5.16 SET TRC_FILE

The Listener Control utility command SET TRC_FILE sets the name of the listener trace
file.
Purpose
To set the name of the listener trace file. By default, the trace file name is
listener.trc.
Note:
enabled. The default is for ADR to be enabled, and use the log directory
Prerequisites
None
Syntax
lsnrctl SET TRC_FILE file_name
LSNRCTL> SET TRC_FILE file_name
Arguments
file_name: The file name of the listener trace.
1-18
Chapter 1
Example
LSNRCTL> SET TRC_FILE list.trc

LISTENER parameter "trc_file" set to list.trc
1.5.17 SET TRC_LEVEL

The Listener Control utility command SET TRC_LEVEL sets a specific level of tracing for the
listener.
Purpose
To set a specific level of tracing for the listener.
Prerequisites
None
Syntax
lsnrctl SET TRC_LEVEL level
LSNRCTL> SET TRC_LEVEL level
Arguments
level: One of the following trace levels:
• off for no trace output

• user for user trace information
• admin for administration trace information
• support for Oracle Support Services trace information
Usage Notes
This command has the same functionality as the TRACE command.
Example
LSNRCTL> SET TRC_LEVEL admin

LISTENER parameter "trc_level" set to admin
1-19
Chapter 1
Related Topics
• TRACE
1.5.18 SHOW
The Listener Control utility command SHOW displays the current parameter values for
the listener.
Purpose
To view the current parameter values for the listener.
All of the SET parameters have equivalent SHOW parameters.
Prerequisites
None
Syntax
lsnrctl SHOW parameter
LSNRCTL> SHOW parameter
Arguments
parameter: A parameter whose configuration settings you want to review. Parameters
are shown in the example output.
When you enter SHOW without an argument, the Listener Control utility displays a list of
all the parameters.
Example
LSNRCTL> SHOW
The following properties are available with SHOW:
current_listener
displaymode
log_file
log_directory
log_status
rawmode
save_config_on_stop
trc_file
trc_directory
trc_level
1-20
Chapter 1
Related Topics
• SET
1.5.19 SPAWN
The Listener Control utility command SPAWN starts a program stored on the computer on
which the listener is running,and that is listed with an alias in the listener.ora file.
Purpose
To start a program stored on the computer on which the listener is running, and that is listed
with an alias in the listener.ora file.
Prerequisites
None
Syntax
lsnrctl SPAWN listener_name alias (arguments='arg1,arg2,...')
LSNRCTL> SPAWN listener_name alias (arguments='arg1,arg2,...')
Arguments
alias: The alias of the program to be spawned off is specified by a listener.ora file entry,
similar to the following:
alias = (PROGRAM=(NAME=)(ARGS=)(ENVS=))
For example:
nstest = (PROGRAM=(NAME=nstest)(ARGS=test1)(ENVS='ORACLE_HOME=/usr/oracle'))
Example
The nstest program, shown in the preceding section, can then be spawned off using the
following command:
lsnrctl SPAWN listener_name nstest
1-21
Chapter 1
1.5.20 START
Purpose
To start the named listener.
Prerequisites
The listener must not be running.
Syntax
lsnrctl START listener_name
LSNRCTL> START listener_name
Note:
On Microsoft Windows, if the database was installed with the Oracle Home
User, then the utility can prompt for a password. The password is the
operating system password for the Oracle Home User. The prompt is
displayed only if the listener service does not exist, and it needs to be
created as part of starting the listener.
Arguments
Usage Notes
To start a listener configured in the listener.ora file with a name other than
LISTENER, include that name.
For example, if the listener name is tcp_lsnr, enter:
lsnrctl START tcp_lsnr
LSNRCTL> START tcp_lsnr
1-22
Chapter 1
Example
LSNRCTL> START
Starting /private/sales_group/sales/bin/tnslsnr: please wait...
TNSLSNR for Linux: Version 18.0.0.0.0

System parameter file is $ORACLE_HOME/network/admin/listener.ora
Log messages written to $ORACLE_BASE/diag/tnslsnr/node_name/listener/alert/
log.xml
Listening on: (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=sales-server)
(PORT=1521)))
(PORT=1521)))
STATUS of the LISTENER
------------------------
Alias LISTENER
Version TNSLSNR for Linux: Version 18.0.0.0.0
Start Date 21-JAN-2018 21:50:49
Uptime 0 days 0 hr. 0 min. 0 sec
Trace Level off
Security ON: Local OS Authetication
SNMP OFF
Listener Parameter File $ORACLE_HOME/network/admin/listener.ora
Listener Log File $ORACLE_BASE/diag/tnslsnr/node_name/listener/alert/
log.xml
Listening Endpoints Summary...
(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=sales-server)(PORT=1521)))
The listener supports no services
See Also:
Oracle Database Administrator’s Reference for Microsoft Windows for information
about the Oracle Home User
1.5.21 STATUS
listener.
Purpose
To display basic status information about a listener, including a summary of listener
configuration settings, listening protocol addresses, and a summary of services registered
with the listener.
1-23
Chapter 1
Note:
You can also obtain the status of the listener through the Oracle Enterprise
Manager Cloud Control console.
Prerequisites
None
Syntax
lsnrctl STATUS listener_name
LSNRCTL> STATUS listener_name
Arguments
Usage Notes
The SET DISPLAYMODE command changes the format and level of the detail of the
output.
See Also:
Oracle Database Net Services Administrator's Guide for a complete
description of STATUS output
Example
The following example shows STATUS output in the default display mode. The output
contains:
• Listener configuration settings
• Listening endpoints summary
• Services summary, which is an abbreviated version of the SERVICES command
output
LSNRCTL> STATUS
Connecting to (DESCRIPTION=(ADDRESS=(PROTOCOL=ipc)(KEY=net)))
STATUS of the LISTENER
------------------------
Alias LISTENER
Version TNSLSNR for Linux: Version 18.0.0.0.0 -
1-24
Chapter 1
Production
Start Date 12-JAN-2018 12:02:00
Trace Level support
Security OFF
SNMP OFF
Listener Parameter File /oracle/network/admin/listener.ora
Listener Log File /oracle/network/log/listener.log
Listener Trace File /oracle/network/trace/listener.trc
Listening Endpoints Summary...

(DESCRIPTION=(ADDRESS=(PROTOCOL=ipc)(KEY=net)))
(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=sales-server)(PORT=1521)))
(DESCRIPTION=(ADDRESS=(PROTOCOL=tcps)(HOST=sales-server)(PORT=2484)))
Services Summary...
Related Topics
• SET DISPLAYMODE
• SERVICES
1.5.22 STOP
Purpose
To stop the named listener.
Prerequisites
The listener must be running.
Syntax
lsnrctl STOP listener_name
LSNRCTL> STOP listener_name
1-25
Chapter 1
Arguments
Example
LSNRCTL> STOP
1.5.23 TRACE
Purpose
To set tracing for the listener.
Syntax
lsnrctl trace level listener_name
LSNRCTL> trace level listener_name
Arguments
level: One of the following trace levels:

listener_name: Specify the listener name, if the default name of LISTENER is not used.
Usage Notes
This command has the same functionality as the SET TRC_LEVEL command.
Example
LSNRCTL> TRACE ADMIN lsnr

Opened trace file: /oracle/network/trace/listener.trc
1-26
Chapter 1
1.5.24 VERSION
The Listener Control utility command VERSION displays the current version of the Listener
Control utility.
Purpose
To display the current version of Listener Control utility.
Prerequisites
None
Syntax
lsnrctl VERSION listener_name
LSNRCTL> VERSION listener_name
Arguments
Example
LSNRCTL> version listener

Connecting to ADDRESS=(PROTOCOL=TCP)(HOST=sales-server)(PORT=1521))
TNSLSNR for Linux: Version 19.0.0.0.0
TNS for Linux: Version 19.0.0.0.0
Oracle Bequeath NT Protocol Adapter for Linux: Version 19.0.0.0.0
Unix Domain Socket IPC NT Protocol Adaptor for Linux: Version
19.0.0.0.0
TCP/IP NT Protocol Adapter for Linux: Version 19.0.0.0.0
1-27
2
Oracle Connection Manager Control Utility
This chapter describes the commands and syntax of the Oracle Connection Manager Control
Utility.
• Command Modes and Syntax

The Oracle Connection Manager Control Utility (CMCTL) enables you to start up,
configure and alter how client connection requests are managed.
• Oracle Connection Manager Control Utility Overview
• Oracle Connection Manager Control Utility Commands
Use the Oracle Connection Manager Control utility commands to manage and configure
Oracle Connection Manager instances.
2.1 Command Modes and Syntax

The Oracle Connection Manager Control Utility (CMCTL) enables you to start up, configure
and alter how client connection requests are managed.
The basic syntax of the Oracle Connection Manager Control utility is as follows:
cmctl command [argument]
The Oracle Connection Manager Control utility supports the following types of commands:
• Initialization and termination commands such as STARTUP and SHUTDOWN
• Alter commands such as SET LOG_LEVEL and SET EVENT
• Display commands, such as SHOW STATUS and SHOW RULES
• Gateway commands such as SHOW GATEWAYS and RESUME GATEWAYS
2-1
Chapter 2
Command Modes and Syntax
Note:
You can use SET commands to dynamically alter configuration parameters
that control how the listener receives client connections. The changes only
remain in effect until Oracle Connection Manager is shut down. You cannot
save them to the cman.ora file. The one exception is the Oracle Connection
Manager password, which you can save using the command SAVE_PASSWD.
You can use the Oracle Connection Manager Control utility in command
mode, or batch mode.
• Using command mode:
– From the Oracle Connection Manager Control utility:
Enter cmctl at the command line to obtain the program prompt, and
then issue the command:
cmctl
CMCTL> command
– From the operating system:

Enter the entire command from the operating system command
prompt:
cmctl [command] [argument1 . . . argumentN] [-c

instance_name]
Each command issued this way can have an Oracle Connection

Manager instance name appended as an argument. If an Oracle
Connection Manager instance name is not provided, then the default
instance name is assumed. The default name is cman_hostname. If a
password was set in a previous CMCTL session, then you can be
prompted for a password. If a password has been set, then to issue
commands from an Oracle Connection Manager Control utility
session of Oracle Connection Manager, you must enter a password
once, at the beginning of the session.
Caution:
There is an option to specify the password on the
command line. However, doing so exposes the password
on the screen, and is a potential security risk. Oracle
recommends not using the password option (-p) on the
command line.
• Using batch mode:
2-2
Chapter 2
Oracle Connection Manager Control Utility Overview
You can combine commands in a standard text file, and then run them as a
sequence of commands. To run in batch mode, use the following syntax:
cmctl @input_file
See Also:
Oracle Database Net Services Administrator's Guide for more information about
Oracle Connection Manager architecture
2.2 Oracle Connection Manager Control Utility Overview

The Oracle Connection Manager Control utility (CMCTL) enables you to administer Oracle
Connection Manager. You can use Oracle Connection Manager Control utility commands to
perform basic management functions on one or more Oracle Connection Manager instances.
Additionally, you can view and change parameter settings.
2.3 Oracle Connection Manager Control Utility Commands

Use the Oracle Connection Manager Control utility commands to manage and configure
Oracle Connection Manager instances.
• ADMINISTER
The ADMINISTER command can be issued only from the Oracle Connection Manager
utility and lets you select the Oracle Connection Manager instance to administer.
• CLOSE CONNECTIONS
It is an Oracle Connection Manager utility command to terminate connections but Oracle
Connection Manager must be running at that time.
• EXIT
Oracle Connection Manager Control utility command EXIT is used to exit from the Oracle
Connection Manager utility.
• HELP
• QUIT
• RELOAD
Reload Oracle Connection Manager Control utility command dynamically rereads
parameters and rules.
• RESUME GATEWAYS
• SAVE_PASSWD
• SET
• SET ASO_AUTHENTICATION_FILTER
• SET CONNECTION_STATISTICS
• SET EVENT
2-3
Chapter 2
Oracle Connection Manager Control Utility Commands
• SET IDLE_TIMEOUT
• SET INBOUND_CONNECT_TIMEOUT
• SET LOG_DIRECTORY
• SET LOG_LEVEL
• SET OUTBOUND_CONNECT_TIMEOUT
• SET PASSWORD
• SET SESSION_TIMEOUT
• SET TRACE_DIRECTORY
• SET TRACE_LEVEL
• SHOW
• SHOW ALL
• SHOW CONNECTIONS
• SHOW DEFAULTS
• SHOW EVENTS
• SHOW GATEWAYS
• SHOW PARAMETERS
• SHOW RULES
• SHOW SERVICES
• SHOW STATUS
• SHOW VERSION
• SHUTDOWN
• STARTUP
• SUSPEND GATEWAY
2.3.1 ADMINISTER
The ADMINISTER command can be issued only from the Oracle Connection Manager
utility and lets you select the Oracle Connection Manager instance to administer.
Purpose
To select an Oracle Connection Manager instance.
Prerequisites
None
Syntax
From the Oracle Connection Manager Control utility:
CMCTL> ADMINISTER [-c] instance_name
2-4
Chapter 2
Arguments
instance_name: The instance name of Oracle Connection Manager that you would like to
administer. Instances are defined in the cman.ora file.
Usage Notes
You can issue the ADMINISTER command only within the utility. You cannot issue the
command from the operating system.
ADMINISTER enables you to choose which Oracle Connection Manager instance to administer.
To start the Oracle Connection Manager instance, you must issue the STARTUP command.
When you omit the instance name from the command, the instance administered defaults to
the local instance.
Use the -c option when to administer an instance that is not the local instance.
A password is required only if one was provided at installation time or during a previous
session of the Oracle Connection Manager.
Example
CMCTL> ADMINISTER cman_indl040ad

Enter CMAN password: password
Current instance cman_indl040ad is already started
Connections refer to (address=(protocol=TCP)(host=indl040ad)(port=1560)).
Related Topics
• STARTUP
2.3.2 CLOSE CONNECTIONS

It is an Oracle Connection Manager utility command to terminate connections but Oracle
Connection Manager must be running at that time.
Purpose
To terminate connections, using specific qualifiers to select connections.
Prerequisites
Oracle Connection Manager must be running.
Syntax
cmctl CLOSE CONNECTIONS [in state] [gt time] [from source] [to destination]
[for service] [using gateway_process_id] [connect_identifier_list]
[-c cman_name]
2-5
Chapter 2
CMCTL> CLOSE CONNECTIONS [in state] [gt time] [from source] [to
destination]
[for service] [using gateway_process_id] [connect_identifier_list
Arguments
state: One of the following values to specify the connection state:
• idle: Connections that are inactive in the established state.

• connecting: Connections that are in the process of connecting.
• established: Connections that are connected and are transferring data.
• terminating: Connections that are disconnecting.
If no state is specified, then CLOSE CONNECTIONS defaults to all possible states. If the
time qualifier is included under these conditions, then the time specified is the amount
of time that has elapsed since a client initiated a connection.
time: The time format. Use the following format to specify connections greater than the
time indicated:
gt[hh:mm:]ss
source: The source address. Use one of the following formats to specify the source
address:
• from IP
• from hostname
• from subnet
destination: The destination address. Use one of the following formats to specify the
destination address:
• to IP
• to hostname
• to subnet
service: The service name. Use the service_name parameter to specify the service,
such as sales.us.example.com.
gateway_process_id: The gateway process identifier is a number. Use this number to

specify connections that are proxied by the gateway process indicated. To determine
the gateway process identifier, use the Oracle Connection Manager control utility show
gateways command.
connect_identifier_list: The connection identifiers. Use a space between multiple

connection identifiers in a list.
Usage Notes
Because the CLOSE CONNECTIONS command terminates connections, it might generate
error messages on both client and server sides.
The IDLE state qualifier always requires a time qualifier.
2-6
Chapter 2
Issuing CLOSE CONNECTIONS without an argument closes all connections.
Examples
The following example shuts down connections in any state. The elapsed time of the
connection must be greater than 1 hour and 30 minutes. The connection source is the
specified subnet, and the destination is the specified host name.
CMCTL> CLOSE CONNECTIONS gt 1:30:00 from 192.0.2.32/24 to host1
The following example shuts down those connections proxied by gateway process 0 that
have been in the idle state more than 30 minutes:
CMCTL> CLOSE idle CONNECTIONS gt 30:00 using 0
The following example shuts down connections that are connected to the service
sales.us.example.com:
CMCTL> CLOSE established CONNECTIONS for sales.us.example.com
2.3.3 EXIT
Oracle Connection Manager Control utility command EXIT is used to exit from the Oracle
Connection Manager utility.
Purpose
To exit from the Oracle Connection Manager Control utility.
Prerequisites
None
Syntax
cmctl EXIT [-c instance_name]
CMCTL> EXIT
Usage Notes
This command is identical to the QUIT command.
Example 2-1 Example

CMCTL> EXIT
2.3.4 HELP
Purpose
To provide a list of all commands for the Oracle Connection Manager Control utility or to
provide help with the syntax of a particular command.
Prerequisites
None
2-7
Chapter 2
Syntax
cmctl HELP [command] [-c instance_name]

CMCTL> HELP [command]
Arguments
command: Specify a HELP command. Commands are shown in the following sample
output.
When you enter a command as an argument to HELP, the Oracle Connection Manager
Control utility displays information about how to use the command. When you enter
HELP without an argument, the Oracle Connection Manager Control utility displays a
list of all the commands.
Example
CMCTL> HELP
The following operations are available
administer close* exit reload

resume* save_passwd set* show*
shutdown sleep startup suspend*
show_version quit
2.3.5 QUIT
Purpose
To exit the Oracle Connection Manager Control utility and return to the operating
system prompt.
Prerequisites
None
Syntax
cmctl QUIT

CMCTL> QUIT
Usage Notes
This command is identical to the EXIT command.
Example
CMCTL> QUIT
2-8
Chapter 2
2.3.6 RELOAD
Reload Oracle Connection Manager Control utility command dynamically rereads parameters
and rules.
Purpose
To dynamically reread parameters and rules.
Prerequisites
Syntax
cmctl RELOAD [-with_ha] [-c instance_name]

CMCTL> RELOAD [-with_ha]
Arguments
-with_ha: It is used to reload cman.ora without dropping registrations
Usage Notes
Configuration information modified using the RELOAD command applies only to new
connections. Existing connections are unaffected. The SET RELOAD command restores
configurations set in cman.ora, and override the SET command.
RELOAD reregisters gateways with the Oracle Connection Manager listener during which some
new connections might be refused until the registration process is complete.
-with_ha option can be used with RELOAD to not drop registrations, thus providing high
service availability during reload.
Example
CMCTL> RELOAD
2.3.7 RESUME GATEWAYS

Purpose
To resume gateway processes that have been suspended.
Prerequisites
Syntax
2-9
Chapter 2
cmctl RESUME GATEWAYS [gateway_process_id] [cman_name]

CMCTL> RESUME GATEWAYS [gateway_process_id]
Arguments
gateway_process_id: One or more gateway processes to reopen. Separate multiple
gateway processes using a space between the process identifiers.
Usage Notes
Issuing RESUME GATEWAYS without an argument reopens all gateway processes that
have been closed.
Example
CMCTL> RESUME GATEWAYS 1
2.3.8 SAVE_PASSWD
Purpose
To save the current password to the cman.ora file, the configuration file for Oracle
Connection Manager.
Prerequisites
Syntax
cmctl SAVE_PASSWD [-c instance_name]

CMCTL> SAVE_PASSWD
Usage Notes
If you run this command, then the next session of Oracle Connection Manager uses
the password. The password is stored in an encrypted format in the cman.ora file.
Example
CMCTL> SAVE_PASSWD
2.3.9 SET
Purpose
To display a list of parameters that can be modified using this command.
2-10
Chapter 2
Prerequisites
None
Syntax
cmctl SET

CMCTL> SET
Example
CMCTL> SET
The following operations are available after set
aso_authentication_filter outbound_connect_timeout
connection_statistics password
event session_timeout
idle_timeout trace_directory
trace_level
log_directory
log_level
2.3.10 SET ASO_AUTHENTICATION_FILTER

Purpose
To indicate whether the client must use Oracle Database security to authenticate.
Prerequisites
Syntax
cmctl SET ASO_AUTHENTICATION_FILTER {on | off}[-c instance_name]

CMCTL> SET ASO_AUTHENTICATION_FILTER {on | off}
Arguments
on: To reject connections that are not using Secure Network Service (SNS) to perform client
authentication. SNS is part of Oracle Database security.
off: To specify whether no authentication is required for client connections. This is the
default.
2-11
Chapter 2
Example
CMCTL> set aso_authentication_filter ON
CMAN_user.us.example.com parameter aso_authentication_filter set to ON
2.3.11 SET CONNECTION_STATISTICS

Purpose
To specify whether gateway processes collect connection statistics.
Prerequisites
Syntax
cmctl SET CONNECTION_STATISTICS {yes | no}[-c instance_name]

CMCTL> SET CONNECTION_STATISTICS {yes | no}
Arguments
yes: To have gateway processes collect connection statistics.
no: To not have gateway processes collect connection statistics. This is the default.
Usage Notes
If SET CONNECTION_STATISTICS is set to yes, then you can obtain statistics by issuing
the SHOW CONNECTIONS command.
Example
CMCTL> set connection_statistics ON
CMAN_user.us.example.com parameter connection_statistics set to ON
2.3.12 SET EVENT

Purpose
To log information for a particular event.
Syntax
cmctl SET EVENT event_group [-c instance_name]

CMCTL> SET EVENT event_group {on | off}
2-12
Chapter 2
Arguments
event_group: Specify one of the following event groups:
• init_and_term: Initialization and termination event group.
• memory_ops: Memory operations event group.
• conn_hdlg: Connection handling event group.
• proc_mgmt: Process management event group.
• reg_and_load: Registration and load update event group.
• wake_up: Events related to Connection Manager Administration (CMADMIN) wakeup
queue event group.
• timer: Gateway timeouts event group.
• cmd_proc: Command processing event group.
• relay: Events associated with connection control blocks event group.
on: To turn an event group on.
off: To turn an event group off.
Usage Notes
The SET EVENT command accepts only one argument. To log multiple events, you must issue
the command for each event separately.
Example
CMCTL> set event memory_ops off
cman11 event memory_ops set to OFF.
2.3.13 SET IDLE_TIMEOUT

Purpose
To specify the amount of time a client can be idle without transmitting data.
Prerequisites
Syntax
cmctl SET IDLE_TIMEOUT [time] [-c instance_name]
From the From the Oracle Connection Manager Control utility:

CMCTL> SET IDLE_TIMEOUT [time]
Arguments
time: Specify the idle timeout in seconds. The default is 0 (zero), which disables this feature.
2-13
Chapter 2
Example
CMCTL> SET IDLE_TIMEOUT 30
CMAN_user.us.example.com parameter idle_timeout set to 30
2.3.14 SET INBOUND_CONNECT_TIMEOUT

Purpose
To specify the maximum amount of time the Oracle Connection Manager listener waits
for a valid connection request from the client before timing out.
Prerequisites
Syntax
cmctl SET INBOUND_CONNECT_TIMEOUT [time] [-c instance_name]

CMCTL> SET INBOUND_CONNECT_TIMEOUT [time]
Arguments
time: The inbound connect timeout in seconds. The default is 0 (zero), which disables
this feature.
Example
CMCTL> SET INBOUND_CONNECT_TIMEOUT 30
CMAN_user.us.example.com parameter inbound_connect_timeout set to 30
2.3.15 SET LOG_DIRECTORY
Note:
enabled. The default is for ADR to be enabled, and use the log directory
ORACLE_HOME/log.
Purpose
To designate where the log files for Oracle Connection Manager are written.
Prerequisites
2-14
Chapter 2
Syntax
cmctl SET LOG_DIRECTORY [directory_path] [-c instance_name]

CMCTL> SET LOG_DIRECTORY [directory_path]
Arguments
directory_path: The location of the log directory. The default path is as follows:
• Linux and UNIX:
ORACLE_HOME/network/log directory
• Microsoft Windows:
ORACLE_HOME\network\log directory
Usage Notes
Use the SHOW PARAMETERS command to determine the location of the log files.
Example
CMCTL>
SET LOG_DIRECTORY /disk1/user_cman_test/oracle/network/admin
CMAN_user.us.example.com parameter log_directory set to

/disk1/user_cman_test/oracle/network/admin
2.3.16 SET LOG_LEVEL

Purpose
To set the log level for Oracle Connection Manager.
Prerequisites
Syntax
cmctl SET LOG_LEVEL [level] [-c instance_name]

CMCTL> SET LOG_LEVEL [level]
Arguments
level: Specify one of the following log levels:
• off: No logging.
2-15
Chapter 2
• user: User log information.

• admin: Administrative log information.
• support: Oracle Support Services log information. This is the default.
Usage Notes
Specify off to capture the minimum amount of log information. Specify support to
capture the maximum amount.
Example
CMCTL> SET LOG_LEVEL SUPPORT
CMAN_user.us.example.com parameter log_level set to SUPPORT
2.3.17 SET OUTBOUND_CONNECT_TIMEOUT

Purpose
To specify the maximum amount of time the Oracle Connection Manager instance
waits for a valid connection with the server before timing out.
Prerequisites
Syntax
cmctl SET OUTBOUND_CONNECT_TIMEOUT [time] [-c instance_name]
From the From the Oracle Connection Manager Control utility:

CMCTL> SET OUTBOUND_CONNECT_TIMEOUT [time]
Arguments
time: The outbound connect timeout in seconds. The default is 0.
Example
CMCTL> SET OUTBOUND_CONNECT_TIMEOUT 30
CMAN_user.us.example.com parameter outbound_connect_timeout set to 30
2.3.18 SET PASSWORD

Purpose
To assign a password to the Oracle Connection Manager instance.
Prerequisites
2-16
Chapter 2
Syntax
cmctl SET PASSWORD

CMCTL> SET PASSWORD
Arguments
None.
Usage Notes
This command may be used either to set a password for the first time or to change an
existing one.
This command does not save the password to cman.ora. As a result the password is valid
only for the current session. To save the password after you have set it, run the
SAVE_PASSWD command.
Example
CMCTL> SET PASSWORD
Enter Old password: old_password

Enter New password: new_password
Reenter New password: new_password
2.3.19 SET SESSION_TIMEOUT

Purpose
To specify the maximum amount of time for a session of Oracle Connection Manager.
Prerequisites
Syntax
cmctl SET SESSION_TIMEOUT [time] [-c instance_name]

CMCTL> SET SESSION_TIMEOUT [time]
Arguments
time: The session timeout in seconds. The default is 0 (zero), which disables this feature.
2-17
Chapter 2
Example
CMCTL> SET SESSION_TIMEOUT 60
CMAN_user.us.example.com parameter session_timeout set to 60
2.3.20 SET TRACE_DIRECTORY
Note:
enabled. The default is for ADR to be enabled.
Purpose
To designate where the trace files for an Oracle Connection Manager instance are
written.
Prerequisites
Syntax
cmctl SET TRACE_DIRECTORY [directory_path] [-c instance_name]

CMCTL> SET TRACE_DIRECTORY [directory_path]
Arguments
directory_path: The location of the trace directory. The default path is ORACLE_HOME/
network/trace.
Usage Notes
Use the SHOW PARAMETERS command to determine the location of the trace files.
Example
CMCTL> SET TRACE_DIRECTORY /disk1/mpurayat_newtest/oracle/network/trace
cman1 parameter trace_directory set to /disk1/mpurayat_newtest/oracle/network
/trace
2.3.21 SET TRACE_LEVEL

Purpose
To set the trace level for an Oracle Connection Manager instance.
2-18
Chapter 2
Prerequisites
Syntax
cmctl SET TRACE_LEVEL [level] [-c instance_name]

CMCTL> SET TRACE_LEVEL [level]
Arguments
level: Specify one of the following log levels:
• off: No tracing. This is the default.
• user: User trace information.
• admin: Administrative trace information.
• support: Oracle Support Services trace information.
Usage Notes
Specify off to capture the minimum amount of trace information. Specify support to capture
the maximum amount.
Use the SHOW PARAMETERS command to determine the current trace level.
Example
CMCTL> SET TRACE_LEVEL USER
CMAN_user.us.example.com parameter trace_level set to USER
2.3.22 SHOW
Purpose
To display a list of parameters that may be used as arguments for this command. Entering
one of these parameters with the command displays the parameter value or values.
Prerequisites
None
Syntax
cmctl SHOW [-c instance_name]

CMCTL> SHOW
2-19
Chapter 2
Example
CMCTL> SHOW
The following operations are available after show
all gateways status

connections parameters version
defaults rules
events services
2.3.23 SHOW ALL

Purpose
To combine and display output from the SHOW PARAMETERS and SHOW RULES commands.
Prerequisites
Syntax
cmctl SHOW ALL [-c instance_name]

CMCTL> SHOW ALL
Example
CMCTL> SHOW ALL
listener_address |
(address=(protocol=tcp)(host=users.us.example.com)(port=1630))
aso_authentication_filter | OFF
connection_statistics | OFF
event_group | OFF
log_directory | /disk1/user_cman_test/oracle/network/log/
log_level | SUPPORT
max_connections | 256
idle_timeout | 0
inbound_connect_timeout | 0
session_timeout | 0
outbound_connect_timeout | 0
max_gateway_processes | 16
min_gateway_processes | 2
max_cmctl_sessions | 4
password | OFF
trace_directory | /disk1/user_cman_test/oracle/network/trace/
trace_level | OFF
trace_timestamp | OFF
trace_filelen | 0
trace_fileno | 0
(rule_list=
(rule=
(src=*)
(dst=*)
2-20
Chapter 2
(srv=*)
(act=accept)
)
)
2.3.24 SHOW CONNECTIONS

Purpose
To display information about specific connections or all connections.
Prerequisites
Syntax
cmctl SHOW CONNECTIONS [information] [in state] [gt time] [from source]
[to destination] [for service] [using gateway_process_id]
[connect_identifier_list] [-c instance_name]

CMCTL> SHOW CONNECTIONS [information][in state] [gt time] [from source]
[to destination] [for service] [using gateway_process_id]
[connect_identifier_list]
Arguments
information: Specify one of the following values to display information about connections.
Information categories include connection identifier, source, destination, service, current
state, total idle time, and total elapsed time.
• count: The total number of connections that meet the criteria specified by the other
qualifiers. This is the default.
• detail: All information about connections specified by the other qualifiers.
state: Specify one of the following values to specify the connection state:
• idle: Connections that are inactive in the established state.

• connecting: Connections that are in the process of connecting.
• established: Connections that are connected and are transferring data.
• terminating: Connections that are disconnecting.
If no state is specified, then SHOW CONNECTIONS defaults to all possible states. If the time
qualifier is included under these conditions, then the time specified is the amount of time that
has elapsed since a client initiated a connection.
Note:
This argument is not supported with Oracle Connection Manager in Traffic Director
mode.
2-21
Chapter 2
time: Use the following format to specify connections greater than the time indicated:
gt[hh:mm:]ss
Note:
This argument is not supported with Oracle Connection Manager in Traffic
Director mode.
source: Specify one of the following formats to specify the source address:
• from IP
• from hostname
• from subnet
destination: Specify one of the following formats to specify the destination address:
• to IP
• to hostname
• to subnet
service: Use the service_name format to request a service:
gateway_process_id: Use the following format to specify connections that are proxied
by the gateway process indicated:
using gateway_process_id
connect_identifier_list: Separate multiple connection identifiers using a space.
Usage Notes
Connections are sorted by gateway process identifier and connection identifier, in
ascending order.
Issuing SHOW CONNECTIONS without an argument displays all connections.
Examples
The following command displays a detailed description of connections in any state.
The elapsed time of the connection must be greater than 1 hour and 30 minutes. The
connection source is the specified subnet, and the destination the specified host
name.
CMCTL> SHOW CONNECTIONS gt 1:30:00 from 192.0.2.32/24 to host1
The following command displays the number of connections proxied by Oracle

Connection Manager using the gateway process identifier 0 that have been in the idle
state more than 30 minutes:
CMCTL> SHOW idle CONNECTIONS count gt 30:00 using 0
The following command displays a detailed description of connections that are

connected to the service sales.us.example.com:
CMCTL> SHOW established CONNECTIONS detail for sales.us.example.com
2-22
Chapter 2
Additional Statistics Shown in Traffic Director Mode

Each connection to Oracle Connection Manager in Traffic Director mode displays these
additional statistics:
• Source Host Name: Host name of the client connection.
• Source Process Id: Process Id of the connected client.
• Source Program Name: The name of the connected client program.
• Destination Hostname: Host name of the database server to which the client is
connected through Oracle Connection Manager.
• State: State of the inbound connection with one of the following values
– THREAD WAIT: Connection is waiting for a worker thread, not seen in dedicated
threads mode
– ACTIVE: Connection is transferring data, occupying the thread
– IDLE: Connection is established but inactive, can still occupy the thread if
tdm_bind_thread=true in cman.ora
• Idle time: Cumulative time inµs the connection is inIDLE state.
• Thread Wait time: Cumulative time inµs the connection is in THREAD WAIT state. It is
always 0 in dedicated threads mode.
• Active time: Cumulative time in µs the connection is in ACTIVE state.
• PRCP State: State of the inbound connection with respect to the Proxy Resident
Connection Pool (PRCP) and can be one of the following values
– WAIT: Connection is waiting for a session from the PRCP
– CHECKED-OUT: Connection is holding an outbound session from PRCP but not making
any OCI calls
– ACTIVE: Connection is holding an outbound session from PRCP and busy with OCI
calls
– CHECKED-IN: Connection released the CHECKED-OUT session back to the PRCP
– NO STATE: Clients to a service without a configured PRCP configured have this state
• PRCP Wait time, PRCP Checked-out time, and PRCP Active time: Cumulative time inµs
the connection is in PRCP WAIT, CHECKED-OUT, and ACTIVE states. All these three states
are zero in case of non-PRCP service.
• Total Session Gets: Total count ofPRCP session get requests from this connection. It is
always 1 if PRCP is not configured.
• Session Get Hits: Number of times a session is found existing in the PRCP out of all the
requests. It is always 0 if PRCP is not configured.
2.3.25 SHOW DEFAULTS

Purpose
To display default parameter settings.
2-23
Chapter 2
Prerequisites
Syntax
cmctl SHOW DEFAULTS [-c instance_name]

CMCTL> SHOW DEFAULTS
Example
CMCTL> SHOW DEFAULTS
listener_address |
aso_authentication_filter | OFF
connection_statistics | OFF
event_group | OFF
log_level | SUPPORT
idle_timeout | 0
session_timeout | 0
password | OFF
trace_level | OFF
trace_filelen | 0
trace_fileno | 0
2.3.26 SHOW EVENTS

Purpose
To display the events that are in operation.
Prerequisites
Syntax
cmctl SHOW EVENTS [-c instance_name]

CMCTL> SHOW EVENTS
2-24
Chapter 2
Example
CMCTL> SHOW EVENTS
Event Groups:
memory_ops
2.3.27 SHOW GATEWAYS

Purpose
To display the current status of a specific gateway process or processes. Statistics displayed
include number of active connections, number of peak active connections, total number of
connections handled, and number of connections refused.
Prerequisites
Syntax
cmctl SHOW GATEWAYS [gateway] [-c instance_name]

CMCTL> SHOW GATEWAYS [gateway]
Arguments
gateway: The identifier of the gateway or gateways whose status to display.
Issuing SHOW GATEWAYS without an argument displays the status of all gateway processes.
Usage Notes
To display multiple gateways, use a space to separate the identifiers when entering the
command.
Example
CMCTL> SHOW GATEWAYS 1
Gateway ID 1
Gateway state READY
Number of active connections 0
Peak active connections 0
Total connections 0
Total connections refused 0
2.3.28 SHOW PARAMETERS

Purpose
To display current parameter settings for an instance.
2-25
Chapter 2
Prerequisites
Syntax
cmctl SHOW PARAMETERS [-c instance_name]

CMCTL> SHOW PARAMETERS
Usage Notes
Several configuration parameters can be dynamically modified using the SET
command. Therefore, the information that SHOW PARAMETERS displays might be
different from what appears in the cman.ora file.
Example
CMCTL> SHOW PARAMETERS
listener_address |
aso_authentication_filter | ON
connection_statistics | ON
event_group | (memory_ops)
log_level | SUPPORT
idle_timeout | 0
session_timeout | 0
password | OFF
trace_level | SUPPORT
trace_filelen | 0
trace_fileno | 0
2.3.29 SHOW RULES

Purpose
To display the access control list currently used by the instance.
Prerequisites
2-26
Chapter 2
Syntax
cmctl SHOW RULES [-c instance_name]

CMCTL> SHOW RULES
Usage Notes
You can update the rules list by issuing the RELOAD command.
Example
CMCTL> SHOW RULES
Number of filtering rules currently in effect: 5
(rule_list=
(rule=
(src=usunnae12)
(dst=usunnae13)
(srv=*)
(act=accept)
(action_list=(mit=120)(mct=1800)(conn_stats=on)(aut=off))
)
(rule=
(src=usunnae12)
(dst=usunnae14)
(srv=service2)
(act=accept)
)
(rule=
(src=*)
(dst=usunnae15)
(srv=*)
(act=accept)
(action_list=(mit=120)(mct=3000)(moct=200)(aut=on))
)
(rule=
(src=*)
(dst=usunnae16)
(srv=*)
(act=reject)
(action_list=(moct=20)(aut=on))
)
(rule=
(src=users.us.example.com)
(dst=users.us.example.com)
(srv=cmon)
(act=accept)
(action_list=(mit=100)(mct=1130)(moct=200)(aut=on))
)
)
2-27
Chapter 2
2.3.30 SHOW SERVICES

Purpose
To display comprehensive information about the Oracle Connection Manager instance.
The information displayed includes number of handlers for gateway and CMADMIN
processes, listening ports of handlers, and number of connections, both refused and
current.
Prerequisites
Syntax
cmctl SHOW SERVICES [-c instance_name]

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

Purpose
To display basic information about the instance, including version, start time, and
current statistics.
Prerequisites
Syntax
2-28
Chapter 2
cmctl SHOW STATUS

CMCTL> SHOW STATUS
Example
CMCTL> SHOW STATUS
Status of the Instance
----------------------
Instance name CMAN_user.us.example.com
Version CMAN for Linux: Version 18.0.0.0.0
Start date 12-JAN-2018 14:50:35
Num of gateways started 2
Average Load level 0
Log Level SUPPORT
Trace Level OFF
Instance Config file /disk1/user_cman_test/oracle/network/admin/cman.ora
Instance Log directory /disk1/user_cman_test/oracle/network/log/
Instance Trace directory /disk1/user_cman_test/oracle/network/trace/
2.3.32 SHOW VERSION

Purpose
To display the current version and name of the Oracle Connection Manager Control utility.
Prerequisites
None
Syntax
cmctl SHOW VERSION [-c instance_name]

CMCTL> SHOW VERSION
Examples
CMCTL> SHOW VERSION
CMAN for Linux: Version 18.0.0.0.0
2.3.33 SHUTDOWN
Purpose
To shut down specific gateway processes or the entire Oracle Connection Manager instance.
Prerequisites
2-29
Chapter 2
Syntax
cmctl SHUTDOWN [gateways gateway] [normal | abort] [-c instance_name]

CMCTL> SHUTDOWN [gateways gateway] {normal | abort}
Arguments
gateways: To shut down a specific gateway.
normal: To reject new connections and terminate after existing connections close. This
is the default.
abort: To shut down Oracle Connection Manager immediately, and close all open
connections.
To specify more than one gateway, separate gateways using a space.
Usage Notes
Issuing SHUTDOWN without an argument shuts down all gateways.
Example
CMCTL> SHUTDOWN GATEWAYS 0
2.3.34 STARTUP
Purpose
To start Oracle Connection Manager.
Prerequisites
Another Oracle Connection Manager instance configured with the same protocol
address must not be running.
Syntax
cmctl STARTUP [-c instance_name]

CMCTL> STARTUP
Usage Notes
Before issuing this command, you must use the ADMINISTER command to select an
instance to start.
2-30
Chapter 2
Issuing this command starts all instance components, which are the listener, CMADMIN, and
the gateway processes. The command fails if any one of these components is already
running.
The utility may prompt for a password if Oracle Connection Manager was installed with
secure installation option.
Example
CMCTL> STARTUP
Starting Oracle Connection Manager instance cman_1. Please wait...
CMAN for Linux: Version 18.0.0.0.0
Status of the Instance
----------------------
Instance name cman_1
Version CMAN for Linux: Version 18.0.0.0.0
Start date 22-JAN-2018 01:16:55
Num of gateways started 8
Average Load level 0
Log Level SUPPORT
Trace Level OFF
Instance Config file $ORACLE_HOME/network/admin/cman.ora
Instance Log directory $ORACLE_BASE/diag/netcman/node_name/cman_1/alert
Instance Trace directory $ORACLE_BASE/diag/netcman/node_name/cman_1/trace
2.3.35 SUSPEND GATEWAY

Purpose
To specify which gateway processes will no longer accept new client connections.
Prerequisites
Syntax
cmctl SUSPEND GATEWAY [gateway_process_id] [-c instance_name]

CMCTL> SUSPEND GATEWAY [gateway_process_id]
Arguments
gateway_process_id: The gateway process that will no longer accept new connections.
Specify multiple gateway processes by putting a space between entries.
Issuing SUSPEND GATEWAY without an argument suspends all gateway processes.
Usage Notes
Use the RESUME GATEWAYS command to enable gateway processes to accept new
connections.
2-31
Chapter 2
Example
CMCTL> SUSPEND GATEWAY 1
2-32
3
Syntax Rules for Configuration Files
Learn how to follow the syntax configuration rules for Oracle Net Services parameters,
keywords, addresses, and naming methods.
• Overview of Configuration File Syntax
Construct your Oracle Net Services configuration files in accordance with syntax rules
and standard conventions.
• Syntax Rules for Configuration Files
Follow the structure, hierarchy, and character requirements for configuration files.
• Network Character Set for Keywords
Use the permitted character set for keyword values and network character sets.
• Character Set for Listener and Net Service Names
Learn how to create listener names and net service names for clients that comply with
character set requirements.
3.1 Overview of Configuration File Syntax

Construct your Oracle Net Services configuration files in accordance with syntax rules and
standard conventions.
The Oracle Net Services configuration files consist of parameters that 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=
(keyword1=value1)
(keyword2=value2))
For example, the address portion of a local naming configuration file (tnsnames.ora) can
include lines such as the following:
(ADDRESS=
(PROTOCOL=tcp)
(HOST=sales-server)
(PORT=1521))
Set up your configuration files so that indentation reflects what keyword is the parent or
owner of other keyword-value pairs. If you do not choose to indent your files in this way, then
3-1
Chapter 3
Syntax Rules for Configuration Files
you must still indent a wrapped line by at least one space, or it will be misread as a
new parameter. The following syntax is acceptable:
(ADDRESS=(PROTOCOL=tcp)
(HOST=sales-server)(PORT=1521))
The following syntax is not acceptable:
(ADDRESS=(PROTOCOL=tcp)
(HOST=sales-server)(PORT=1521))
3.2 Syntax Rules for Configuration Files

Follow the structure, hierarchy, and character requirements for configuration files.
The following rules apply to the syntax of configuration files:
• Any keyword in a configuration file that begins a parameter that includes one or
more keyword-value pairs must be in the far left column of a line. If it is indented
by one or more spaces, then it is interpreted as a continuation of the previous line.
• All characters must belong to the network character set.
• Keywords are not case sensitive. However, values can be case-sensitive,
depending on your operating system and protocol.
• In keyword-value pairs, spaces around the equal sign (=) are optional.
• There is a hierarchy of keywords, which requires that some keywords are always
followed by others. At any level of the hierarchy, keywords can be listed in any
order. For example, the following entries are equally valid:
(ADDRESS=
(PROTOCOL=TCP)
(HOST=sales-server)
(PORT=1521))
(ADDRESS=
(PROTOCOL=tcp)
(PORT=1521)
(HOST=sales-server))
• Keywords cannot contain spaces.

• Values must not contain spaces, unless the values with spaces are enclosed
within double quotation marks (") or single quotation marks (').
• If the keyword-value pair consists of a single word, or a concatenation of words on
either side of the equal sign, then no parentheses are needed.
• The maximum length of a connect descriptor is 4 KB.
• You can include comments by using the number sign (#) at the beginning of a line.
Anything following the number sign to the end of the line is considered a comment.
3-2
Chapter 3
Network Character Set for Keywords
3.3 Network Character Set for Keywords

Use the permitted character set for keyword values and network character sets.
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 has quotation marks. If you have a value that contains reserved symbols,
then use either single or double quotation marks to enclose the value. To include a quotation
marks within a value that is surrounded by quotation marks, use different quotation marks.
The backslash (\) is used as an escape character.
You can use the following characters within a connect descriptor, but not in a keyword or
value:
• Space
• Tab
• Carriage return
• Newline
3.4 Character Set for Listener and Net Service Names

Learn how to create listener names and net service names for clients that comply with
character set requirements.
Listener names and net service names are limited to the following character set:
[a...z] [A...Z] [0...9] _
The first character in the listener name or net service name must be an alphanumeric
character. In general, names up to 64 characters in length are acceptable. In addition, a
database service name must match the global database name defined by the database
administrator, which consists of a database name, and the database domain. Both net
service names and global database names are not case-sensitive.
3-3
4
Protocol Address Configuration
Learn how to configure connections for Oracle Database instances and clients.
A network object is identified by a protocol address. When a connection is made, the client
and the receiver of the request (listener or Oracle Connection Manager) are configured with
identical protocol addresses. 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.
• Protocol Addresses
The protocol address is comprised of ADDRESS and ADDRESS_LIST elements.
• Protocol Parameters
The listener and Oracle Connection Manager are identified by protocol addresses.
• Recommended Port Numbers
Oracle recommends that you use the default port numbers for client and Oracle
Connection Manager connections.
• Port Number Limitations
Understand limitations for port numbers. If it is necessary to configure a listener to use a
system port number (in the 1 to 1024 range), then use the procedure described here to
configure the listener.
4.1 Protocol Addresses

The protocol address is comprised of ADDRESS and ADDRESS_LIST elements.
• ADDRESS
The ADDRESS networking parameter specifies the protocol address under the
ADDRESS_LIST or DESCRIPTION parameter.
• ADDRESS_LIST
The ADDRESS_LIST networking parameter specifies the number of protocol addresses
sharing common characteristics.
4.1.1 ADDRESS
The ADDRESS networking parameter specifies the protocol address under the ADDRESS_LIST or
DESCRIPTION parameter.
Purpose
To define a protocol address.
Usage Notes
Put this parameter under an ADDRESS_LIST or DESCRIPTION parameter. A DESCRIPTION is used
in a tnsnames.ora or a listener.ora file.
4-1
Chapter 4
Protocol Parameters
Example
(ADDRESS=
(PROTOCOL=tcp)
(HOST=sales-server)
(PORT=1521))
See Also:
• "Protocol Parameters" for each protocol's required parameters

• Oracle Database Global Data Services Concepts and Administration
Guide for information about management of global services
4.1.2 ADDRESS_LIST
The ADDRESS_LIST networking parameter specifies the number of protocol addresses
sharing common characteristics.
Purpose
To define a list of protocol addresses that share common characteristics.
Usage Notes
This parameter is not mandatory when specifying multiple addresses.
Example
(ADDRESS_LIST=
(LOAD_BALANCE=on)
(ADDRESS=
(PROTOCOL=tcp)
(HOST=sales-server)
(PORT=1521))
(ADDRESS=
(PROTOCOL=tcp)
(HOST=hr-server)
(PORT=1521)))
4.2 Protocol Parameters

The listener and Oracle Connection Manager are identified by protocol addresses.
The following table lists the parameters used by the Oracle protocol support:
4-2
Chapter 4
Protocol Parameters
Table 4-1 Protocol-Specific Parameters
Protocol Parameter Description

IPC PROTOCOL Specify ipc as the value.
IPC KEYPATH On UNIX variants, IPC protocol uses the UNIX domain socket and this socket
creates an internal file for client/server communication. The parameter
keypath specifies the location where this file is created. If keypath is used,
then use the same value of version greater than 18 on the client and listener
sides.
IPC KEY Specify a unique name for the service. Oracle recommends using the service
name or the Oracle system identifier (SID) of the service.
Example:
(PROTOCOL=ipc)(KEY=sales)
Named Pipes PROTOCOL Specify nmp as the value.

Named Pipes SERVER Specify the name of the Oracle server.
Named Pipes PIPE Specify the pipe name used to connect to the database server. This is the
same PIPE keyword specified on server with Named Pipes. This name can
be any name.
Example:
(PROTOCOL=nmp)(SERVER=sales)(PIPE=dbpipe0)
SDP PROTOCOL Specify sdp as the value.

SDP HOST Specify the host name or IP address of the computer.
SDP PORT Specify the listening port number.
Example:
(PROTOCOL=sdp)(HOST=sales-server)(PORT=1521)
(PROTOCOL=sdp)(HOST=192.0.2.204)(PORT=1521)
TCP/IP PROTOCOL Specify tcp as the value.

TCP/IP HOST Specify the host name or IP address of the computer.
TCP/IP PORT Specify the listening port number.
Example:
(PROTOCOL=tcp)(HOST=sales-server)(PORT=1521)
(PROTOCOL=tcp)(HOST=192.0.2.204)(PORT=1521)
TCP/IP with TLS PROTOCOL Specify tcps as the value.

TCP/IP with TLS HOST Specify the host name or IP address of the computer.
TCP/IP with TLS PORT Specify the listening port number.
Example:
(PROTOCOL=tcps)(HOST=sales-server)(PORT=2484)
(PROTOCOL=tcps)(HOST=192.0.2.204)(PORT=2484)
Exadirect PROTOCOL Specify exadirect as the value.

Exadirect HOST Specify the IP address of the InfiBand interface.
4-3
Chapter 4
Recommended Port Numbers
Table 4-1 (Cont.) Protocol-Specific Parameters
Protocol Parameter Description

Exadirect PORT Specify the listening port number.
Example:
(PROTOCOL=exadirect)(HOST=sales-server)(PORT=2484)
(PROTOCOL=tcps)(HOST=192.0.2.204)(PORT=1522)
Websocket PROTOCOL Specify ws as the value; use this protocol only to serve as web server
backend database server.
Websocket HOST Specify the host name or IP address of the computer.
Websocket PORT Specify the listening port number.
Example:
(protocol=ws)(host=sales-server)(port=1524)
Secure PROTOCOL Specify ws as the value; use this protocol on the client side to connect to a
Websocket webserver with websocket protocol support. The web server should be
configured to make a websocket connection to the database listener. Wallet
should be configured in sqlnet.ora.
Use SQLNET.URI for mapping on web server.
Secure HOST Specify the host name or IP address of the web server with websocket
Websocket support.
Secure PORT Specify the listening port number.
Websocket Example:
(protocol=wss)(host=sales-server)(port=1524)
4.3 Recommended Port Numbers

Oracle recommends that you use the default port numbers for client and Oracle
Connection Manager connections.
Table 4-2 Recommended Port Numbers
Port Description
1521 Default listening port for client connections to the listener.
This port number can change to the officially registered port
number of 2483 for TCP/IP, and 2484 for TCP/IP with TLS.
1521 Default and officially registered listening port for client connections
to Oracle Connection Manager.
1830 Default and officially registered listening port for administrative
commands to Oracle Connection Manager.
4.4 Port Number Limitations

Understand limitations for port numbers. If it is necessary to configure a listener to use
a system port number (in the 1 to 1024 range), then use the procedure described here
to configure the listener.
4-4
Chapter 4
Port Number Limitations
Oracle allows port numbers from 1 to 65535. However, the port numbers below 1024 (the
well-known ports or system ports) are typically reserved. Normally, only privileged
processes can listen for TCP connections on ports below 1024.
If you need to configure a listener to listen on a port number less than 1024, then complete
the following procedure:
Note:
This procedure is a guideline. Your operating system can require a different
procedure.
1. Use Oracle Net Configuration Assistant or Oracle Net Manager to configure the listener
with protocol addresses and other configuration parameters.
2. Log in as the root user on the machine that has the listener.
3. Set file ownership and access permissions for the listener executable (tnslsnr) and the
dependent shared libraries, so that these files can be modified only by the root user.
4. Starting with the root directory, ensure that the permissions of the individual directories
found in the path names to these files share the same ownership and access
permissions.
5. Start the listener as the root user.
6. Enter the following command at the system prompt:
tnslsnr listener_name -user user -group group
In the preceding command, the following options are used:
Table 4-3 tnslsnr Utility Options
Options Description
listener_name Specify the name of the listener that you want to configure. If omitted,
then the default name LISTENER is used.
user Specify the user whose privileges you want the listener to use when super
user (root) privileges are not needed. After performing the privileged
operations, the listener gives up root privileges irreversibly.
group Specify the group whose privileges you want the listener to use when
super user (root) group privileges are not needed. After performing the
privileged operations, the listener gives up root group privileges
irreversibly.
During this step, the listener changes from root to the user and group privileges that you
specify. All operations are done with the specified user and group privileges, except the
system calls necessary to listen on configured endpoints. The listener reverts to the root
user to listen on reserved addresses, such as TCP ports less than 1024.
After the listener starts listening on all of its endpoints configured in the listener.ora file,
it switches to the specified user and group irreversibly. At that point. the listener gives up
4-5
Chapter 4
Port Number Limitations
the root privilege that it initially had. The -user and -group command line
arguments only accept user and group identifiers specified in numeric form.
For example, to run a listener called mylsnr with root privileges, and to have it
use privileges of the Oracle user with the user identifier (UID) of 37555, and with
OSDBA group dba membership, with a group identifier (GID) of 16, enter the
following command at the operating system prompt:
tnslsnr mylsnr -user 37555 -group 16
7. After the listener starts, you can administer it with the Listener Control utility.
Caution:
• Oracle recommends that the user under whose privileges the listener
process runs is the oracle user, or a similarly privileged user with
whose privileges the listener process normally runs on the operating
system.
• Do not leave the listener process running as the root user. Running
processes as the super user is a security vulnerability.
4-6
5
Parameters for the sqlnet.ora File
This chapter provides a complete listing of the sqlnet.ora file configuration parameters.
• Overview of Profile Configuration File

• sqlnet.ora Profile Parameters
• ADR Diagnostic Parameters in sqlnet.ora
The diagnostic data for the critical errors is quickly captured and stored in the ADR for
sqlnet.ora.
• Non-ADR Diagnostic Parameters in sqlnet.ora
5.1 Overview of Profile Configuration File

The sqlnet.ora file is the profile configuration file. It resides on the client machines and the
database server. Profiles are stored and implemented using this file. The database server
can be configured with access control parameters in the sqlnet.ora file. These parameters
specify whether clients are allowed or denied access based on the protocol.
The sqlnet.ora file enables you to do the following:
• Specify the client domain to append to unqualified names

• Prioritize naming methods
• Enable logging and tracing features
• Route connections through specific processes
• Configure parameters for external naming
• Configure Oracle Advanced Security
• Use protocol-specific parameters to restrict access to the database
By default, the sqlnet.ora file is located in the ORACLE_HOME/network/admin directory. The
sqlnet.ora file can also be stored in the directory specified by the TNS_ADMIN environment
variable.
5-1
Chapter 5
sqlnet.ora Profile Parameters
Note:
• The settings in the sqlnet.ora file apply to all pluggable databases

(PDBs) in a multitenant container database environment.
• Oracle Net Services supports the IFILE parameter in the sqlnet.ora file,
with up to three levels of nesting. The parameter is added manually to
the file. The following is an example of the syntax:
IFILE=/tmp/listener_em.ora
IFILE=/tmp/listener_cust1.ora
Refer to Oracle Database Reference for additional information.

• In the read-only Oracle home mode,, the sqlnet.ora file default location
is ORACLE_BASE_HOME/network/admin.
• In the read-only Oracle home mode, the parameters that default to
ORACLE_HOME location change to default to ORACLE_BASE_HOME location.
5.2 sqlnet.ora Profile Parameters

This section lists and describes the following sqlnet.ora file parameters:
• ACCEPT_MD5_CERTS
• ACCEPT_SHA1_CERTS
• ADD_SSLV3_TO_DEFAULT
• BEQUEATH_DETACH
Use the sqlnet.ora parameter to enable and disable signal handling on Linux and
UNIX systems.
• DEFAULT_SDU_SIZE
• DISABLE_OOB
DISABLE_OOB is a networking parameter of the sqlnet.ora file and is used to
enable or disable Oracle Net to send or receive out-of-band break messages using
urgent data provided by the underlying protocol.
• DISABLE_OOB_AUTO
The DISABLE_OOB_AUTO networking parameter of the sqlnet.ora file checks the
server path for out-of-band break messages support at the connection time.
• EXADIRECT_FLOW_CONTROL
• EXADIRECT_RECVPOLL
• HTTPS_SSL_VERSION
Use the sqlnet.ora profile parameter HTTPS_SSL_VERSION to control the Transport
Layer Security (TLS) version that XDB HTTPS connections use.
• IPC.KEYPATH
• NAMES.DEFAULT_DOMAIN
• NAMES.DIRECTORY_PATH
5-2
Chapter 5
• NAMES.LDAP_AUTHENTICATE_BIND
• NAMES.LDAP_CONN_TIMEOUT
• NAMES.LDAP_PERSISTENT_SESSION
• NAMES.NIS.META_MAP
• RECV_BUF_SIZE
Use the sqlnet.ora parameter RECV_BUF_SIZE to specify buffer space limit for session
receive operations.
• SDP.PF_INET_SDP
• SEC_USER_AUDIT_ACTION_BANNER
• SEC_USER_UNAUTHORIZED_ACCESS_BANNER
• SEND_BUF_SIZE
Use the sqlnet parameter SEND_BUF_SIZE to specify the buffer space limit for session
send operations.
• SQLNET.ALLOW_WEAK_CRYPTO
Use the sqlnet.ora compatibility parameter SQLNET.ALLOW_WEAK_CRYPTO to configure
your client-side network connection by reviewing the specified encryption and crypto-
checksum algorithms.
• SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS
Use the sqlnet.ora compatibility parameter SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS to
configure your server-side network connection by reviewing the specified encryption and
crypto-checksum algorithms.
• SQLNET.ALLOWED_LOGON_VERSION_CLIENT
• SQLNET.ALLOWED_LOGON_VERSION_SERVER
• SQLNET.AUTHENTICATION_SERVICES
Use the sqlnet.ora parameter SQLNET.AUTHENTICATION_SERVICES to enable one or more
authentication services.
• SQLNET.CLIENT_REGISTRATION
• SQLNET.CLOUD_USER
• SQLNET.COMPRESSION
• SQLNET.COMPRESSION_ACCELERATION
• SQLNET.COMPRESSION_LEVELS
• SQLNET.COMPRESSION_THRESHOLD
• SQLNET.CRYPTO_CHECKSUM_CLIENT
• SQLNET.CRYPTO_CHECKSUM_SERVER
• SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT
• SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER
• SQLNET.DBFW_PUBLIC_KEY
• SQLNET.DOWN_HOSTS_TIMEOUT
• SQLNET.ENCRYPTION_CLIENT
The SQLNET.ENCRYPTION_CLIENT networking parameter turns encryption on for the
client.
5-3
Chapter 5
• SQLNET.ENCRYPTION_SERVER
The SQLNET.ENCRYPTION_SERVER networking parameter turns encryption on for the
database server.
• SQLNET.ENCRYPTION_TYPES_CLIENT
Use the sqlnet.ora parameter SQLNET.ENCRYPTION_TYPES_CLIENT to list
encryption algorithms for clients to use.
• SQLNET.ENCRYPTION_TYPES_SERVER
Use the sqlnet.ora parameter SQLNET.ENCRYPTION_TYPES_SERVER to list the
encryption algorithms for the database to use.
• SQLNET.EXPIRE_TIME
• SQLNET.IGNORE_ANO_ENCRYPTION_FOR_TCPS
The SQLNET.IGNORE_ANO_ENCRYPTION_FOR_TCPS parameter is used on the server-
side to ignore the value set in SQLNET.ENCRYPTION_SERVER for TCPS connections
(effectively disabling ANO encryption on the TCPS listener).
• SQLNET.INBOUND_CONNECT_TIMEOUT
• SQLNET.FALLBACK_AUTHENTICATION
• SQLNET.KERBEROS5_CC_NAME
Use the sqlnet.ora parameter SQLNET.KERBEROS5_CC_NAME to specify the
complete path name to the Kerberos credentials cache file.
• SQLNET.KERBEROS5_CLOCKSKEW
• SQLNET.KERBEROS5_CONF
• SQLNET.KERBEROS5_CONF_LOCATION
• SQLNET.KERBEROS5_KEYTAB
• SQLNET.KERBEROS5_REALMS
• SQLNET.KERBEROS5_REPLAY_CACHE
• SQLNET.OUTBOUND_CONNECT_TIMEOUT
Use the sqlnet.ora parameter SQLNET.OUTBOUND_CONNECT_TIMEOUT to specify the
amount of time, in milliseconds, seconds, or minutes, in which clients must
establish Oracle Net connections to database instances.
• SQLNET.RADIUS_ALTERNATE
• SQLNET.RADIUS_ALTERNATE_PORT
• SQLNET.RADIUS_ALTERNATE_RETRIES
• SQLNET.RADIUS_AUTHENTICATION
• SQLNET.RADIUS_AUTHENTICATION_INTERFACE
• SQLNET.RADIUS_AUTHENTICATION_PORT
• SQLNET.RADIUS_AUTHENTICATION_RETRIES
• SQLNET.RADIUS_AUTHENTICATION_TIMEOUT
• SQLNET.RADIUS_CHALLENGE_RESPONSE
• SQLNET.RADIUS_SECRET
• SQLNET.RADIUS_SEND_ACCOUNTING
5-4
Chapter 5
• SQLNET.RECV_TIMEOUT
Use the sqlnet.ora parameter SQLNET.RECV_TIMEOUT to specify the duration of time that
a database client or server should wait for data from a peer after establishing a
connection.
• SQLNET.SEND_TIMEOUT
Use the sqlnet.ora parameter SQLNET.SEND_TIMEOUT to specify the duration of time for a
database server to complete a send operation to clients after establishing a connection.
• SQLNET.URI
SQLNET.URI networking parameter of the sqlnet.ora file specifies a database client URI
mapping on the web server.
• SQLNET.USE_HTTPS_PROXY
• SQLNET.WALLET_OVERRIDE
• SSL_CERT_REVOCATION
Use the sqlnet.ora parameter SSL_CERT_REVOCATION to configure revocation checks for
certificates.
• SSL_CRL_FILE
• SSL_CRL_PATH
• SSL_CIPHER_SUITES
Use the sqlnet.ora parameter SSL_CIPHER_SUITES to control which combination of
encryption and data integrity that Transport Layer Security (TLS) uses.
• SSL_EXTENDED_KEY_USAGE
• SSL_SERVER_DN_MATCH
• SSL_VERSION
Use the SSL_VERSION parameter to limit the valid Transport Layer Security (TLS) versions
that Oracle uses for connections.
• TCP.CONNECT_TIMEOUT
• TCP.EXCLUDED_NODES
• TCP.INVITED_NODES
• TCP.NODELAY
• TCP.QUEUESIZE
• TCP.VALIDNODE_CHECKING
• TNSPING.TRACE_DIRECTORY
• TNSPING.TRACE_LEVEL
• TOKEN_AUTH
Use the TOKEN_AUTH parameter in the tnsnames.ora or sqlnet.ora file to configure
token-based authentication for Oracle Cloud Infrastructure (OCI) Identity and Access
Management (IAM) users on an Oracle Autonomous Database.
• TOKEN_LOCATION
Use the TOKEN_LOCATION parameter in the tnsnames.ora or sqlnet.ora file to override
the default directory where the db-token and private key are stored. You use this
parameter while configuring token-based authentication for Oracle Cloud Infrastructure
(OCI) Identity and Access Management (IAM) users on an Oracle Autonomous
Database.
5-5
Chapter 5
• USE_CMAN
• USE_DEDICATED_SERVER
• WALLET_LOCATION
Use the sqlnet.ora parameter WALLET_LOCATION to specify the location of Oracle
wallets.
5.2.1 ACCEPT_MD5_CERTS
Purpose
To accept MD5 signed certificates, in addition to sqlnet.ora, this parameter must also
be set in listener.ora.
Default
FALSE
Values
• TRUE to accept MD5 signed certificates
• FALSE to not accept MD5 signed certficates
5.2.2 ACCEPT_SHA1_CERTS
Purpose
To not accept SHA1 signed certificates, in addition to sqlnet.ora, this parameter must
also be set in listener.ora.
Default
TRUE
Values
• TRUE to accept SHA1 signed certificates
• FALSE to not accept SHA1 signed certificates
5.2.3 ADD_SSLV3_TO_DEFAULT
Purpose
If the server wants to accept SSL_VERSION=3.0 in its default list of SSL_VERSIONs, then
in addition to sqlnet.ora, this parameter must also be set in listener.ora.
Default
FALSE
Values
• If set to TRUE and SSL_VERSION is not specified or is set to "undetermined", then
SSL_VERSION includes versions 1.2, 1.1, 1.0, and 3.0.
5-6
Chapter 5
• If set to FALSE and SSL_VERSION is not specified or is set to "undetermined", then

SSL_VERSION includes versions 1.2, 1.1, and 1.0
5.2.4 BEQUEATH_DETACH
Use the sqlnet.ora parameter to enable and disable signal handling on Linux and UNIX
systems.
Purpose
To turn signal handling on or off for Linux and UNIX systems
Default
no
Values
• yes to turn signal handling off
• no to leave signal handling on
Example
BEQUEATH_DETACH=yes
5.2.5 DEFAULT_SDU_SIZE
Purpose
To specify the session data unit (SDU) size, in bytes to connections.
Usage Notes
Oracle recommends setting this parameter in both the client-side and server-side sqlnet.ora
file to ensure the same SDU size is used throughout a connection. When the configured
values of client and database server do not match for a session, the lower of the two values
is used.
You can override this parameter for a particular client connection by specifying the SDU
parameter in the connect descriptor for a client.
Default
8192 bytes (8 KB)
Values
512 to 2097152 bytes
Example 5-1 Example
DEFAULT_SDU_SIZE=4096
5-7
Chapter 5
5.2.6 DISABLE_OOB
DISABLE_OOB is a networking parameter of the sqlnet.ora file and is used to enable
or disable Oracle Net to send or receive out-of-band break messages using urgent
data provided by the underlying protocol.
Purpose
To enable or disable Oracle Net to send or receive out-of-band break messages using
urgent data provided by the underlying protocol.
Usage Notes
If turned off, then the parameter enables Oracle Net to send and receive break
messages. If turned on, then the parameter disables the ability to send and receive
break messages. Once enabled, this feature applies to all protocols used by this client.
Default
off
Example 5-2 Example
DISABLE_OOB=on
5.2.7 DISABLE_OOB_AUTO
The DISABLE_OOB_AUTO networking parameter of the sqlnet.ora file checks the server
path for out-of-band break messages support at the connection time.
Purpose
Disable automatic out-of-band (OOB) support checks the server path at connection
time.
Usage Notes
By default, the client checks if the server path supports out-of-band break messages
or not at the connection time. If this parameter is set to TRUE, then the client does not
perform this check at the connection time.
Default
FALSE
Example 5-3 Example

DISABLE_OOB_AUTO = TRUE
5.2.8 EXADIRECT_FLOW_CONTROL
Purpose
To enable or disable Exadirect flow control.
5-8
Chapter 5
Usage Notes
If turned on, the parameter enables Oracle Net to broadcast available receive window to the
sender. The sender limits the sends based on the receiver broadcast window.
Default
off
Example
EXADIRECT_FLOW_CONTROL=on
5.2.9 EXADIRECT_RECVPOLL
Purpose
To specify the time that a receiver polls for incoming data.
Usage Notes
The parameter can be set to a fixed value or AUTO for auto tuning of the polling value.
Default
0
Example
EXADIRECT_RECVPOLL = 10
EXADIRECT_RECVPOLL = AUTO
5.2.10 HTTPS_SSL_VERSION
Use the sqlnet.ora profile parameter HTTPS_SSL_VERSION to control the Transport Layer
Security (TLS) version that XDB HTTPS connections use.
Purpose
To control the Transport Layer Security (TLS) version used by XDB HTTPS connections
separately.
Usage Notes
In particular, the SSL_VERSION parameter no longer controls the TLS version used by HTTPS.
You can set this parameter to any valid SSL_VERSION values.
Default
1.1 or 1.2, meaning TLSv1.1 or TLSv1.2.
Values
Any valid SSL_VERSION value
5-9
Chapter 5
5.2.11 IPC.KEYPATH
Purpose
To specify the destination directory where the internal file is created for UNIX domain
sockets.
Usage Notes
This parameter applies only to Oracle Net's usage of UNIX domain socket and does
not apply to other usages of UNIX domain sockets in the database, such as
clusterware. If keypath is used, then the same value should be used on both the client
and the listener sides with version greater than 18.
Default
The directory path is either /var/tmp/.oracle for Oracle Linux, Oracle Solaris
or /tmp/.oracle for other UNIX variants.
Example
ipc.keypath=/home/oracleuser.
5.2.12 NAMES.DEFAULT_DOMAIN
Purpose
To set the domain from which the client most often looks up names resolution
requests.
Usage Notes
When this parameter is set, the default domain name is automatically appended to any
unqualified net service name or service name.
For example, if the default domain is set to us.example.com, then the connect string
CONNECT scott@sales gets searched as sales.us.example.com. If the connect string
includes the domain extension, such as CONNECT [email protected], then
the domain is not appended to the string.
Default
None
Example
NAMES.DEFAULT_DOMAIN=example.com
5.2.13 NAMES.DIRECTORY_PATH
Purpose
To specify the order of the naming methods used for client name resolution lookups.
5-10
Chapter 5
Default
NAMES.DIRECTORY_PATH=(tnsnames, ldap, ezconnect)
Values
The following table shows the NAMES.DIRECTORY_PATH values for the naming methods.
Naming Method Value Description

tnsnames (local naming method) Set to resolve a network service name through the
tnsnames.ora file on the client.
ldap (directory naming method) Set to resolve a database service name, net service name, or
network service alias through a directory server.
ezconnect or hostname (Easy Select to enable clients to use a TCP/IP connect identifier,
Connect naming method) consisting of a host name and optional port and service name.
nis (external naming method) Set to resolve service information through an existing Network
Information Service (NIS).
Example
NAMES.DIRECTORY_PATH=(tnsnames)
5.2.14 NAMES.LDAP_AUTHENTICATE_BIND
Purpose
To specify whether the LDAP naming adapter should attempt to authenticate using a
specified wallet when it connects to the LDAP directory to resolve the name in the connect
string.
Usage Notes
The parameter value is Boolean.
If the parameter is set to TRUE, then the LDAP connection is authenticated using a wallet
whose location must be specified in the WALLET_LOCATION parameter.
If the parameter is set to FALSE, then the LDAP connection is established using an
anonymous bind.
Default
false
Example
NAMES.LDAP_AUTHENTICATE_BIND=true
5.2.15 NAMES.LDAP_CONN_TIMEOUT
Purpose
To specify number of seconds for a non-blocking connect timeout to the LDAP server.
5-11
Chapter 5
Usage Notes
The parameter value -1 is for infinite timeout.
Default
15 seconds
Values
Values are in seconds. The range is -1 to the number of seconds acceptable for your
environment. There is no upper limit.
Example
names.ldap_conn_timeout = -1
5.2.16 NAMES.LDAP_PERSISTENT_SESSION
Purpose
To specify whether the LDAP naming adapter should leave the session with the LDAP
server open after name lookup is complete.
Usage Notes
The parameter value is Boolean.
If the parameter is set to TRUE, then the connection to the LDAP server is left open
after the name lookup is complete. The connection will effectively stay open for the
duration of the process. If the connection is lost, then it is re-established as needed.
If the parameter is set to FALSE, then the LDAP connection is terminated as soon as
the name lookup completes. Every subsequent lookup opens the connection, performs
the lookup, and closes the connection. This option prevents the LDAP server from
having a large number of clients connected to it at any one time.
Default
false
Example
NAMES.LDAP_PERSISTENT_SESSION=true
5.2.17 NAMES.NIS.META_MAP
Purpose
To specify the map file to be used to map Network Information Service (NIS) attributes
to an NIS mapname.
Default
sqlnet.maps
5-12
Chapter 5
Example
NAMES.NIS.META_MAP=sqlnet.maps
5.2.18 RECV_BUF_SIZE
Use the sqlnet.ora parameter RECV_BUF_SIZE to specify buffer space limit for session
receive operations.
Purpose
To specify the buffer space limit for receive operations of sessions.
Usage Notes
You can override this parameter for a particular client connection by specifying the
RECV_BUF_SIZE parameter in the connect descriptor for a client.
This parameter is supported by the TCP/IP, TCP/IP with TLS, and SDP protocols.
Note:
Additional protocols might support this parameter on certain operating systems.
Refer to the operating system-specific documentation for additional information
about additional protocols that support this parameter.
Default
The default value for this parameter is operating system specific. The default for Linux 2.6
operating system is 87380 bytes.
Example
RECV_BUF_SIZE=11784
Related Topics
5.2.19 SDP.PF_INET_SDP
Purpose
To specify the protocol family or address family constant for the SDP protocol on your
system.
Default
27
Values
Any positive integer
5-13
Chapter 5
Example
SDP.PF_INET_SDP=30
5.2.20 SEC_USER_AUDIT_ACTION_BANNER
Purpose
To specify a text file containing the banner contents that warn the user about possible
user action auditing.
Usage Notes
The complete path of the text file must be specified in the sqlnet.ora file on the
server. Oracle Call Interface (OCI) applications can make use of OCI features to
retrieve this banner and display it to the user.
Default
None
Values
Name of the file for which the database owner has read permissions.
Example
SEC_USER_AUDIT_ACTION_BANNER=/opt/oracle/admin/data/auditwarning.txt
5.2.21 SEC_USER_UNAUTHORIZED_ACCESS_BANNER
Purpose
To specify a text file containing the banner contents that warn the user about
unauthorized access to the database.
Usage Notes
The complete path of the text file must be specified in the sqlnet.ora file on the
server. OCI applications can make use of OCI features to retrieve this banner and
display it to the user.
Default
None
Values
Name of the file for which the database owner has read permissions.
Example
SEC_USER_UNAUTHORIZED_ACCESS_BANNER=/opt/oracle/admin/data/unauthwarning.txt
5-14
Chapter 5
5.2.22 SEND_BUF_SIZE
Use the sqlnet parameter SEND_BUF_SIZE to specify the buffer space limit for session send
operations.
Purpose
To specify the buffer space limit for send operations of sessions.
Usage Notes
You can override this parameter for a particular client connection by specifying the
SEND_BUF_SIZE parameter in the connect descriptor for a client.
Note:
Refer to the operating system-specific documentation for additional information
about additional protocols that support this parameter.
Default
The default value for this parameter is operating system specific. The default for Linux 2.6
operating system is 16 KB.
Example
SEND_BUF_SIZE=11784
Related Topics
5.2.23 SQLNET.ALLOW_WEAK_CRYPTO
Use the sqlnet.ora compatibility parameter SQLNET.ALLOW_WEAK_CRYPTO to configure your
client-side network connection by reviewing the specified encryption and crypto-checksum
algorithms.
Purpose
To configure your client-side network connection by reviewing the encryption and crypto-
checksum algorithms enabled on the client and server. This ensures that the connection does
not encounter compatibility issues and your configuration uses supported strong algorithms.
Usage Notes
• The DES, DES40, 3DES112, 3DES168, RC4_40, RC4_56, RC4_128, RC4_256, and MD5
5-15
Chapter 5
To transition your Oracle Database environment to use stronger algorithms,
download and install the patch described in My Oracle Support note 2118136.2.
• If you set this parameter to TRUE, then you can specify deprecated algorithms for
backward compatibility. This configuration allows patched clients to connect to
unpatched servers, and thus such a connection is less secure.
• If you set this parameter to FALSE, then you can specify only supported algorithms
so that clients and servers can communicate in a fully patched environment. The
server enforces key fold-in for all Kerberos and JDBC thin clients. This
configuration strengthens the connection between clients and servers by using
strong native network encryption and integrity capabilities.
Using this setting, if native network encryption or checksumming is enabled and a
patched server or client attempts to communicate with an unpatched old client or
server, then the connection fails with an error message.
Values
• TRUE
• FALSE
Default Value
TRUE
Recommended Value
FALSE
Note:
Before setting this parameter to FALSE, you must remove all deprecated
algorithms listed in the server and client sqlnet.ora files.
Example
SQLNET.ALLOW_WEAK_CRYPTO = FALSE
Related Topics
• SQLNET.ENCRYPTION_TYPES_CLIENT
Use the sqlnet.ora parameter SQLNET.ENCRYPTION_TYPES_CLIENT to list
encryption algorithms for clients to use.
• SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT
5-16
Chapter 5
5.2.24 SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS
Use the sqlnet.ora compatibility parameter SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS to
configure your server-side network connection by reviewing the specified encryption and
crypto-checksum algorithms.
Purpose
To configure your server-side network connection by reviewing the encryption and crypto-
checksum algorithms enabled on the client and server. This ensures that the connection does
not encounter compatibility issues and your configuration uses supported strong algorithms.
Usage Notes
• The DES, DES40, 3DES112, 3DES168, RC4_40, RC4_56, RC4_128, RC4_256, and MD5
• If you set this parameter to TRUE, then you can specify deprecated algorithms for
backward compatibility. This configuration allows patched servers to connect to
unpatched clients, and thus such a connection is less secure.
• If you set this parameter to FALSE, then you can specify only supported algorithms so that
clients and servers can communicate in a fully patched environment. The server enforces
key fold-in for all Kerberos and JDBC thin clients. This configuration strengthens the
connection between clients and servers by using strong native network encryption and
integrity capabilities.
Using this setting, if native network encryption or checksumming is enabled and a
patched server or client attempts to communicate with an unpatched old client or server,
then the connection fails with an error message.
Values
• TRUE
• FALSE
Default Value
TRUE
Recommended Value
FALSE
5-17
Chapter 5
Note:
Before setting this parameter to FALSE, you must remove all deprecated
algorithms listed in the server and client sqlnet.ora files.
Example
SQLNET.ALLOW_WEAK_CRYPTO_CLIENTS = FALSE
Related Topics
• SQLNET.ENCRYPTION_TYPES_SERVER
Use the sqlnet.ora parameter SQLNET.ENCRYPTION_TYPES_SERVER to list the
encryption algorithms for the database to use.
• SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER
5.2.25 SQLNET.ALLOWED_LOGON_VERSION_CLIENT
Purpose
To set the minimum authentication protocol allowed for clients, and when a server is
acting as a client, such as connecting over a database link, when connecting to Oracle
Database instances.
Usage Notes
The term VERSION in the parameter name refers to the version of the authentication
protocol, not the Oracle Database release.
If the version does not meet or exceed the value defined by this parameter, then
authentication fails with an ORA-28040: No matching authentication protocol
error.
See Also:
Oracle Database Security Guide
Values
• 12a for Oracle Database 12c Release 1 (12.1.0.2) or later (strongest protection)
Note:
Using this setting, the clients can only authenticate using a de-optimized
password version. For example, the 12C password version.
5-18
Chapter 5
• 12 for the critical patch updates CPUOct2012 and later Oracle Database 11g
authentication protocols (stronger protection)
Note:
Using this setting, the clients can only authenticate using a password hash
value that uses salt. For example, the 11G or 12C password versions.
• 11 for Oracle Database 11g authentication protocols (default)

• 10 for Oracle Database 10g authentication protocols
• 8 for Oracle8i authentication protocol
Default
11
Example
If an Oracle Database 12c database hosts a database link to an Oracle Database 10g
database, then the SQLNET.ALLOWED_LOGON_VERSION_CLIENT parameter should be set as
follows in order for the database link connection to proceed:
SQLNET.ALLOWED_LOGON_VERSION_CLIENT=10
See Also:
Oracle Database Reference
5.2.26 SQLNET.ALLOWED_LOGON_VERSION_SERVER
Purpose
To set the minimum authentication protocol allowed when connecting to Oracle Database
instances.
Usage Notes
• Authentication Protocol Versions:
The term VERSION in the parameter name refers to the version of the authentication
protocol, not the Oracle Database release.
The authentication fails with an ORA-28040: No matching authentication protocol
error or an ORA-03134: Connections to this server version are no longer
supported error if the client does not have the ability listed in the "Ability Required of the
Client" column corresponding to the row matching the value of the
SQLNET.ALLOWED_LOGON_VERSION_SERVER parameter in Table 1.
A setting of 8 permits all password versions, and allows any combination of the
DBA_USERS.PASSWORD_VERSIONS values 10G, 11G, and 12C.
A setting of 12a permits only the 12C password version.
5-19
Chapter 5
A greater value means the server is less compatible in terms of the protocol that
clients must understand in order to authenticate. The server is also more
restrictive in terms of the password version that must exist to authenticate any
specific account. Whether a client can authenticate to a specific account depends
on both the server's setting of its SQLNET.ALLOWED_LOGON_VERSION_SERVER
parameter, as well as on the password versions which exist for the specified
account. The list of password versions can be seen in
DBA_USERS.PASSWORD_VERSIONS.
Note the following implications of setting the value to 12 or 12a:
– A value of FALSE for the SEC_CASE_SENSITIVE_LOGON Oracle instance
initialization parameter must not be used because password case insensitivity
requires the use of the 10G password version. If the
SEC_CASE_SENSITIVE_LOGON Oracle instance initialization parameter is set to
FALSE, then user accounts and secure roles become unusable because
Exclusive Mode excludes the use of the 10G password version. The
SEC_CASE_SENSITIVE_LOGON Oracle instance initialization parameter enables
or disables password case sensitivity. However, since Exclusive mode is
enabled by default in this release, disabling the password case sensitivity is
not supported.
Note:
* The use of the Oracle instance initialization parameter

SEC_CASE_SENSITIVE_LOGON is deprecated in favor of setting the
SQLNET.ALLOWED_LOGON_VERSION_SERVER parameter to 12 to
ensure that passwords are treated in a case-sensitive fashion.
* Disabling password case sensitivity is not supported in Exclusive
mode (when SQLNET.ALLOWED_LOGON_VERSION_SERVER is set to
12 or 12a.)
– Releases of OCI clients earlier than Oracle Database 10g cannot authenticate
to the Oracle database using password-based authentication.
– If the client uses Oracle Database 10g, then the client will receive an
ORA-03134: Connections to this server version are no longer
supported error message. To allow the connection, set the
SQLNET.ALLOWED_LOGON_VERSION_SERVER value to 8. Ensure the
DBA_USERS.PASSWORD_VERSIONS value for the account contains the value 10G. It
may be necessary to reset the password for that account.
Note the following implication of setting the value to 12a:
– To take advantage of the new 12C password version introduced in Oracle
Database release 12.2, user passwords should be expired to encourage users
to change their passwords and cause the new 12C password version to be
generated for their account. By default in this release, new passwords are
treated in a case-sensitive fashion. When an account password is changed,
the earlier 10G case-insensitive password version is automatically removed,
and the new 12C password version is generated.
5-20
Chapter 5
– When an account password is changed, the earlier 10G case-insensitive password

version and the 11G password version are both automatically removed.
– JDBC Thin Client Support:
In Oracle Database release 12.1.0.2 and later, if you set the sqlnet.ora parameter
SQLNET.ALLOWED_LOGON_VERSION_SERVER to 12a and you create a new account or
change the password of an existing account, then only the new 12C password version
is generated. The 12C password version is based on a SHA-2 (Secure Hash
Algorithm) SHA-512 salted cryptographic hash deoptimized using the PBKDF2
(Password-Based Key Derivation Function 2) algorithm. When the database server is
running with ALLOWED_LOGON_VERSION_SERVER set to 12a, it is running in Exclusive
Mode. In this mode, to log in using a JDBC client, the JRE version must be at least
version 8. The JDBC client enables its O7L_MR capability flag only when it is running
with at least version 8 of the JRE.
Note:
Check the PASSWORD_VERSIONS column of the DBA_USERS catalog view to see
the list of password versions for any given account.
If you set the sqlnet.ora parameter SQLNET.ALLOWED_LOGON_VERSION_SERVER to 12,

the server runs in Exclusive Mode and only the 11G and 12C password versions (the
SHA-1 and PBKDF2 SHA-2 based hashes of the password, respectively) are generated
and allowed to be used. In such cases, fully-patched JDBC clients having the
CPUOct2012 patch can connect because these JDBC clients provide the O5L_NP
client ability.
Older JDBC clients which do not have the CPUOct2012 containing the fix for the
stealth password cracking vulnerability CVE-2012-3132, do not provide the O5L_NP
client ability. Therefore, ensure that all the JDBC clients are patched properly.
• Client Capabilities:
The client must support certain abilities of the authentication protocol before the server
will authenticate. If the client does not support a specified authentication ability, then the
server rejects the connection with an ORA-28040: No matching authentication
protocol error message.
The following is the list of all client abilities. Some clients do not have all abilities. Clients
that are more recent have all the capabilities of the older clients, but older clients tend to
have less abilities than more recent clients.
– O8L_LI: The ability to support long identifiers (user names up to 128 bytes).
– O7L_MR: The ability to perform the Oracle Database 10g authentication protocol using
the 12C password version. For JDBC clients, only those running on at least JRE
version 8 offer the O7L_MR capability.
– O5L_NP: The ability to perform the Oracle Database 10g authentication protocol using
the 11G password version, and generating a session key encrypted for critical patch
update CPUOct2012.
– O5L: The ability to perform the Oracle Database 10g authentication protocol using the
10G password version.
5-21
Chapter 5
– O4L: The ability to perform the Oracle9i database authentication protocol using
the 10G password version.
– O3L: The ability to perform the Oracle8i database authentication protocol using
the 10G password version.
An ability which appears higher in the above list is more recent and secure than an
ability which appears lower in the list. Clients that are more recent have all the
capabilities of the older clients.
When the gradual database password rollover feature is enabled for a user
account, any of the client capabilities may appear in the CIENT_CAPABILITIES
clause of the AUTHENTICATION_TYPE field for the LOGON audit record. The
LOGON_INFO clause of the AUTHENTICATION_TYPE field also indicates whether the
old password or the new password is used, and the verifier type used for
authentication. The AUTHENTICATION_TYPE field may appear as follows:
(TYPE=(DATABASE));(CLIENT ADDRESS=((PROTOCOL=ipc)
(HOST=0.0.0.0)));(LOGON_INFO=((VERIFIER=11G-OLD)
(CLIENT_CAPABILITIES=O5L_NP,O7L_MR,O8L_LI)));
This information in an audit record enables you to find users who still log in using
their old passwords or applications that have not been updated to log in using the
new password.
• Allowed Parameter Settings:
The following table describes the allowed settings of the
SQLNET.ALLOWED_LOGON_VERSION_SERVER parameter, its effect on the generated
password versions when an account is created or a password is changed, the
ability flag required of the client to authenticate while the server has this setting,
and whether the setting is considered to be an Exclusive Mode.
Table 5-1 SQLNET.ALLOWED_LOGON_VERSION_SERVER Settings
Value of the Generated Ability Required Meaning for Server

ALLOWED_LO Password Version of the Client Clients Runs in
GON_VERSION Exclusive
_SERVER Mode
Parameter
12a 12C O7L_MR Only Oracle Yes
Database 12c because it
release 1 excludes
(12.1.0.2 or the use of
later) clients both 10G
can connect to and 11G
the server. password
versions.
5-22
Chapter 5
Table 5-1 (Cont.) SQLNET.ALLOWED_LOGON_VERSION_SERVER Settings

_SERVER Mode
Parameter
12 11G, 12C O5L_NP Oracle Yes
Database 11g because it
release 2 excludes
(11.2.0.3 or the use of
later) clients the 10G
can connect to password
the server. version.
Older clients
need the
critical patch
update
CPUOct2012
or later, to gain
the O5L_NP
ability.
Only older
clients which
have applied
critical patch
update
CPUOct2012
or later can
connect to the
server.
11 10G, 11G, 12C O5L Clients using No
Oracle
Database 10g
and later can
connect to the
server.
Clients using
releases earlier
than Oracle
Database
release
11.2.0.3 that
have not
applied critical
patch update
CPUOct2012
or later patches
must use the
10G password
version.
10 10G, 11G, 12C O5L It has the same No
meaning as the
earlier row.
meaning as the
earlier row.
5-23
Chapter 5
Table 5-1 (Cont.) SQLNET.ALLOWED_LOGON_VERSION_SERVER Settings

_SERVER Mode
Parameter
meaning as the
earlier row.
Values
• 12a for Oracle Database 12c release 12.1.0.2 or later authentication protocols
(strongest protection)
• 12 for Oracle Database 12c release 12.1 authentication protocols (default and
recommended value)
• 9 for Oracle9i Database authentication protocol
• 8 for Oracle8i Database authentication protocol
Note:
• Starting with Oracle Database 12c Release 2 (12.2), the default value is
12.
• For earlier releases, the value 12 can be used after the critical patch
updates CPUOct2012 and later are applied.
Default
12
Example
SQLNET.ALLOWED_LOGON_VERSION_SERVER=12
Related Topics
• Ensuring Against Password Security Threats by Using the 12C Password Version
• Managing Gradual Database Password Rollover for Applications
5-24
Chapter 5
5.2.27 SQLNET.AUTHENTICATION_SERVICES
Use the sqlnet.ora parameter SQLNET.AUTHENTICATION_SERVICES to enable one or more
authentication services.
Purpose
To enable one or more authentication services. If authentication has been installed, then it is
recommended that this parameter be set to either none or to one of the listed authentication
methods.
Usage Notes
When using the SQLNET.AUTHENTICATION_SERVICES value all, the server attempts to
authenticate using each of the following methods. The server falls back to the ones lower on
the list if the ones higher on the list were unsuccessful.
• Authentication based on a service external to the database, such as a service on the
network layer, Kerberos, or RADIUS.
• Authentication based on the operating system user's membership in an administrative
operating system group. Group names are platform-specific. This authentication is
applicable to administrative connections only.
• Authentication performed by the database.
• Authentication based on credentials stored in a directory server.
Operating system authentication allows access to the database using any user name and any
password when an administrative connection is attempted, such as using the AS SYSDBA
clause when connecting using SQL*Plus. An example of a connection is as follows.
sqlplus ignored_username/ignored_password AS SYSDBA
When the operating-system user who issued the preceding command is already a member of
the appropriate administrative operating system group, then the connection is successful.
This is because the user name and password are ignored by the server due to checking the
group membership first.
See Also:
Oracle Database Security Guide for additional information about authentication
methods
Default
all
Note:
When installing the database with Database Configuration Assistant (DBCA), this
parameter may be set to nts in the sqlnet.ora file.
5-25
Chapter 5
Values
Authentication methods available with Oracle Net Services:
• none for no authentication methods, including Microsoft Windows native operating
system authentication. When SQLNET.AUTHENTICATION_SERVICES is set to none, a
valid user name and password can be used to access the database.
• all for all authentication methods.
• beq for native operating system authentication for operating systems other than
Microsoft Windows
• kerberos5 for Kerberos authentication
• nts for Microsoft Windows native operating system authentication
• radius for Remote Authentication Dial-In User Service (RADIUS) authentication
• tcps for TLS authentication
Example
SQLNET.AUTHENTICATION_SERVICES=(kerberos5)
See Also:
5.2.28 SQLNET.CLIENT_REGISTRATION
Purpose
To set a unique identifier for the client computer.
Usage Notes
This identifier is passed to the listener with any connection request, and is included in
the audit trail. The identifier can be any alphanumeric string up to 128 characters long.
Default
None
Example
SQLNET.CLIENT_REGISTRATION=1432
5.2.29 SQLNET.CLOUD_USER
Purpose
To specify a user name for the web server HTTP basic authentication.
5-26
Chapter 5
Usage Notes
When secure websocket protocol is used, the client uses this user as the user name for
authentication. The password for this user should be stored in a wallet using mkstore
commands.
Configuration steps to use HTTP basic authentication with secure websockets:
1. Create wallet using orapki utility.

orapki wallet create -wallet wallet_directory
Example
orapki wallet create -wallet /app/wallet
2. Add web server public certificate.
orapki wallet -wallet wallet_directory -trusted_cert -cert
web_server_public_certificate_in_pem_format
Example
orapki wallet -wallet /app/wallet -trusted_cert -cert server_cert.txt
3. Add web server user name to sqlnet.ora. This user name is only used for authenticating
the web server. This is not a database user name. After web server authentication , the
web server makes connection to the backend database server and usual database
authentication happens.
Example
sqlnet.cloud_user = dbuser1
4. Add web server user password to wallet.
mkstore -wrl wallet_location -createEntry username password
Example
mkstore -wrl /app/wallet -createEntry dbuser1 Secretdb#
5. Make wallet auto login and protect this wallet directory using operating system file
permissions or any other means, so that ONLY database client can have read access to
it. Refer to the operating system utilities for information about changing file permissions.
orapki wallet create -wallet wallet_directory -auto_login
Example
orapki wallet create -wallet /app/wallet -auto_login
6. Update sqlnet.ora with wallet entry.
Example
wallet_location=(SOURCE= (METHOD=file) (METHOD_DATA= (DIRECTORY=/app/

wallet)))
Default
None
5-27
Chapter 5
5.2.30 SQLNET.COMPRESSION
Purpose
To enable or disable data compression. If both the server and client have this
parameter set to ON, then compression is used for the connection.
Note:
The SQLNET.COMPRESSION parameter applies to all database connections,
except for Oracle Data Guard streaming redo and SecureFiles LOBs (Large
Objects).
Default
off
Values
• on to enable data compression.
• off to disable data compression.
Example
SQLNET.COMPRESSION=on
5.2.31 SQLNET.COMPRESSION_ACCELERATION
Purpose
To specify the use of hardware accelerated version of compression using this
parameter if it is available for that platform.
Usage Notes
This parameter can be specified under Oracle Connection Manager alias description.
Default
on
Values
• on
• off
• 0
• 1
Example 5-4 Example

compression_acceleration = on
5-28
Chapter 5
5.2.32 SQLNET.COMPRESSION_LEVELS
Purpose
To specify the compression level.
Usage Notes
The compression levels are used at time of negotiation to verify which levels are used at both
ends, and to select one level.
For Database Resident Connection Pooling (DRCP), only the compression level low is
supported.
Default
low
Values
• low to use low CPU usage and low compression ratio.
• high to use high CPU usage and high compression ratio.
Example
SQLNET.COMPRESSION_LEVELS=(high)
5.2.33 SQLNET.COMPRESSION_THRESHOLD
Purpose
To specify the minimum data size, in bytes, for which compression is needed.
Usage Notes
Compression is not be done if the size of the data to be sent is less than this value.
Default
1024 bytes
Example
SQLNET.COMPRESSION_THRESHOLD=1024
5.2.34 SQLNET.CRYPTO_CHECKSUM_CLIENT
Purpose
To specify the checksum behavior for the client.
5-29
Chapter 5
See Also:
Default
accepted
Values
• accepted to enable the security service if required or requested by the other side.
• rejected to disable the security service, even if required by the other side.
• requested to enable the security service if the other side allows it.
• required to enable the security service and disallow the connection if the other
side is not enabled for the security service.
Example
SQLNET.CRYPTO_CHECKSUM_CLIENT=accepted
5.2.35 SQLNET.CRYPTO_CHECKSUM_SERVER
Purpose
To specify the checksum behavior for the database server.
Default
accepted
Values
Example
SQLNET.CRYPTO_CHECKSUM_SERVER=accepted
See Also:
5-30
Chapter 5
5.2.36 SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT
Purpose
To specify a list of crypto-checksum algorithms for the client to use.
Default
All available algorithms
Values
• MD5 for the RSA Data Security MD5 algorithm.
The MD5 algorithm is deprecated in this release. To transition your Oracle Database
environment to use stronger algorithms, download and install the patch described in My
Oracle Support note 2118136.2.
• SHA1 for the Secure Hash Algorithm.
• SHA256 for SHA-2 uses 256 bits with the hashing algorithm.
Example
SQLNET.CRYPTO_CHECKSUM_TYPES_CLIENT=(SHA256, MD5)
See Also:
5.2.37 SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER
Purpose
To specify a list of crypto-checksum algorithms for the database server to use.
Default
All available algorithms
Values
• MD5 for the RSA Data Security's MD5 algorithm
The MD5 algorithm is deprecated in this release. To transition your Oracle Database
environment to use stronger algorithms, download and install the patch described in My
Oracle Support note 2118136.2.
• SHA1 for the Secure Hash algorithm.
5-31
Chapter 5
Example
SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER=(SHA256, MD5)
See Also:
5.2.38 SQLNET.DBFW_PUBLIC_KEY
Purpose
To provide Oracle Database Firewall public keys to Advanced Security Option (ASO)
by specifying the file that stores the Oracle Database Firewall public keys.
Default
None
Values
Full path name of the operating system file that has the public keys.
Example
SQLNET.DBFW_PUBLIC_KEY="/path_to_file/dbfw_public_key_file.txt"
See Also:
"SQLNET.ENCRYPTION_TYPES_SERVER"
5.2.39 SQLNET.DOWN_HOSTS_TIMEOUT
Purpose
To specify the amount of time in seconds that information about the down state of
server hosts is kept in client process cache.
Usage Notes
Clients discover the down state of server hosts when attempting connections. When a
connection attempt fails, the information about the down state of the server host is
added to the client process cache. Subsequent connection attempts by the same client
process move the down hosts to the end of the address list, thereby reducing the
priority of such hosts. When the time specified by the SQLNET.DOWN_HOSTS_TIMEOUT
5-32
Chapter 5
parameter has passed, the host is purged from the process cache, and its priority in the
address list is restored.
Default
600 seconds (10 minutes)
Values
Any positive integer
Example
SQLNET.DOWN_HOSTS_TIMEOUT=60
5.2.40 SQLNET.ENCRYPTION_CLIENT
The SQLNET.ENCRYPTION_CLIENT networking parameter turns encryption on for the
client.
Purpose
To turn encryption on for the client. Setting the tnsnames.ora parameter
IGNORE_ANO_ENCRYPTION_FOR_TCPS to TRUE disables SQLNET.ENCRYPTION_CLIENT.
Default
accepted
Values
• required to enable the security service and disallow the connection if the other side is
not enabled for the security service.
Example
SQLNET.ENCRYPTION_CLIENT=accepted
See Also:
5-33
Chapter 5
5.2.41 SQLNET.ENCRYPTION_SERVER
The SQLNET.ENCRYPTION_SERVER networking parameter turns encryption on for the
database server.
Purpose
To turn encryption on for the database server. Setting
SQLNET.IGNORE_ANO_ENCRYPTION_FOR_TCPS to FALSE disables
SQLNET.ENCRYPTION_SERVER.
Default
accepted
Values
Example
SQLNET.ENCRYPTION_SERVER=accepted
See Also:
5.2.42 SQLNET.ENCRYPTION_TYPES_CLIENT
Use the sqlnet.ora parameter SQLNET.ENCRYPTION_TYPES_CLIENT to list encryption
algorithms for clients to use.
Purpose
To specify a list of encryption algorithms for clients to use.
Default
All available algorithms.
Values
One or more of the following:
• 3des112 for triple DES with a two-key (112-bit) option
• 3des168 for triple DES with a three-key (168-bit) option
5-34
Chapter 5
• aes128 for AES (128-bit key size)

• des for standard DES (56-bit key size)
• des40 for DES (40-bit key size)
• rc4_40 for RSA RC4 (40-bit key size)
The DES, DES40, 3DES112, 3DES168, RC4_40, RC4_56, RC4_128, and RC4_256 algorithms are
deprecated in this release.
Example
SQLNET.ENCRYPTION_TYPES_CLIENT=(rc4_56)
See Also:
5.2.43 SQLNET.ENCRYPTION_TYPES_SERVER
Use the sqlnet.ora parameter SQLNET.ENCRYPTION_TYPES_SERVER to list the encryption
algorithms for the database to use.
Purpose
To specify a list of encryption algorithms for the database to use.
Default
All available algorithms.
Values
One or more of the following:
• 3des112 for triple DES with a two-key (112-bit) option
• 3des168 for triple DES with a three-key (168-bit) option
5-35
Chapter 5
• des for standard DES (56-bit key size)

• des40 for DES40 (40-bit key size)
The DES, DES40, 3DES112, 3DES168, RC4_40, RC4_56, RC4_128, and RC4_256
To transition your Oracle Database environment to use stronger algorithms,
download and install the patch described in My Oracle Support note 2118136.2.
Example
SQLNET.ENCRYPTION_TYPES_SERVER=(rc4_56, des, ...)
See Also:
5.2.44 SQLNET.EXPIRE_TIME
Purpose
To specify a time interval, in minutes, to send a check to verify that client/server
connections are active.
Usage Notes
Setting a value greater than 0 ensures that connections are not left open indefinitely,
due to an abnormal client termination. If the system supports TCP keepalive tuning,
then Oracle Net Services automatically uses the enhanced detection model, and tunes
the TCP keepalive parameters
If the probe finds a terminated connection, or a connection that is no longer in use,
then it returns an error, causing the server process to exit.
This parameter is primarily intended for the database server, which typically handles
multiple connections at any one time.
Limitations on using this terminated connection detection feature are:
• It is not allowed on bequeathed connections.
• Though very small, a probe packet generates additional traffic that may
downgrade network performance.
• Depending on which operating system is in use, the server may need to perform
additional processing to distinguish the connection probing event from other
events that occur. This can also result in degraded network performance.
5-36
Chapter 5
Default
0
Minimum Value
0
Recommended Value
10
Example
SQLNET.EXPIRE_TIME=10
5.2.45 SQLNET.IGNORE_ANO_ENCRYPTION_FOR_TCPS
The SQLNET.IGNORE_ANO_ENCRYPTION_FOR_TCPS parameter is used on the server-side to
ignore the value set in SQLNET.ENCRYPTION_SERVER for TCPS connections (effectively
disabling ANO encryption on the TCPS listener).
Purpose
Used on the server-side to ignore the value set in SQLNET.ENCRYPTION_SERVER for TCPS
connections (effectively disabling ANO encryption on the TCPS listener).
Usage Notes
If you set the SQLNET.ENCRYPTION_CLIENT parameter on the client to required and
SQLNET.ENCRYPTION_SERVER on the server to required, and if a TCPS listener is used, then
the ORA-12696 Double Encryption Turned On, login disallowed error appears. Starting
with this release, you can set a new parameter, SQLNET.IGNORE_ANO_ENCRYPTION_FOR_TCPS,
to TRUE to ignore the SQLNET.ENCRYPTION_CLIENT or SQLNET.ENCRYPTION_SERVER when there
is a conflict between the use of a TCPS client and these two parameters are set to required.
Default
FALSE
Example 5-5 Example

SQLNET.IGNORE_ANO_ENCRYPTION_FOR_TCPS=TRUE
5.2.46 SQLNET.INBOUND_CONNECT_TIMEOUT
Purpose
To specify the time, in ms, sec, or min, for a client to connect with the database server and
provide the necessary authentication information.
Usage Notes
If the client fails to establish a connection and complete authentication in the time specified,
then the database server terminates the connection. In addition, the database server logs the
IP address of the client and an ORA-12170: TNS:Connect timeout occurred error message
5-37
Chapter 5
to the sqlnet.log file. The client receives either an ORA-12547: TNS:lost contact or
an ORA-12637: Packet receive failed error message.
The default value of this parameter is appropriate for typical usage scenarios.
However, if you need to explicitly set a different value, then Oracle recommends
setting this parameter in combination with the
INBOUND_CONNECT_TIMEOUT_listener_name parameter in the listener.ora file. When
specifying the values for these parameters, note the following recommendations:
• Set both parameters to an initial low value.
• Set the value of the INBOUND_CONNECT_TIMEOUT_listener_name parameter to a
lower value than the SQLNET.INBOUND_CONNECT_TIMEOUT parameter.
It accepts different timeouts with or without space between the value and the unit. In
case, no unit is mentioned, the default unit is sec. For example, you can set
INBOUND_CONNECT_TIMEOUT_listener_name to 2 seconds and
SQLNET.INBOUND_CONNECT_TIMEOUT parameter to 3 seconds. If clients are unable to
complete connections within the specified time due to system or network delays that
are normal for the particular environment, then increment the time as needed.
Default
60 seconds
Example
SQLNET.INBOUND_CONNECT_TIMEOUT=3ms
5.2.47 SQLNET.FALLBACK_AUTHENTICATION
Purpose
To specify whether password-based authentication is going to be attempted if
Kerberos authentication fails. This is relevant for direct connections as well as
database link connections.
Default
FALSE
Example
SQLNET.FALLBACK_AUTHENTICATION=TRUE
See Also:
5-38
Chapter 5
5.2.48 SQLNET.KERBEROS5_CC_NAME
Use the sqlnet.ora parameter SQLNET.KERBEROS5_CC_NAME to specify the complete path
name to the Kerberos credentials cache file.
Purpose
To specify the complete path name to the Kerberos credentials cache file.
Usage Notes
The MSLSA option specifies that the file is on Microsoft Windows and is running Microsoft
KDC.
The OS_MEMORY option specifies that an operating system-managed memory credential is
used for the credential cache file. This option is supported for all operating systems with such
a feature.
Default
/usr/tmp/krbcache on Linux and UNIX operating systems
c:\tmp\krbcache on Microsoft Windows operating systems
Examples
SQLNET.KERBEROS5_CC_NAME=/usr/tmp/krbcache
SQLNET.KERBEROS5_CC_NAME=MSLSA
SQLNET.KERBEROS5_CC_NAME=OS_MEMORY
Note:
If you want to authenticate multiple Kerberos principals, then you can specify
additional Kerberos principals either directly through the connect string or in the
tnsnames.ora file.
Related Topics
• KERBEROS5_PRINCIPAL
Use this parameter to specify Kerberos principals.
5.2.49 SQLNET.KERBEROS5_CLOCKSKEW
Purpose
To specify how many seconds can pass before a Kerberos credential is considered out of
date.
Default
300
5-39
Chapter 5
Example
SQLNET.KERBEROS5_CLOCKSKEW=1200
See Also:
5.2.50 SQLNET.KERBEROS5_CONF
Purpose
To specify the complete path name to the Kerberos configuration file, which contains
the realm for the default Key Distribution Center (KDC) and maps realms to KDC
hosts.
Usage Notes
The KDC maintains a list of user principals and is contacted through the kinit
program for the user's initial ticket.
The AUTO_DISCOVER option allows the automatic discovery of KDC and realms. It is the
default configuration for Kerberos clients. If there are multiple realms to be specified,
then Oracle recommends creating configuration files instead of using the
AUTO_DISCOVER option. This option is supported for all operating systems with such a
feature.
Default
/krb5/krb.conf on Linux and UNIX operating systems
c:\krb5\krb.conf on Microsoft Windows operating systems
Values
• Directory path to krb.conf file
• AUTO_DISCOVER
Example
SQLNET.KERBEROS5_CONF=/krb5/krb.conf
See Also:
5-40
Chapter 5
5.2.51 SQLNET.KERBEROS5_CONF_LOCATION
Purpose
To specify the directory for the Kerberos configuration file. The parameter also specifies the
file is created by the system, and not by the client.
Usage Notes
The configuration file uses DNS lookup to obtain the realm for the default KDC, and maps
realms to the KDC hosts. This option is supported for all operating systems with such a
feature.
Default
/krb5 on Linux and UNIX operating systems
c:\krb5 on Microsoft Windows operating systems
Example
SQLNET.KERBEROS5_CONF_LOCATION=/krb5
5.2.52 SQLNET.KERBEROS5_KEYTAB
Purpose
To specify 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 Linux and UNIX operating systems
c:\krb5\v5srvtab on Microsoft Windows operating systems
Example
SQLNET.KERBEROS5_KEYTAB=/etc/v5srvtab
See Also:
5.2.53 SQLNET.KERBEROS5_REALMS
Purpose
To specify the complete path name to the Kerberos realm translation file, which provides a
mapping from a host name or domain name to a realm.
5-41
Chapter 5
Default
/krb5/krb.realms on Linux and UNIX operating systems
c:\krb5\krb.realms on Microsoft Windows operating systems
Example
SQLNET.KERBEROS5_REALMS=/krb5/krb.realms
See Also:
5.2.54 SQLNET.KERBEROS5_REPLAY_CACHE
Purpose
To specify replay cache is stored in operating system-managed memory on the server,
and that file-based replay cache is not used.
Usage Notes
The OS_MEMORY option specifies the replay cache is stored in operating system-
managed memory on the server, and file-based replay cache is not used.
Example
SQLNET_KERBEROS5_REPLAY_CACHE=OS_MEMORY
5.2.55 SQLNET.OUTBOUND_CONNECT_TIMEOUT
Use the sqlnet.ora parameter SQLNET.OUTBOUND_CONNECT_TIMEOUT to specify the
amount of time, in milliseconds, seconds, or minutes, in which clients must establish
Oracle Net connections to database instances.
Purpose
To specify the time, in ms, sec, or min, for a client to establish an Oracle Net connection
to the database instance.
Usage Notes
If an Oracle Net connection is not established in the time specified, then the connect
attempt is terminated. The client receives an ORA-12170: TNS:Connect timeout
occurred error.
The outbound connect timeout interval is a superset of the TCP connect timeout
interval, which specifies a limit on the time taken to establish a TCP connection.
Additionally, the outbound connect timeout interval includes the time taken to be
connected to an Oracle instance providing the requested service. It accepts different
timeouts with or without space between the value and the unit.
5-42
Chapter 5
Without this parameter, a client connection request to the database server may block for the
default TCP connect timeout duration (60 seconds) when the database server host system is
unreachable. In case, no unit is mentioned, the default unit is sec.
The outbound connect timeout interval is only applicable for TCP, TCP with TLS, and IPC
transport connections.
This parameter is overridden by the CONNECT_TIMEOUT parameter in the address
description.
Default
None
Example
SQLNET.OUTBOUND_CONNECT_TIMEOUT=10 ms
5.2.56 SQLNET.RADIUS_ALTERNATE
Purpose
To specify an alternate RADIUS server to use in case the primary server is unavailable.
Usage Notes
The value can be either the IP address or host name of the server.
Default
None
Example
SQLNET.RADIUS_ALTERNATE=radius2
See Also:
5.2.57 SQLNET.RADIUS_ALTERNATE_PORT
Purpose
To specify the listening port of the alternate RADIUS server.
Default
1645
Example
SQLNET.RADIUS_ALTERNATE_PORT=1667
5-43
Chapter 5
See Also:
5.2.58 SQLNET.RADIUS_ALTERNATE_RETRIES
Purpose
To specify the number of times the database server should resend messages to the
alternate RADIUS server.
Default
3
Example
SQLNET.RADIUS_ALTERNATE_RETRIES=4
See Also:
5.2.59 SQLNET.RADIUS_AUTHENTICATION
Purpose
To specify the location of the primary RADIUS server, either by its host name or IP
address.
Default
Local host
Example
SQLNET.RADIUS_AUTHENETICATION=officeacct
See Also:
5-44
Chapter 5
5.2.60 SQLNET.RADIUS_AUTHENTICATION_INTERFACE
Purpose
To specify the class containing the user interface used to interact with the user.
Default
DefaultRadiusInterface
Example
SQLNET.RADIUS_AUTHENTICATION_INTERFACE=DefaultRadiusInterface
See Also:
5.2.61 SQLNET.RADIUS_AUTHENTICATION_PORT
Purpose
To specify the listening port of the primary RADIUS server.
Default
1645
Example
SQLNET.RADIUS_AUTHENTICATION_PORT=1667
See Also:
5.2.62 SQLNET.RADIUS_AUTHENTICATION_RETRIES
Purpose
To specify the number of times the database server should resend messages to the primary
RADIUS server.
Default
3
5-45
Chapter 5
Example
SQLNET.RADIUS_AUTHENTICATION_RETRIES=4
See Also:
5.2.63 SQLNET.RADIUS_AUTHENTICATION_TIMEOUT
Purpose
To specify the time, in seconds, that the database server should wait for a response
from the primary RADIUS server.
Default
5
Example
SQLNET.RADIUS_AUTHENTICATION_TIMEOUT=10
See Also:
5.2.64 SQLNET.RADIUS_CHALLENGE_RESPONSE
Purpose
To turn challenge response on or off.
Default
off
Values
on | off
Example
SQLNET.RADIUS_CHALLENGE_RESPONSE=on
5-46
Chapter 5
See Also:
5.2.65 SQLNET.RADIUS_SECRET
Purpose:
To specify the location of the RADIUS secret key.
Default
The ORACLE_HOME/network/security/radius.key file.
Example
SQLNET.RADIUS_SECRET=oracle/bin/admin/radiuskey
See Also:
5.2.66 SQLNET.RADIUS_SEND_ACCOUNTING
Purpose
To turn accounting on and off. If enabled, then packets are sent to the active RADIUS server
at listening port plus one.
Usage Notes
The default port is 1646.
Default
off
Values
on | off
Example
SQLNET.RADIUS_SEND_ACCOUNTING=on
5-47
Chapter 5
See Also:
5.2.67 SQLNET.RECV_TIMEOUT
Use the sqlnet.ora parameter SQLNET.RECV_TIMEOUT to specify the duration of time
that a database client or server should wait for data from a peer after establishing a
connection.
Purpose
To specify the time for a database client or server to wait for data from the peer after
establishing a connection. The peer must send some data within the time interval.
You can specify the time in hours, minutes, seconds, or milliseconds by using the hr,
min, sec, or ms keyword respectively. If you do not specify a unit of measurement, then
the default unit is sec.
Usage Notes
Setting this parameter for clients ensure that receive operation is not left in wait state
indefinitely or for a long period due to an abnormal termination of server process or
server busy state. If a client does not receive response data in time specified, then it
logsORA-12535: TNS:operation timed out and ORA-12609: TNS: Receive timeout
occurred messages to the sqlnet.log file. If you choose to set the value, then set the
value to an initial low value and adjust according to the system and network capacity. If
necessary, use this parameter with the SQLNET.SEND_TIMEOUT parameter.
You can also set this parameter on the server-side to specify the time, in ms, sec, or
min, for a server to wait for client data after connection establishment. If a client does
not send any data in time specified, then the database server logs ORA-12535:
TNS:operation timed out and ORA-12609: TNS: Receive timeout occurred
messages to the sqlnet.log file. Without this parameter, the database server may
continue to wait for data from clients that may be down or are experiencing difficulties.
The server usually blocks on input from the client and gets these timeouts frequently if
set to a low value.
Default Value
None
Minimum Value
1 ms
Recommended Value
Any number greater than the minimum value of 1 ms up to 4294967295 ms.
Example
SQLNET.RECV_TIMEOUT=10 ms
5-48
Chapter 5
Related Topics
5.2.68 SQLNET.SEND_TIMEOUT
Use the sqlnet.ora parameter SQLNET.SEND_TIMEOUT to specify the duration of time for a
database server to complete a send operation to clients after establishing a connection.
Purpose
To specify the time for a database server to complete a send operation to clients after
establishing a connection.
You can specify the time in hours, minutes, seconds, or milliseconds by using the hr, min,
sec, or ms keyword respectively. If you do not specify a unit of measurement, then the default
unit is sec.
Usage Notes
Setting this parameter is recommended for environments in which clients shut down
occasionally or abnormally.
If the database server cannot complete a send operation in the time specified, then it logs
ORA-12535: TNS:operation timed out and ORA-12608: TNS: Send timeout occurred
messages to the sqlnet.log file. Without this parameter, the database server may continue
to send responses to clients that are unable to receive data due to a downed computer or a
busy state.
You can also set this parameter on the client-side to specify the time, in ms, sec, or min , for a
client to complete send operations to the database server after connection establishment. It
accepts different timeouts with or without space between the value and the unit.Without this
parameter, the client may continue to send requests to a database server already saturated
with requests. If you choose to set the value, then set the value to an initial low value and
adjust according to system and network capacity.
If necessary, use this parameter with the SQLNET.RECV_TIMEOUT parameter.
Default Value
None
Minimum Value
1 ms
Recommended Value
Example
SQLNET.SEND_TIMEOUT=3 ms
Related Topics
5-49
Chapter 5
5.2.69 SQLNET.URI
SQLNET.URI networking parameter of the sqlnet.ora file specifies a database client
URI mapping on the web server.
Purpose
To specify a database client URI mapping on the web server.
Usage Notes
You can use this parameter to customize URI for mapping the database websocket
requests coming onto web server to the backend database server. Secure websocket
handshaking requests are sent with this URI.
Default
/sqlnet
Example 5-6 Example

sqlnet.uri="/my_uri_prefix/database/"
5.2.70 SQLNET.USE_HTTPS_PROXY
Purpose
To enable forward HTTP proxy tunneling client connections.
Usage Notes
If turned on, the clients can tunnel secure connections over forward HTTP proxy using
HTTP CONNECT method. This helps in accessing the public cloud database service
as it eliminates the requirement to open an outbound port on a client side firewall.
This parameter is applicable with Oracle Connection Manager on the server side.
Default
on
Example
SQLNET.USE_HTTPS_PROXY=on
5.2.71 SQLNET.WALLET_OVERRIDE
OracleMetaLink note 340559.1.
Purpose
To determine whether the client should override the strong authentication credential
with the password credential in the stored wallet to log in to the database.
5-50
Chapter 5
Usage Notes
When wallets are used for authentication, the database credentials for user name and
password are securely stored in an Oracle wallet. The auto-login feature of the wallet is
turned on so the database does not need a password to open the wallet. From the wallet, the
database gets the credentials to access the database for the user.
Wallet usage can simplify large-scale deployments that rely on password credentials for
connecting to databases. When this feature is configured, application code, batch jobs, and
scripts do not need embedded user names and passwords. Risk is reduced because such
passwords are no longer exposed in the clear, and password management policies are more
easily enforced without changing application code whenever user names or passwords
change.
Users connect using the connect /@database_name command instead of specifying a user
name and password explicitly. This simplifies the maintenance of the scripts and secures the
password management for the applications.
Middle-tier applications create an Oracle Applications wallet at installation time to store the
application's specific identity. The password may be randomly generated rather than
hardcoded. When an Oracle application accesses the database, it sets appropriate values for
SQLNET.AUTHENTICATION_SERVICES and WALLET_LOCATION. The new wallet-based password
authentication code uses the password credential in the Oracle Applications wallet to log on
to the database.
Values
true | false
Examples
SQLNET.WALLET_OVERRIDE=true
See Also:
In order to use wallets, a wallet must be configured on the client. Refer to Oracle
Database Security Guide for additional information about configuring the clients.
5.2.72 SSL_CERT_REVOCATION
Use the sqlnet.ora parameter SSL_CERT_REVOCATION to configure revocation checks for
certificates.
Purpose
To configure a revocation check for a certificate.
See Also:
5-51
Chapter 5
Default
none
Values
• none disables certificate revocation status checking. This is the default value.
Note:
Oracle recommends that you do not set the SSL_CERT_REVOCATION
parameter to none because this removes a critical component in
certificate-based authentication. Without certificate revocation status
checking, you cannot protect against stolen certificates that are used for
authentication. Set the none value only in cases where mitigating
controls safeguard the use of certificates for authentication, such as
network access control lists or Oracle Database Vault policies that limit
the database connection to trusted clients.
• requested to perform certificate revocation in case a Certificate Revocation List

(CRL) is available. Reject TLS connection if the certificate is revoked. If no
appropriate CRL is found to determine the revocation status of the certificate and
the certificate is not revoked, then accept the TLS connection.
• required to perform certificate revocation when a certificate is available. If a
certificate is revoked and no appropriate CRL is found, then reject the TLS
connection. If no appropriate CRL is found to ascertain the revocation status of the
certificate and the certificate is not revoked, then accept the TLS connection.
Example
SSL_CERT_REVOCATION=required
5.2.73 SSL_CRL_FILE
Purpose
To specify the name of the file where you can assemble the CRL for client
authentication.
Usage Notes
This file contains the PEM-encoded CRL files, in order of preference. You can use this
file alternatively or in addition to the SSL_CERT_PATH parameter. This parameter is
only valid if SSL_CERT_REVOCATION is set to either requested or required.
Default
None
Example
SSL_CRL_FILE=
5-52
Chapter 5
5.2.74 SSL_CRL_PATH
Purpose
To specify the destination directory of the CRL of CA.
Usage Notes
The files in this directory are hashed symbolic links created by Oracle Wallet Manager.
This parameter is only valid if SSL_CERT_REVOCATION is set to either requested or
required.
Default
None
Example
SSL_CRL_PATH=
5.2.75 SSL_CIPHER_SUITES
Use the sqlnet.ora parameter SSL_CIPHER_SUITES to control which combination of
encryption and data integrity that Transport Layer Security (TLS) uses.
Purpose
To control which combination of encryption and data integrity is used by Transport Layer
Security (TLS). Cipher suites that use Advanced Encryption Standard (AES) only work with
Transport Layer Security (TLS 1.0).
Default
None
Values
• SSL_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
• SSL_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
• SSL_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
• SSL_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
• SSL_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
• SSL_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
• SSL_RSA_WITH_AES_128_CBC_SHA256
• SSL_RSA_WITH_AES_128_GCM_SHA256
• SSL_RSA_WITH_AES_128_CBC_SHA
• SSL_RSA_WITH_AES_256_CBC_SHA
• SSL_RSA_WITH_AES_256_CBC_SHA256
5-53
Chapter 5
• SSL_RSA_WITH_AES_256_GCM_SHA384
• SSL_RSA_WITH_RC4_128_MD5
• SSL_RSA_WITH_RC4_128_SHA
• SSL_RSA_WITH_3DES_EDE_CBC_SHA
• SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
• SSL_DH_anon_WITH_RC4_128_MD5
Note:
SSL_DH_anon_WITH_3DES_EDE_CBC_SHA and SSL_DH_anon_WITH_RC4_128_MD5
do not the provide authentication of the communicating parties, and can be
vulnerable to man-in-the-middle attacks. Oracle recommends that you do not
use these cipher suites to protect sensitive data. However, they are useful if
the communicating parties want to remain anonymous or simply do not want
the overhead caused by mutual authentication.
Example
SSL_CIPHER_SUITES=(ssl_rsa_with_aes_128_cbc_sha256)
See Also:
Oracle Database Security Guide for additional information about cipher suite
values
5.2.76 SSL_EXTENDED_KEY_USAGE
Purpose
To specify the purpose of the key in the certificate.
Usage Notes
When this parameter is specified, the certificate with the matching extended key is
used.
Values
client authentication
Example
SSL_EXTENDED_KEY_USAGE="client authentication"
5-54
Chapter 5
5.2.77 SSL_SERVER_DN_MATCH
Purpose
To enforce server-side certification validation through distinguished name (DN) matching.
Usage Notes
If you enforce the DN matching, in addition to verifying the server's certificate chain, the client
performs another check through DN matching. There are two flavors of DN matching. Partial
DN matching happens if the server's CN contains its host name. Complete DN matching
happens against the server's complete DN. Not enforcing the match allows the server to
potentially fake its identity. This parameter must be set to TRUE to do both full or partial DN
matching
In addition to the sqlnet.ora file, configure the tnsnames.ora parameter
SSL_SERVER_CERT_DN to enable full DN matching.
Default
no
Values
• yes | on | true to enforce a match. If the DN matches the service name, then the
connection succeeds. If the DN does not match the service name, then the connection
fails.
• no | off | false to not enforce a match. If the DN does not match the service name, then
the connection is successful, but an error is logged to the sqlnet.log file.
Example
SSL_SERVER_DN_MATCH=yes
See Also:
5.2.78 SSL_VERSION
Use the SSL_VERSION parameter to limit the valid Transport Layer Security (TLS) versions that
Oracle uses for connections.
Purpose
To limit allowable TLS versions used for connections.
5-55
Chapter 5
Usage Notes
Clients and database servers must use a compatible version. This parameter should
only be used when absolutely necessary for backward compatibility. The current
default uses TLS version 1.2 which is the version required for multiple security
compliance requirements.
If you set SSL_VERSION to undetermined, then by default it uses 3.0.
Default
1.2
Values
Note:
The sqlnet.ora parameter ADD_SSLV3_TO_DEFAULT has no impact on this
parameter.
undetermined | 3.0 | 1.0| 1.1 | 1.2
If you want to specify one version or another version, then use “or”. The following
values are permitted:
1.0 or 3.0 | 1.2 or 3.0 | 1.1 or 1.0 | 1.2 or 1.0 | 1.2 or 1.1 | 1.1 or 1.0 or
3.0 |
1.2 or 1.0 or 3.0 | 1.2 or 1.1 or 1.0 | 1.2 or 1.1 or 3.0 |1.2 or 1.1 or 1.0 or
3.0
Example
SSL_VERSION=1.2
The remaining version numbers correspond to the TLS versions, such as, TLSv1.0,
TLSv1.1, and TLSv1.2.
See Also:
5.2.79 TCP.CONNECT_TIMEOUT
Purpose
To specify the time, in ms, sec, or min, for a client to establish a TCP connection
(PROTOCOL=tcp in the TNS connect address) to the database server.
5-56
Chapter 5
Usage Notes
If a TCP connection to the database host is not established in the specified time, then the
connection attempt is terminated. The client receives an ORA-12170: TNS:Connect timeout
occurred error.
The timeout applies to each IP address that resolves to a host name. It accepts different
timeouts with or without space between the value and the unit. For example, if a host name
resolves to an IPv6 and an IPv4 address, and if the host is not reachable through the
network, then the connection request times out twice because there are two IP addresses. In
this example, the default timeout setting of 60 causes a timeout in 120 seconds. In case, no
unit is mentioned, the default unit is sec.
Default
60
Example
TCP.CONNECT_TIMEOUT=10 ms
5.2.80 TCP.EXCLUDED_NODES
Purpose
To specify which clients are denied access to the database.
Usage Notes
This parameter is only valid when the TCP.VALIDNODE_CHECKING parameter is set to yes.
This parameter can use wildcards for IPv4 addresses and CIDR notation for IPv4 and IPv6
addresses.
Syntax
TCP.EXCLUDED_NODES=(hostname | ip_address, hostname | ip_address, ...)
Example
TCP.EXCLUDED_NODES=(finance.us.example.com, mktg.us.example.com, 192.0.2.25,
172.30.*, 2001:DB8:200C:417A/32)
5.2.81 TCP.INVITED_NODES
Purpose
To specify which clients are allowed access to the database. This list takes precedence over
the TCP.EXCLUDED_NODES parameter if both lists are present.
Syntax
TCP.INVITED_NODES=(hostname | ip_address, hostname | ip_address, ...)
5-57
Chapter 5
Usage Notes
• This parameter is only valid when the TCP.VALIDNODE_CHECKING parameter is
set to yes.
• This parameter can use wildcards for IPv4 addresses and CIDR notation for IPv4
and IPv6 addresses.
Example
TCP.INVITED_NODES=(sales.us.example.com, hr.us.example.com, 192.0.*,
2001:DB8:200C:433B/32)
5.2.82 TCP.NODELAY
Purpose
To preempt delays in buffer flushing within the TCP/IP protocol stack.
Default
yes
Values
yes | no
Example
TCP.NODELAY=yes
5.2.83 TCP.QUEUESIZE
Purpose
To configure the maximum length of the queue for pending connections on a TCP
listening socket.
Default
System-defined maximum value. The defined maximum value for Linux is 128.
Values
Any integer value up to the system-defined maximum.
Examples
TCP.QUEUESIZE=100
5.2.84 TCP.VALIDNODE_CHECKING
Purpose
To enable and disable valid node checking for incoming connections.
5-58
Chapter 5
Usage Notes
If this parameter is set to yes, then incoming connections are allowed only if they originate
from a node that conforms to list specified by TCP.INVITED_NODES or
TCP.EXCLUDED_NODES parameters.
The TCP.INVITED_NODES and TCP.EXCLUDED_NODES parameters are valid only when
the TCP.VALIDNODE_CHECKING parameter is set to yes.
This parameter and the depending parameters, TCP.INVITED_NODES and

TCP.EXCLUDED_NODES must be set in the sqlnet.ora file of the listener. This is important
in an Oracle RAC environment where the listener runs out of the Oracle Grid Infrastructure
home. Setting the parameter in the database home does not have any effect in Oracle RAC
environments. In such environments, the address of all Single Client Access Name (SCANs),
Virtual IPs (VIPs), local IP must be included in the TCP.INVITED_NODES list.
In VLAN environments, the sqlnet.ora file present in the Oracle Grid Infrastructure home
should include all the addresses of all the VLANs. The VLANs perform the network
segregation, whereas the INVITED_NODES allows or restricts access to databases within
the VLANs.
If multiple databases within the same VLAN require different INVITED_NODE lists, then
separate listeners are required.
Default
no
Values
yes | no
Example
TCP.VALIDNODE_CHECKING=yes
5.2.85 TNSPING.TRACE_DIRECTORY
Purpose
To specify the destination directory for the TNSPING utility trace file, tnsping.trc.
Default
The ORACLE_HOME/network/trace directory.
Example
TNSPING.TRACE_DIRECTORY=/oracle/traces
5.2.86 TNSPING.TRACE_LEVEL
Purpose
To turn TNSPING utility tracing on at a specified level or to turn it off.
5-59
Chapter 5
Default
off
Values
Example
TNSPING.TRACE_LEVEL=admin
5.2.87 TOKEN_AUTH
Purpose
To configure token-based authentication for IAM users on the Oracle Autonomous
Database instances. This method enforces strong authentication, which enables IAM
users to use a database token (db-token) from IAM for a client connection. This token
is a unique string of characters that you can request from IAM using Oracle Cloud
Infrastructure (OCI) Command Line Interface (CLI).
Usage Notes
• You can specify the TOKEN_AUTH setting in the connect string under the SECURITY
section of the tnsnames.ora file. Alternatively, you can specify this parameter in
the sqlnet.ora file. The parameter value specified in the connect string takes
precedence over the value specified in the sqlnet.ora file.
• With this connection method, you use one of the IAM user credentials, such as
API-key, security token, resource principal, instance principal, or delegation token
to retrieve the db-token and private key from IAM.
• When an IAM user logs in using /@connect_identifier, then the TOKEN_AUTH
setting (TOKEN_AUTH=OCI_TOKEN) instructs the database client to get the db-token
and private key files from either the default directory or the location specified by
TOKEN_LOCATION.
When an IAM user logs in using the IAM user name and IAM database password
instead of /@connect_identifier, then the database client initiates the login
without retrieving a token (using IAM database password authentication).
• If your client application is updated to work with IAM, then you can override the
TOKEN_AUTH setting. In this case, IAM directly passes the db-token and private key
to the database client using the client API as an attribute. When the client receives
this request, the client signs the db-token with the private key and sends it to the
database.
5-60
Chapter 5
• The general token-based authentication process is as follows:

1. An IAM user or application in OCI first requests the db-token from IAM by using API-
key, security token, resource principal, instance principal, or delegation token
(delegation token is available only in the Cloud Shell).
To use a security token, you need to generate it by completing the browser
authentication process and then request the db-token using that security token. If the
IAM policy that authorizes you to be issued the db-token exists, then the db-token is
returned.
You request the db-token using OCI CLI (or OCI SDK for applications). For example,
run the following OCI CLI command to request the db-token by using an API-key
(apikey):
$ oci iam db-token get --profile scott
The profile flag specifies the profile for which you want to access the IAM user
credentials and retrieve the db-token.
2. OCI CLI references the config file (that stores your IAM user credentials as part of
the profile) and makes a call to IAM to get the db-token. The db-token and private
key files are written at the default or specified token location.
If an application is updated to work with IAM, it then passes the db-token and private
key directly to the database client through the client API as an attribute.
You can specify the TOKEN_LOCATION parameter to override the default directory
where the db-token and private key files are stored.
3. The database client signs the db-token with the private key and sends it to the
database. The database verifies the db-token, gets the group membership
information for the user, and completes the login.
Default
None
Value
TOKEN_AUTH=OCI_TOKEN
Examples
• In the tnsnames.ora file:
net_service_name=
(DESCRIPTION =
(ADDRESS=(PROTOCOL=tcps)(HOST=sales-svr)(PORT=1521))
(SECURITY=(SSL_SERVER_DN_MATCH=TRUE)
(SSL_SERVER_CERT_DN="C=US,O=example,CN=OracleContext")
(TOKEN_AUTH=OCI_TOKEN))
(CONNECT_DATA=(SERVICE_NAME=sales.us.example.com))
)
5-61
Chapter 5
• In the sqlnet.ora file:
In these examples, the optional TOKEN_LOCATION parameter is not specified. Thus, the
db-token and private key files are written at the default token location.
Related Topics
• Using Oracle Autonomous Database on Shared Exadata Infrastructure
• Oracle Cloud Infrastructure CLI Command Reference
• TOKEN_LOCATION
Use the TOKEN_LOCATION parameter in the tnsnames.ora or sqlnet.ora file to
override the default directory where the db-token and private key are stored. You
use this parameter while configuring token-based authentication for Oracle Cloud
Infrastructure (OCI) Identity and Access Management (IAM) users on an Oracle
Autonomous Database.
5.2.88 TOKEN_LOCATION
Database.
Purpose
To override the default directory where the db-token and private key are stored during
IAM token-based authentication. This location is used by the database client to
retrieve the db-token and private key from IAM.
Usage Notes
This is an optional parameter. Use this parameter along with the TOKEN_AUTH
parameter while configuring IAM token-based authentication. You can specify these
parameters in the connect string under the SECURITY section of the tnsnames.ora file.
Alternatively, you can specify these parameters in the sqlnet.ora file. The parameter
values specified in the connect string takes precedence over the values specified in
the sqlnet.ora file.
When an IAM user initiates a connection using /@connect_identifier, the database

client retrieves the db-token and private key from either the default directory or the
location specified by TOKEN_LOCATION, signs the db-token using the private key, and
sends the db-token to the database.
Default
On Linux: /home/username/.oci/db-token
Value
TOKEN_LOCATION="token_file_directory"
5-62
Chapter 5
Examples
net_service_name=
(DESCRIPTION =
(TOKEN_AUTH=OCI_TOKEN)(TOKEN_LOCATION="/home/dbuser1/.oci/db-token"))
)
TOKEN_LOCATION="/home/dbuser1/.oci/db-token"
Related Topics
• TOKEN_AUTH
5.2.89 USE_CMAN
Purpose
To specify client routing to Oracle Connection Manager.
Usage Notes
If set to true, then the parameter routes the client to a protocol address for Oracle
Connection Manager.
If set to false, then the client picks one of the address lists at random and fails over to the
other address list if the chosen ADDRESS_LIST fails. With USE_CMAN=true, the client always
uses the first address list.
If no Oracle Connection Manager addresses are available, then connections are routed
through any available listener address.
Default
false
Values
true | false
5-63
Chapter 5
Example
USE_CMAN=true
5.2.90 USE_DEDICATED_SERVER
Purpose
To append (SERVER=dedicated) to the CONNECT_DATA section of the connect descriptor
used by the client.
Usage Notes
It overrides the current value of the SERVER parameter in the tnsnames.ora file.
If set to on, then the parameter USE_DEDICATED_SERVER automatically appends

(SERVER=dedicated) to the connect data for a connect descriptor. This way
connections from this client use a dedicated server process, even if shared server is
configured.
Default
off
Values
• on to append (SERVER=dedicated)
• off to send requests to existing server processes
Example
USE_DEDICATED_SERVER=on
See Also:
Oracle Database Net Services Administrator's Guide for complete
configuration information
5.2.91 WALLET_LOCATION
Use the sqlnet.ora parameter WALLET_LOCATION to specify the location of Oracle
wallets.
Purpose
To specify the location of Oracle wallets. Wallets are certificates, keys, and trustpoints
processed by Transport Layer Security (TLS).
Usage Notes
• The key/value pair for Microsoft certificate store (MCS) omits the METHOD_DATA
parameter because MCS does not use wallets. Instead, Oracle PKI (public key
5-64
Chapter 5
infrastructure) applications obtain certificates, trustpoints and private keys directly from
the user's profile.
• If an Oracle wallet is stored in the Microsoft Windows registry and the wallet's key (KEY) is
SALESAPP, then the storage location of the encrypted wallet is
HKEY_CURRENT_USER\SOFTWARE\ORACLE\WALLETS\SALESAPP\EWALLET.P12. The storage
location of the decrypted wallet is
HKEY_CURRENT_USER\SOFTWARE\ORACLE\WALLETS\SALESAPP\CWALLET.SSO.
• The WALLET_LOCATION parameter is optional for TLS connections that do not use a client
wallet. In this case, the database server certificate needs to be signed by a trusted root
certificate that is already installed in the client system's default certificate store. If you do
not set this parameter in the sqlnet.ora file or connect string, then the driver picks up
common root certificates from the system's default certificate store.
While configuring a TLS connection without a client wallet, you can set the
WALLET_LOCATION parameter to specify the server and listener wallet locations. The
server and listener wallets exist in the default locations defined by the WALLET_ROOT
system parameter or the WALLET_LOCATION sqlnet.ora parameter.
You can override the sqlnet.ora WALLET_LOCATION setting using the
MY_WALLET_DIRECTORY=SYSTEM syntax in the connect string (in the tnsnames.ora file or
directly to the command line). The database client then uses common root certificates
from the client system's default certificate store instead of a client wallet, even if the
WALLET_LOCATION parameter is set in the sqlnet.ora file:
net_service_name=
(DESCRIPTION =
(ADDRESS=(PROTOCOL=tcps)(HOST=host_name)(PORT=1234))
(SECURITY=(MY_WALLET_DIRECTORY=SYSTEM))
(CONNECT_DATA=(SERVICE_NAME=service_name))
)
Syntax
The syntax depends on the wallet, as follows:
• Oracle wallets on the file system:
WALLET_LOCATION=
(SOURCE=
(METHOD=file)
(METHOD_DATA=
(DIRECTORY=directory)
[(PKCS11=TRUE/FALSE)]))
• Microsoft certificate store:

WALLET_LOCATION=
(SOURCE=
(METHOD=mcs))
• Oracle wallets in the Microsoft Windows registry:

WALLET_LOCATION=
(SOURCE=
(METHOD=reg)
(METHOD_DATA=
(KEY=registry_key)))
5-65
Chapter 5
• Entrust wallets:
WALLET_LOCATION=
(SOURCE=
(METHOD=entr)
(METHOD_DATA=
(PROFILE=file.epf)
(INIFILE=file.ini)))
Additional Parameters
WALLET_LOCATION supports the following parameters:
• SOURCE: The type of storage for wallets, and storage location.

• METHOD: The type of storage.
• METHOD_DATA: The storage location.
• DIRECTORY: The location of Oracle wallets on file system.
• KEY: The wallet type and location in the Microsoft Windows registry.
• PROFILE: The Entrust profile file (.epf).
• INIFILE: The Entrust initialization file (.ini).
Default
None
Values
true | false
Examples
Oracle wallets on file system:
WALLET_LOCATION=
(SOURCE=
(METHOD=file)
(METHOD_DATA=
(DIRECTORY=/etc/oracle/wallets/databases)))
Microsoft certificate store:

WALLET_LOCATION=
(SOURCE=
(METHOD=mcs))
Oracle Wallets in the Microsoft Windows registry:

WALLET_LOCATION=
(SOURCE=
(METHOD=REG)
(METHOD_DATA=
(KEY=SALESAPP)))
Entrust Wallets:
WALLET_LOCATION=
(SOURCE=
5-66
Chapter 5
ADR Diagnostic Parameters in sqlnet.ora
(METHOD=entr)
(METHOD_DATA=
(PROFILE=/etc/oracle/wallets/test.epf)
(INIFILE=/etc/oracle/wallets/test.ini)))
Related Topics
• Oracle Database Enterprise User Security Administrator's Guide
5.3 ADR Diagnostic Parameters in sqlnet.ora

sqlnet.ora.
• About ADR Diagnostic Parameters

You can use ADR diagnostic parameters when ADR is enabled. ADR is enabled by
default. Non-ADR parameters listed in the sqlnet.ora file are ignored when ADR is
enabled.
• ADR_BASE
It is a diagnostic parameter in the sqlnet.ora file and it specifies the base location of the
ADR files.
• DIAG_ADR_ENABLED
DIAG_ADR_ENABLED diagnostic parameter of the sqlnet.ora file specifies whether ADR
tracing is enabled.
• TRACE_LEVEL_CLIENT
The TRACE_LEVEL_CLIENT diagnostic parameter of the sqlnet.ora file turns client tracing
on or off at a specified level.
• TRACE_LEVEL_SERVER
The TRACE_LEVEL_SERVER diagnostic parameter of the sqlnet.ora file turns server tracing
on or off at a specified level.
• TRACE_TIMESTAMP_CLIENT
The TRACE_TIMESTAMP_CLIENT diagnostic parameter of the sqlnet.ora file adds a time
stamp to every trace event in the client trace file.
• TRACE_TIMESTAMP_SERVER
stamp to every trace event in the database server trace file.
5.3.1 About ADR Diagnostic Parameters

You can use ADR diagnostic parameters when ADR is enabled. ADR is enabled by default.
Non-ADR parameters listed in the sqlnet.ora file are ignored when ADR is enabled.
Since Oracle Database 11g, Oracle Database includes an advanced fault diagnosability
infrastructure for preventing, detecting, diagnosing, and resolving problems. The problems
are critical errors such as those caused by database code bugs, metadata corruption, and
customer data corruption.
When a critical error occurs, it is assigned an incident number, and diagnostic data for the
error, such as traces and dumps, are immediately captured and tagged with the incident
5-67
Chapter 5
number. The data is then stored in the Automatic Diagnostic Repository (ADR), a file-
based repository outside the database.
The following sqlnet.ora parameters are used when ADR is enabled (when
DIAG_ADR_ENABLED is set to on):
5.3.2 ADR_BASE
It is a diagnostic parameter in the sqlnet.ora file and it specifies the base location of
the ADR files.
Purpose
To specify the base directory into which tracing and logging incidents are stored when
ADR is enabled.
Usage Notes
This parameter is applicable only to clients. On the server side, the ADR base location
is defined by the DIAGNOSTIC_DEST initialization parameter in the init.ora file. See
DIAGNOSTIC_DEST in Oracle Database Reference.
Default
ORACLE_BASE or ORACLE_HOME/log (if ORACLE_BASE is not defined)
Values
Any valid directory path to a directory with write permission.
Example
ADR_BASE=/oracle/network/trace
5.3.3 DIAG_ADR_ENABLED
DIAG_ADR_ENABLED diagnostic parameter of the sqlnet.ora file specifies whether ADR
tracing is enabled.
Purpose
To specify whether ADR tracing is enabled.
Usage Notes
If the DIAG_ADR_ENABLED parameter is set to OFF, then non-ADR file tracing is used.
Default
on
Values
on | off
Example 5-7 Example

DIAG_ADR_ENABLED=on
5-68
Chapter 5
5.3.4 TRACE_LEVEL_CLIENT
The TRACE_LEVEL_CLIENT diagnostic parameter of the sqlnet.ora file turns client tracing on
or off at a specified level.
Purpose
To turn client tracing on at a specified level or to turn it off.
Usage Notes
This parameter is also applicable when non-ADR tracing is used.
Default
off or 0
Values
• off or 0 for no trace output
• user or 4 for user trace information
• admin or 10 for administration trace information
• support or 16 for Oracle Support Services trace information
Example
TRACE_LEVEL_CLIENT=user
5.3.5 TRACE_LEVEL_SERVER
The TRACE_LEVEL_SERVER diagnostic parameter of the sqlnet.ora file turns server tracing on
or off at a specified level.
Purpose
To turn server tracing on at a specified level or to turn it off.
Usage Notes
Default
off or 0
Values
5-69
Chapter 5
Example
TRACE_LEVEL_SERVER=admin
5.3.6 TRACE_TIMESTAMP_CLIENT
stamp to every trace event in the client trace file.
Purpose
To add a time stamp in the form of dd-mmm-yyyy hh:mm:ss:mil to every trace event in
the client trace file, which has a default name of sqlnet.trc.
Usage Notes
Default
on
Values
on or true | off or false
Example
TRACE_TIMESTAMP_CLIENT=true
5.3.7 TRACE_TIMESTAMP_SERVER
stamp to every trace event in the database server trace file.
Purpose
To add a time stamp in the form of dd-mmm-yyyy hh:mm:ss:mil to every trace event in
the database server trace file, which has a default name of svr_pid.trc.
Usage Notes
Default
on
Values
on or true | off or false
Example
TRACE_TIMESTAMP_SERVER=true
5-70
Chapter 5
Non-ADR Diagnostic Parameters in sqlnet.ora
5.4 Non-ADR Diagnostic Parameters in sqlnet.ora

This section lists the sqlnet.ora parameters used when ADR is disabled.
Note:
The default value of DIAG_ADR_ENABLED is on. Therefore, the DIAG_ADR_ENABLED
parameter must explicitly be set to off in order for non-ADR tracing to be used.
• LOG_DIRECTORY_CLIENT
The LOG_DIRECTORY_CLIENT non-ADR diagnostic parameter of the sqlnet.ora file
specifies the destination directory for the client log file.
• LOG_DIRECTORY_SERVER
• LOG_FILE_CLIENT
• LOG_FILE_SERVER
• TRACE_DIRECTORY_CLIENT
• TRACE_DIRECTORY_SERVER
• TRACE_FILE_CLIENT
• TRACE_FILE_SERVER
• TRACE_FILEAGE_CLIENT
• TRACE_FILEAGE_SERVER
• TRACE_FILELEN_CLIENT
• TRACE_FILELEN_SERVER
• TRACE_FILENO_CLIENT
• TRACE_FILENO_SERVER
• TRACE_UNIQUE_CLIENT
5.4.1 LOG_DIRECTORY_CLIENT
The LOG_DIRECTORY_CLIENT non-ADR diagnostic parameter of the sqlnet.ora file specifies
the destination directory for the client log file.
Purpose
To specify the destination directory for the client log file.
Usage Notes
Use this parameter when ADR is not enabled.
Default
ORACLE_HOME/network/log
5-71
Chapter 5
Values
Any valid directory path.
Example
LOG_DIRECTORY_CLIENT=/oracle/network/log
5.4.2 LOG_DIRECTORY_SERVER
Purpose
To specify the destination directory for the database server log file.
Usage Notes
Default
ORACLE_HOME/network/trace
Values
Example
LOG_DIRECTORY_SERVER=/oracle/network/trace
5.4.3 LOG_FILE_CLIENT
Purpose
To specify the name of the log file for the client.
Usage Notes
Default
ORACLE_HOME/network/log/sqlnet.log
Values
The default value cannot be changed.
5.4.4 LOG_FILE_SERVER
Purpose
To specify the name of the log file for the database server.
5-72
Chapter 5
Usage Notes
Default
sqlnet.log
Values
Example
LOG_FILE_SERVER=svr.log
5.4.5 TRACE_DIRECTORY_CLIENT
Purpose
To specify the destination directory for the client trace file.
Usage Notes
Default
Values
Example
TRACE_DIRECTORY_CLIENT=/oracle/traces
5.4.6 TRACE_DIRECTORY_SERVER
Purpose
To specify the destination directory for the database server trace file. Use this parameter
when ADR is not enabled.
Default
Values
Example
TRACE_DIRECTORY_SERVER=/oracle/traces
5-73
Chapter 5
5.4.7 TRACE_FILE_CLIENT
Purpose
To specify the name of the client trace file.
Usage Notes
Default
ORACLE_HOME/network/trace/cli.trc
Values
Any valid file name.
Example
TRACE_FILE_CLIENT=clientsqlnet.trc
5.4.8 TRACE_FILE_SERVER
Purpose
To specify the destination directory for the database server trace output.
Usage Notes
Default
ORACLE_HOME/network/trace/svr_pid.trc
Values
Any valid file name. The process identifier (pid) is appended to the name automatically.
Example
TRACE_FILE_SERVER=svrsqlnet.trc
5.4.9 TRACE_FILEAGE_CLIENT
Purpose
To specify the maximum age of client trace files in minutes.
Usage Notes
When the age limit is reached, the trace information is written to the next file. The
number of files is specified with the TRACE_FILENO_CLIENT parameter. Use this
parameter when ADR is not enabled.
5-74
Chapter 5
Default
Unlimited
This is the same as setting the parameter to 0.
Example 5-8 Example

TRACE_FILEAGE_CLIENT=60
5.4.10 TRACE_FILEAGE_SERVER
Purpose
To specify the maximum age of database server trace files in minutes.
Usage Notes
When the age limit is reached, the trace information is written to the next file. The number of
files is specified with the TRACE_FILENO_SERVER parameter. Use this parameter when
ADR is not enabled.
Default
Unlimited
This is the same as setting the parameter to0.
Example 5-9 Example

TRACE_FILEAGE_SERVER=60
5.4.11 TRACE_FILELEN_CLIENT
Purpose
To specify the size of the client trace files in kilobytes (KB).
Usage Notes
When the size is met, the trace information is written to the next file. The number of files is
specified with the TRACE_FILENO_CLIENT parameter. Use this parameter when ADR is not
enabled.
Example
TRACE_FILELEN_CLIENT=100
5.4.12 TRACE_FILELEN_SERVER
Purpose
To specify the size of the database server trace files in kilobytes (KB).
5-75
Chapter 5
Usage Notes
When the size is met, the trace information is written to the next file. The number of
files is specified with the TRACE_FILENO_SERVER parameter. Use this parameter
Example
TRACE_FILELEN_SERVER=100
5.4.13 TRACE_FILENO_CLIENT
Purpose
To specify the number of trace files for client tracing.
Usage Notes
When this parameter is set with the TRACE_FILELEN_CLIENT 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, then the first file is re-used, and so on.
When this parameter is set with theTRACE_FILEAGE_CLIENT parameter, trace files
are cycled based on their age. The first file is used until the age limit is reached, then
the second file is used, and so on. When the last file's age limit is reached, the first file
is re-used, and so on.
When this parameter is set with both the TRACE_FILELEN_CLIENT and
TRACE_FILEAGE_CLIENT parameters, trace files are cycled when either the size
limit or the age limit is reached.
The trace file names are distinguished from one another by their sequence number.
For example, if the default trace file of sqlnet.trc is used, and this parameter is set to
3, then the trace files would be named sqlnet1.trc, sqlnet2.trc and sqlnet3.trc.
In addition, trace events in the trace files are preceded by the sequence number of the
file. Use this parameter when ADR is not enabled.
Default
None
Example
TRACE_FILENO_CLIENT=3
5.4.14 TRACE_FILENO_SERVER
Purpose
To specify the number of trace files for database server tracing.
Usage Notes
When this parameter is set with the TRACE_FILELEN_SERVER 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, then the first file is re-used, and so on.
5-76
Chapter 5
When this parameter is set with theTRACE_FILEAGE_SERVER parameter, trace files are
cycled based on the age of the trace file. The first file is used until the age limit is reached,
then the second file is used, and so on. When the last file's age limit is reached, the first file is
re-used, and so on.
When this parameter is set with both the TRACE_FILELEN_SERVER and
TRACE_FILEAGE_SERVER parameters, trace files are cycled when either the size limit or
the age limit is reached.
The trace file names are distinguished from one another by their sequence number. For
example, if the default trace file of svr_pid.trc is used, and this parameter is set to 3, then
the trace files would be named svr1_pid.trc, svr2_pid.trc and svr3_pid.trc.
In addition, trace events in the trace files are preceded by the sequence number of the file.
Default
None
Example
TRACE_FILENO_SERVER=3
5.4.15 TRACE_UNIQUE_CLIENT
Purpose
To specify whether a unique trace file is created for each client trace session.
Usage Notes
When the value is set to on, a process identifier is appended to the name of each trace file,
enabling several files to coexist. For example, trace files named sqlnetpid.trc are created if
default trace file name sqlnet.trc is used. When the value is set to off, data from a new
client trace session overwrites the existing file. Use this parameter when ADR is not enabled.
Default
on
Values
on or off
Example
TRACE_UNIQUE_CLIENT=on
5-77
6
Local Naming Parameters in the
tnsnames.ora File
This chapter provides a complete listing of the tnsnames.ora file configuration parameters.
• Overview of Local Naming Parameters

• General Syntax of tnsnames.ora
• Multiple Descriptions in tnsnames.ora
• Multiple Address Lists in tnsnames.ora
• Connect-Time Failover and Client Load Balancing with Oracle Connection Managers
When a connect descriptor in a tnsnames.ora file contains at least two protocol
addresses for Oracle Connection Manager, parameters for connect-time failover and load
balancing can be included in the file.
• Connect Descriptor Descriptions
Each connect descriptor is contained within the DESCRIPTION parameter. Multiple connect
descriptors are characterized by the DESCRIPTION_LIST parameter.
• Protocol Address Section
• Optional Parameters for Address Lists
For multiple addresses, you can use the optional parameters to configure address lists.
• Connection Data Section
Learn how to configure network connections with protocol addresses.
• Security Section
The security section of the tnsnames.ora file specifies these security-related parameters
for use with Oracle security features.
• Timeout Parameters
The timeout section of the tnsnames.ora file provides the ability to specify timeout and
retry configuration through the TNS connect string.
• Compression Parameters
The compression section of the tnsnames.ora file provides the ability to enable
compression and specify compression levels. These parameters can be set at the
DESCRIPTION level of a connect string.
6.1 Overview of Local Naming Parameters

The tnsnames.ora file is a configuration file that contains network service names mapped to
connect descriptors for the local naming method, or net service names mapped to listener
protocol addresses.
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
6-1
Chapter 6
General Syntax of tnsnames.ora
database servers (that are clients of other database servers) use the net service name
when making a connection with an application.
By default, the tnsnames.ora file is located in the ORACLE_HOME/network/admin
directory. Oracle Net will check the other directories for the configuration file. For
example, the order checking the tnsnames.ora file is as follows:
1. The directory specified by the TNS_ADMIN environment variable. If the file is not
found in the directory specified, then it is assumed that the file does not exist.
2. If the TNS_ADMIN environment variable is not set, then Oracle Net checks the
ORACLE_HOME/network/admin directory.
Note:
On Microsoft Windows, the TNS_ADMIN environment variable is used if it is set
in the environment of the process. If the TNS_ADMIN environment variable is
not defined in the environment, or the process is a service which does not
have an environment, then Microsoft Windows scans the registry for a
TNS_ADMIN parameter.
See Also:
• Oracle Database Global Data Services Concepts and Administration

• Oracle operating system-specific documentation
6.2 General Syntax of tnsnames.ora

The basic syntax for a tnsnames.ora file is shown in Example 6-1.
Example 6-1 Basic Format of tnsnames.ora File

net_service_name=
(DESCRIPTION=
(ADDRESS=(protocol_address_information))
(CONNECT_DATA=
(SERVICE_NAME=service_name)))
In the preceding example, DESCRIPTION contains the connect descriptor, ADDRESS

contains the protocol address, and CONNECT_DATA contains the database service
identification information.
6.3 Multiple Descriptions in tnsnames.ora

A tnsnames.ora file can contain net service names with one or more connect
descriptors. Each connect descriptor can contain one or more protocol addresses.
6-2
Chapter 6
Multiple Address Lists in tnsnames.ora
Example 6-2 shows two connect descriptors with multiple addresses. DESCRIPTION_LIST
defines a list of connect descriptors.
Example 6-2 Net Service Name with Multiple Connect Descriptors in tnsnames.ora
net_service_name=
(DESCRIPTION_LIST=
(DESCRIPTION=
(ADDRESS=(PROTOCOL=tcp)(HOST=sales1-svr)(PORT=1521))
(CONNECT_DATA=
(SERVICE_NAME=sales.us.example.com)))
(DESCRIPTION=
(ADDRESS=(PROTOCOL=tcp)(HOST=hr1-svr)(PORT=1521))
(ADDRESS=(PROTOCOL=tcp)(HOST=hr2-svr)(PORT=1521))
(CONNECT_DATA=
(SERVICE_NAME=hr.us.example.com))))
Note:
Oracle Net Manager does not support the creation of multiple connect descriptors
for a net service name when using Oracle Connection Manager.
6.4 Multiple Address Lists in tnsnames.ora

The tnsnames.ora file also supports connect descriptors with multiple lists of addresses,
each with its own characteristics. In Example 6-3, two address lists are presented. The first
address list features client load balancing and no connect-time failover, affecting only those
protocol addresses within its ADDRESS_LIST. The second protocol address list features no
client load loading balancing, but does have connect-time failover, affecting only those
protocol addresses within its ADDRESS_LIST. The client first tries the first or second protocol
address at random, then tries protocol addresses three and four sequentially.
Example 6-3 Multiple Address Lists in tnsnames.ora
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(LOAD_BALANCE=on)
(FAILOVER=off)
(ADDRESS=(protocol_address_information)))
(ADDRESS_LIST=
(LOAD_BALANCE=off)
(FAILOVER=on)
(ADDRESS=(protocol_address_information)))
(CONNECT_DATA=
(SERVICE_NAME=service_name)))
6-3
Chapter 6
Connect-Time Failover and Client Load Balancing with Oracle Connection Managers
Note:
• Oracle Net Manager supports only the creation of one protocol address
list for a connect descriptor.
• Oracle Net Services supports the IFILE parameter in the tnsnames.ora
file, with up to three levels of nesting. The parameter is added manually
to the file. The following is an example of the syntax:
6.5 Connect-Time Failover and Client Load Balancing with

Oracle Connection Managers
When a connect descriptor in a tnsnames.ora file contains at least two protocol
addresses for Oracle Connection Manager, parameters for connect-time failover and
load balancing can be included in the file.
Example 6-4 Multiple Oracle Connection Manager Addresses in tnsnames.ora
This example illustrates failover of multiple Oracle Connection Manager protocol
addresses.
sample1=
(DESCRIPTION=
(SOURCE_ROUTE=yes)
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=host1)(PORT=1630)) # 1
(ADDRESS_LIST=
(FAILOVER=on)
(LOAD_BALANCE=off) # 2
(ADDRESS=(PROTOCOL=tcp)(HOST=host2a)(PORT=1630))
(ADDRESS=(PROTOCOL=tcp)(HOST=host2b)(PORT=1630)))
(ADDRESS=(PROTOCOL=tcp)(HOST=host3)(PORT=1521))) # 3
(CONNECT_DATA=(SERVICE_NAME=sales.us.example.com)))
Here, the syntax does the following:

1. The client is instructed to connect to the protocol address of the first Oracle
Connection Manager, as indicated by:
(ADDRESS=(PROTOCOL=tcp)(HOST=host1)(PORT=1630))
2. The first Oracle Connection Manager is instructed to connect to the first protocol
address of another Oracle Connection Manager. If the first protocol address fails,
6-4
Chapter 6
Connect Descriptor Descriptions
then it tries the second protocol address. This sequence is specified with the following
configuration:
(ADDRESS_LIST=
(FAILOVER=on)
(LOAD_BALANCE=off)
(ADDRESS=(PROTOCOL=tcp)(HOST=host2a)(PORT=1630))
(ADDRESS=(PROTOCOL=tcp)(HOST=host2b)(PORT=1630)))
3. Oracle Connection Manager connects to the database service using the following
protocol address:
(ADDRESS=(PROTOCOL=tcp)(HOST=host3)(PORT=1521))
Example 6-5 Client Load Balancing in tnsnames.ora
This example illustrates client load balancing among two Oracle Connection Managers and
two protocol addresses:
sample2=
(DESCRIPTION=
(LOAD_BALANCE=on) # 1
(FAILOVER=on)
(ADDRESS_LIST=
(SOURCE_ROUTE=yes)
(ADDRESS=(PROTOCOL=tcp)(HOST=host1)(PORT=1630)) # 2
(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.us.example.com))) # 3
Here, the syntax does the following:

1. The client is instructed to pick an ADDRESS_LIST at random and to fail over 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 Oracle Connection
Manager, using the Oracle Connection Manager protocol address that uses port 1630
indicated for the ADDRESS_LIST.
3. Oracle Connection Manager then connects to the database service, using the protocol
address indicated for the ADDRESS_LIST.
6.6 Connect Descriptor Descriptions

Each connect descriptor is contained within the DESCRIPTION parameter. Multiple connect
descriptors are characterized by the DESCRIPTION_LIST parameter.
• DESCRIPTION_LIST
DESCRIPTION_LIST networking parameter of the tnsnames.ora file defines a list of
connect descriptors for a particular net service name.
6-5
Chapter 6
Protocol Address Section
• DESCRIPTION
DESCRIPTION networking parameter of the tnsnames.ora file specifies a
container for a connect descriptor.
6.6.1 DESCRIPTION_LIST
DESCRIPTION_LIST networking parameter of the tnsnames.ora file defines a list of
connect descriptors for a particular net service name.
Purpose
To define a list of connect descriptors for a particular net service name.
Example 6-6 Example
net_service_name=
(DESCRIPTION_LIST=
(DESCRIPTION=
(ADDRESS=...)
(CONNECT_DATA=(SERVICE_NAME=sales.example.com)))
(DESCRIPTION=
6.6.2 DESCRIPTION
DESCRIPTION networking parameter of the tnsnames.ora file specifies a container for
a connect descriptor.
Purpose
To specify a container for a connect descriptor.
Usage Notes
When using more than one DESCRIPTION parameter, put the parameters under the
DESCRIPTION_LIST parameter.
Example 6-7 Example
net_service_name=
(DESCRIPTION=
(ADDRESS=...)
6.7 Protocol Address Section

The protocol address section of the tnsnames.ora file specifies the protocol addresses
of the listener. If there is only one listener protocol address, then use the ADDRESS
parameter. If there is more than one address, then use the ADDRESS_LIST parameter.
• ADDRESS
The ADDRESS networking parameter is in the tnsnames.ora file and it specifies the
protocol address under the ADDRESS_LIST or the DESCRIPTION parameter for one
listener.
6-6
Chapter 6
• HTTPS_PROXY
Learn to use the tnsnames.ora parameter HTTPS_PROXY to specify HTTP proxy host
names to tunnel Transport Layer Security (TLS) client connections.
• HTTPS_PROXY_PORT
Learn how to use the tnsnames.ora parameter HTTPS_PROXY_PORT to specify forward
HTTP proxy host ports for tunneling Transport Layer Security (TLS) client connections.
• ADDRESS_LIST
The ADDRESS_LIST networking parameter specifies the number of protocol addresses.
6.7.1 ADDRESS
The ADDRESS networking parameter is in the tnsnames.ora file and it specifies the protocol
address under the ADDRESS_LIST or the DESCRIPTION parameter for one listener.
Purpose
To specify a single listener protocol address.
Usage Notes
Put this parameter under either the ADDRESS_LIST parameter or the DESCRIPTION parameter.
Example
net_service_name=
(DESCRIPTION=
(ADDRESS=(PROTOCOL=tcp)(HOST=sales-svr)(PORT=1521))
6.7.2 HTTPS_PROXY
Learn to use the tnsnames.ora parameter HTTPS_PROXY to specify HTTP proxy host names to
tunnel Transport Layer Security (TLS) client connections.
Purpose
To specify HTTP proxy host name for tunneling TLS client connections.
Usage Notes
The clients can tunnel secure connections over forward HTTP proxy using HTTP CONNECT
method. This helps in accessing the public cloud database service as it eliminates the
requirement to open an outbound port on a client side firewall. This parameter is applicable
only to the connect descriptors where PROTOCOL=TCPS. This is similar to the web browser
setting for intranet users who want to connect to internet hosts. Increase the forward web
proxy read timeout for requests to a higher value depending on client queries. Otherwise, the
forward web proxy closes the connection assuming that no requests are made from the
client.
Successful connection depends on specific proxy configurations. The performance of data
transfers depends on proxy capacity. Oracle recommends not to use this feature in
production environments where performance is critical.
6-7
Chapter 6
Configuring tnsnames.ora for the HTTP proxy may not be enough depending your
organization’s network configuration and security policies. For example, some
networks require a username and password for the HTTP proxy.
Oracle Client versions earlier than 18c does not support connections through HTTP
proxy.
Contact your network administrator to open outbound connections to hosts in the
oraclecloud.com domain using the relevant port, without going through an HTTP
proxy. For example, port 1522.
Default
None
Values
HTTP proxy host name that can make an outbound connection to the internet hosts.
Example
HTTPS_PROXY=www-proxy.mycompany.com
6.7.3 HTTPS_PROXY_PORT
Learn how to use the tnsnames.ora parameter HTTPS_PROXY_PORT to specify forward
HTTP proxy host ports for tunneling Transport Layer Security (TLS) client connections.
Purpose
To specify forward HTTP proxy host port for tunneling TLS client connections.
Usage Notes
It forwards the HTTP proxy host port that receives HTTP CONNECT method. This
parameter should be used along with HTTPS_PROXY_PORT. This value takes effect only
when SQLNET.USE_HTTPS_PROXY=1 is set in sqlnet.ora.
Default
none
Values
port number
Example
HTTPS_PROXY_PORT=80
6.7.4 ADDRESS_LIST
The ADDRESS_LIST networking parameter specifies the number of protocol addresses.
Purpose
To define a list of protocol addresses.
6-8
Chapter 6
Optional Parameters for Address Lists
Usage Notes
If there is only one listener protocol address, then ADDRESS_LIST is not necessary.
Put this parameter either under the DESCRIPTION parameter or the DESCRIPTION_LIST
parameter.
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=sales2-svr)(PORT=1521)))
6.8 Optional Parameters for Address Lists

For multiple addresses, you can use the optional parameters to configure address lists.
• ENABLE
• FAILOVER
• LOAD_BALANCE
• RECV_BUF_SIZE
Use the RECV_BUF_SIZE parameter to specify buffer space for session receive operations.
• SDU
• SEND_BUF_SIZE
Use the SEND_BUF_SIZE parameter to specify buffer space for session send operations.
• SOURCE_ROUTE
• TYPE_OF_SERVICE
6.8.1 ENABLE
Purpose
To allow the caller to detect a terminated remote server, typically it takes 2 hours or more to
notice.
Usage Notes
The keepalive feature on the supported TCP transports can be enabled for a net service
client by putting (ENABLE=broken) under the DESCRIPTION parameter in the connect string. On
the client side, the default for tcp_keepalive is off. Operating system TCP configurables,
which vary by platform, define the actual keepalive timing details.
Values
broken
6-9
Chapter 6
Example
net_service_name=
(DESCRIPTION=
(ENABLE=broken)
Although the preceding example has multiple addresses, the ADDRESS_LIST parameter
was not used. This is because the ADDRESS_LIST parameter is not mandatory.
6.8.2 FAILOVER
Purpose
To enable or disable connect-time failover for multiple protocol addresses.
Usage Notes
When you set the parameter to on, yes, or true, Oracle Net fails over at connect time
to a different address if the first protocol address fails. When you set the parameter to
off, no, or false, Oracle Net tries one protocol address.
Put this parameter under the DESCRIPTION_LIST parameter, the DESCRIPTION

parameter, or the ADDRESS_LIST parameter.
Note:
Do not set the GLOBAL_DBNAME parameter in the SID_LIST_listener_name
section of the listener.ora. A statically configured global database name
disables connect-time failover.
Default
on for the DESCRIPTION_LIST, DESCRIPTION, and ADDRESS_LIST parameters
Values
• yes | on | true
• no | off | false
Example
net_service_name=
(DESCRIPTION=
(FAILOVER=on)
(ADDRESS_LIST=
6-10
Chapter 6
6.8.3 LOAD_BALANCE
Purpose
To enable or disable client load balancing for multiple protocol addresses.
Usage Notes
When you set the parameter to on, yes, or true, Oracle Net goes through the list of
addresses in a random sequence, balancing the load on the various listener or Oracle
Connection Manager protocol addresses. When you set the parameter to off, no, or false,
Oracle Net tries the protocol addresses sequentially until one succeeds.
Put this parameter under the DESCRIPTION_LIST parameter, the DESCRIPTION parameter, or
the ADDRESS_LIST parameter.
Default
on for DESCRIPTION_LIST
Values
• yes | on | true
• no | off | false
Example
net_service_name=
(DESCRIPTION=
(LOAD_BALANCE=on)
(ADDRESS_LIST=
6.8.4 RECV_BUF_SIZE
Purpose
To specify, in bytes, the buffer space for receive operations of sessions.
Usage Notes
Put this parameter under the DESCRIPTION parameter or at the end of the protocol address.
Setting this parameter in the connect descriptor for a client overrides the RECV_BUF_SIZE
parameter at the client-side sqlnet.ora file.
6-11
Chapter 6
Note:
Additional protocols might support this parameter on certain operating
systems. Refer to the operating system-specific documentation for additional
information about additional protocols.
Default
The default value for this parameter is specific to the operating system. The default for
the Linux 2.6 operating system is 87380 bytes.
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=sales1-server)(PORT=1521)
(RECV_BUF_SIZE=11784))
(CONNECT_DATA=
net_service_name=
(DESCRIPTION=
(RECV_BUF_SIZE=11784)
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=hr1-server)(PORT=1521))
(ADDRESS=(PROTOCOL=tcp)(HOST=hr2-server)(PORT=1521)))
(CONNECT_DATA=
(SERVICE_NAME=hr.us.example.com)))
Related Topics
6.8.5 SDU
Purpose
To instruct Oracle Net to optimize the transfer rate of data packets being sent across
the network with a specified session data unit (SDU) size.
Usage Notes
Put this parameter under the DESCRIPTION parameter.
Setting this parameter in the connect descriptor for a client overrides the
DEFAULT_SDU_SIZE parameter at client-side sqlnet.ora file.
Default
8192 bytes (8 KB)
Values
512 to 2097152 bytes.
6-12
Chapter 6
Example
net_service_name=
(DESCRIPTION=
(SDU=8192)
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=sales1-server)(PORT=1521))
(ADDRESS=(PROTOCOL=tcp)(HOST=sales2-server)(PORT=1521)))
(CONNECT_DATA=
(SERVICE_NAME=sales.us.example.com))
6.8.6 SEND_BUF_SIZE
Purpose
To specify, in bytes, the buffer space for send operations of sessions.
Usage Notes
Put this parameter under the DESCRIPTION parameter or at the end of the protocol address.
Setting this parameter in the connect descriptor for a client overrides the SEND_BUF_SIZE
parameter at the client-side sqlnet.ora file.
Note:
Refer to the operating system-specific documentation for information about
additional protocols.
Default
The default value for this parameter is operating system specific. The default for the Linux 2.6
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(SEND_BUF_SIZE=11784))
(SEND_BUF_SIZE=11784)))
(CONNECT_DATA=
net_service_name=
(DESCRIPTION=
(SEND_BUF_SIZE=11784)
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=hr1-server)(PORT=1521)
6-13
Chapter 6
(ADDRESS=(PROTOCOL=tcp)(HOST=hr2-server)(PORT=1521)))
(CONNECT_DATA=
(SERVICE_NAME=hr.us.example.com)))
Related Topics
6.8.7 SOURCE_ROUTE
Purpose
To enable routing through multiple protocol addresses.
Usage Notes
When you set this parameter to on or yes, Oracle Net uses each address in order until
the destination is reached.
To use Oracle Connection Manager, an initial connection from the client to Oracle
Connection Manager is required, and a second connection from Oracle Connection
Manager to the listener is required.
Put this parameter under either the DESCRIPTION_LIST parameter, the DESCRIPTION
parameter, or the ADDRESS_LIST parameter.
Default
off
Values
• yes | on
• no | off
Example
net_service_name=
(DESCRIPTION=
(SOURCE_ROUTE=on)
(ADDRESS=(PROTOCOL=tcp)(HOST=cman-pc)(PORT=1630))
See Also:
Oracle Database Net Services Administrator's Guide for complete
6-14
Chapter 6
Connection Data Section
6.8.8 TYPE_OF_SERVICE
Purpose
To specify the type of service to use for an Oracle Rdb database.
Usage Notes
This parameter should only be used if the application supports both an Oracle Rdb and
Oracle database service, and you want the application to load balance between the two.
Example
net_service_name=
(DESCRIPTION_LIST=
(DESCRIPTION=
(ADDRESS=...)
(CONNECT_DATA=
(SERVICE_NAME=generic)
(RDB_DATABASE=[.mf]mf_personal.rdb)
(GLOBAL_NAME=alpha5))
(TYPE_OF_SERVICE=rdb_database))
(DESCRIPTION=
(ADDRESS=...)
(CONNECT_DATA=
(TYPE_OF_SERVICE=oracle11_database)))
6.9 Connection Data Section

Learn how to configure network connections with protocol addresses.
A network object is identified by a protocol address. When a connection is made, the client
and the receiver of the request (listener or Oracle Connection Manager) are configured with
identical protocol addresses. 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.
• COLOCATION_TAG
• CONNECT_DATA
• FAILOVER_MODE
• GLOBAL_NAME
• HS
• INSTANCE_NAME
• RDB_DATABASE
• SHARDING_KEY
Use this parameter to route the database request to a particular shard.
6-15
Chapter 6
• SUPER_SHARDING_KEY
Use this parameter to route the database request to a collection of shards.
• SERVER
• SERVICE_NAME
6.9.1 COLOCATION_TAG
Purpose
To direct the listener to route all connections with the same colocation_tag to the
same database instance.
Usage Notes
Use this parameter with the CONNECT_DATA parameter.
The parameter value must be an alphanumeric string.
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=...)
(ADDRESS=...))
(CONNECT_DATA=
(SERVICE_NAME=sales.us.example.com)
(COLOCATION_TAG=abc)))
Note:
Under certain conditions, such as, when maximum load of an instance is
reached or when new instances are added or deleted for a service, the
colocation of client connections that have the same colocation_tag to the
same database instance may not be consistent.
6.9.2 CONNECT_DATA
Purpose
To define the service to which to connect, such as SERVICE_NAME.
Usage Notes
CONNECT_DATA permits the following additional parameters:
• FAILOVER_MODE
• GLOBAL_NAME
6-16
Chapter 6
• HS
• INSTANCE_NAME
• RDB_DATABASE
• SHARDING_KEY
• SUPER_SHARDING_KEY
• SERVER
• SERVICE_NAME
• COLOCATION_TAG
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(CONNECT_DATA=
6.9.3 FAILOVER_MODE
Purpose
To instruct Oracle Net to fail over to a different listener if the first listener fails during run time.
Usage Notes
Depending upon the configuration, the session or any SELECT statements which were in
progress are automatically failed over.
This type of failover is called Transparent Application Failover (TAF) and should not be
confused with the connect-time failover FAILOVER parameter.
Put this parameter under the CONNECT_DATA parameter.
FAILOVER_MODE supports the following parameters:
• BACKUP: Specifies the failover node by its net service name. A separate net service name
must be created for the failover node.
• TYPE: Specifies the type of failover. Three types of Oracle Net failover functionality are
available by default to Oracle Call Interface (OCI) applications:
– SESSION: Fails over the session. For example, if a user's connection is lost, then a
new session is automatically created for the user on the backup. This type of failover
does not attempt to recover selects.
– SELECT: Allows users with open cursors to continue fetching them after failure.
However, this mode involves overhead on the client side in normal select operations.
– NONE: This is the default, in which no failover functionality is used. This can also be
explicitly specified to prevent failover from happening.
6-17
Chapter 6
• METHOD: Specifies how fast failover is to occur from the primary node to the backup
node:
– BASIC: Establishes connections at failover time. This option requires almost no
work on the backup database server until failover time.
– PRECONNECT: Pre-establishes connections. This provides faster failover but
requires that the backup instance be able to support all connections from
every supported instance.
• TRANSACTION: Allows the database to complete the current database transaction
following a recoverable error. This parameter is used with the
COMMIT_OUTCOME=TRUE parameter.
• RETRIES: Specifies the number of times to attempt to connect after a failover. If
DELAY is specified, then RETRIES defaults to five retry attempts.
• DELAY: Specifies the amount of time in seconds to wait between connect attempts.
If RETRIES is specified, then DELAY defaults to one second.
Note:
If a callback function is registered, then RETRIES and DELAY parameters are
ignored.
See Also:
Oracle Database Net Services Administrator's Guide for additional
6.9.4 GLOBAL_NAME
Purpose
To identify the Oracle Rdb database.
Usage Notes
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=...)
(ADDRESS=...))
(CONNECT_DATA=
(SERVICE_NAME=generic)
(RDB_DATABASE=[.mf]mf_personal.rdb)
(GLOBAL_NAME=alpha5)))
6-18
Chapter 6
6.9.5 HS
Purpose
To direct Oracle Net to connect to a non-Oracle system through Heterogeneous Services.
Usage Notes
Default
None
Values
ok
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=...)
(ADDRESS=...))
(CONNECT_DATA=
(SID=sales6)
)
(HS=ok))
See Also:
Oracle Database Net Services Administrator's Guide for complete configuration
information
6.9.6 INSTANCE_NAME
Purpose
To identify the database instance to access.
Usage Notes
Set the value to the value specified by the INSTANCE_NAME parameter in the initialization
parameter file.
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
6-19
Chapter 6
(ADDRESS=...)
(ADDRESS=...))
(CONNECT_DATA=
(INSTANCE_NAME=sales1)))
See Also:
Oracle Database Net Services Administrator's Guide for additional
information about the use of INSTANCE_NAME
6.9.7 KERBEROS5_PRINCIPAL
Purpose
When you configure Kerberos authentication for an Oracle Database client, you can
specify multiple Kerberos principals with a single Oracle Database client.
This is an optional parameter. When specified, it is used to verify if the principal name
in the credential cache matches the parameter value.
Usage Notes
Use this parameter with the CONNECT_DATA parameter. Alternatively, you can specify
KERBEROS5_CC_NAME in the connect string along with the optional KERBEROS5_PRINCIPAL
parameter to connect as a different Kerberos principal. Each Kerberos principal must
have a valid credential cache.
Example
For a user krbuser1, who is externally authenticated using the Kerberos principal
krbprinc1.example.com and the credential cache for this principal is located at /tmp/
krbuser1/krb.cc, the connect string is:
net_service_name=
(DESCRIPTION=
(CONNECT_DATA=(SERVICE_NAME=sales.example.com))
(SECURITY=
(KERBEROS5_CC_NAME=/tmp/krbuser1/krb.cc)
([email protected])))
Note:
The connection fails if the principal in the /tmp/krbuser1/krb.cc file does
not contain the [email protected] value.
6-20
Chapter 6
Similarly, for a user krbuser2, who is externally authenticated using the Kerberos principal
krbprinc2.example.com and the credential cache for this principal is located at /tmp/
krbuser2/krb.cc, the connect string is:
net_service_name=
(DESCRIPTION=
(CONNECT_DATA=(SERVICE_NAME=sales.example.com))
(SECURITY=
(KERBEROS5_CC_NAME=/tmp/krbuser2/krb.cc)
([email protected])))
Related Topics
6.9.8 RDB_DATABASE
Purpose
To specify the file name of an Oracle Rdb database.
Usage Notes
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=...)
(ADDRESS=...))
(CONNECT_DATA=
(RDB_DATABASE= [.mf]mf_personal.rdb)))
6.9.9 SHARDING_KEY
Use this parameter to route the database request to a particular shard.
Usage Notes
Example 6-8
net_service_name
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=...)
(ADDRESS=...))
(CONNECT_DATA=
6-21
Chapter 6
((SHARDING_KEY=40598230))))
Note:
Use the SHARDING_KEY parameter for sharding values in simplified text
format. This parameter does not support special characters. Use the
SHARDING_KEY_B64 parameter for base64 encoded binary representation of
shard key. The indicator for base64 format is a '+' sign prepended to the
shard key value.
Related Topics
6.9.10 SUPER_SHARDING_KEY
Use this parameter to route the database request to a collection of shards.
Usage Notes
Example 6-9
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=...)
(ADDRESS=...))
(CONNECT_DATA=
((SHARDING_KEY=40598230)(SUPER_SHARDING_KEY=gold)))
Note:
Use the SUPER_SHARDING_KEY parameter for specifying group key values in
simplified text format. This parameter does not support special characters.
Use the SUPER_SHARDING_KEY_B64 parameter for base64 encoded binary
representation of group key. The indicator for base64 format is a '+' sign
prepended to the shard key value.
Related Topics
6-22
Chapter 6
6.9.11 SERVER
Purpose
To direct the listener to connect the client to a specific type of service handler.
Usage Notes
Values
• dedicated to specify whether client requests be served by dedicated server.
• shared to specify whether client requests be served by a dispatcher or shared server.
• pooled to get a connection from the connection pool if database resident connection
pooling is enabled on the server.
Note:
• Shared server must be configured in the database initialization file in order for
the client to connect to the database with a shared server process.
• The USE_DEDICATED_SERVER parameter in the sqlnet.ora file overrides
this parameter.
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=...)
(ADDRESS=...))
(CONNECT_DATA=
(SERVER=dedicated)))
6.9.12 SERVICE_NAME
Purpose
To identify the Oracle Database database service to access.
Usage Notes
Set the value to a value specified by the SERVICE_NAMES parameter in the initialization
parameter file.
6-23
Chapter 6
Security Section
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=...)
(ADDRESS=...))
(CONNECT_DATA=
Related Topics
6.10 Security Section

The security section of the tnsnames.ora file specifies these security-related
parameters for use with Oracle security features.
• IGNORE_ANO_ENCRYPTION_FOR_TCPS
The IGNORE_ANO_ENCRYPTION_FOR_TCPS parameter specifies if the
SQLNET.ENCRYPTION_CLIENT parameter should be ignored for this specific TNS
alias.
• SECURITY
Use the SECURITY parameter to change the security properties of a connection.
• SSL_SERVER_CERT_DN
Use the SSL_SERVER_CERT_DN parameter to specify the distinguished name (DN) of
the database server.
• TOKEN_AUTH
token-based authentication for Oracle Cloud Infrastructure (OCI) Identity and
Access Management (IAM) users on an Oracle Autonomous Database.
• TOKEN_LOCATION
6.10.1 IGNORE_ANO_ENCRYPTION_FOR_TCPS
The IGNORE_ANO_ENCRYPTION_FOR_TCPS parameter specifies if the
SQLNET.ENCRYPTION_CLIENT parameter should be ignored for this specific TNS alias.
Purpose
To specify if the SQLNET.ENCRYPTION_CLIENT parameter should be ignored for this
specific TNS alias.
6-24
Chapter 6
Security Section
Usage Notes
If your requirements are that SQLNET.ENCRYPTION_SERVER be set to required, then you can
set the IGNORE_ANO_ENCRYPTION_FOR_TCPS parameter in both SQLNET.ENCRYPTION_CLIENT
and SQLNET.ENCRYPTION_SERVER to TRUE. This forces the client to ignore the value that is set
for the SQLNET.ENCRYPTION_CLIENT parameter for all outgoing TCPS connections.
Default
FALSE
Example 6-10 Example
test_ssl=
(DESCRIPTION =
(ADDRESS=(PROTOCOL=tcps)(HOST=)(PORT=1750))
(CONNECT_DATA=(SID=^ORACLE_SID^))
(SECURITY=(IGNORE_ANO_ENCRYPTION_FOR_TCPS=TRUE))
)
6.10.2 SECURITY
Use the SECURITY parameter to change the security properties of a connection.
Purpose
To change the security properties of a connection. Put this parameter under the DESCRIPTION
parameter.
Usage Notes
The parameters permitted under SECURITY are SSL_SERVER_CERT_DN and
AUTHENTICATION_SERVICE.
Example
net_service_name=
(DESCRIPTION=
(ADDRESS_LIST=
(CONNECT_DATA=
(SECURITY=
(SSL_SERVER_CERT_DN="cn=sales,cn=OracleContext,dc=us,dc=acme,dc=com")))
6.10.3 SSL_SERVER_CERT_DN
Use the SSL_SERVER_CERT_DN parameter to specify the distinguished name (DN) of the
database server.
Purpose
To specify the distinguished name (DN) of the database server.
6-25
Chapter 6
Security Section
Usage Notes
The server DN must be known by the client ahead of time. Otherwise, the client cannot
specify the server's DN in SSL_SERVER_CERT_DN. The client uses this information to
obtain the list of DNs it expects for each of the servers, enforcing the database server
DN to match its service name. This parameter must be set to the server DN (for
example, SSL_SERVER_CERT_DN="finance, cn=OracleContext,c=us,o=example") to
use full DN matching. For partial DN matching, do not include this parameter.
Use this parameter with the sqlnet.ora parameter SSL_SERVER_DN_MATCH to
enable full DN matching.
Example
finance=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL = tcps) (HOST = finance)
(PORT = 1575)))
(CONNECT_DATA=
(SERVICE_NAME=finance.us.example.com))
(SECURITY=
(SSL_SERVER_CERT_DN="cn=finance,cn=OracleContext,c=us,o=example")))
See Also:
6.10.4 TOKEN_AUTH
Purpose
To configure token-based authentication for IAM users on the Oracle Autonomous
Database instances. This method enforces strong authentication, which enables IAM
users to use a database token (db-token) from IAM for a client connection. This token
is a unique string of characters that you can request from IAM using Oracle Cloud
Infrastructure (OCI) Command Line Interface (CLI).
Usage Notes
• You can specify the TOKEN_AUTH setting in the connect string under the SECURITY
section of the tnsnames.ora file. Alternatively, you can specify this parameter in
the sqlnet.ora file. The parameter value specified in the connect string takes
precedence over the value specified in the sqlnet.ora file.
• With this connection method, you use one of the IAM user credentials, such as
API-key, security token, resource principal, instance principal, or delegation token
to retrieve the db-token and private key from IAM.
6-26
Chapter 6
Security Section
• When an IAM user logs in using /@connect_identifier, then the TOKEN_AUTH setting
(TOKEN_AUTH=OCI_TOKEN) instructs the database client to get the db-token and private key
files from either the default directory or the location specified by TOKEN_LOCATION.
When an IAM user logs in using the IAM user name and IAM database password instead
of /@connect_identifier, then the database client initiates the login without retrieving a
token (using IAM database password authentication).
• If your client application is updated to work with IAM, then you can override the
TOKEN_AUTH setting. In this case, IAM directly passes the db-token and private key to the
database client using the client API as an attribute. When the client receives this request,
the client signs the db-token with the private key and sends it to the database.
• The general token-based authentication process is as follows:
1. An IAM user or application in OCI first requests the db-token from IAM by using API-
key, security token, resource principal, instance principal, or delegation token
(delegation token is available only in the Cloud Shell).
To use a security token, you need to generate it by completing the browser
authentication process and then request the db-token using that security token. If the
IAM policy that authorizes you to be issued the db-token exists, then the db-token is
returned.
You request the db-token using OCI CLI (or OCI SDK for applications). For example,
run the following OCI CLI command to request the db-token by using an API-key
(apikey):
$ oci iam db-token get --profile scott
The profile flag specifies the profile for which you want to access the IAM user
credentials and retrieve the db-token.
2. OCI CLI references the config file (that stores your IAM user credentials as part of
the profile) and makes a call to IAM to get the db-token. The db-token and private
key files are written at the default or specified token location.
If an application is updated to work with IAM, it then passes the db-token and private
key directly to the database client through the client API as an attribute.
You can specify the TOKEN_LOCATION parameter to override the default directory
where the db-token and private key files are stored.
3. The database client signs the db-token with the private key and sends it to the
database. The database verifies the db-token, gets the group membership
information for the user, and completes the login.
Default
None
Value
6-27
Chapter 6
Security Section
Examples
net_service_name=
(DESCRIPTION =
(TOKEN_AUTH=OCI_TOKEN))
)
In these examples, the optional TOKEN_LOCATION parameter is not specified. Thus, the
db-token and private key files are written at the default token location.
Related Topics
• Oracle Cloud Infrastructure CLI Command Reference
• TOKEN_LOCATION
6.10.5 TOKEN_LOCATION
Database.
Purpose
To override the default directory where the db-token and private key are stored during
IAM token-based authentication. This location is used by the database client to
retrieve the db-token and private key from IAM.
Usage Notes
This is an optional parameter. Use this parameter along with the TOKEN_AUTH
parameter while configuring IAM token-based authentication. You can specify these
parameters in the connect string under the SECURITY section of the tnsnames.ora file.
Alternatively, you can specify these parameters in the sqlnet.ora file. The parameter
6-28
Chapter 6
Timeout Parameters
values specified in the connect string takes precedence over the values specified in the
sqlnet.ora file.
When an IAM user initiates a connection using /@connect_identifier, the database client
retrieves the db-token and private key from either the default directory or the location
specified by TOKEN_LOCATION, signs the db-token using the private key, and sends the db-
token to the database.
Default
On Linux: /home/username/.oci/db-token
Value
TOKEN_LOCATION="token_file_directory"
Examples
net_service_name=
(DESCRIPTION =
(TOKEN_AUTH=OCI_TOKEN)(TOKEN_LOCATION="/home/dbuser1/.oci/db-token"))
)
TOKEN_LOCATION="/home/dbuser1/.oci/db-token"
Related Topics
• TOKEN_AUTH
6.11 Timeout Parameters

The timeout section of the tnsnames.ora file provides the ability to specify timeout and retry
configuration through the TNS connect string.
The following parameters can be set at the DESCRIPTION level of a connect string:
• CONNECT_TIMEOUT
• RETRY_COUNT
• RETRY_DELAY
6-29
Chapter 6
Timeout Parameters
• TRANSPORT_CONNECT_TIMEOUT
• RECV_TIMEOUT
Use the tnsnames.ora parameter RECV_TIMEOUT to specify the duration of time that
a database client or server should wait for data from a peer after establishing a
connection.
6.11.1 CONNECT_TIMEOUT
Purpose
To specify the timeout duration in ms, sec, or min for a client to establish an Oracle Net
connection to an Oracle database.
Usage Notes
The timeout interval specified by CONNECT_TIMEOUT is a superset of the TCP connect

timeout interval. It includes the time to be connected to the database instance
providing the requested service, not just the duration of the TCP connection. It accepts
different timeouts with or without space between the value and the unit. In case, no
unit is mentioned, the default unit is sec.
The timeout interval is applicable for each ADDRESS in an ADDRESS_LIST, and each IP
address to which a host name is mapped.
The CONNECT_TIMEOUT parameter is equivalent to the sqlnet.ora parameter
SQLNET.OUTBOUND_CONNECT_TIMEOUT, and overrides it.
Example
net_service_name=
(DESCRIPTION=
(CONNECT_TIMEOUT=10 ms)(RETRY_COUNT=3)
(ADDRESS_LIST=
(CONNECT_DATA=
6.11.2 RETRY_COUNT
Purpose
To specify the number of times an ADDRESS list is traversed before the connection
attempt is terminated.
Usage Notes
When a DESCRIPTION_LIST is specified, each DESCRIPTION is traversed multiple times

based on the specified number of retries.
6-30
Chapter 6
Timeout Parameters
Example
net_service_name=
(DESCRIPTION_LIST=
(DESCRIPTION=
(CONNECT_TIMEOUT=10)(RETRY_COUNT=3)
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=sales1a-svr)(PORT=1521))
(ADDRESS=(PROTOCOL=tcp)(HOST=sales1b-svr)(PORT=1521)))
(CONNECT_DATA=(SERVICE_NAME=sales1.example.com)))
(DESCRIPTION=
(CONNECT_TIMEOUT=60)(RETRY_COUNT=1)
(ADDRESS_LIST=
(CONNECT_DATA=(SERVICE_NAME=sales2.us.example.com))))
6.11.3 RETRY_DELAY
Purpose
To specify the delay in seconds between subsequent retries for a connection. This parameter
works in conjunction with RETRY_COUNT parameter.
Usage Notes
When a DESCRIPTION_LIST is specified, each DESCRIPTION is traversed multiple times based

on the specified number of retries, and the specific delay for the description.
Example
net_service_name=
(DESCRIPTION_LIST=
(DESCRIPTION=
(CONNECT_TIMEOUT=10)(RETRY_COUNT=3)(RETRY_DELAY=2)
(ADDRESS_LIST=
(CONNECT_DATA=(SERVICE_NAME=sales1.example.com)))
(DESCRIPTION=
(CONNECT_TIMEOUT=60)(RETRY_COUNT=2)(RETRY_DELAY=1)
(ADDRESS_LIST=
(CONNECT_DATA=(SERVICE_NAME=sales2.us.example.com))))
6.11.4 TRANSPORT_CONNECT_TIMEOUT
Purpose
To specify the transport connect timeout duration in ms, sec, or min for a client to establish an
Oracle Net connection to an Oracle database.
6-31
Chapter 6
Timeout Parameters
Usage Notes
This parameter is put under the DESCRIPTION parameter.
The TRANSPORT_CONNECT_TIMEOUT parameter specifies the time, in ms, sec, or min, for a
client to establish a TCP connection to the database server. It accepts different
timeouts with or without space between the value and the unit. The default value is 60
seconds. In case, no unit is mentioned, the default unit is sec.
The timeout interval is applicable for each ADDRESS in an ADDRESS_LIST description,

and each IP address that a host name is mapped. The TRANSPORT_CONNECT_TIMEOUT
parameter is equivalent to the sqlnet.ora parameter TCP.CONNECT_TIMEOUT, and
overrides it.
Example
net_service_name =
(DESCRIPTION=
(TRANSPORT_CONNECT_TIMEOUT=10 ms)
(ADDRESS_LIST=
(CONNECT_DATA=
6.11.5 RECV_TIMEOUT
Use the tnsnames.ora parameter RECV_TIMEOUT to specify the duration of time that a
database client or server should wait for data from a peer after establishing a
connection.
Purpose
To specify the time, in ms, sec, or min, for a database client or server to wait for data
from the peer after establishing a connection. The peer must send data within the time
interval that you specify.
You can specify the time in hours, minutes, seconds, or milliseconds by using the hr,
min, sec, or ms keyword respectively. If you do not specify a unit of measurement, then
the default unit is sec.
Usage Notes
This parameter is put under the DESCRIPTION parameter.
Setting this parameter for clients ensures that receive operations are not left in a wait
state indefinitely or for a long period due to server host being down, server busy state,
or network connectivity issues. If a client does not receive response data in the time
specified, then the client logs ORA-12535: TNS:operation timed out and ORA-12609:
TNS: Receive timeout occurred messages to the sqlnet.log file.
Default Value
None
6-32
Chapter 6
Compression Parameters
Minimum Value
1 ms
Recommended Value
Example
RECV_TIMEOUT=10ms
or
RECV_TIMEOUT=10 ms
Related Topics
6.12 Compression Parameters

The compression section of the tnsnames.ora file provides the ability to enable compression
and specify compression levels. These parameters can be set at the DESCRIPTION level of a
connect string.
• COMPRESSION
The tnsnames.ora file’s compression parameter enables or disables the data
compression.
• COMPRESSION_LEVELS
The COMPRESSION_LEVELS parameter of the tnsnames.ora file specifies the compression
level.
6.12.1 COMPRESSION
The tnsnames.ora file’s compression parameter enables or disables the data compression.
Purpose
To enable or disable data compression.
Usage Notes
Setting this parameter in the connect descriptor for a client overrides the
SQLNET.COMPRESSION parameter in the client-side sqlnet.ora file.
Default
off
Values
6-33
Chapter 6
Example
net_service_name=
(DESCRIPTION=
(COMPRESSION=on)
(ADDRESS_LIST=
(ADDRESS= (PROTOCOL=tcp) (HOST=sales1-server) (PORT=1521))
(ADDRESS= (PROTOCOL=tcp) (HOST=sales2-server) (PORT=1521)))
(CONNECT_DATA=
Related Topics
• SQLNET.COMPRESSION
6.12.2 COMPRESSION_LEVELS
The COMPRESSION_LEVELS parameter of the tnsnames.ora file specifies the
compression level.
Purpose
Usage Notes
The compression levels are used at the time of negotiation to verify which levels are
used at both ends, and select one level. Put this parameter under the DESCRIPTION
parameter.
This parameter is used with the COMPRESSION parameter. Setting this parameter in the
connect descriptor for a client overrides the SQLNET.COMPRESSION_LEVELS parameter in
the client-side sqlnet.ora file.
Default
low
Values
• low for low CPU usage and a low compression ratio.
• high for high CPU usage and a high compression ratio.
Example
net_service_name=
(DESCRIPTION=
(COMPRESSION=on)
(COMPRESSION_LEVELS=(LEVEL=low)(LEVEL=high))
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=sales1-server)(PORT=1521))
(ADDRESS=(PROTOCOL=tcp)(HOST=sales2-server)(PORT=1521)))
(CONNECT_DATA=
6-34
Chapter 6
Related Topics
• SQLNET.COMPRESSION_LEVELS
6-35
7
Oracle Net Listener Parameters in the
listener.ora File
This chapter provides a complete listing of the listener.ora file configuration parameters.
• Overview of Oracle Net Listener Configuration File

• Protocol Address Parameters
• Connection Rate Limiter Parameters
The connection rate limiter feature in Oracle Net Listener enables a database
administrator to limit the number of new connections handled by the listener. When this
feature is enabled, Oracle Net Listener imposes a user-specified maximum limit on the
number of new connections handled by the listener every second. Depending on the
configuration, the rate can be applied to a collection of endpoints, or to a specific
endpoint.
• Control Parameters
This section describes the following parameters that control the behavior of the listener:
• ADR Diagnostic Parameters for Oracle Net Listener
Oracle Net listener.
• Non-ADR Diagnostic Parameters for Oracle Net Listener
This section lists the parameters used when ADR is disabled. The default value of
DIAG_ADR_ENABLED_listener_name is on. Therefore, the
DIAG_ADR_ENABLED_listener_name parameter must explicitly be set to off to use non-
ADR tracing.
• Class of Secure Transports Parameters
The class of secure transports (COST) parameters specify a list of transports that are
considered secure for administration and registration of a particular listener.
7.1 Overview of Oracle Net Listener Configuration File

Oracle Net Listener configuration, stored in the listener.ora file, consists of the following
elements:
• Name of the listener
• Protocol addresses that the listener is accepting connection requests on
• Valid nodes that the listener allows to register with the database
• Database services
• Control parameters
Dynamic service registration, eliminates the need for static configuration of supported
services. However, static service configuration is required if you plan to use Oracle Enterprise
Manager Cloud Control. For information about static service configuration, see Oracle
Database Net Services Administrator's Guide.
7-1
Chapter 7
Overview of Oracle Net Listener Configuration File
By default, the listener.ora file is located in the ORACLE_HOME/network/admin

directory. The listener.ora file can also be stored the following locations:
• The directory specified by the TNS_ADMIN environment variable or registry value.

• On Linux and UNIX operating systems, it is the global configuration directory. For
example, on the Oracle Solaris operating system, the directory is /var/opt/
oracle.
See Also:
– Oracle Database Global Data Services Concepts and Administration

– Oracle operating system-specific documentation
• In the read-only Oracle home mode, the listener.ora file default location is
ORACLE_BASE_HOME/network/admin.
• In the read-only Oracle home mode, the parameters that default to ORACLE_HOME
location change to default to ORACLE_BASE_HOME location.
It is possible to configure multiple listeners, each with a unique name, in one
listener.ora file. Multiple listener configurations are possible because each of the
top-level configuration parameters has a suffix of the listener name or is the listener
name itself.
Note:
• It is often useful to configure multiple listeners in one listener.ora file.

However, Oracle recommends running only one listener for each node in
most customer environments.
• Oracle Net Services supports the IFILE parameter in the listener.ora
file, with up to three levels of nesting. The parameter is added manually
to the file. The following is an example of the syntax:
Example 7-1 shows a listener.ora file for a listener named LISTENER, which is the
default name of the listener.
Example 7-1 listener.ora File
LISTENER=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=sale-server)(PORT=1521))
(ADDRESS=(PROTOCOL=ipc)(KEY=extproc))))
7-2
Chapter 7
Protocol Address Parameters
7.2 Protocol Address Parameters

The protocol address section of the listener.ora file defines the protocol addresses on
which the listener is accepting connection requests. This section describes the most common
parameters used in protocol addresses. The ADDRESS_LIST parameter is also supported.
This section lists and describes the following parameters:
• ADDRESS
The protocol ADDRESS parameter’s networking parameter is in the listener.ora file. It
specifies the protocol address under the DESCRIPTION parameter for one listener.
• DESCRIPTION
DESCRIPTION networking parameter of the listener.ora file contains listener protocol
addresses.
• Firewall
• IP
The protocol address parameter IP determine which IP address the listener listens on
when a host name is specified
• QUEUESIZE
• RECV_BUF_SIZE
• SEND_BUF_SIZE
7.2.1 ADDRESS
The protocol ADDRESS parameter’s networking parameter is in the listener.ora file. It
specifies the protocol address under the DESCRIPTION parameter for one listener.
Purpose
Specifies a single listener protocol address in the DESCRIPTION parameter
Usage Notes
Use this parameter to define the protocol, the host, and the port number for the listener.
Example
listener_name=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=hr-server)(PORT=1521))
(ADDRESS=(PROTOCOL=tcp)(HOST=sales-server)(PORT=1521))))
7-3
Chapter 7
7.2.2 DESCRIPTION
DESCRIPTION networking parameter of the listener.ora file contains listener protocol
addresses.
Purpose
To contain listener protocol addresses.
Example 7-2 Example
listener_name
7.2.3 Firewall
Purpose
It can be set in endpoint to enable firewall functionality.
Related Topics
7.2.4 IP
The protocol address parameter IP determine which IP address the listener listens on
when a host name is specified
Purpose
To determine which IP address the listener listens on when a host name is specified.
Usage Notes
This parameter is only applicable when the HOST parameter specifies a host name.
Values
• first
Listen on the first IP address returned by the DNS resolution of the host name. If
the user wants the listener to listen on the first IP to which the specified host name
resolves, then the address must be qualified with (IP=first).
• v4_only
Listen only on IPv4 addresses.
• v6_only
Listen only on IPv6 addresses.
Default
This feature is disabled by default.
7-4
Chapter 7
Example
listener_name=
(DESCRIPTION=
(ADDRESS=(PROTOCOL=tcp)(HOST=rancode1-vip)(PORT=1522)(IP=v6_only))
7.2.5 QUEUESIZE
Purpose
To specify the number of concurrent connection requests that the listener can accept on a
TCP/IP or IPC listening endpoint (protocol address).
Usage Notes
The number of concurrent connection requests is dependent on the platform and listener
usage scenarios. If the listener is heavily-loaded, then set the parameter to a higher number.
Put this parameter at the end of the protocol address with its value set to the expected
number of concurrent connection requests.
Default
The default number of concurrent connection requests is operating system specific.
Example
listener_name=
(DESCRIPTION=
(ADDRESS=(PROTOCOL=tcp)(HOST=hr-server)(PORT=1521)(QUEUESIZE=20)))
See Also:
about configuring this parameter
7.2.6 RECV_BUF_SIZE
Purpose
To specify, in bytes, the buffer space for receive operations of sessions.
Usage Notes
Put this parameter under the DESCRIPTION parameter or at the end of the protocol address
with its value set to the expected number of bytes.
7-5
Chapter 7
Note:
systems. Refer to the operating system-specific documentation for
information about additional protocols that support this parameter.
Default
The default value for this parameter is operating system specific. The default for the
Linux operating system is 87380 bytes.
Example
listener_name=
(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=sales-server)(PORT=1521)
(ADDRESS=(PROTOCOL=ipc)(KEY=extproc)
(RECV_BUF_SIZE=11784))))
listener_name=
(DESCRIPTION=
(ADDRESS_LIST=
Related Topics
7.2.7 SEND_BUF_SIZE
Purpose
To specify, in bytes, the buffer space for send operations of sessions.
Usage Notes
Put this parameter under the DESCRIPTION parameter or at the end of the protocol
address.
Note:
systems. Refer to operating system-specific documentation for additional
information about additional protocols that support this parameter.
7-6
Chapter 7
Connection Rate Limiter Parameters
Default
The default value for this parameter is operating system specific. The default for the Linux
Example
listener_name=
(DESCRIPTION=
(ADDRESS_LIST=
(SEND_BUF_SIZE=11280))
(ADDRESS=(PROTOCOL=ipc)(KEY=extproc)
(SEND_BUF_SIZE=11280))))
listener_name=
(DESCRIPTION=
(SEND_BUF_SIZE=11280)
(ADDRESS_LIST=
Related Topics
7.3 Connection Rate Limiter Parameters

The connection rate limiter feature in Oracle Net Listener enables a database administrator to
limit the number of new connections handled by the listener. When this feature is enabled,
Oracle Net Listener imposes a user-specified maximum limit on the number of new
connections handled by the listener every second. Depending on the configuration, the rate
can be applied to a collection of endpoints, or to a specific endpoint.
This feature is controlled through the following listener.ora configuration parameters:
• CONNECTION_RATE_listener_name
The CONNECTION_RATE_listener_name configuration parameter of thelistener.ora file
specifies a global rate that is enforced across all listening endpoints that are rate-limited.
• RATE_LIMIT
The RATE_LIMIT configuration parameter of the listener.ora file indicates that a
particular listening endpoint is rate-limited.
7.3.1 CONNECTION_RATE_listener_name
The CONNECTION_RATE_listener_name configuration parameter of thelistener.ora file
specifies a global rate that is enforced across all listening endpoints that are rate-limited.
Purpose
To specify a global rate that is enforced across all listening endpoints that are rate-limited.
Usage Notes
When this parameter is specified, it overrides any endpoint-level numeric rate values that
might be specified.
7-7
Chapter 7
Connection Rate Limiter Parameters
Syntax
CONNECTION_RATE_listener_name=number_of_connections_per_second
7.3.2 RATE_LIMIT
The RATE_LIMIT configuration parameter of the listener.ora file indicates that a
particular listening endpoint is rate-limited.
Purpose
To indicate that a particular listening endpoint is rate-limited.
Usage Notes
The parameter is specified in the ADDRESS section of the listener endpoint
configuration.
Syntax
LISTENER=
(ADDRESS=(PROTOCOL=tcp)(HOST=)(PORT=1521)(RATE_LIMIT=yes))
• When the RATE_LIMIT parameter is set to yes for an endpoint, that endpoint is
included in the enforcement of the global rate configured by the
CONNECTION_RATE_listener_name parameter. The global rate limit is enforced
individually at each endpoint that has RATE_LIMIT set to yes.
• Dynamic endpoints for listeners managed by Oracle Clusterware have the
RATE_LIMIT parameter set to yes.
• When the RATE_LIMIT parameter is set to a value greater than 0, then the rate limit
is enforced at that endpoint level.
Examples
The following examples use the CONNECTION_RATE_listener name and RATE_LIMIT
parameters.
Example 1
CONNECTION_RATE_LISTENER=10
LISTENER=
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=)(PORT=1523)))
In the preceding example, the global rate of new connections is enforced separately
for each endpoint. Connections through port 1521 are limited at 10 every second, and
the connections through port 1522 are also separately limited at 10 every second.
Connections through port 1523 are not limited.
7-8
Chapter 7
Control Parameters
Example 2
LISTENER= (ADDRESS_LIST=
(ADDRESS=(PROTOCOL=tcp)(HOST=)(PORT=1521)(RATE_LIMIT=5))
(ADDRESS=(PROTOCOL=tcp)(HOST=)(PORT=1522)(RATE_LIMIT=10))
(ADDRESS=(PROTOCOL=tcp)(HOST=)(PORT=1523))
)
In the preceding example, the connection rates are enforced at the endpoint level. A
maximum of 5 connections are processed through port 1521 every second. The limit for
connections through port 1522 is 10 every second. Connections through port 1523 are not
limited.
Note:
The global CONNECTON_RATE_listener_name parameter is not specified in the
preceding configuration. If it is specified, then the limits on ports 1521 and 1522 are
ignored, and the global value is used instead.
7.4 Control Parameters

This section describes the following parameters that control the behavior of the listener:
• ADMIN_RESTRICTIONS_listener_name
The listener.ora control parameter ADMIN_RESTRICTIONS_listener_name restricts
runtime administration of the listener.
• ALLOW_MULTIPLE_REDIRECTS_listener_name
The listener.ora control parameter ALLOW_MULTIPLE_REDIRECTS_listener_name enables
multiple redirects of the client.
• ENABLE_EXADIRECT_listener_name
• CRS_NOTIFICATION_listener_name
CRS_NOTIFICATION_listener_name control parameter of the listener.ora file sets
notification to allow or disallow Cluster Ready Services (CRS) to manage the listener in
an Oracle Real Application Clusters environment.
• DEDICATED_THROUGH_BROKER_LISTENER
DEDICATED_THROUGH_BROKER_LISTENER networking parameter of the listener.ora file
enables the server to spawn a thread or process when a connection to the database is
requested through the listener.
• DEFAULT_SERVICE_listener_name
DEFAULT_SERVICE_listener_name control parameter of the listener.ora file enables
users to connect to the database without having to specify a service name from the client
side.
• INBOUND_CONNECT_TIMEOUT_listener_name
• LOCAL_REGISTRATION_ADDRESS_listener_name
• MAX_ALL_CONNECTIONS_listener_name
• MAX_REG_CONNECTIONS_listener_name
7-9
Chapter 7
Control Parameters
• REGISTRATION_EXCLUDED_NODES_listener_name
• REGISTRATION_INVITED_NODES_listener_name
• REMOTE_REGISTRATION_ADDRESS_listener_name
• SAVE_CONFIG_ON_STOP_listener_name
• SERVICE_RATE_listener_name
The SERVICE_NAME_listener_name control parameter specifies incoming
connection rate that is allowed per service for an instance.
• SSL_CLIENT_AUTHENTICATION
Use the SSL_CLIENT_AUTHENTICATION parameter to specify whether a client is
authenticated using Transport Layer Security (TLS).
• SSL_VERSION
Use the SSL_VERSION parameter to limit the valid Transport Layer Security (TLS)
versions that Oracle uses for connections.
• SUBSCRIBE_FOR_NODE_DOWN_EVENT_listener_name
• USE_SID_AS_SERVICE_listener_name
• VALID_NODE_CHECKING_REGISTRATION_listener_name
The listener.ora control parameter
VALID_NODE_CHECKING_REGISTRATION_listener_name determines if valid node
checking registration is performed, or if the subnet is allowed.
• WALLET_LOCATION
Use the WALLET_LOCATION parameter to specify the location of Oracle wallets.
7.4.1 ADMIN_RESTRICTIONS_listener_name
The listener.ora control parameter ADMIN_RESTRICTIONS_listener_name restricts
runtime administration of the listener.
Purpose
To restrict runtime administration of the listener.
Usage Notes
Setting ADMIN_RESTRICTIONS_listener_name=on disables the runtime modification of
parameters in listener.ora. That is, the listener refuses to accept SET commands
that alter its parameters. To change any of the parameters in listener.ora, including
ADMIN_RESTRICTIONS_listener_name itself, modify the listener.ora file manually and
reload its parameters using the RELOAD command for the new changes to take effect
without explicitly stopping and restarting the listener.
Default
off
Example
ADMIN_RESTRICTIONS_listener=on
7-10
Chapter 7
Control Parameters
Related Topics
• SET
• RELOAD
The Listener Control utility command RELOAD reloads the listener.ora file, so that you
can add or change statically configured services without stopping the listener.
7.4.2 ALLOW_MULTIPLE_REDIRECTS_listener_name
The listener.ora control parameter ALLOW_MULTIPLE_REDIRECTS_listener_name enables
multiple redirects of the client.
Purpose
To support multiple redirects of the client.
Usage Notes
This parameter should only be set on the SCAN listener on the Oracle Public Cloud. When
set to on, multiple redirects of the client are allowed.
Do not set this parameter for a node listener if that is used as a SCAN listener.
Default
off
Values
on | off
Example
ALLOW_MULTIPLE_REDIRECTS_listener=on
7.4.3 ENABLE_EXADIRECT_listener_name
Purpose
To enable Exadirect protocol.
Usage Notes
The parameter enables Exadirect support.
Default
Off
Values
on | off
Example 7-3 Example

ENABLE_EXADIRECT_listener=on
7-11
Chapter 7
Control Parameters
7.4.4 CRS_NOTIFICATION_listener_name
CRS_NOTIFICATION_listener_name control parameter of the listener.ora file sets
notification to allow or disallow Cluster Ready Services (CRS) to manage the listener
in an Oracle Real Application Clusters environment.
Purpose
To set notification.
Usage Notes
By default, the Oracle Net listener notifies Cluster Ready Services (CRS) when it is
started or stopped. These notifications allow CRS to manage the listener in an Oracle
Real Application Clusters environment. This behavior can be prevented by setting the
CRS_NOTIFICATION_listener_name parameter to off.
Default
on
Values
on | off
7.4.5 DEDICATED_THROUGH_BROKER_LISTENER
DEDICATED_THROUGH_BROKER_LISTENER networking parameter of the listener.ora file
enables the server to spawn a thread or process when a connection to the database is
requested through the listener.
Purpose
To enable the server to spawn a thread or process when a connection to the database
is requested through the listener.
Default
off
Values
on | off
Example 7-4 Example
(Optional) Enter an example to illustrate your reference here.
7-12
Chapter 7
Control Parameters
7.4.6 DEFAULT_SERVICE_listener_name
DEFAULT_SERVICE_listener_name control parameter of the listener.ora file enables users
to connect to the database without having to specify a service name from the client side.
Purpose
To enable users to connect to the database without having to specify a service name from the
client side.
Usage Notes
When a client tries to connect to the database, the connection request passes through the
listener. The listener may be servicing several different databases. If a service name is
configured in this parameter, then users may not necessarily need to specify a service name
in the connect syntax. If a user specifies a service name, then the listener connects the user
to that specific database, otherwise the listener connects to the service name specified by the
DEFAULT_SERVICE_listener_name parameter. For container databases, the client must
explicitly specify the service name.
Default
There is no default value for the DEFAULT_SERVICE_listener_name parameter. If this
parameter is not configured and a user does not specify a fully-qualified service name in the
connect syntax, then the connection attempt fails. This parameter only accepts one value.
Example 7-5 Example
DEFAULT_SERVICE_listener=sales.us.example.com
7.4.7 INBOUND_CONNECT_TIMEOUT_listener_name
Purpose
To specify the time, in seconds, for the client to complete its connect request to the listener
after the network connection had been established.
Usage Notes
If the listener does not receive the client request in the time specified, then it terminates the
connection. In addition, the listener logs the IP address of the client and an ORA-12525:TNS:
listener has not received client's request in time allowed error message to the
listener.log file.
To protect both the listener and the database server, Oracle recommends setting this
parameter in combination with the SQLNET.INBOUND_CONNECT_TIMEOUT parameter in
the sqlnet.ora file. When specifying values for these parameters, consider the following
recommendations:
• Set both parameters to an initial low value.
• Set the value of the INBOUND_CONNECT_TIMEOUT_listener_name parameter to a lower
value than the SQLNET.INBOUND_CONNECT_TIMEOUT parameter.
For example, you can set the INBOUND_CONNECT_TIMEOUT_listener_name parameter to 2
seconds and the INBOUND_CONNECT_TIMEOUT parameter to 3 seconds. If clients are unable to
7-13
Chapter 7
Control Parameters
complete connections within the specified time due to system or network delays that
are normal for the particular environment, then increment the time as needed.
Default
60 seconds
Example
INBOUND_CONNECT_TIMEOUT_listener=2
7.4.8 LOCAL_REGISTRATION_ADDRESS_listener_name
Purpose
To secure registration requests through dedicated secure registration endpoints for
local listeners. Service ACLs are accepted by listener only if
LOCAL_REGISTRATION_ADDRESS_lsnr alias is configured. The parameter specifies the
group that is allowed to send ACLs.
Usage Notes
The local registration endpoint accepts local registration connections from the
specified group. All local registration requests coming on normal listening endpoints
are redirected to the local registration endpoint. If the registrar is not a part of the
group, then it cannot connect to the endpoint.
Default
OFF
Values
ON, OFF, or IPC endpoint address with group
When set to ON, listener defaults the group to oinstall on UNIX and ORA_INSTALL on
Windows.
Example 7-6 Example
LOCAL_REGISTRATION_ADDRESS_lsnr_alias = (address=(protocol=ipc)
(group=xyz)) LOCAL_REGISTRATION_ADDRESS_lsnr_alias =ON
Related Topics
• Firewall
• DBMS_SFW_ACL_ADMIN
7.4.9 MAX_ALL_CONNECTIONS_listener_name
Purpose
To specify the maximum number of concurrent registration and client connection
sessions that can be supported by Oracle Net Listener.
7-14
Chapter 7
Control Parameters
Usage Notes
This number includes registration connections from databases, and ongoing client connection
establishment requests. After a connection is established, the clients do not maintain a
connection to the listener. This limit only applies to client connections that are in the initial
connection establishment phase from a listener perspective.
Default
Operating system-specific
Example
MAX_ALL_CONNECTIONS_listener=4096
7.4.10 MAX_REG_CONNECTIONS_listener_name
Purpose
To specify the maximum number of concurrent registration connection sessions that can be
supported by Oracle Net Listener.
Default
512
Example
MAX_REG_CONNECTIONS_listener=2048
7.4.11 REGISTRATION_EXCLUDED_NODES_listener_name
Purpose
To specify the list of nodes that cannot register with the listener.
Usage Notes
The list can include host names or CIDR notation for IPv4 and IPv6 addresses. The wildcard
format (*) is supported for IPv4 addresses. The presence of a host name in the list results in
the inclusion of all IP addresses mapped to the host name. The host name should be
consistent with the public network interface.
If the REGISTRATION_INVITED_NODES_listener_name parameter and the
REGISTRATION_EXCLUDED_NODES_listener_name parameter are set, then the
REGISTRATION_EXCLUDED_NODES_listener_name parameter is ignored.
Values
Valid nodes and subnet IP addresses or names.
Example
REGISTRATION_EXCLUDED_NODES_listener = (10.1.26.*, 10.16.40.0/24, \

2001:DB8:3eff:fe38, node2)
7-15
Chapter 7
Control Parameters
7.4.12 REGISTRATION_INVITED_NODES_listener_name
Purpose
To specify the list of node that can register with the listener.
Usage Notes
• The list can include host names or CIDR notation for IPv4 and IPv6 addresses.
The wildcard format (*) is supported for IPv4 addresses. The presence of a host
name in the list results in the inclusion of all IP addresses mapped to the host
name. The host name should be consistent with the public network interface.
• If the REGISTRATION_INVITED_NODES_listener_name parameter and the
REGISTRATION_EXCLUDED_NODES_listener_name parameter are set, then the
REGISTRATION_EXCLUDED_NODES_listener_name parameter is ignored.
• Starting with Oracle Grid Infrastructure 12c, for a SCAN listener, if the
VALID_NODE_CHECKING_REGISTRATION_listener_name and
REGISTRATION_INVITED_NODES_listener_name parameters are set in the
listener.ora file, then the listener agent overwrites these parameters.
Values
Example
REGISTRATION_INVITED_NODES_listener = (10.1.35.*, 10.1.34.0/24, \
2001:DB8:fe38:7303, node1)
See Also:
Oracle Real Application Clusters Administration and Deployment Guide for
information about valid node checking for registration
7.4.13 REMOTE_REGISTRATION_ADDRESS_listener_name
Purpose
To secure registration requests through dedicated secure registration endpoints for
SCAN listeners.
Usage Notes
The registration endpoint is on a private network within the cluster. All remote
registration requests coming in on normal listening endpoints are redirected to the
registration endpoint. Any system which is not a part of the cluster cannot connect to
the endpoint. This feature is not supported when ADMIN_RESTRICTIONS_listener_name
is set to ON as the Cluster Ready Services agent configures the
remote_registration_address dynamically at run time.
7-16
Chapter 7
Control Parameters
Default
This parameter is configured internally in listeners managed by Oracle Clusterware to restrict
registrations to the private network. The value of this parameter should not be modified or
specified explicitly. The only supported explicit setting is for turning this feature off by setting
the value to OFF.
Values
off
Example
REMOTE_REGISTRATION_ADDRESS_listener=off
7.4.14 SAVE_CONFIG_ON_STOP_listener_name
Purpose
To specify whether runtime configuration changes are saved to the listener.ora file.
Usage Notes
When you set the parameter to true, any parameters that were modified while the listener
was running using the Listener Control utility SET command are saved to the listener.ora
file when the STOP command is issued. When you set the parameter to false, the Listener
Control utility does not save the runtime configuration changes to the listener.ora file.
Default
false
Values
true | false
Example
SAVE_CONFIG_ON_STOP_listener=true
7.4.15 SERVICE_RATE_listener_name
The SERVICE_NAME_listener_name control parameter specifies incoming connection rate
that is allowed per service for an instance.
Purpose
To specify incoming connection rate that is allowed per service for an instance.
Usage Notes
Any user-specified value greater than 0 sets the maximum limit on the number of new
connections per service-instance handled by the proxy listener every second. Listener rejects
connections after it reaches the maximum limit. Client side connection failure is reported with
“TNS:listener: rate limit reached”.
7-17
Chapter 7
Control Parameters
Default
0
Example 7-7 Example

SERVICE_RATE=10
7.4.16 SSL_CLIENT_AUTHENTICATION
Use the SSL_CLIENT_AUTHENTICATION parameter to specify whether a client is
authenticated using Transport Layer Security (TLS).
Purpose
To specify whether a client is authenticated using Transport Layer Security (TLS).
Usage Notes
The database server authenticates the client. Therefore, this value should be set to
false. If this parameter is set to true, then the listener attempts to authenticate the
client, which can result in a failure.
Default
true
Values
true | false
Example
SSL_CLIENT_AUTHENTICATION=false
See Also:
7.4.17 SSL_VERSION
Use the SSL_VERSION parameter to limit the valid Transport Layer Security (TLS)
versions that Oracle uses for connections.
Purpose
To limit allowable TLS versions used for connections.
Usage Notes
Clients and database servers must use a compatible version. This parameter should
only be used when absolutely necessary for backward compatibility. The current
7-18
Chapter 7
Control Parameters
default uses TLS version 1.2 which is the version required for multiple security compliance
requirements.
If you set SSL_VERSION to undetermined, then by default it uses 3.0.
Default
1.2
Values
Note:
The sqlnet.ora parameter ADD_SSLV3_TO_DEFAULT has no impact on this
parameter.
undetermined | 3.0 | 1.0| 1.1 | 1.2
If you want to specify one version or another version, then use “or”. The following values are
permitted:
1.0 or 3.0 | 1.2 or 3.0 | 1.1 or 1.0 | 1.2 or 1.0 | 1.2 or 1.1 | 1.1 or 1.0 or 3.0 |
1.2 or 1.0 or 3.0 | 1.2 or 1.1 or 1.0 | 1.2 or 1.1 or 3.0 |1.2 or 1.1 or 1.0 or 3.0
Example
SSL_VERSION=1.2
The remaining version numbers correspond to the TLS versions, such as, TLSv1.0, TLSv1.1,
and TLSv1.2.
See Also:
7.4.18 SUBSCRIBE_FOR_NODE_DOWN_EVENT_listener_name
Purpose
To subscribe to Oracle Notification Service (ONS) notifications for downed events.
Usage Notes
By default, the listener subscribes to the ONS node down event on startup, if ONS is
available. This subscription enables the listener to remove the affected service when it
receives node down event notification from ONS. The listener uses asynchronous
subscription for the event notification. Alter this behavior by setting
SUBSCRIBE_FOR_NODE_DOWN_EVENT_listener_name=off in listener.ora.
Default
on
7-19
Chapter 7
Control Parameters
Values
on | off
7.4.19 USE_SID_AS_SERVICE_listener_name
Purpose
To enable the system identifier (SID) in the connect descriptor to be interpreted as a
service name when a user attempts a database connection.
Usage Notes
Database clients with earlier releases of Oracle Database that have hard-coded
connect descriptors can use this parameter to connect to a container or pluggable
database.
For an Oracle container database, the client must specify a service name in order to
connect to it. Setting this parameter to on instructs the listener to use the SID in the
connect descriptor as a service name and connect the client to the specified database.
Default
off
Example
USE_SID_AS_SERVICE_listener=on
7.4.20 VALID_NODE_CHECKING_REGISTRATION_listener_name
The listener.ora control parameter
VALID_NODE_CHECKING_REGISTRATION_listener_name determines if valid node
checking registration is performed, or if the subnet is allowed.
Purpose
To determine whether valid node checking registration is performed, or the subnet is
allowed.
Usage Notes
• When set to on, valid node checking registration is performed at the listener for
any incoming registration request, and only local IP addresses are allowed.
• Starting with Oracle Grid Infrastructure 12c, for a SCAN listener, if the
VALID_NODE_CHECKING_REGISTRATION_listener_name and
REGISTRATION_INVITED_NODES_listener_name parameters are set in the
listener.ora file, then the listener agent overwrites these parameters.
Default
on
7-20
Chapter 7
Control Parameters
Values
• off | 0 to specify valid node checking registration is off, and no checking is performed.
• on | 1 | local to specify valid node checking registration is on, and all local IP
addresses can register. If a list of invited nodes is set, then all IP addresses, host names,
or subnets in the list as well as local IP addresses are allowed.
• subnet | 2 to specify valid node checking registration is on, and all machines in the local
subnets are allowed to register. If a list of invited nodes is set, then all nodes in the local
subnets as well as all IP addresses, host names and subnets in the list are allowed.
Example
VALID_NODE_CHECKING_REGISTRATION_listener=on
See Also:
Oracle Real Application Clusters Administration and Deployment Guide for
information about valid node checking for registration
Use the WALLET_LOCATION parameter to specify the location of Oracle wallets.
Purpose
To specify the location of Oracle wallets.
Usage Notes
Wallets are certificates, keys, and trustpoints processed by Transport Layer Security (TLS)
that allow secure connections.
The key/value pair for Microsoft certificate store (MCS) omits the METHOD_DATA parameter
because MCS does not use wallets. Instead, Oracle PKI (public key infrastructure)
applications obtain certificates, trustpoints and private keys directly from the user's profile.
If an Oracle wallet is stored in the Microsoft Windows registry and the wallet's key (KEY) is
Syntax
Table 7-1 shows the syntax for the WALLET_LOCATION parameter based on wallet storage
location.
7-21
Chapter 7
Control Parameters
Table 7-1 Syntax for WALLET_LOCATION
Wallet Location Syntax

Oracle wallets on file system WALLET_LOCATION=
(SOURCE=
(METHOD=file)
(METHOD_DATA=
Microsoft certificate store WALLET_LOCATION=

(SOURCE=
(METHOD=mcs))
Oracle wallets in the Microsoft Windows WALLET_LOCATION=

registry (SOURCE=
(METHOD=reg)
(METHOD_DATA=
Entrust wallets WALLET_LOCATION=

(SOURCE=
(METHOD=entr)
(METHOD_DATA=
(PROFILE=file.epf)
The following additional parameters are available for WALLET_LOCATION:
• SOURCE: Type of storage for wallets and storage location.

• METHOD: Type of storage.
• METHOD_DATA: Storage location.
• DIRECTORY: Location of Oracle wallets on file system.
• KEY: Wallet type and location in the Microsoft Windows registry.
• PROFILE: Entrust profile file (.epf).
• INIFILE: Entrust initialization file (.ini).
Default
None
Examples
WALLET_LOCATION=
(SOURCE=
(METHOD=file)
7-22
Chapter 7
ADR Diagnostic Parameters for Oracle Net Listener
(METHOD_DATA=

WALLET_LOCATION=
(SOURCE=
(METHOD=mcs))

WALLET_LOCATION=
(SOURCE=
(METHOD=REG)
(METHOD_DATA=
(KEY=SALESAPP)))
Entrust Wallets:
WALLET_LOCATION=
(SOURCE=
(METHOD=entr)
(METHOD_DATA=
See Also:
Oracle Database Enterprise User Security Administrator's Guide
7.5 ADR Diagnostic Parameters for Oracle Net Listener

The diagnostic data for the critical errors is quickly captured and stored in the ADR for Oracle
Net listener.
number. The data is then stored in the Automatic Diagnostic Repository (ADR), a file-based
repository outside the database.
This section includes the parameters used when ADR is enabled. ADR is enabled by default.
Non-ADR parameters listed in the listener.ora file are ignored when ADR is enabled.
The following listener.ora parameters are used when ADR is enabled (when
DIAG_ADR_ENABLED is set to on):
7-23
Chapter 7
• ADR_BASE_listener_name
The ADR_BASE_listener_name parameter is a diagnostic parameter specifies the
base directory that stores tracing and logging incidents when ADR is enabled.
• DIAG_ADR_ENABLED_listener_name
The DIAG_ADR_ENABLED_listener_name is a diagnostic parameter of the
listener.ora file. It indicates whether ADR is enabled.
• LOG_FILE_NUM_listener_name
The LOG_FILE_NUM_listener_name is a diagnostic parameter of the listener.ora
file that specifies the number of log file segments.
• LOG_FILE_SIZE_listener_name
The LOG_FILE_SIZE_listener_name diagnostic parameter of thelistener.ora file
specifies the size of each log file segment.
• LOGGING_listener_name
The LOGGING_listener_name diagnostic parameter of the listener.ora file turns
logging on or off.
• TRACE_LEVEL_listener_name
The TRACE_LEVEL_listener_name diagnostic parameter of the listener.ora file
turns listener tracing on, at a specific level, or turns it off.
• TRACE_TIMESTAMP_listener_name
The TRACE_TIMESTAMP_listener_name diagnostic parameter of the listener.ora
file adds a time stamp to every trace event in the trace file for the listener.
7.5.1 ADR_BASE_listener_name
The ADR_BASE_listener_name parameter is a diagnostic parameter specifies the base
directory that stores tracing and logging incidents when ADR is enabled.
Purpose
To specify the base directory that stores tracing and logging incidents when ADR is
enabled.
Default
The default is ORACLE_BASE, or ORACLE_HOME/log if ORACLE_BASE is not defined.
Values
Example
ADR_BASE_listener=/oracle/network/trace
7-24
Chapter 7
7.5.2 DIAG_ADR_ENABLED_listener_name
The DIAG_ADR_ENABLED_listener_name is a diagnostic parameter of the listener.ora file. It
indicates whether ADR is enabled.
Purpose
To indicate whether ADR tracing is enabled.
Usage Notes
When the DIAG_ADR_ENABLED_listener_name parameter is set to on, then ADR file tracing is
used. When the DIAG_ADR_ENABLED_listener_name parameter is set to off, then non-ADR
file tracing is used.
Default
on
Values
on|off
Example 7-8 Example

DIAG_ADR_ENABLED_listener=on
7.5.3 LOG_FILE_NUM_listener_name
The LOG_FILE_NUM_listener_name is a diagnostic parameter of the listener.ora file that
specifies the number of log file segments.
Purpose
To specify the number of log file segments. At any point of time there can be only n log file
segments where n is LOG_FILE_NUM_listener_name. If the log grows beyond this number,
then the older segments are deleted.
Default
No default. If you don't specify a value, or set the value to zero, then the number of segments
grows indefinitely.
Values
Any integer value.
Example 7-9
LOG_FILE_NUM_listener=3
7-25
Chapter 7
7.5.4 LOG_FILE_SIZE_listener_name
The LOG_FILE_SIZE_listener_name diagnostic parameter of thelistener.ora file
specifies the size of each log file segment.
Purpose
To specify the size of each log file segment. The size is in MB.
Default
300 MB
Values
Any integer value.
LOG_FILE_SIZE_listener=10
7.5.5 LOGGING_listener_name
The LOGGING_listener_name diagnostic parameter of the listener.ora file turns
logging on or off.
Purpose
To turn logging on or off.
Usage Notes
Default
on
Values
on | off
Example
LOGGING_listener=on
7.5.6 TRACE_LEVEL_listener_name
The TRACE_LEVEL_listener_name diagnostic parameter of the listener.ora file turns
listener tracing on, at a specific level, or turns it off.
Purpose
To turn listener tracing on, at a specific level, or to turn it off.
7-26
Chapter 7
Usage Notes
Default
off | 0
Values
Example
TRACE_LEVEL_listener=admin
7.5.7 TRACE_TIMESTAMP_listener_name
The TRACE_TIMESTAMP_listener_name diagnostic parameter of the listener.ora file adds a
time stamp to every trace event in the trace file for the listener.
Purpose
To add a time stamp in the form of dd-mmm-yyyy hh:mi:ss:mil to every trace event in the
trace file for the listener.
Usage Notes
This parameter is used with the TRACE_LEVEL_listener_name parameter. This parameter is
also applicable when non-ADR tracing is used.
Default
on
Values
• on | true
• off | false
Example
TRACE_TIMESTAMP_listener=true
7-27
Chapter 7
Non-ADR Diagnostic Parameters for Oracle Net Listener
7.6 Non-ADR Diagnostic Parameters for Oracle Net Listener

This section lists the parameters used when ADR is disabled. The default value of
DIAG_ADR_ENABLED_listener_name is on. Therefore, the
DIAG_ADR_ENABLED_listener_name parameter must explicitly be set to off to use non-
ADR tracing.
• LOG_DIRECTORY_listener_name
• LOG_FILE_listener_name
• TRACE_DIRECTORY_listener_name
• TRACE_FILE_listener_name
• TRACE_FILEAGE_listener_name
• TRACE_FILELEN_listener_name
• TRACE_FILENO_listener_name
7.6.1 LOG_DIRECTORY_listener_name
Purpose
To specify the destination directory of the listener log file.
Usage Notes
Default
ORACLE_HOME/network/log
Example
LOG_DIRECTORY_listener=/oracle/network/admin/log
7.6.2 LOG_FILE_listener_name
Purpose
To specify the name of the log file for the listener.
Usage Notes
Default
listener.log
Example
LOG_FILE_listener=list.log
7-28
Chapter 7
Non-ADR Diagnostic Parameters for Oracle Net Listener
7.6.3 TRACE_DIRECTORY_listener_name
Purpose
To specify the destination directory of the listener trace file.
Usage Notes
Default
Example
TRACE_DIRECTORY_listener=/oracle/network/admin/trace
7.6.4 TRACE_FILE_listener_name
Purpose
To specify the name of the trace file for the listener.
Usage Notes
Default
listener.trc
Example
TRACE_FILE_listener=list.trc
7.6.5 TRACE_FILEAGE_listener_name
Purpose
To specify the maximum age of listener trace files in minutes.
Usage Notes
When the age limit is reached, the trace information is written to the next file. The number of
files is specified with the TRACE_FILENO_listener_name parameter. Use this parameter
Default
Unlimited
This is the same as setting the parameter to 0.

TRACE_FILEAGE_listener=60
7-29
Chapter 7
Class of Secure Transports Parameters
7.6.6 TRACE_FILELEN_listener_name
Purpose
To specify the size of the listener trace files in kilobytes (KB).
Usage Notes
When the size is met, the trace information is written to the next file. The number of
files is specified using the TRACE_FILENO_listener_name parameter. Use this
Default
Unlimited
Example
TRACE_FILELEN_listener=100
7.6.7 TRACE_FILENO_listener_name
Purpose
To specify the number of trace files for listener tracing.
Usage Notes
When this parameter is set along with the TRACE_FILELEN_listener_name
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 re-used, and so
on.
For example, if the default trace file of listener.trc is used, and this parameter is set
to 3, then the trace files would be named listener1.trc, listener2.trc and
listener3.trc.
Default
1
Example
TRACE_FILENO_listener=3
7.7 Class of Secure Transports Parameters

The class of secure transports (COST) parameters specify a list of transports that are
considered secure for administration and registration of a particular listener.
7-30
Chapter 7
The COST parameters identify which transports are considered secure for that installation
and whether the administration of a listener requires secure transports. Configuring these
parameters is optional.
• SECURE_REGISTER_listener_name
• Using COST Parameters in Combination
• DYNAMIC_REGISTRATION_listener_name
DYNAMIC_REGISTRATION_listener_name is a class of secure transports (COST)
parameter and it enables or disables dynamic registration of a listener.
• SECURE_PROTOCOL_listener_name
• SECURE_CONTROL_listener_name
See Also:
about COST parameters and listener security
7.7.1 SECURE_REGISTER_listener_name
Purpose
To specify the transports on which registration requests are to be accepted.
Usage Notes
If the SECURE_REGISTER_listener_name parameter is configured with a list of transport
names, then only the connections arriving on the specified transports are able to register the
service with the listener. Connections arriving by other transport protocols are refused. The
following is an example:
SECURE_REGISTER_listener1 = (TCPS,IPC)
In the preceding example, registration requests are accepted only on TCPS and IPC
transports.
If no values are entered for this parameter, then the listener accepts registration requests
from any transport.
Syntax
SECURE_REGISTER_listener_name =
[(]transport1[,transport2, ....,transportn)]
In the preceding example, transport1, transport2, and transportn are valid, installed
transport protocol names.
If this parameter and SECURE_CONTROL_listener_name are configured, then they override
the SECURE_PROTOCOL_listener_name parameter.
Example
LISTENER1=
(DESCRIPTION=
7-31
Chapter 7
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=ipc)(KEY=extproc))
(ADDRESS=(PROTOCOL=tcps)(HOST=sales-server)(PORT=1522))))
SECURE_REGISTER_listener1=tcps
7.7.2 Using COST Parameters in Combination

COST parameters can also be used in combination to further control which transports
accept service registration and control commands.
In Example 7-12, control commands are accepted only on the IPC channel and the
TCPS transport, and service registrations are accepted only on an IPC channel.
Example 7-12 Combining COST Parameters
LISTENER1=
(DESCRIPTION=
(ADDRESS_LIST=
SECURE_CONTROL_listener1=(tcps,ipc)
SECURE_REGISTER_listener1=ipc
In Example 7-13, control commands are accepted only on the TCPS transport, and
service registrations are accepted only on the IPC channel.
Example 7-13 Combining COST Parameters
LISTENER1=
(DESCRIPTION=
(ADDRESS_LIST=
SECURE_CONTROL_listener1=tcps
SECURE_PROTOCOL_listener1=ipc
7.7.3 DYNAMIC_REGISTRATION_listener_name
DYNAMIC_REGISTRATION_listener_name is a class of secure transports (COST)
parameter and it enables or disables dynamic registration of a listener.
Purpose
To enable or disable dynamic registration.
Usage Notes
Static registrations are not affected by this parameter.
Default
The default value is on. Unless this parameter is explicitly set to off, all registration
connections are accepted.
7-32
Chapter 7
Values
• on: The listener accepts dynamic registration.
• off: The listener refuses dynamic registration.
DYNAMIC_REGISTRATION_listener_name=on
7.7.4 SECURE_PROTOCOL_listener_name
Purpose
To specify the transports on which administration and registration requests are accepted.
Usage Notes
If this parameter is configured with a list of transport names, then the control commands and
service registration can happen only if the connection belongs to the list of transports.
If this parameter is not present and neither SECURE_CONTROL_listener_name or
SECURE_REGISTER_listener_name are configured, then all supported transports accept
control and registration requests.
If the SECURE_CONTROL_listener_name and SECURE_REGISTER_listener_name
parameters are configured, then they override the SECURE_PROTOCOL_listener_name
parameter.
Syntax
SECURE_PROTOCOL_listener_name =
In the preceding syntax, transport1, transport2, and transportn are valid, installed
Example
LISTENER1=
(DESCRIPTION=
(ADDRESS_LIST=
SECURE_PROTOCOL_listener1=tcps
7.7.5 SECURE_CONTROL_listener_name
Purpose
To specify the transports on which control commands are to be serviced.
Usage Notes
If the SECURE_CONTROL_listener_name parameter is configured with a list of transport names,
then the control commands are serviced only if the connection is one of the listed transports.
Connections arriving by other transport protocols are refused. The following is an example:
7-33
Chapter 7
SECURE_CONTROL_listener1 = (TCPS,IPC)
In the preceding example, administration requests are accepted only on TCPS and
IPC transports.
If no values are entered for this parameter, then the listener accepts any connection on
any endpoint.
Syntax
SECURE_CONTROL_listener_name =
In the preceding syntax, transport1, transport2, and transportn are valid, installed
Example
LISTENER1=
(DESCRIPTION=
(ADDRESS_LIST=
SECURE_CONTROL_LISTENER1=tcps
7-34
8
Oracle Connection Manager Parameters
This chapter provides a complete listing of the cman.ora file configuration parameters.
• Overview of Oracle Connection Manager Configuration File

Oracle Connection Manager configuration information is stored in the cman.ora file.
• Oracle Connection Manager Parameters
This section lists and describes the following cman.ora file parameters:
• Oracle Connection Manager in Traffic Director Mode Parameters
• ADR Diagnostic Parameters for Oracle Connection Manager
The diagnostic data for critical errors is quickly captured and stored in the ADR for Oracle
Connection Manager.
• Non-ADR Diagnostic Parameters for Oracle Connection Manager
This section lists the parameters used when ADR is disabled:
8.1 Overview of Oracle Connection Manager Configuration File

Oracle Connection Manager configuration information is stored in the cman.ora file.
Oracle Connection Manager Configuration File

Oracle Connection Manager configuration information consists of the following elements:
• Protocol address of the Oracle Connection Manager listener
• Access control parameters
• Performance parameters
By default, the cman.ora file is located in the ORACLE_HOME/network/admin directory. The
cman.ora file can also be stored in the following locations:
• The directory specified by the TNS_ADMIN environment variable or registry value.

• On Linux and UNIX operating systems, the global configuration directory. For example,
on the Oracle Solaris operating system, this directory is /var/opt/oracle.
Example 8-1 Sample cman.ora File
CMAN=
(CONFIGURATION=
(ADDRESS=(PROTOCOL=tcp)(HOST=proxysvr)(PORT=1521))
(RULE_LIST=
(RULE=(SRC=192.0.2.32/27)(DST=sales-server)(SRV=*)(ACT=accept))
(ACTION_LIST=(AUT=on)(MCT=120)(MIT=30)))
(RULE=(SRC=foo)(DST=hr-server)(SRV=cmon)(ACT=accept)))
(PARAMETER_LIST=
(MAX_GATEWAY_PROCESSES=8)
(MIN_GATEWAY_PRCESSSES=3)
8-1
Chapter 8
Overview of Oracle Connection Manager Configuration File
(DIAG_ADR_ENABLED=ON)
(ADR_BASE=/oracle/log)))
cman.ora File Sections

• Listening address: Preceded by ADDRESS=, this section contains information
pertinent to the listener. The ADDRESS parameter is required.
• Rule list: Preceded by RULE_LIST=, this section contains rule information. TheRULE
parameter is listed in the rule list section of the file. The RULE parameter is
required.
• Parameter list: Preceded by PARAMETER_LIST=, this section contains all other
parameters including those listed in " ADR Diagnostic Parameters for Oracle
Connection Manager", and "Non-ADR Diagnostic Parameters for Oracle
Connection Manager".
The following parameters are allowed in the parameter list section of the cman.ora
file. The default values are bold. To override the default setting for a parameter,
enter the parameter and a nondefault value.
ASO_AUTHENTICATION_FILTER={off | on}
CONNECTION_STATISTICS={no | yes}
EVENT_GROUP={init_and_term | memory_ops | conn_hdlg | proc_mgmt |
reg_and_load | wake_up | timer | cmd_proc | relay}
IDLE_TIMEOUT=0 or greater
INBOUND_CONNECT_TIMEOUT=0 or greater. The default value is 60.
LOG_DIRECTORY=log_directory. The default value is ORACLE_HOME/network/log.
LOG_LEVEL={off | user | admin | support}
MAX_CMCTL_SESSIONS= Any positive number. The default value is 4.
MAX_CONNECTIONS= A value between 1 and 1024. The default value is 256.
MAX_GATEWAY_PROCESSES= Any number greater than the minimum number of
gateway processes up to 64. The default value is 16.
MIN_GATEWAY_PROCESSES= Any positive number less than or equal to 64. Must be
less than or equal to the maximum number of gateway processes. The default
value is 2.
OUTBOUND_CONNECT_TIMEOUT=0 or greater
PASSWORD_instance_name= Value is the encrypted instance password, if one has
been set. The default value is no value.
SESSION_TIMEOUT=0 or greater
TRACE_DIRECTORY=trace_directory. The default value is ORACLE_HOME/network/
trace.
TRACE_FILELEN= Any positive number. The default value is 0 (zero).
TRACE_FILENO= Any positive number. The default value is 0 (zero).
TRACE_LEVEL={off | user | admin | support}
TRACE_TIMESTAMP={off | on}
8-2
Chapter 8
Note:
You cannot add the parameter PASSWORD_instance_name directly to the

cman.ora file. The parameter is added using the SAVE_PASSWD command.
(PARAMETER_LIST=
(ASO_AUTHENTICATION_FILTER=ON)
(CONNECTION_STATISTICS=NO)
(EVENT_GROUP=INIT_AND_TERM,MEMORY_OPS,PROCESS_MGMT)
(IDLE_TIMEOUT=30)
(INBOUND_CONNECT_TIMEOUT=30)
(LOG_DIRECTORY=/home/user/network/admin/log)
(LOG_LEVEL=SUPPORT)
(MAX_CMCTL_SESSIONS=6)
(MAX_CONNECTIONS=512)
(MAX_GATEWAY_PROCESSES=10)
(MIN_GATEWAY_PROCESSES=4)
(OUTBOUND_CONNECT_TIMEOUT=30)
(SESSION_TIMEOUT=60)
(TRACE_DIRECTORY=/home/user/network/admin/trace)
(TRACE_FILELEN=100)
(TRACE_FILENO=2)
(TRACE_LEVEL=SUPPORT)
(TRACE_TIMESTAMP=ON)
(VALID_NODE_CHECKING_REGISTRATION=ON)
(REGISTRATION_EXCLUDED_NODES = 10.1.26.*)
(REGISTRATION_INVITED_NODES = 10.1.35.*)
)
8.2 Oracle Connection Manager Parameters

• ADDRESS
The ADDRESS networking parameter specifies the protocol address of Oracle Connection
Manager.
• ASO_AUTHENTICATION_FILTER
It is a networking parameter for Oracle Connection Manager. It instructs Oracle
Connection Manager to check the connection requests for Secure Network Services
(SNS).
• COMPRESSION
• COMPRESSION_LEVELS
The COMPRESSION_LEVELS networking parameter of the cman.ora file specifies the CPU
usage and compression ratio.
• COMPRESSION_THRESHOLD
• CONNECTION_STATISTICS
CONNECTION_STATISTICS networking parameter of the cman.ora file specifies whether the
SHOW_CONNECTIONS command displays connection statistics.
8-3
Chapter 8
• EVENT_GROUP
EVENT_GROUP networking parameter of the cman.ora file specifies which event
groups are logged.
• EXPIRE_TIME
The EXPIRE_TIME networking parameter of cman.ora file specifies a time interval,
in minutes, to send a check to verify that client/gateway connections are active.
• IDLE_TIMEOUT
• INBOUND_CONNECT_TIMEOUT
• LOG_DIRECTORY
• LOG_FILE_NUM
LOG_FILE_NUM networking parameter of the cman.ora file specifies the number of
log file segments.
• LOG_FILE_SIZE
LOG_FILE_SIZE networking parameter of thecman.ora file specifies the size of each
log file segment.
• LOG_LEVEL
• MAX_ALL_CONNECTIONS
• MAX_CMCTL_SESSIONS
• MAX_CONNECTIONS
• MAX_GATEWAY_PROCESSES
• MAX_REG_CONNECTIONS
• MIN_GATEWAY_PROCESSES
• OUTBOUND_CONNECT_TIMEOUT
• PASSWORD_instance_name
• REGISTRATION_EXCLUDED_NODES
The Oracle Connection Manager parameter file (cman.ora)
REGISTRATION_EXCLUDED_NODES specifies the list of nodes that cannot
register with the listener.
• REGISTRATION_INVITED_NODES
REGISTRATION_EXCLUDED_NODES parameter specifies the list of node that can
register with the listener.
• RULE
• SDU
• SERVICE_RATE
The SERVICE_RATE parameter of cman.ora file specifies incoming connection
rate that is allowed per service for an instance.
• SESSION_TIMEOUT
• TRACE_FILE
• TRACE_FILELEN
• TRACE_FILENO
• TRACE_LEVEL
8-4
Chapter 8
• TRACE_TIMESTAMP
• USE_SID_AS_SERVICE
The USE_SID_AS_SERVICE Oracle Connection Manager parameter enables the system
identifier (SID) in the connect descriptor to be interpreted as a service name when a user
attempts a database connection.
• VALID_NODE_CHECKING_REGISTRATION
• WALLET_LOCATION
8.2.1 ADDRESS
The ADDRESS networking parameter specifies the protocol address of Oracle Connection
Manager.
Purpose
To specify the protocol address of Oracle Connection Manager.
Syntax
(ADDRESS=(PROTOCOL=protocol)(HOST=host_name)(PORT=port_number)
Example
8.2.2 ASO_AUTHENTICATION_FILTER
It is a networking parameter for Oracle Connection Manager. It instructs Oracle Connection
Manager to check the connection requests for Secure Network Services (SNS).
Purpose
To specify whether Oracle Database security authentication settings must be used by the
client.
Usage Notes
The global setting can be overridden by a rule-level setting in ACTION_LIST.
Values
• on to instruct Oracle Connection Manager to reject connection requests that are not using
Secure Network Services (SNS). SNS is part of Oracle Database security.
• off to instruct Oracle Connection Manager not to check for SNS between the client and
server. This is the default.
8-5
Chapter 8
8.2.3 COMPRESSION
Purpose
To enable or disable data compression. If both the Oracle Connection Manager and
the other end (server or client or Oracle Connection Manager) have this parameter set
to ON, then compression is used for the connection.
Default
off
Values
Example
COMPRESSION=on
8.2.4 COMPRESSION_LEVELS
The COMPRESSION_LEVELS networking parameter of the cman.ora file specifies the CPU
usage and compression ratio.
Purpose
Usage Notes
The compression levels are used at the time of negotiation to verify which levels are
used at both ends, and select one level.
Default
low
Values
• low for low CPU usage and a low compression ratio.
• high for high CPU usage and a high compression ratio.
Example 8-2 Example
COMPRESSION_LEVELS=high,low
8.2.5 COMPRESSION_THRESHOLD
Purpose
To specify the minimum data size, in bytes, for which compression is required.
8-6
Chapter 8
Usage Notes
Compression is not be done if the size of the data to be sent is less than this value.
Default
1024 bytes
Example
COMPRESSION_THRESHOLD=1024
8.2.6 CONNECTION_STATISTICS
CONNECTION_STATISTICS networking parameter of the cman.ora file specifies whether the
SHOW_CONNECTIONS command displays connection statistics.
Purpose
To specify whether the SHOW_CONNECTIONS command displays connection statistics.
Usage Notes
Values
• yes to display statistics.
• no to not display statistics. This is the default.
8.2.7 EVENT_GROUP
EVENT_GROUP networking parameter of the cman.ora file specifies which event groups are
logged.
Purpose
To specify which event groups are logged.
Usage Notes
Multiple events may be designated using a comma-delimited list.
Values
• alert for alert notifications.
• cmd_proc for command processing.
• conn_hdlg for connection handling.
• init_and_term for initialization and termination.
• memory_ops for memory operations.
• proc_mgmt for process management.
• reg_and_load for registration and load update.
8-7
Chapter 8
• relay for events associated with connection control blocks.

• timer for gateway timeouts.
• wake_up for events related to Connection Manager Administration (CMADMIN)
wake-up queue.
Note:
The event group ALERT cannot be turned off.
8.2.8 EXPIRE_TIME
The EXPIRE_TIME networking parameter of cman.ora file specifies a time interval, in
minutes, to send a check to verify that client/gateway connections are active.
Purpose
To specify a time interval, in minutes, to send a check to verify that client/server
connections are active.
Usage Notes
Setting a value greater than 0 ensures that connections are not left open indefinitely,
due to an abnormal client termination. If the system supports TCP keepalive tuning,
then Oracle Net Services automatically uses the enhanced detection model, and tunes
the TCP keepalive parameters
If the probe finds a terminated connection, or a connection that is no longer in use,
then it returns an error, causing the server process to exit.
This parameter is primarily intended for the database server, which typically handles
multiple connections at any one time.
Limitations on using this terminated connection detection feature are:
• It is not allowed on bequeathed connections.
• Though very small, a probe packet generates additional traffic that may
downgrade network performance.
• Depending on which operating system is in use, the server may need to perform
additional processing to distinguish the connection probing event from other
events that occur. This can also result in degraded network performance.
Values
• 0 to disable dead connection detection. This is the default
• Any number greater than 0 to enable dead connection detection. The number
equals the time interval in minutes.
Example 8-3 Example
EXPIRE_TIME=10
8-8
Chapter 8
8.2.9 IDLE_TIMEOUT
Purpose
To specify the amount of time that an established connection can remain active without
transmitting data.
Usage Notes
Values
• 0 to disable the timeout. This is the default.
• Any number greater than 0 to enable the timeout. The number equals the timeout period
in seconds.
8.2.10 INBOUND_CONNECT_TIMEOUT
Purpose
To specify how long in seconds the Oracle Connection Manager listener waits for a valid
connection from a client or another instance of Oracle Connection Manager.
Values
• 60 sec is the default. Use value 0 to disable timeout.
• Any number greater than 0 to enable the timeout. The number equals the timeout period
in seconds.
8.2.11 LOG_DIRECTORY
Purpose
To specify the directory for the Oracle Connection Manager log files.
Default
ORACLE_BASE_HOME/network/log
8.2.12 LOG_FILE_NUM
LOG_FILE_NUM networking parameter of the cman.ora file specifies the number of log file
segments.
Purpose
To specify the number of log file segments. At any point of time there can be only n log file
segments where n is LOG_FILE_NUM and if the log grows beyond this number, then the older
segments are deleted.
8-9
Chapter 8
Default
No default. Number of segments grow indefinitely, if not specified or set to zero.
Values
Any integer value.
Example 8-4 Example
LOG_FILE_NUM=3
8.2.13 LOG_FILE_SIZE
LOG_FILE_SIZE networking parameter of thecman.ora file specifies the size of each log
file segment.
Purpose
To specify the size of each log file segment. The size is in MB.
Default
300 MB
Values
Any integer value.
Example 8-5 Example
LOG_FILE_SIZE=10
8.2.14 LOG_LEVEL
Purpose
To specify the level for log messages.
Values
• off for no logging. This is the default.
• user for user-induced errors log information.
• admin for administration log information, such as installation-specific.
• support for Oracle Support Services information.
8.2.15 MAX_ALL_CONNECTIONS
Purpose
To specify the maximum number of concurrent registration and client connection
sessions that can be supported by Oracle Connection Manager.
8-10
Chapter 8
Usage Notes
This number includes registration connections from databases, and ongoing client connection
establishment requests. After a connection is established, the clients do not maintain a
connection to the listener. This limit only applies to client connections that are in the initial
connection establishment phase from a listener perspective.
Default
Operating system-specific
Example
MAX_ALL_CONNECTIONS=40
8.2.16 MAX_CMCTL_SESSIONS
Purpose
To specify the maximum number of concurrent local or remote sessions of the Oracle
Connection Manager control utility allowable for a given instance.
Usage Notes
One of the sessions must be a local session.
Values
Any number of sessions can be designated.
8.2.17 MAX_CONNECTIONS
Purpose
To specify the maximum number of connection slots that a gateway process can handle.
Values
Any number in the range of 1 to 1024.
8.2.18 MAX_GATEWAY_PROCESSES
Purpose
To specify the maximum number of gateway processes that an instance of Oracle Connection
Manager supports.
Values
The number designated must be greater than the minimum number of gateway processes.
The maximum is 64.
8-11
Chapter 8
8.2.19 MAX_REG_CONNECTIONS
Purpose
To specify the maximum number of concurrent registration connection sessions that
can be supported by Oracle Connection Manager.
Default
512
Example
MAX_REG_CONNECTIONS=20
8.2.20 MIN_GATEWAY_PROCESSES
Purpose
To specify the minimum number of gateway processes that an instance of Oracle
Connection Manager supports.
Values
Any number of sessions can be designated up to 64.
8.2.21 OUTBOUND_CONNECT_TIMEOUT
Purpose
To specify the length of time in seconds that the Oracle Connection Manager instance
waits for a valid connection to be established with the database server or with another
Oracle Connection Manager instance.
Values
• Any number greater than 0 to enable the timeout. The number equals the timeout
period in seconds.
8.2.22 PASSWORD_instance_name
Purpose
To specify the encrypted instance password, if one has been set.
8-12
Chapter 8
8.2.23 REGISTRATION_EXCLUDED_NODES
REGISTRATION_EXCLUDED_NODES specifies the list of nodes that cannot register with
the listener.
Purpose
To specify the list of nodes that cannot register with the listener.
Usage Notes
If the REGISTRATION_INVITED_NODES parameter and the REGISTRATION_EXCLUDED_NODES
parameter are set, then the REGISTRATION_EXCLUDED_NODES parameter is ignored.
Values
Example
REGISTRATION_EXCLUDED_NODES = 10.1.26.*, 10.16.40.0/24, \

2001:DB8:3eff:fe38, node2
8.2.24 REGISTRATION_INVITED_NODES
The Oracle Connection Manager parameter file (cman.ora) REGISTRATION_EXCLUDED_NODES
parameter specifies the list of node that can register with the listener.
Purpose
To specify the list of node that can register with the listener.
Usage Notes
If the REGISTRATION_INVITED_NODES parameter and the REGISTRATION_EXCLUDED_NODES
parameter are set, then the REGISTRATION_EXCLUDED_NODES parameter is ignored.
Values
8-13
Chapter 8
Example
REGISTRATION_INVITED_NODES = 10.1.35.*, 10.1.34.0/24, \

2001:DB8:fe38:7303, node1
8.2.25 RULE
Purpose
To specify an access control rule list to filter incoming connections.
Usage Notes
A rule list specifies which connections are accepted, rejected, or dropped.
If no rules are specified, then all connections are rejected.
The source and destination can be a host name, IP address, or subnet mask.
There must be at least one rule for client connections and one rule for CMCTL
connections. Omitting one or the other results in the rejection of all connections for the
rule type omitted. The last rule in the example that follows is a CMCTL rule.
Oracle Connection Manager does not support wildcards for partial IP addresses. If you
use a wildcard, then use it in place of a full IP address. The IP address of the client
may, for example, be (SRC=*).
Oracle Connection Manager supports only the /nn notation for subnet addresses. In
the first rule in Example “Sample cman.ora File”, /27 represents a subnet mask that
comprises 27 left-most bits.
Values
This parameter is listed in the rule list section of the cman.ora file preceded by
RULE_LIST=.
Syntax
(RULE_LIST=
(RULE=
(SRC=host)
(DST=host)
(SRV=service_name)
(ACT={accept|reject|drop})
(ACTION_LIST=AUT={on|off}
((CONN_STATS={yes|no})(MCT=time)(MIT=time)(MOCT=time)))
(RULE= ...))
The RULE parameter filters a connection or group of connections using the following
parameters:
SRC: The source host name or IP address of the client.
DST: The destination server host name or IP address of the database server.
8-14
Chapter 8
SRV: The database service name of Oracle Database obtained from the SERVICE_NAME
parameter in the initialization parameter file.
ACT: The action for the connection request. Use accept to accept incoming requests, reject
to reject incoming requests, or drop to reject incoming requests without sending an error
message.
ACTION_LIST: The rule-level parameter settings for some parameters. These parameters are
as follows:
• AUT: Oracle Database security authentication on client side.
• CONN_STATS: Log input and output statistics.
• MCT: Maximum connect time.
• MIT: Maximum idle timeout.
• MOCT: Maximum outbound connect time.
Rule-level parameters override their global counterparts.
Example
(RULE_LIST=
(RULE=
(SRC=client1-pc)
(DST=sales-server)
(SRV=sales.us.example.com)
(ACT=reject))
(RULE=
(SRC=192.0.2.45)
(DST=192.0.2.200)
(SRV=db1)
(ACT=accept))
(RULE=
(SRC=sale-rep)
(DST=sales1-server)
(SRV=cmon)
(ACT=accept)))
8.2.26 SDU
Purpose
To specify the session data unit (SDU) size, in bytes, to connections
Usage Notes
Oracle Connection Manager can negotiate large SDU with client and server when configured.
When the configured values of client, database server, and Oracle Connection Manager do
not match for a session, the least value of all the three values is used.
Default
8192 bytes (8 KB)
Values
512 to 2097152 bytes
8-15
Chapter 8
Example
SDU=32768
8.2.27 SERVICE_RATE
The SERVICE_RATE parameter of cman.ora file specifies incoming connection rate
that is allowed per service for an instance.
Purpose
To specify incoming connection rate that is allowed per service for an instance.
Usage Notes
Any user-specified value greater than 0 sets the maximum limit on the number of new
connections per service-instance handled by the proxy listener every second. Listener
rejects connections after it reaches the maximum limit. Client side connection failure is
reported with “TNS:listener: rate limit reached”.
Values
• 0 to disable service rate limit. This is the default.
• Any number greater than 0 to enable service rate limit.
Example 8-6 Example
SERVICE_RATE=10
8.2.28 SESSION_TIMEOUT
Purpose
To specify the maximum time in seconds allowed for a user session.
Usage Notes
Values
• Any number greater than 0 to enable the timeout. The number equals the timeout
period in seconds.
8.2.29 TRACE_FILE
Purpose
To specify the directory for Oracle Connection Manager trace files.
8-16
Chapter 8
8.2.30 TRACE_FILELEN
Purpose
To specify the size of the trace file in KB.
Usage Notes
When the size is reached, the trace information is written to the next file. The number of files
is specified with the TRACE_FILENO parameter.
8.2.31 TRACE_FILENO
Purpose
To specify the number of trace files.
Usage Notes
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.
8.2.32 TRACE_LEVEL
Purpose
To specify the level for trace messages.
Values
• off for no tracing. This is the default.
• user for user-induced errors trace information.
• admin for administration trace information, such as installation-specific.
• support for Oracle Support Services information.
8.2.33 TRACE_TIMESTAMP
Purpose
To specify the use of a timestamp for the tracing logs.
Usage Notes
If the TRACING parameter is enabled, then a time stamp in the form of dd-mmm-yyyy
hh:mi:ss:mil for every trace event in the trace file.
Values
• off for no timestamp to be included in the file.
• on for timestamp to be included in the file.
8-17
Chapter 8
8.2.34 USE_SID_AS_SERVICE
The USE_SID_AS_SERVICE Oracle Connection Manager parameter enables the system
identifier (SID) in the connect descriptor to be interpreted as a service name when a
user attempts a database connection.
Purpose
To enable the system identifier (SID) in the connect descriptor to be interpreted as a
service name when a user attempts a database connection.
Usage Notes
Database clients with earlier releases of Oracle Database that have hard-coded
connect descriptors can use this parameter to connect to a container or pluggable
database.
For an Oracle container database, the client must specify a service name in order to
connect to it. Setting this parameter to on instructs the Oracle Connection Manager
listener to use the SID in the connect descriptor as a service name and connect the
client to the specified database.
Values
• off. This is the default.
• on.
Example 8-7 Example
USE_SID_AS_SERVICE=on.
8.2.35 VALID_NODE_CHECKING_REGISTRATION
Purpose
To determine whether valid node checking registration is performed, and if the subnet
is allowed.
Usage Notes
When set to on, valid node checking registration is performed at the listener for any
incoming registration request, and only local IP addresses are allowed.
Default
on
Values
• off | 0 to specify valid node checking registration is off, and no checking is
performed.
• on | 1 | local to specify valid node checking registration is on, and all local IP
addresses can register. If a list of invited nodes is set, then all IP addresses, host
names, or subnets in the list as well as local IP addresses are allowed.
8-18
Chapter 8
• subnet | 2 to specify valid node checking registration is on, and all machines in the local
subnets are allowed to register. If a list of invited nodes is set, then all nodes in the local
subnets as well as all IP addresses, host names and subnets in the list are allowed.
Example
VALID_NODE_CHECKING_REGISTRATION = on
Purpose
To specify the location of wallets. Wallets are certificates, keys, and trustpoints processed by
SSL.
Usage Notes
The key/value pair for Microsoft certificate store (MCS) omits the METHOD_DATA parameter
because MCS does not use wallets. Instead, Oracle PKI (public key infrastructure)
applications obtain certificates, trustpoints and private keys directly from the user's profile.
If an Oracle wallet is stored in the Microsoft Windows registry and the wallet's key (KEY) is
Note:
This parameter must be specified outside Oracle Connection Manager alias
Syntax
The syntax depends on the wallet, as follows:
• Oracle wallets on the file system:
WALLET_LOCATION=
(SOURCE=
(METHOD=file)
(METHOD_DATA=
• Microsoft certificate store:

WALLET_LOCATION=
(SOURCE=
(METHOD=mcs))
• Oracle wallets in the Microsoft Windows registry:

WALLET_LOCATION=
(SOURCE=
(METHOD=reg)
(METHOD_DATA=
8-19
Chapter 8
• Entrust wallets:
WALLET_LOCATION=
(SOURCE=
(METHOD=entr)
(METHOD_DATA=
(PROFILE=file.epf)
WALLET_LOCATION supports the following parameters:
• SOURCE: The type of storage for wallets, and storage location.

• METHOD: The type of storage.
• METHOD_DATA: The storage location.
• DIRECTORY: The location of Oracle wallets on file system.
• KEY: The wallet type and location in the Microsoft Windows registry.
• PROFILE: The Entrust profile file (.epf).
• INIFILE: The Entrust initialization file (.ini).
Default
None
Values
true | false
Examples
WALLET_LOCATION=
(SOURCE=
(METHOD=file)
(METHOD_DATA=

WALLET_LOCATION=
(SOURCE=
(METHOD=mcs))

WALLET_LOCATION=
(SOURCE=
(METHOD=REG)
(METHOD_DATA=
(KEY=SALESAPP)))
Entrust Wallets:
WALLET_LOCATION=
(SOURCE=
8-20
Chapter 8
Oracle Connection Manager in Traffic Director Mode Parameters
(METHOD=entr)
(METHOD_DATA=
8.3 Oracle Connection Manager in Traffic Director Mode

Parameters
• SERVICE_AFFINITY
Use the cman.ora parameter SERVICE_AFFINITY to modify the default load distribution
mechanism for Oracle Connection Manager in Traffic Director Mode.
• TDM
• TDM_BIND_THREAD
• TDM_DATATYPE_CHECK
• TDM_PRCP_MAX_CALL_WAIT_TIME
• TDM_PRCP_MAX_TXN_CALL_WAIT_TIME
• TDM_SHARED_THREADS_MAX
• TDM_SHARED_THREADS_MIN
• TDM_THREADING_MODE
8.3.1 SERVICE_AFFINITY
Use the cman.ora parameter SERVICE_AFFINITY to modify the default load distribution
mechanism for Oracle Connection Manager in Traffic Director Mode.
Purpose
To configure load distribution mechanism for Oracle Connection Manager in Traffic Director
Mode. By default, Oracle Connection Manager in Traffic Director Mode uses service affinity to
select a gateway for routing incoming connection requests. All new connection requests are
routed to the gateways associated with database services.
Usage Notes
If you set this parameter to ON, then all new connection requests are routed to the gateways
associated with database services.
If you set this parameter to OFF, then all new connection requests are routed to the least-
loaded gateways.
Values
• ON
• OFF
Default
ON
8-21
Chapter 8
Example
SERVICE_AFFINITY = {ON | OFF}
Related Topics
• Oracle Multitenant Administrator's Guide
8.3.2 TDM
Purpose
To configure Oracle Connection Manager to act as Oracle Connection Manager in
Traffic Director Mode.
Default
FALSE
Values
• TRUE
• FALSE
Example
tdm = TRUE
8.3.3 TDM_BIND_THREAD
Purpose
To make the application connection hold on to the TDM thread and has different
implications with and without PRCP. This parameter only applies when
TDM_THREADING_MODE is set to SHARED.
Usage Notes
Without PRCP, setting this parameter to yes makes the application connection hold on
the TDM worker thread as long as there is a transaction in progress.
With PRCP, setting this parameter to yes makes the application connection hold on to
the TDM thread from the time OCISessionGet is done by the application till it does an
OCISessionRelease.
Default
no
Values
• yes
8-22
Chapter 8
• no
Example
TDM_BIND_THREAD = yes
8.3.4 TDM_DATATYPE_CHECK
Purpose
To validate all the inbound data to the database, of the data type NUMBER, DATE, TIMESTAMP,
TIMESTAMP WITH LOCAL TIMEZONE, TIMESTAMP WITH TIMEZONE, BLOB, CLOB, BFILE,
UROWID and REF. The following error is received by the application if there is any problem with
the data sent to the Oracle Connection Manager in Traffic Director Mode.
ORA-03137: malformed TTC packet from client rejected: [3101]
Usage Notes
Turning ON/OFF this parameter enables or disables the data validation.
Default
OFF
Values
• ON
• OFF
Example
tdm_datatype_check={ON | OFF}
8.3.5 TDM_PRCP_MAX_CALL_WAIT_TIME
Purpose
To record the maximum time of inactivity, in seconds, for a client after obtaining a session
from the PRCP pool. This parameter is applicable when the Oracle Connection Manager in
Traffic Director Mode is configured to have Proxy Resident Connection Pool.
Usage Notes
After obtaining a session from the PRCP pool, if the client application does not issue a
database call for the time specified by TDM_PRCP_MAX_CALL_WAIT_TIME parameter, then the
PRCP session is freed and the client connection is terminated. As a result, if the client
application attempts a round trip call on such a connection, then it receives an ORA-3113 or
ORA-3115 error.
Default
30 seconds
8-23
Chapter 8
Values
Any non negative value. However, Oracle recommends not to use a value of 0 as that
implies that a connection can acquire a PRCP session for an indefinite amount of time
8.3.6 TDM_PRCP_MAX_TXN_CALL_WAIT_TIME
Purpose
To record the maximum time of inactivity, in seconds, for a client after it obtains a
session from the Proxy Resident Connection Pool and starts a transaction. This
parameter is applicable when the Oracle Connection Manager in Traffic Director Mode
is configured to have PRCP.
Usage Notes
If the client application does not issue a database call for the time specified by
TDM_PRCP_MAX_TXN_CALL_WAIT_TIME parameter while in a transaction, the PRCP
session is freed, the transaction is rolled back, and the client connection is terminated.
As a result, if the client application attempts a round trip call on such a connection,
then it receives an ORA-3113 or ORA-3115 error.
Default
0
Values
Any nonnegative value. However, it is recommended not to use a value of0 as it
implies that a connection can acquire a PRCP session for an indefinite amount of time.
8.3.7 TDM_SHARED_THREADS_MAX
Purpose
To configure the maximum number of threads that an Oracle Connection Manager
process in Traffic Director Mode should have, when tdm_threading_mode is set to
SHARED.
Values
Any number can be designated for the maximum number of threads. For DEDICATED
mode, the maximum number of threads is same as the maximum number of
connections. In SHARED mode, though there is no fixed upper bound, it should ideally
be proportional to the load.
8.3.8 TDM_SHARED_THREADS_MIN
Purpose
To configure the minimum number of threads that an Oracle Connection Manager
process in Traffic Director Mode should have, when tdm_threading_mode is set to
SHARED.
8-24
Chapter 8
ADR Diagnostic Parameters for Oracle Connection Manager
Values
Any number can be designated for the minimum number of threads. For SHARED mode, there
is no limit enforced. However, the number of threads should be proportional to the load.
8.3.9 TDM_THREADING_MODE
Purpose
To configure the usage of threads by the Oracle Connection Manager in Traffic Director
Mode.
Usage Notes
If this parameter is set to DEDICATED, then a worker thread is spawned for each inbound
connection and the maximum number of threads is determined by the max_connections
parameter
If this parameter is set to SHARED, then a shared pool of worker threads handle all inbound
connections. The minimum number of worker threads is specified by the
tdm_shared_threads_min setting and the maximum number of worker threads is specified by
the tdm_shared_threads_max setting. The thread pool is internally managed within these
bounds.
Default
DEDICATED
Values
• DEDICATED
• SHARED
Example
tdm_threading_mode={DEDICATED | SHARED}
tdm_shared_threads_min = 4
tdm_shared_threads_max = 5
8.4 ADR Diagnostic Parameters for Oracle Connection Manager

The diagnostic data for critical errors is quickly captured and stored in the ADR for Oracle
Connection Manager.
number. The data is then stored in the Automatic Diagnostic Repository (ADR), a file-based
repository outside the database.
8-25
Chapter 8
This section describes the parameters used when ADR is enabled. ADR is enabled by
default. Non-ADR parameters listed in the cman.ora file are ignored when ADR is
enabled.
• ADR_BASE
It is a diagnostic parameter in the cman.ora file and it specifies the base directory
to store tracing and logging incidents when ADR is enabled.
• DIAG_ADR_ENABLED
DIAG_ADR_ENABLED diagnostic parameter of the cman.ora file indicates whether
ADR tracing is enabled.
• LOG_LEVEL
• TRACE_LEVEL
• TRACE_TIMESTAMP
8.4.1 ADR_BASE
It is a diagnostic parameter in the cman.ora file and it specifies the base directory to
store tracing and logging incidents when ADR is enabled.
Purpose
To specify the base directory to store tracing and logging incidents when ADR is
enabled.
Default
The default is ORACLE_BASE, or ORACLE_HOME/log if ORACLE_BASE is not defined.
Values
Example 8-8 Example
ADR_BASE=/oracle/network/trace
8.4.2 DIAG_ADR_ENABLED
DIAG_ADR_ENABLED diagnostic parameter of the cman.ora file indicates whether ADR
tracing is enabled.
Purpose
To indicate whether ADR tracing is enabled.
Usage Notes
When the DIAG_ADR_ENABLED parameter is set to OFF, then non-ADR file tracing is
used.
Values
on | off
8-26
Chapter 8
Example 8-9 Example

DIAG_ADR_ENABLED=on
8.4.3 LOG_LEVEL
Purpose
To specify the level of logging performed by Oracle Connection Manager.
Usage Notes
This parameter is also applicable when non-ADR logging is used.
The following log files are used with Oracle Connection Manager:
• instance-name_pid.log for the listener.
• instance-name_cmadmin_pid.log for CMADMIN.
• instance-name_cmgw_pid.log for the gateway processes.
The log files are located in the ORACLE_HOME/network/log directory.
Default
off or 0
Values
• off or 0 for no log output.
• user or 4 for user log information.
• admin or 10 for administration log information.
• support or 16 for Oracle Support Services log information.
Example
LOG_LEVEL=admin
8.4.4 TRACE_LEVEL
Purpose
To specify the trace level for the Oracle Connection Manager instance.
Usage Notes
The following trace files are used with Oracle Connection Manager:
• instance-name_pid.trc for the listener.
• instance-name_cmadmin_pid.trc for CMADMIN.
• instance-name_cmgw_pid.trc for the gateway processes.
The log files are located in the ORACLE_HOME/network/log directory.
8-27
Chapter 8
Non-ADR Diagnostic Parameters for Oracle Connection Manager
Default
off
Values
• off for no trace output.
• user for user trace information.
• admin for administration trace information.
• support for Oracle Support Services trace information.
Example
TRACE_LEVEL=admin
8.4.5 TRACE_TIMESTAMP
Purpose
To add a time stamp in the form of dd-mmm-yyyy hh:mi:ss:mil to every trace event in
the trace file for the listener.
Usage Notes
This parameter is used with the TRACE_LEVEL parameter. This parameter is also
applicable when non-ADR tracing is used.
Default
on
Values
• on or true
• off or false
Example
TRACE_TIMESTAMP=true
8.5 Non-ADR Diagnostic Parameters for Oracle Connection

Manager
This section lists the parameters used when ADR is disabled:
• LOG_DIRECTORY
• TRACE_DIRECTORY
• TRACE_FILELEN
• TRACE_FILENO
8-28
Chapter 8
8.5.1 LOG_DIRECTORY
Purpose
To specify the location of Oracle Connection Manager log files.
Usage Notes
Default
ORACLE_BASE_HOME/network/log
Values
Example
LOG_DIRECTORY=/oracle/network/log
8.5.2 TRACE_DIRECTORY
Purpose
To specify the location of the Oracle Connection Manager trace files.
Usage Notes
Default
ORACLE_BASE_HOME/network/trace
Values
Example
TRACE_DIRECTORY=/oracle/network/admin/trace
8.5.3 TRACE_FILELEN
Purpose
To specify the size, in KB, of the trace file.
Usage Notes
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. Any size can be designated. Use this
8-29
Chapter 8
Default
Unlimited
Example
TRACE_FILELEN=100
8.5.4 TRACE_FILENO
Purpose
To specify the number of trace files for Oracle Connection Manager tracing.
Usage Notes
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. Any number of files
can be designated.
For example, if this parameter is set to 3, then the gateway trace files would be named
instance-name_cmgw1_pid.trc, instance_name_cmgw2_pid.trc and
instance_name_cmgw3_pid.trc.
Default
1
Example
TRACE_FILENO=3
8-30
9
Directory Usage Parameters in the ldap.ora
File
This chapter provides a complete listing of the ldap.ora file configuration parameters.
• Overview of Directory Server Usage File

The ldap.ora file contains directory usage configuration parameters created by Oracle
Internet Directory Configuration Assistant, or Oracle Net Configuration Assistant. Do not
modify these parameters or their settings.
• Directory Usage Parameters
This section lists and describes the following ldap.ora file configuration parameters.
9.1 Overview of Directory Server Usage File

The ldap.ora file contains directory usage configuration parameters created by Oracle
Internet Directory Configuration Assistant, or Oracle Net Configuration Assistant. Do not
modify these parameters or their settings.
When created with Oracle Internet Directory Configuration Assistant, ldap.ora is located in
the ORACLE_HOME/ldap/admin directory. When created with Oracle Net Configuration
Assistant, the ldap.ora file is located in the ORACLE_HOME/network/admin directory. The
ldap.ora file can also be stored in the directory specified by the LDAP_ADMIN or TNS_ADMIN
environment variable.
Related Topics
• Oracle Internet Directory
• Oracle Net Configuration Assistant
9.2 Directory Usage Parameters

This section lists and describes the following ldap.ora file configuration parameters.
• DEFAULT_ADMIN_CONTEXT
DEFAULT_ADMIN_CONTEXT ldap.ora file configuration parameter specifies the default
directory for the creation, modification, or search of the connect identifiers.
• DIRECTORY_SERVER_TYPE
DIRECTORY_SERVER_TYPE is a networking parameter of theldap.ora file and it specifies
the type of directory server that is being used.
• DIRECTORY_SERVERS
DIRECTORY_SERVERS is a directory usage parameter and it lists the host names and port
number of the primary and alternate LDAP directory servers.
9-1
Chapter 9
Directory Usage Parameters
9.2.1 DEFAULT_ADMIN_CONTEXT
DEFAULT_ADMIN_CONTEXT ldap.ora file configuration parameter specifies the default
directory for the creation, modification, or search of the connect identifiers.
Purpose
To specify the default directory entry that contains an Oracle Context from which
connect identifiers can be created, modified, or looked up.
Values
Valid distinguished name (DN)
Example 9-1 Example
DEFAULT_ADMIN_CONTEXT="o=OracleSoftware,c=US"
9.2.2 DIRECTORY_SERVER_TYPE
DIRECTORY_SERVER_TYPE is a networking parameter of theldap.ora file and it specifies
the type of directory server that is being used.
Purpose
To specify the type of directory server that is being used.
Values
• oid for Oracle Internet Directory
• ad for Microsoft Active Directory
Example 9-2 Example
DIRECTORY_SERVER_TYPE=oid
9.2.3 DIRECTORY_SERVERS
DIRECTORY_SERVERS is a directory usage parameter and it lists the host names and port
number of the primary and alternate LDAP directory servers.
Purpose
To list the host names and port number of the primary and alternate LDAP directory
servers.
Values
host:port[:sslport]
Example 9-3 Example
DIRECTORY_SERVERS=(ldap-server1:389:636, ldap-server2:389:636)
9-2
Appendices
Review information about features no longer supported in this release, upgrade concerns,
and information about the Oracle Net Services LDAP schema.
• Features Not Supported in this Release
This appendix describes features no longer supported by Oracle Net Services.
• Upgrade Considerations for Oracle Net Services
This appendix describes the coexistence and upgrade issues for Oracle Net Services.
• LDAP Schema for Oracle Net Services
This appendix describes the Oracle schema object classes and attributes defined in the
directory server for Oracle Net Services objects. It does not describe object classes and
attributes reserved for future functionality or used by other Oracle products.
A
Features Not Supported in this Release
This appendix describes features no longer supported by Oracle Net Services.
• Overview of Unsupported Features

This section describes the features and the configuration file that are no longer being
supported in Oracle Database.
• Unsupported Parameters
This section describes the unsupported or obsolete parameters.
• Unsupported Control Utility Commands
This section describes the control utility commands not supported by this release.
• Unsupported or Deprecated Protocols
This section describes the protocols not supported or deprecated since Oracle Database
12c.
A.1 Overview of Unsupported Features

This section describes the features and the configuration file that are no longer being
supported in Oracle Database.
• Oracle Net Connection Pooling

In Oracle Database 12c Release 2 (12.2), Oracle Net connection pooling is no longer
supported
• Oracle Names
Oracle Names is not supported in this release.
• Oracle Net Listener Password
In Oracle Database 12c Release 2 (12.2), the Oracle Net Listener password feature is no
longer supported.
A.1.1 Oracle Net Connection Pooling

In Oracle Database 12c Release 2 (12.2), Oracle Net connection pooling is no longer
supported
Deprecation of Oracle Net Connection Pooling

It was deprecated in Oracle Database 11g release. Refer to My Oracle Support note
1469466.1.
A-1
Appendix A
Unsupported Parameters
A.1.2 Oracle Names

Oracle Names is not supported in this release.
Naming Method
Oracle Names has not been supported as a naming method since Oracle Database
11g. You must migrate to directory naming.
A.1.3 Oracle Net Listener Password

In Oracle Database 12c Release 2 (12.2), the Oracle Net Listener password feature is
no longer supported.
Oracle Net Listener Password Support

In Oracle Database 12c Release 2 (12.2), the Oracle Net Listener password feature is
no longer supported. This does not cause a loss of security because authentication is
enforced through local operating system authentication.
A.2 Unsupported Parameters

This section describes the unsupported or obsolete parameters.
Table A-1 Unsupported Networking Parameters
File Parameter Description Last Supported

Release
sqlnet.ora SQLNET.KERBEROS5_ This parameter was 11.2
CONF_MIT used to specify that
MIT Kerberos
configuration format
was used. Starting
with Oracle Database
12c Release 2 (12.2),
only the current MIT
Kerberos configuration
is supported.
sqlnet.ora SQLNET.ALLOWED_LO This parameter has 11.2
GON_VERSION been divided into
SQLNET.ALLOWED_LO
GON_VERSION_CLIEN
T and
SQLNET.ALLOWED_LO
GON_VERSION_SERVE
R.
A.3 Unsupported Control Utility Commands

This section describes the control utility commands not supported by this release.
A-2
Appendix A
Unsupported or Deprecated Protocols
Table A-2 Unsupported Network Control Utility Commands
Control Utility Commands Description Last Supported

Release
Oracle Names Control All commands Oracle Names is no 9.2
Utility longer supported.
A.4 Unsupported or Deprecated Protocols

This section describes the protocols not supported or deprecated since Oracle Database 12c.
Table A-3 Unsupported Protocols
Protocol Description Last Supported Release

NT LAN Manager (NTLM) NTLM domain authentication has 11.2
protocol for domain been deprecated from the Oracle
authentication Windows adapter. Only Kerberos
authentication is used for the
NTS adapter.
NTLM is still used for local user
authentication, as well as in the
case in which the database
service runs as a local user.
A-3
B
Upgrade Considerations for Oracle Net
Services
This appendix describes the coexistence and upgrade issues for Oracle Net Services.
• Anonymous Access to Oracle Internet Directory

Typical users of directory naming (LDAP) require anonymous access to the Oracle
Internet Directory for name lookup.
B.1 Anonymous Access to Oracle Internet Directory

Typical users of directory naming (LDAP) require anonymous access to the Oracle Internet
Directory for name lookup.
Oracle Internet Directory Setting

If you upgrade your Oracle Internet Directory software release 11g or later, then the default
setting for Oracle Internet Directory changes to disallow anonymous access to the directory.
The directory administrator must configure the directory to enable anonymous binds after
upgrading the directory to release 11g. In addition, the way anonymous binds are configured
in Oracle Internet Directory changed between Oracle Database 10g and Oracle Database
11g.
B-1
C
LDAP Schema for Oracle Net Services
This appendix describes the Oracle schema object classes and attributes defined in the
directory server for Oracle Net Services objects. It does not describe object classes and
attributes reserved for future functionality or used by other Oracle products.
• Structural Object Classes

The Oracle schema supports the structural object classes for Oracle Net directory
naming lookups.
• Attributes
It lists the attributes used for the object classes. This list is subject to change.
C.1 Structural Object Classes

The Oracle schema supports the structural object classes for Oracle Net directory naming
lookups.
Table C-1 Oracle Net Structural Object Classes
Object Class Attributes Description

orclDBServer • orclNetDescName Defines the attributes for
• orclVersion database service entries.
orclNetAddress • orclNetAddressString Specifies a listener protocol
• orclNetProtocol address.
• orclVersion
orclNetAddressAux1 • orclNetHostname Specifies an auxiliary object
class to add attributes to an
orclNetAddress entry.
orclNetAddressList • orclNetAddrList Specifies a list of protocol
• orclNetFailover addresses.
• orclNetLoadBalance
• orclNetSourceRoute
• orclVersion
orclNetDescription • orclNetAddrList Specifies a connect descriptor
• orclNetInstanceName containing the protocol address
• orclNetConnParamList of the listener and the connect
information to the service.
• orclNetFailover
• orclNetLoadBalance
• orclNetSdu
• orclNetServiceName
• orclNetSourceRoute
• orclSid
• orclVersion
C-1
Appendix C
Attributes
Table C-1 (Cont.) Oracle Net Structural Object Classes
Object Class Attributes Description

orclNetDescriptionAux1 • orclNetSendBufSize Specifies auxiliary object class to
• orclNetReceiveBufSize add attributes to an
• orclNetFailoverModeString orclNetDescription entry.
• orclNetInstanceRole
orclNetDescriptionList • orclNetDescList Specifies a list of connect
• orclVersion descriptors.
orclNetService • orclNetDescName Defines the attributes for network
• orclVersion service name entries.
orclNetServiceAlias • orclNetDescName Defines the attributes for network
• orclVersion service alias entries.
C.2 Attributes
It lists the attributes used for the object classes. This list is subject to change.
Table C-2 LDAP Schema Attributes for Oracle Net Services
Attribute Description
orclCommonContextMap Allows the mapping of more than one default
Oracle Context in the directory server.
orclNetAddrList Identifies one or more listener protocol
addresses.
orclNetAddressString Defines a listener protocol address.
orclNetConnParamList Placeholder for connect data parameters.
orclNetDescList Identifies one or more connect descriptors.
orclNetDescName Identifies a connect descriptor or a list of
connect descriptors.
orclNetFailover Turns connect-time failover on for a protocol
address list.
orclNetFailoverModeString Instructs Oracle Net to fail over to a different
listener if the first listener fails during runtime.
Depending on the configuration, session or
any SELECT statements that were in progress
are automatically failed over.
orclNetHostname Specifies the host name.
orclNetInstanceName Specifies the instance name to access.
orclNetInstanceRole Specifies a connection to the primary or
secondary instance of an Oracle Real
Application Clusters (Oracle RAC)
configuration.
orclNetLoadBalance Turns client load balancing on for a protocol
address list.
orclNetProtocol Identifies the protocol used in the
orclAddressString attribute.
C-2
Appendix C
Attributes
Table C-2 (Cont.) LDAP Schema Attributes for Oracle Net Services
Attribute Description
orclNetReceiveBufSize Specifies the buffer space limit for receive
operations of sessions.
orclNetSdu Specifies the session data unit (SDU) size.
orclNetSendBufSize Specifies the buffer space limit for send
operations of sessions.
orclNetServiceName Specifies the database service name in the
CONNECT_DATA portion.
orclNetSourceRoute Instructs Oracle Net to use each address in
order until the destination is reached.
orclSid Specifies the Oracle system identifier (SID) in
the CONNECT_DATA portion of a connection
descriptor.
orclVersion Specifies the version of software used to
create the entry.
C-3
Glossary
access control list (ACL)

The group of access directives that you define. The directives grant levels of access to
specific data for specific clients or groups of clients.
ACL
See access control list (ACL).
access control
A feature of Oracle Connection Manager that sets rules for denying or allowing certain clients
to access designated servers.
address
See protocol address.
ADR
See Automatic Diagnostic Repository (ADR).
alias
An alternative name for a network object in a server. An alias stores the name of the object it
is referencing. When a client requests a lookup of an alias, Oracle completes the lookup as if
it is the referenced object.
application gateway
A host computer that runs the Oracle Net Firewall Proxy. An application gateway looks and
acts like a real server from the client's point of view, and a real client from the server's point of
view. An application gateway sits between the Internet and company's internal network and
provides middleman services (or proxy services) to users on either side.
Glossary-1
Glossary
ASCII character set

American Standard Code for Information Interchange character set, a convention for
representing alphanumeric information using digital data. The collation sequence used
by most computers with the exception of IBM and IBM-compatible computers.
attribute
A piece of information that describes an aspect of a directory entry. An entry comprises
a set of attributes, each of which belongs to an object class. Moreover, each attribute
has both a type, which describes the kind of information in the attribute, and a value
which contains the actual data.
authentication method
A security method that enables you to have high confidence in the identity of users,
clients, and servers in distributed environments. Network authentication methods can
also provide the benefit of single sign-on for users. The following authentication
methods are supported:
• Kerberos
• Microsoft Windows NT native authentication
• Oracle Cloud Infrastructure (OCI) Identity and Access Management (IAM) user
authentication and authorization for Oracle Autonomous Cloud Databases (See
Oracle Database Security Guide)
• RADIUS
• Transport Layer Security (TLS)
Automatic Diagnostic Repository (ADR)

Automatic Diagnostic Repository is a systemwide central repository for tracing and
logging files. The repository is a file-based hierarchical data store for depositing
diagnostic information.
cache
Memory that stores recently-accessed data to so that subsequent requests to access
the same data can be processed quickly.
CIDR
Classless Inter-Domain Routing. In CIDR notation, an IPv6 subnet is denoted by the
subnet prefix and the size in bits of the prefix (in decimal), separated by the slash (/)
character. For example, 2001:0db8:0000:0000::/64 denotes a subnet with addresses
2001:0db8:000:0000:0000:0000:0000:0000 through
2001:0db8:000:0000:FFFF:FFFF:FFFF:FFFF. The CIDR notation includes support for
Glossary-2
Glossary
IPv4 addresses. For example, 192.0.2.1/24 denotes the subnet with addresses 192.0.2.1
through 192.0.2.255.
Classless Inter-Domain Routing (CIDR)

See CIDR.
client
A user, software application, or computer that requests the services, data, or processing from
another application or computer. The client is the user process. In a network environment, the
client is the local user process and the server may be local or remote.
client load balancing

Load balancing, whereby if more than one listener services a single database, a client can
randomly choose between the listeners for its connect requests. This randomization enables
all listeners to share the burden of servicing incoming connect requests.
client profile
The properties of a client, which may include the preferred order of naming methods, client
and server logging and tracing, the domain from which to request names, and other client
options.
client/server architecture
Software architecture based on a separation of processing between two CPUs. One CPU
acts as the client in the transaction, requesting and receiving services. The other acts as the
server that provides service for the requests.
cman.ora file
An Oracle Connection Manager configuration file that specifies protocol addresses for
incoming requests and administrative commands, as well as Oracle Connection Manager
parameters and access control rules.
CMADMIN (Connection Manager Administration)

An Oracle Connection Manager process that monitors the health of the listener and Oracle
Connection Manager gateway processes, shutting down and starting processes as needed.
CMADMIN registers information about gateway processes with the listener and processes
commands run with the Oracle Connection Manager Control utility.
CMGW (Connection Manager gateway)

An Oracle Connection Manager process that receives client connections screened and
forwarded by the listener located at the Oracle Connection Manager instance. The gateway
Glossary-3
Glossary
process forwards the requests to the database server. In addition, it can multiplex or
process multiple client connections through a single protocol connection.
connect data
A portion of the connect descriptor that defines the destination database service name
or Oracle system identifier (SID). In the following example, SERVICE_NAME defines a
database service called sales.us.example.com:
(DESCRIPTION=
(CONNECT_DATA=
connect descriptor
A specially-formatted description of the destination for a network connection. A
connect descriptor contains destination service and network route information.
The destination service is indicated by using its service name. The network route
provides, at a minimum, the location of the listener through use of a network address.
connect identifier
A connect descriptor or a name that maps to a connect descriptor. A connect identifier
can be a network service name, database service name, or network service alias.
Users initiate a connect request by passing a user name and password along with a
connect identifier in a connect string for the service to which they want to connect:
CONNECT username@connect_identifier
connect string
Information the user passes to a service to connect, such as user name, and connect
identifier:
CONNECT username@net_service_name
connect-time failover
A client connect request is forwarded to a another listener if a listener is not
responding. Connect-time failover is enabled by service registration, because the
listener knows if an instance is running to attempt a connection.
connection
An interaction between two processes on a network. Connections are originated by an
initiator (client) that requests a connection with a destination (server).
Glossary-4
Glossary
connection load balancing

The method for balancing the number of active connections for the same service across the
instances and dispatchers. Connection load balancing enables listeners to make routing
decisions based on how many connections for each dispatcher and the load on the nodes.
connection pooling
A resource utilization and user scalability feature used to maximize the number of sessions
over a limited number of protocol connections to a shared server.
connection request
A notification sent by an initiator and received by a listener that indicates that the initiator
wants to start a connection.
database token
An database token (db-token) is a unique string of characters used for Oracle Cloud
Infrastructure (OCI) Identity and Access Management (IAM) token-based authentication on
Oracle Autonomous Cloud Databases. IAM users can request this token from IAM using OCI
Command Line Interface (CLI).
data packet
See packet.
database link
A pointer that defines a one-way communication path from an Oracle database server to
another database server. Public and private database links are a defined entries in a data
dictionary table. Global database links are stored in an LDAP directory and can be accessed
by all users on the network. To access public and private links, the user must be connected to
the local database that contains the data dictionary entry.
A client connected to local database A can use a public or private link stored in database A to
access information in remote database B. However, users connected to database B cannot
use the same link to access data in database A. If local users on database B want to access
data on database A, then a link must be defined and stored in the data dictionary of database
B. Global links may be used between any clients and database on the network.
The following database links are supported:
• A private database link in a specific schema of a database. Only the owner of a private
database link can use it.
• A public database link for a database. All users in the database can use it.
• A global database link is a database link stored in the LDAP directory.
Glossary-5
Glossary
dedicated connection
A dedicated server with a database session.
dedicated server
A server process that is dedicated to one client connection. Contrast with shared
server.
default domain
The domain within which most client requests take place. It could be the domain where
the client resides, or it could be a domain from which the client requests network
services often. Default domain is also the client configuration parameter that
determines what domain should be appended to unqualified network name requests. A
name request is unqualified if it does not have a period (.) character within it.
directory information tree (DIT)

A hierarchical tree-like structure in a directory server of the distinguished names (DNs)
of the entries. This structure is specific to x500 and LDAP.
directory naming
A naming method that resolves a database service, network service name, or network
service alias to a connect descriptor stored in a central directory server. A directory
server provides central administration of directory naming objects, reducing the work
effort associated with adding or relocating services.
directory server
A directory server that is accessed with the Lightweight Directory Access Protocol
(LDAP). Support of LDAP-compliant directory servers provides a centralized method
for managing and configuring a distributed Oracle network. The directory server can
replace client-side and server-side localized tnsnames.ora files.
dispatcher
A process that enables many clients to connect to the same server without the need
for a dedicated server process for each client. A dispatcher handles and directs
multiple incoming network session requests to shared server processes.
distinguished name (DN)

Name of entry in a directory server. The DN specifies where the entry resides in the
LDAP directory hierarchy, similar to the way a directory path specifies the exact
location of a file.
Glossary-6
Glossary
distributed processing
Division of front-end and back-end processing to different computers. Oracle Net Services
supports distributed processing by transparently connecting applications to remote
databases.
domain
Any tree or subtree within the Domain Name System (DNS) namespace. Domain most
commonly refers to a group of computers whose host names share a common suffix, the
domain name.
Domain Name System (DNS)

A system for naming computers and network services that is organized into a hierarchy of
domains. DNS is used in TCP/IP networks to locate computers through user-friendly names.
DNS resolves a friendly name into an IP address, which is understood by computers.
For Oracle Net Services, DNS translates the host name in a TCP/IP address into an IP
address.
DNS
See Domain Name System (DNS).
enterprise role
An enterprise role is analogous to a regular database role, except that it spans authorization
on multiple databases. An enterprise role is a category of roles that define privileges on a
particular database. An enterprise role is created by the database administrator of a particular
database. An enterprise role can be granted to or revoked from one or more enterprise users.
The information for granting and revoking these roles is stored in the directory server.
enterprise user
A user that has a unique identity across an enterprise. Enterprise users connect to individual
databases through a schema. Enterprise users are assigned enterprise roles that determine
their access privileges on databases.
entry
The building block of a directory server, it contains information about an object of interest to
directory users.
Glossary-7
Glossary
external naming
A naming method that uses a third-party naming service, such as Network
Information Service (NIS).
external procedure
Function or procedure written in a third-generation language (3GL) that can be called
from PL/SQL code. Only C is supported for external procedures.
failover
See connect-time failover.
firewall support
See access control.
FTP
File Transfer Protocol. A client/server protocol which allows a user on one computer to
transfer files to and from another computer over a TCP/IP network.
global database link

A database link definition stored in an LDAP directory which can be accessed by all
users on the network. This definition is the same as the one used for client
connections to the database (name/connect-descriptor).
Global database links cannot include user or password clauses. They only work when
the database initiating the link uses the identity of the existing client to establish the
link.
global database name

The full name of the database which uniquely identifies it from any other database.
The global database name is of the form "database_name.database_domain," for
example, sales.us.example.com.
The database name portion, sales, is a simple name to call a database. The database
domain portion, us.example.com, specifies the database domain which the database is
located, making the global database name unique. When possible, Oracle
recommends that your database domain mirror the network domain.
The global database name is the default service name of the database, as specified by
the SERVICE_NAMES parameter in the initialization parameter file.
Glossary-8
Glossary
Heterogeneous Services
An integrated component that provides the generic technology for accessing non-Oracle
systems from the Oracle database server. Heterogeneous Services enables you to:
• Use Oracle SQL to transparently access data stored in non-Oracle systems as if the data
resides within an Oracle server.
• Use Oracle procedure calls to transparently access non-Oracle systems, services, or

application programming interfaces (APIs), from your Oracle distributed environment.
hierarchical naming model

An infrastructure in which names are divided into multiple hierarchically-related domains.
host naming
A naming method resolution that enables users in a TCP/IP environment to resolve names
through their existing name resolution service. This name resolution service might be Domain
Name System (DNS), Network Information Service (NIS), or simply a centrally-maintained set
of /etc/hosts files. Host naming enables users to connect to an Oracle database server by
simply providing the server computer's host name or host name alias. No client configuration
is required to take advantage of this feature. This method is recommended for simple TCP/IP
environments.
HTTP
Hypertext Transfer Protocol. A protocol that provides the language that enables Web
browsers and application Web servers to communicate.
identity management realm

A collection of identities, all of which are governed by the same administrative policies. In an
enterprise, all employees having access to the intranet may belong to one realm, while all
external users who access the public applications of the enterprise may belong to another
realm. An identity management realm is represented in the directory by a specific entry with a
special object class associated with it.
instance
The combination of the System Global Area (SGA) and the Oracle background processes.
When a database is started on a database server (regardless of the type of computer),
Oracle allocates a memory area called the SGA, and starts one or more Oracle processes.
The memory and processes of an instance efficiently manage the associated database data
and serve the database users. You can connect to any instance to access information within
a cluster database.
instance name
A name of an Oracle database instance. The instance name is identified by the
INSTANCE_NAME parameter in the database initialization parameter file. INSTANCE_NAME
Glossary-9
Glossary
corresponds to the Oracle system identifier (SID) of the instance. Clients can connect
to a specific instance by specifying the INSTANCE_NAME parameter in the connect
descriptor.
The instance name is included in the connect data part of the connect descriptor.
IP address
Used to identify a node on a network. Each computer on the network is assigned a
unique Internet Protocol (IP) address, which is made up of the network ID, and a
unique host ID. This address is typically represented in dotted-decimal notation, with
the decimal value of each octet separated by a period, for example 192.0.2.22.
IPC
Interprocess Communication is a protocol used by client applications that resides on
the same node as the listener to communicate with the database. IPC can provide a
faster local connection than TCP/IP.
IPv4
Internet Protocol Version 4. IPv4 is the current standard for the IP protocol. IPv4 uses
32-bit (four-byte) addresses, which are typically represented in dotted-decimal
notation. The decimal value of each octet is separated by a period, as in 192.0.2.22.
IPv6
Internet Protocol Version 6. The protocol designed to replace IPv4. In IPv6, an IP
address is typically represented in eight fields of hexadecimal values separated by
colons, as in 2001:0db8:0000:0000:0000:0000:1428:57AB. In some cases, fields with
0 values can be compressed, as in 2001:DB8::1428:57AB.
IP Version 4 (IPv4)
See IPv4.
IP Version 6 (IPv6)
See IPv6.
Java Database Connectivity (JDBC) Driver

A driver that provides Java applications and applets access to an Oracle database.
Glossary-10
Glossary
JDBC OCI Driver

A Type II driver for use with client/server Java applications. This driver requires an Oracle
client installation.
JDBC Thin Driver

A Type IV driver for Oracle JDBC applets and applications. Because it is written entirely in
Java, this driver is platform-independent. It does not require any additional Oracle software
on the client side. The Thin driver communicates with the server using Two-Task Common
(TTC), a protocol developed by Oracle to access the database server.
Kerberos
A network authentication service that strengthens security in distributed environments.
Kerberos is a trusted third-party authentication system that relies on shared secrets and
assumes that the third party is secure. It provides single sign-on capabilities and database
link authentication (MIT Kerberos only) for users, provides centralized password storage, and
enhances PC security.
keyword-value pair
The combination of a keyword and a value, used as the standard unit of information in
connect descriptors and many configuration files. Keyword-value pairs may be nested; that is,
a keyword may have another keyword-value pair as its value.
latency
The amount of time it takes to send a request and receive an answer.
LDAP Data Interchange Format (LDIF)

See LDIF
ldap.ora file
A file created by Oracle Internet Directory Configuration Assistant or Oracle Net Configuration
Assistant that contains the following directory server access information:
• Type of directory server
• Location of the directory server
• Default Oracle Context that the client or server use to look up or configure connect
identifiers for connections to database services
When created with Oracle Internet Directory Configuration Assistant, the ldap.ora file is
located in the ORACLE_HOME/ldap/admin directory. When created with Oracle Net
Glossary-11
Glossary
Configuration Assistant, the ldap.ora file is located in the ORACLE_HOME/network/

admin directory.
LDIF
LDAP Data Interchange Format (LDIF) is the set of standards for formatting an input
file for any of the LDAP command line utilities.
Lightweight Directory Access Protocol (LDAP)

A standard, extensible directory access protocol. It is a common language that LDAP
clients and servers use to communicate. The framework of design conventions
supporting industry-standard directory servers.
link qualifier
An extension to the database link name which specifies the connect name used to
connect to the database. It provides alternate settings for the database user name and
password credentials. For example, a link qualifier of fieldrep can be appended to a
global database link of sales.us.example.com.
SQL> SELECT * FROM [email protected]@fieldrep
listener
See Oracle Net Listener.
Listener Control utility

A utility included with Oracle Net Services to control listener functions, such as
starting, stopping, and getting the status of the listener.
listener.ora file
A configuration file for the listener that identifies the following for a listener:
• Unique name
• Protocol addresses that it is accepting connection requests on
• Services it is listening for
The listener.ora file typically resides in the ORACLE_HOME/network/admin directory.
Oracle does not require identification of the database service because of service
registration. However, static service configuration is required if you plan to use Oracle
Enterprise Manager Cloud Control.
Glossary-12
Glossary
Listener Registration (LREG)

As a part of service registration, LREG registers instance information with the listener. LREG
is an instance background process of each database instance that is configured in the
database initialization parameter file.
load balancing
A feature by which client connections are distributed evenly among multiple listeners,
dispatchers, instances, and nodes so that no single component is overloaded.
Oracle Net Services support client load balancing and connection load balancing.
local naming
A naming method that locates network addresses by using information configured and stored
on each individual client's tnsnames.ora file. Local naming is most appropriate for simple
distributed networks with a small number of services that change infrequently.
location transparency
A distributed database characteristic that enables applications to access data tables without
knowing where they reside. All data tables appear to be in a single database, and the system
determines the actual data location based on the table name. The user can reference data on
multiple nodes in a single statement, and the system automatically and transparently routes
(parts of) SQL statements to remote nodes for execution if needed. The data can move
among nodes with no impact on the user or application.
logging
A feature in which errors, service activity, and statistics are written to a log file. The log file
provides additional information for an administrator when the error message on the screen is
inadequate to understand the failure. The log file, by way of the error stack, shows the state
of the software at various layers.
See also tracing.
loopback test
A connection from the server back to itself. Performing a successful loopback verifies that
Oracle Net is functioning on the database server.
map
Files used by the Network Information Service (NIS) ypserv program to handle name
requests.
Microsoft Active Directory

An LDAP-compliant directory server included with Microsoft Windows 2000 Server. It stores
information about objects on the network, and makes this information available to users and
Glossary-13
Glossary
network administrators. Active Directory also provides access to resources on the

network using a single logon process.
Microsoft Active Directory can be configured as a directory naming method to store

service information that clients can access.
Microsoft Windows NT native authentication

An authentication method that enables a client single login access to a Microsoft
Windows NT server and a database running on the server.
Named Pipes protocol

A high-level interface protocol providing interprocess communications between clients
and servers using distributed applications. Named Pipes enables client/server
conversation over a network using Named Pipes protocol.
naming context
A subtree that resides entirely on one directory server. It is a contiguous subtree, that
is, it must begin at an entry that serves as the top of the subtree, and extend
downward to either leaf entries or references to subordinate naming contexts. It can
range in size from a single entry to the entire directory information tree (DIT).
Oracle Context can be created under a naming context.
naming method
The resolution method used by a client application to resolve a connect identifier to a
connect descriptor when attempting to connect to a database service. Oracle Net
provides four naming methods:
• Domain Name System (DNS)
• directory naming
• Easy Connect naming
• external naming
network service alias

An alternative name for a directory naming object in a directory server. A directory
server stores network service aliases for any defined network service name or
database service. A network service alias entry does not have connect descriptor
information. Instead, it only references the location of the object for which it is an alias.
When a client requests a directory lookup of a network service alias, the directory
determines that the entry is a network service alias and completes the lookup as if it
was actually the entry it is referencing.
Glossary-14
Glossary
network service name

A simple name for a service that resolves to a connect descriptor. Users initiate a connect
request by passing a user name and password along with a network service name in a
connect string for the service to which they want to connect:
CONNECT username/password@net_service_name
Depending on your needs, network service names can be stored in a variety of places,
including:
• Local configuration file, tnsnames.ora, on each client
• Directory server
• External naming service, such as NIS
network
A group of two or more computers linked through hardware and software to allow the sharing
of data and peripherals.
network administrator
The person who performs network management tasks such as installing, configuring, and
testing network components. The administrator typically maintains the configuration files,
connect descriptors and service names, aliases, and public and global database links.
network character set

As defined by Oracle, the set of characters acceptable for use as values in keyword-value
pairs (that is, in connect descriptors and configuration files). The set includes alphanumeric
uppercase, and lowercase, and some special characters.
Network Information Service (NIS)

The client/server protocol for distributing system configuration data such as user and host
names between computers on a network. This service was formerly known as "Sun
Microsystems Yellow Pages (yp)."
Network Interface (NI)

A network layer that provides a generic interface for Oracle clients, servers, or external
processes to access Oracle Net functions. The network interface layer handles the break and
reset requests for a connection.
network listener
See listener.
Glossary-15
Glossary
network object
Any service that can be directly addressed on a network, such as a listener.
network protocol
See Oracle protocol support.
Network Program Interface

An interface for server-to-server interactions that performs all of the functions that the
Oracle Call Interface (OCI) does for clients, allowing a coordinating server to construct
SQL requests for additional servers.
Network Session (NS)

A session layer that is used in typical Oracle Net connections to establish and maintain
the connection between a client application and a database server.
NIS
See Network Information Service (NIS).
node
A computer or terminal that is part of a network
object class
In a directory server, a named group of attributes. To assign attributes to an entry, do
so by assigning the object classes that hold those attributes to that entry.
All objects associated with the same object class share the attributes of that object
class.
OCI
See Oracle Call Interface (OCI).
OPI
See Oracle Program Interface (OPI).
Open Systems Interconnection (OSI)

Open Systems Interconnection is a network architecture model developed by ISO as a
framework for international standards in heterogeneous computer network
architecture.
The OSI architecture has seven layers, from lowest to highest:
Glossary-16
Glossary
1. Physical layer
2. Data link layer
3. Network layer
4. Transport layer
5. Session layer
6. Presentation layer
7. Application layer
Oracle Advanced Security

An Oracle product that provides Transparent Data Encryption (TDE) and data redaction.
Oracle Call Interface (OCI)

An application programming interface (API) that enables creation of applications that use the
native procedures or function calls of a third-generation language to access an Oracle
database server and control all phases of SQL statement execution. OCI supports the data
types, calling conventions, syntax, and semantics of a number of third-generation languages
including C, C++, COBOL and FORTRAN.
Oracle Connection Manager

A router through which a client connection request may be sent either to its next hop or
directly to the database server. Clients who route their connection requests through Oracle
Connection Manager can then take advantage of the session multiplexing, access control, or
protocol conversion features configured for that Oracle Connection Manager.
Oracle Connection Manager Control utility

A utility included with Oracle Net Services to control various functions, such as starting,
stopping, and getting the status of Oracle Connection Manager.
Oracle Context
An entry in an LDAP-compliant Internet directory called cn=OracleContext, under which all
Oracle software relevant information is kept, including entries for Oracle Net Services
directory naming and checksumming security. There may be one or more than one Oracle
Context in a directory. An Oracle Context entry can be associated with a directory naming
context.
Oracle Internet Directory automatically creates an Oracle Context at the root of the DIT
structure. This root Oracle Context has a DN of dn:cn=OracleContext.
Glossary-17
Glossary
Oracle Enterprise Manager Cloud Control

A separate Oracle product that combines a graphical console, agents, common
services, and tools to provide an integrated and comprehensive systems management
platform for managing Oracle products.
Oracle Identity Management

An infrastructure enabling deployments to manage centrally and securely all enterprise
identities and their access to various applications in the enterprise.
Oracle Internet Directory

A directory server implemented as an application on the Oracle database. It enables
retrieval of information about dispersed users and network resources. It combines
Lightweight Directory Access Protocol (LDAP) Version 3, the open Internet standard
directory server access protocol, with the high performance, scalability, robustness,
and availability of the Oracle database.
Oracle Net
Communication software that enables a network session from a client application to an
Oracle database server. After a network session is established, Oracle Net acts as a
data courier for the client application and the database server. It is responsible for
establishing and maintaining the connection between the client application and
database server, as well as exchanging messages between them. Oracle Net can
perform these jobs because it is located on each computer in the network.
Oracle Net Configuration Assistant

A postinstallation tool that configures basic network components after installation,
including:
• Listener names and protocol addresses
• Naming methods the client uses to resolve connect identifiers
• Net service names in a tnsnames.ora file
• Directory server usage
Oracle Net Firewall Proxy

Product offered by some firewall vendors that supplies Oracle Connection Manager
functionality.
Glossary-18
Glossary
Oracle Net foundation layer

A networking communication layer that is responsible for establishing and maintaining the
connection between the client application and server, as well as exchanging messages
between them.
Oracle Net Listener

A process that resides on the server whose responsibility is to listen for incoming client
connection requests and manage the traffic to the server.
When a client requests a network session with a database server, a listener receives the
actual request. If the client information matches the listener information, then the listener
grants a connection to the database server.
Oracle Net Manager

A tool that combines configuration abilities with component control to provide an integrated
environment for configuring and managing Oracle Net Services.
You can use Oracle Net Manager to configure the following network components:
• Naming
Define connect identifiers and map them to connect descriptors to identify the network
location and identification of a service. Oracle Net Manager supports configuration of
connect descriptors in a local tnsnames.ora file or directory server.
• Naming Methods
Configure the ways in which connect identifiers are resolved into connect descriptors.
• Listeners
Create and configure listeners to receive client connections.
Oracle Net Services

A suite of networking components that provide enterprise-wide connectivity solutions in
distributed, heterogeneous computing environments. Oracle Net Services is comprised of
Oracle Net, listener, Oracle Connection Manager, Oracle Net Configuration Assistant, and
Oracle Net Manager.
Oracle Program Interface (OPI)

Oracle Program Interface is the networking layer responsible for responding to each of the
possible messages sent by OCI. For example, an OCI request to fetch 25 rows would have
an OPI response to return the 25 rows after they have been fetched.
Glossary-19
Glossary
Oracle protocol support

A software layer responsible for mapping Transparent Network Substrate (TNS)
functionality to industry-standard protocols used in the client/server connection.
Oracle Real Application Clusters (Oracle RAC)

An architecture that allows multiple instances to access a shared database of data
files. Oracle RAC is also a software component that provides the necessary cluster
database scripts, initialization files, and data files needed for Oracle Enterprise Edition
and Oracle RAC.
Oracle Rdb
A database for Digital's 64-bit platforms. Because Oracle Rdb has its own listener, the
client interacts with Rdb in the same manner as it does with an Oracle database.
Oracle schema
A set of rules that determine what can be stored in a directory server. Oracle has its
own schema that is applied to many types of Oracle entries, including Oracle Net
Services entries. The Oracle schema for Oracle Net Services entries includes the
attributes the entries may contain.
Oracle system identifier (SID)

A name that identifies a specific instance of an Oracle database. For any database,
there is at least one instance referencing the database.
For Oracle databases earlier than release 8.1, a SID is used to identify the database.
The SID is included in the connect descriptor of a tnsnames.ora file and in the
definition of the listener in the listener.ora file.
Oracle XML DB
A high-performance XML storage and retrieval technology provided with Oracle
database server. It is based on the W3C XML data model.
ORACLE_HOME
An alternate name for the top directory in the Oracle directory hierarchy on some
directory-based operating systems.
OSI
See Open Systems Interconnection (OSI).
Glossary-20
Glossary
packet
A block of information sent over the network each time a connection or data transfer is
requested. The information contained in packets depends on the type of packet, such as
connect, accept, redirect, data, and so on. Packet information can be useful in
troubleshooting.
PMON process
A process monitor (PMON) database process that performs process recovery when a user
process fails. PMON is responsible for cleaning the cache and freeing resources that the
process was using. PMON also checks on dispatcher and server processes and restarts
them if they have failed.
presentation layer
A networking communication layer that manages the representation of information that
application layer entities either communicate or reference in their communication. Two-Task
Common (TTC) is an example of presentation layer.
private database link

A database link created by one user for exclusive use.
See also database link and public database link.
profile
A collection of parameters that specifies preferences for enabling and configuring Oracle Net
Services features on the client or server. A profile is stored and implemented through the
sqlnet.ora file.
protocol
A set of rules that defines how data is transported across the network.
protocol address
An address that identifies the network address of a network object.
When a connection is made, the client and the receiver of the request, such as the listener or
Oracle Connection Manager, are configured with identical protocol addresses. 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. It is important to install the same protocols
for the client and the connection recipient, as well as configure the same addresses.
Glossary-21
Glossary
protocol conversion
A feature of Oracle Connection Manager that enables a client and server with different
networking protocols to communicate with each other. This feature replaces
functionality previously provided by the Oracle Multi-Protocol Interchange with
SQL*Net version 2.
protocol stack
Designates a particular presentation layer and session layer combination.
proxy server
A server that substitutes for a real server, forwarding client connection requests to the
real server or to other proxy servers. Proxy servers provide access control, data and
system security, monitoring, and caching.
public database link

A database link created by a DBA on a local database that is accessible to all users on
that database.
See also database link and private database link.
RADIUS
Remote Authentication Dial-In User Service (RADIUS) is a client-server protocol and
software that enables remote access servers to communicate with a central server.
This helps in authenticating dial-in users and authorizing their access to the requested
system or service.
realm Oracle Context

An Oracle Context contained in each identity management realm. It stores the
following information:
• User naming policy of the identity management realm, that is, how users are
named and located
• Mandatory authentication attributes
• Location of groups in the identity management realm
• Privilege assignments for the identity management realm, for example, who has
privileges to add more users to the realm
• Application specific data for that realm including authorizations
Glossary-22
Glossary
RDBMS
Relational Database Management System.
RDN
See relative distinguished name (RDN).
relative distinguished name (RDN)

The local, most granular level entry name. It has no other qualifying entry names that would
serve to address the entry uniquely. It is a fully-qualified X.500 name. For example,
cn=sales,dc=us,dc=example,dc=com, cn=sales is a RDN.
root Oracle Context

In the Oracle Identity Management infrastructure, the root Oracle Context is an entry in
Oracle Net Services containing a pointer to the default identity management realm in the
infrastructure. It also contains information about how to locate an identity management realm
given the simple name of the realm.
RPC
Remote procedure call.
SDP
Sockets Direct Protocol.
Secure Sockets Layer (SSL)

An industry standard protocol for securing network connections. SSL provides authentication,
encryption, and data integrity using public key infrastructure (PKI). The Transport Layer
Security (TLS) protocol is a successor to the SSL protocol.
See The Difference Between Transport Layer Security and Secure Sockets Layer.
server parameter file

A binary file containing initialization parameter settings that is maintained on the Oracle
Database host. You cannot manually edit this file with a text editor. A server parameter file is
initially built from a text initialization parameter file by means of the CREATE SPFILE statement
or created directly.
server process
Database processes that handle a client request on behalf of a database.
Glossary-23
Glossary
service
A program that responds to requests from various clients or performs some operation.
The database is a service that stores and retrieves data for clients.
service handler
A process that acts a connection point from the listener to the database server. A
service handler can be a dispatcher or dedicated server.
service name
A logical representation of a database, which is the way a database is presented to
clients. The service name is a string that is the global database name, that is, a name
comprised of the database name and domain name, entered during installation or
database creation. If you are not sure what the global database name is, then you can
obtain it from the value of the SERVICE_NAMES parameter in the initialization
parameter file.
The service name is included in the connect data part of the connect descriptor.
service registration
A feature by which the Listener Registration (LREG) automatically registers
information with a listener. Because this information is registered with the listener, the
listener.ora file does not need to be configured with this static information.
Service registration provides the listener with information about:
• Service names for each running instance of the database
• Instance names of the database
• Service handlers (dispatcher or dedicated server) available for each instance
These enable the listener to direct a client request appropriately.
• Dispatcher, instance, and node load information
This load information enables the listener to determine which dispatcher can best
handle a client connection request. If all dispatchers are blocked, then the listener can
spawn a dedicated server for the connection.
session data unit (SDU)

A buffer that Oracle Net uses to place data before transmitting it across the network.
Oracle Net sends the data in the buffer either when requested or when it is full.
session layer
A network layer that provides the services needed by the protocol address entities that
enable them to organize and synchronize their dialog and manage their data
Glossary-24
Glossary
exchange. This layer establishes, manages, and terminates network sessions between the
client and server. An example of a session layer is Network Session (NS).
session multiplexing
Combining multiple sessions for transmission over a single network connection to conserve
the operating system's resources.
shared server
A database server that is configured to allow many user processes to share very few server
processes, so the number of users that can be supported is increased. With shared server
configuration, many user processes connect to a dispatcher. The dispatcher directs multiple
incoming network session requests to a common queue. An idle shared server process from
a shared pool of server processes picks up a request from the queue. This means that a
small pool of server processes can serve a large number of clients. Contrast with dedicated
server.
shared server process

A process type used with shared server configuration.
SID
See Oracle system identifier (SID).
SID_LIST_listener_name
A section of the listener.ora file that defines the Oracle system identifier (SID) of the
database served by the listener. This section is valid only for Oracle databases release 8.0,
as information for Oracle8i or later instances is automatically registered with the listener.
Static configuration is also required for other services, such as external procedure calls and
Heterogeneous Services.
single sign-on
The ability for a user to log in to different servers using a single password. This permits the
user to authenticate to all servers the user is authorized to access.
sqlnet.ora file
A configuration file for the client or server that specifies:
• Client domain to append to unqualified service names or net service names
• Order of naming methods the client should use when resolving a name
• Logging and tracing features to use
Glossary-25
Glossary
• Route of connections
• External naming parameters
• Oracle Advanced Security parameters

The sqlnet.ora file typically resides in the ORACLE_HOME/network/admin directory.
SSL
See Secure Sockets Layer (SSL).
System Global Area (SGA)

A group of shared memory structures that contain data and control information for an
Oracle instance.
TCP/IP
Transmission Control Protocol/Internet Protocol. The standard communication protocol
used for client/server conversation over a network.
TCP/IP with TLS protocol

A protocol that enables an Oracle application on a client to communicate with remote
Oracle databases through the TCP/IP and Transport Layer Security (TLS).
tick
The amount of time it takes for a message to be sent and processed from the client to
the server or from the server to the client.
TNS
See Transparent Network Substrate (TNS).
tnsnames.ora file
A configuration file that maps network service names to connect descriptors. This file
is used for the local naming method. The tnsnames.ora file typically resides in the
ORACLE_HOME/network/admin directory.
tracing
A facility that writes detailed information about an operation to an output file. The trace
facility produces a detailed sequence of statements that describe the events of an
operation as they are run. Administrators use the trace facility for diagnosing an
abnormal condition. It is not normally turned on.
Glossary-26
Glossary
See also logging.
Transparent Application Failover (TAF)

A runtime failover for high-availability environments, such as Oracle Real Application Clusters
and Oracle Fail Safe, that refers to the failover and re-establishment of application-to-service
connections. It enables client applications to automatically reconnect to the database if the
connection fails, and, optionally, resume a SELECT statement that was in progress. This
reconnect happens automatically from within the Oracle Call Interface (OCI) library.
Transparent Network Substrate (TNS)

A foundation technology, built into the Oracle Net foundation layer that works with any
standard network transport protocol.
transport
A networking layer that maintains end-to-end reliability through data flow control and error
recovery methods. The Oracle Net foundation layer uses Oracle protocol support for the
transport layer.
Transport Layer Security (TLS)

An industry standard protocol for securing network connections. The TLS protocol is a
successor to the Secure Sockets Layer (SSL) protocol. It provides authentication, encryption,
and data integrity using public key infrastructure (PKI).
See The Difference Between Transport Layer Security and Secure Sockets Layer.
TTC
See Two-Task Common (TTC).
Two-Task Common (TTC)

A presentation layer type that is used in a typical Oracle Net connection to provide character
set and data type conversion between different character sets or formats on the client and
server.
UPI
User Program Interface.
virtual circuit
A piece of shared memory used by the dispatcher for client database connection requests
and replies. The dispatcher places a virtual circuit on a common queue when a request
arrives. An idle shared server picks up the virtual circuit from the common queue, services
Glossary-27
Glossary
the request, and relinquishes the virtual circuit before attempting to retrieve another
virtual circuit from the common queue.
WebDAV protocol
World Wide Web Distributed Authoring and Versioning. A protocol with a set of
extensions to HTTP which allows users to manage files on remote Web servers.
Glossary-28
Index
Symbols ASO_AUTHENTICATION_FILTER networking
parameter, 8-5
.IGNORE_ANO_ENCRYPTION_FOR_TCPS attributes
networking parameter, 6-24 orclCommonContextMap, C-2
( ) (parenthesis) symbol orclDescList, C-2
reserved in configuration files, 3-3 orclDescName, C-2
# (quotation mark) symbol orclLoadBalance, C-2
reserved in configuration files, 3-3 orclNetAddrList, C-2
= (equal sign) symbol orclNetAddrString, C-2
reserved in configuration files, 3-3 orclNetConnParamList, C-2
orclNetFailover, C-2
orclNetFailoverModeString, C-2
Numerics orclNetHostname, C-2
1024 port, 4-4 orclNetInstanceName, C-2
1521 port, 4-4 orclNetInstanceRole, C-2
1575 port, 4-4 orclNetProtocol, C-2
1630 port, 4-4 orclNetReceiveBufSize, C-2
1646 port, 5-47 orclNetSdu, C-2
1830 port, 4-4 orclNetSendBufSize, C-2
2482 port, 4-4 orclNetServiceName, C-2
2484 port, 4-4 orclNetSourceRoute, C-2
orclSid, C-2
orclVersion, C-2
A authentication ability, 5-21
ACCEPT_MD5_CERTS networking parameter, automatic diagnostic repository, 8-25
5-6
ACCEPT_SHA1_CERTS networking parameter, B
5-6
ACT networking parameter, 8-15 BEQUEATH_DETACH networking parameter,
ACTION_LIST networking parameter, 8-15 5-7
ADDRESS networking parameter, 4-1, 6-7, 7-3,
8-5 C
ADDRESS_LIST networking parameter, 4-2, 6-8
ADMINISTER command, 2-4 character sets
ADR, 8-25 for net service name, 3-3
ADR diagnostic parameters network, for keyword values, 3-3
sqlnet.ora class of secure transports parameters
ADR_BASE, 5-68 See COST parameters, 7-30
DIAG_ADR_ENABLED, 5-68 client load balancing
ADR_BASE diagnostic parameter, 5-68, 8-26 configuring, 6-11
ADR_BASE_diagnostic parameter, 7-24 CLOSE CONNECTIONS command, 2-5
ALLOW_MULTIPLE_REDIRECTS_listener_nam cman.ora file
e control parameter, 7-11 control parameters
anonymous access, B-1 USE_SID_AS_SERVICE_listener_name,
8-18
Index-1
Index
cman.ora file (continued) cman.ora file (continued)

diagnostic parameters parameters (continued)
ADR_BASE, 8-26 TDM_SHARED_THREADS_MAX, 8-24
DIAG_ADR_ENABLED, 8-26 TDM_SHARED_THREADS_MIN, 8-24
LOG_DIRECTORY, 8-29 TDM_THREADING_MODE, 8-25
LOG_LEVEL, 8-27 TRACE_FILE, 8-16
TRACE_DIRECTORY, 8-29 TRACE_FILELEN, 8-17
TRACE_FILELEN, 8-29 TRACE_FILENO, 8-17
TRACE_FILENO, 8-30 TRACE_LEVEL, 8-17
TRACE_LEVEL, 8-27 TRACE_TIMESTAMP, 8-17
TRACE_TIMESTAMP, 8-28 WALLET_LOCATION, 8-19
example, 8-1 rule list section, 8-1
listening address section, 8-1 COLOCATION_TAG networking parameter, 6-16
networking parameters combining COST parameters, 7-32
LOG_FILE_NUM, 8-9 comments in configuration files, 3-2
LOG_FILE_SIZE, 8-10 COMPRESSION networking parameter, 6-33,
parameter list section, 8-1 8-6
parameters Compression networking parameters, 6-33
ACT, 8-15 COMPRESSION_LEVELS networking
ACTION_LIST, 8-15 parameter, 6-34, 8-6
ADDRESS, 8-5 COMPRESSION_THRESHOLD networking
ASO_AUTHENTICATION_FILTER, 8-5 parameter, 8-6
COMPRESSION, 8-6 connect descriptors, 6-1
COMPRESSION_LEVELS, 8-6 CONNECT_DATA networking parameter, 6-16
COMPRESSION_THRESHOLD, 8-6 CONNECT_TIMEOUT, 6-30
CONNECTION_STATISTICS, 8-7 CONNECT_TIMEOUT networking parameter,
DST, 8-14 6-30
EVENT_GROUP, 8-7 CONNECTION_RATE_listener_name
EXPIRE_TIME, 8-8 configuration parameter, 7-7
IDLE_TIMEOUT, 8-9 CONNECTION_STATISTICS networking
INBOUND_CONNECT_TIMEOUT, 8-9 parameter, 8-7
LOG_DIRECTORY, 8-9 connections
LOG_LEVEL, 8-10 adjusting listener queue size to avoid errors,
MAX_ALL_CONNECTIONS, 8-10 7-5
MAX_CMCTL_SESSIONS, 8-11 control parameters
MAX_CONNECTIONS, 8-11 listener.ora
MAX_GATEWAY_PROCESSES, 8-11 SSL_CLIENT_AUTHENTICATION, 7-18
MAX_REG_CONNECTIONS, 8-12 WALLET_LOCATION, 7-21
MIN_GATEWAY_PROCESSES, 8-12 control utilities
OUTBOUND_CONNECT_TIMEOUT, 8-12 Listener Control utility, 1-27
PARAMETER_LIST, 8-1 Oracle Connection Manager Control utility,
PASSWORD_instance_name, 8-12 2-3
RULE, 8-14 COST parameters, 7-30
SDU, 8-15 combining, 7-32
SERVICE_RATE, 8-16 DYNAMIC_REGISTRATION_listener_name,
SERVICE_RATE_listener_name, 7-17 7-32
SESSION_TIMEOUT, 8-16 SECURE_CONTROL_listener_name, 7-33
SRC, 8-14 SECURE_PROTOCOL_listener_name, 7-33
SRV, 8-15 SECURE_REGISTER_listener_name, 7-31
TDM, 8-22 CRS_NOTIFICATION_listener_name control
TDM_BIND_THREAD, 8-22 parameter, 7-12
TDM_DATATYPE_CHECK, 8-23
TDM_PRCP_MAX_CALL_WAIT_TIME, 8-23
TDM_PRCP_MAX_TXN_CALL_WAIT_TIME,
D
8-24 database resident connection pooling, 6-23
Index-2
Index
DEDICATED_THROUGH_BROKER_LISTENER diagnostic parameters (continued)

networking parameter, 7-12 sqlnet.ora (continued)
DEFAULT_ADMIN_CONTEXT networking TRACE_FILELEN_CLIENT, 5-75
parameter, 9-2 TRACE_FILELEN_SERVER, 5-75
DEFAULT_SDU_SIZE networking parameter, 5-7 TRACE_FILENO_CLIENT, 5-76
DEFAULT_SERVICE_listener_name control TRACE_FILENO_SERVER, 5-76
parameter, 7-13 TRACE_LEVEL_CLIENT, 5-69
DELAY networking parameter, 6-18 TRACE_LEVEL_SERVER, 5-69
DESCRIPTION networking parameter, 6-6, 7-4 TRACE_TIMESTAMP_CLIENT, 5-70
DESCRIPTION_LIST networking parameter, 6-6 TRACE_TIMESTAMP_SERVER, 5-70
DIAG_ADR_ENABLED diagnostic parameter, TRACE_UNIQUE_CLIENT, 5-77
5-68, 8-26 sqlnet.ora diagnostic reference, 5-67
DIAG_ADR_ENABLED_listener_name directory naming
diagnostic parameter, 7-25 configuring, 5-11
diagnostic parameters DIRECTORY_SERVER_TYPE networking
cman.ora parameter, 9-2
ADR_BASE, 8-26 DIRECTORY_SERVERS, 9-2
DIAG_ADR_ENABLED, 8-26 DISABLE_OOB networking parameter, 5-8
LOG_DIRECTORY, 8-29 DISABLE_OOB_AUTO networking parameter,
LOG_LEVEL, 8-27 5-8
TRACE_DIRECTORY, 8-29 DST networking parameter, 8-14
TRACE_FILELEN, 8-29 DYNAMIC_REGISTRATION_listener_name
TRACE_FILENO, 8-30 COST parameter, 7-32
TRACE_LEVEL, 8-27
TRACE_TIMESTAMP, 8-28
listener.ora, 7-26
E
ADR_BASE_listener_name, 7-24 ENABLE networking parameter, 6-9
LOG_DIRECTORY_listener_name, 7-28 ENABLE_EXADIRECT_listener_name control
LOG_FILE_listener_name, 7-28 parameter, 7-11
LOG_FILE_NUM_listener_name, 7-25 error messages
LOG_FILE_SIZE_listener_name, 7-26 ORA-12170, 5-57
TRACE_DIRECTORY_listener_name, ORA-12525, 1-13, 7-13
7-29 ORA-12535, 5-48, 5-49
TRACE_FILE_listener_name, 7-29 ORA-12608, 5-49
TRACE_FILEAGE_listener_name, 7-29 EVENT_GROUP networking parameter, 8-7
TRACE_FILELEN_listener_name, 7-30 Exadirect protocol
TRACE_FILENO_listener_name, 7-30 parameters for addresses, 4-2
TRACE_LEVEL_listener_name, 7-26 EXADIRECT_FLOW_CONTROL networking
TRACE_TIMESTAMP_listener_name, parameter, 5-8
7-27 EXADIRECT_RECVPOLL networking parameter,
Oracle Net Listener diagnostic reference, 5-9
7-23 EXIT command
sqlnet.ora Listener Control utility, 1-5
ADR_BASE, 5-68 Oracle Connection Manager Control utility,
DIAG_ADR_ENABLED, 5-68 2-7
LOG_DIRECTORY_CLIENT, 5-71 EXPIRE_TIME networking parameter, 8-8
LOG_DIRECTORY_SERVER, 5-72 external naming
LOG_FILE_CLIENT, 5-72 Network Information Service (NIS), 5-11
LOG_FILE_SERVER, 5-72
TRACE_DIRECTORY_CLIENT, 5-73
TRACE_DIRECTORY_SERVER, 5-73 F
TRACE_FILE_CLIENT, 5-74 failover
TRACE_FILE_SERVER, 5-74 connect-time, 6-10
TRACE_FILEAGE_CLIENT, 5-74 Transparent Application Failover, 6-17
TRACE_FILEAGE_SERVER, 5-75 FAILOVER networking parameter, 6-10, 6-11
Index-3
Index
FAILOVER_MODE networking parameter, 6-17 Listener Control utility

Firewall networking parameter, 7-4 command reference, 1-27
commands
EXIT, 1-5
G HELP, 1-6
GLOBAL_NAME networking parameter, 6-18 QUIT, 1-7
RELOAD, 1-7
SAVE_CONFIG, 1-8
H SERVICES, 1-9
HELP command SET, 1-2, 1-10
of Listener Control utility, 1-6 SET CONNECT_TIMEOUT, 1-12
of Oracle Connection Manager Control utility, SET CURRENT_LISTENER, 1-12
2-7 SET DISPLAYMODE, 1-12
heterogeneous services, 6-19 SET INBOUND_CONNECT_TIMEOUT,
HS networking parameter, 6-19 1-13
HTTPS_PROXY networking parameter, 6-7 SET LOG_DIRECTORY, 1-14
HTTPS_PROXY_PORT networking parameter, SET LOG_FILE, 1-15
6-8 SET LOG_STATUS, 1-15
HTTPS_SSL_VERSION networking parameter, SET TRC_DIRECTORY, 1-17
5-9 SET TRC_FILE, 1-18
SET TRC_LEVEL, 1-19
SET USE_PLUGANDPLAY, 1-20
I SHOW, 1-2, 1-20
SHOW CURRENT_LISTENER, 1-20
IDLE_TIMEOUT networking parameter, 8-9
SHOW DISPLAYMODE, 1-20
improving
SHOW INBOUND_CONNECT_TIMEOUT,
client load balancing, 6-11
1-20
INBOUND_CONNECT_TIMEOUT networking
SHOW LOG_DIRECTORY, 1-20
parameter, 8-9
SHOW LOG_FILE, 1-20
INBOUND_CONNECT_TIMEOUT_listener_nam
SHOW LOG_STATUS, 1-20
e control parameter, 7-13
SHOW RAWMODE, 1-20
INBOUND_CONNECT_TIMEPUT_listener_name
SHOW SAVE_CONFIG_ON_STOP, 1-20
networking parameter, 7-13
SHOW TRC_DIRECTORY, 1-20
INSTANCE_NAME networking parameter, 6-19
SHOW TRC_FILE, 1-20
IP networking parameter, 7-4
SHOW TRC_LEVEL, 1-20
IPC protocol
START, 1-22
addresses, 4-2
STATUS, 1-23
KEY parameter, 4-2
STOP, 1-25
IPC, parameters for addresses, 4-2
TRACE, 1-26
IPC.KEYPATH networking parameter, 5-10
VERSION, 1-27
distributed operation, 1-3
K function of and syntax format, 1-1
remote administration, 1-3
keepalive feature, 6-9 Listener Control utility access, 1-3
keyword syntax rules for configuration files, 3-2 listener.ora file
keyword values and network character sets, 3-3 ADR diagnostic parameters, 7-23
configuration parameter reference, 7-23
L configuration parameters
CONNECTION_RATE_listener_name, 7-7
ldap.ora file RATE_LIMIT, 7-8
DEFAULT_ADMIN_CONTEXT parameter, control parameters, 7-10, 7-20
9-2 ALLOW_MULTIPLE_REDIRECTS_listener_name, 7-11
DIRECTORY_SERVER_TYPE parameter, CRS_NOTIFICATION_listener_name, 7-12
9-2 DEFAULT_SERVICE_listener_name, 7-13
ENABLE_EXADIRECT_listener_name, 7-11
Index-4
Index
listener.ora file (continued) LOG_DIRECTORY diagnostic parameter, 8-29

control parameters (continued) LOG_DIRECTORY networking parameter, 8-9
INBOUND_CONNECT_TIMEOUT_listener_name, 7-13
LOG_DIRECTORY_CLIENT diagnostic
MAX_ALL_CONNECTIONS_listener_name, 7-14 parameter, 5-71
MAX_REG_CONNECTIONS_listener_name, 7-15 LOG_DIRECTORY_listener_name diagnostic
REGISTRATION_EXCLUDED_NODES_listener_name, parameter, 7-28
7-15, 8-13 LOG_DIRECTORY_SERVER diagnostic
REGISTRATION_INVITED_NODES_listener_name, 7-16, parameter, 5-72
8-13 LOG_FILE_CLIENT diagnostic parameter, 5-72
REMOTE_REGISTRATION_ADDRESS_listener_name,
LOG_FILE_listener_name
7-16 diagnostic parameter,
SAVE_CONFIG_ON_STOP_listener_name, 7-17 7-28
SERVICE_RATE_listener_name, 7-17 LOG_FILE_NUM networking parameter, 8-9
SSL_CLIENT_AUTHENTICATION, 7-18 LOG_FILE_NUM_listener_name diagnostic
SUBSCRIBE_FOR_NODE_DOWN_EVENT_listener_name, parameter, 7-25
7-19 LOG_FILE_SERVER diagnostic parameter, 5-72
USE_SID_AS_SERVICE_listener_name, 7-20 LOG_FILE_SIZE networking parameter, 8-10
LOG_FILE_SIZE_listener_name diagnostic
VALID_NODE_CHECKING_REGISTRATION_listener_name,
8-18 parameter, 7-26
WALLET_LOCATION, 7-21 LOG_LEVEL diagnostic parameter, 8-27
COST parameters, 7-30 LOG_LEVEL networking parameter, 8-10
diagnostic parameters, 7-26 LOGGING_listener_name
ADR_BASE_listener_name, 7-24 diagnostic parameter, 7-26
DIAG_ADR_ENABLED_listener_name, 7-25
LOG_DIRECTORY_listener_name, 7-28
LOG_FILE_listener_name, 7-28
M
LOG_FILE_NUM_listener_name, 7-25 MAX_ALL_CONNECTIONS control parameter,
LOG_FILE_SIZE_listener_name, 7-26 8-10
TRACE_DIRECTORY_listener_name, 7-29 MAX_ALL_CONNECTIONS_listener_name
TRACE_FILE_listener_name, 7-29 control parameter, 7-14
TRACE_FILEAGE_listener_name, 7-29 MAX_CMCTL_SESSIONS networking
TRACE_FILELEN_listener_name, 7-30 parameter, 8-11
TRACE_FILENO_listener_name, 7-30 MAX_CONNECTIONS networking parameter,
TRACE_LEVEL_listener_name, 7-26 8-11
TRACE_TIMESTAMP_listener_name, 7-27 MAX_GATEWAY_PROCESSES networking
parameters parameter, 8-11
ADDRESS, 7-3 MAX_REG_CONNECTIONS control parameter,
DEDICATED_THROUGH_BROKER_LISTENER, 7-12 8-12
DESCRIPTION, 7-4 MAX_REG_CONNECTIONS_listener_name
Firewall, 7-4 control parameter, 7-15
INBOUND_CONNECT_TIMEOUT_listener_name, 7-13
METHOD networking parameter, 6-18
IP, 7-4 MIN_GATEWAY_PROCESSES networking
QUEUESIZE, 7-5 parameter, 8-12
RECV_BUF_SIZE, 7-5 multiple listeners, 7-2
SEND_BUF_SIZE, 7-6
listeners
adjusting queue size, 7-5 N
connect-request timeouts, 7-13 NAMES.DEFAULT.DOMAIN networking
multiple, 7-2 parameter, 5-10
load balancing NAMES.DIRECTORY_PATH networking
client, 6-11 parameter, 5-10
LOAD_BALANCE networking parameter, 6-11 ezconnect, 5-11
local naming hostname, 5-11
configuring, 5-11 NAMES.LADP_AUTHENTICATE_BIND
LOCAL_REGISTRATION_ADDRESS_listener_n networking parameter, 5-11
ame control parameter, 7-14
Index-5
Index
NAMES.LDAP_CONN_TIMEOUT networking Oracle Connection Manager Control utility (continued)

parameter, 5-11 commands (continued)
NAMES.LDAP_PERSISTENT_SESSION SET EVENT, 2-12, 2-13
networking parameter, 5-12 SET IDLE_TIMEOUT, 2-13
NAMES.NIS.META_MAP networking parameter, SET INBOUND_CONNECT_TIMEOUT, 2-14
5-12 SET LOG_DIRECTORY, 2-14
NAMESCTL.TRACE_UNIQUE networking SET LOG_LEVEL, 2-15, 2-18
parameter, 5-13 SET OUTBOUND_CONNECT_TIMEOUT,
network character sets, keyword values, 3-3 2-16
network configuration files SET PASSWORD, 2-16
listener.ora, 7-23 SET SESSION_TIMEOUT, 2-17
sqlnet.ora, 5-2, 5-67 SET TRACE_DIRECTORY, 2-18
syntax rules, 3-1 SET TRACE_LEVEL, 2-18
Network Information Service external naming SHOW, 2-19
configuring, 5-11 SHOW ALL, 2-20
networking parameters SHOW CONNECTIONS, 2-21
cman.ora SHOW DEFAULTS, 2-23
LOG_FILE_SIZE, 8-10 SHOW EVENTS, 2-24
listener.ora SHOW GATEWAYS, 2-25
LOG_FILE_NUM, 8-9 SHOW PARAMETERS, 2-25
listener.ora configuration reference, 7-23 SHOW RULES, 2-26
sqlnet.ora configuration reference, 5-2 SHOW SERVICES, 2-28
SHOW STATUS, 2-28
SHOW VERSION, 2-29
O SHUTDOWN, 2-29
object classes STARTUP, 2-30, 2-31
orclNetAddress, C-1 SUSPEND GATEWAY, 2-31
orclNetAddressList, C-1 Oracle Connection Manager parameters
orclNetDescription, C-1 ADDRESS, 8-5
orclNetDescriptionList, C-1 ASO_AUTHENTICATION_FILTER, 8-5
orclNetServiceAlias, C-1 CONNECTION_STATISTICS, 8-7
obsolete parameters, A-2 EVENT_GROUP, 8-7
ORA-12170 error message, 5-57 IDLE_TIMEOUT, 8-9
ORA-12525 error message, 1-13, 7-13 INBOUND_CONNECT_TIMEOUT, 8-9
ORA-12535 error message, 5-48, 5-49 LOG_DIRECTORY, 8-9
ORA-12608 error message, 5-49 LOG_LEVEL, 8-10
Oracle Connection Manager MAX_CMCTL_SESSIONS, 8-11
client load balancing, 6-4 MAX_CONNECTIONS, 8-11
connect-time failover, 6-4 MAX_GATEWAY_PROCESSES, 8-11
SOURCE_ROUTE networking parameter, MIN_GATEWAY_PROCESSES, 8-12
6-14 OUTBOUND_CONNECT_TIMEOUT, 8-12
Oracle Connection Manager Control utility PASSWORD_instance_name, 8-12
command reference, 2-3 RULE, 8-14
commands SESSION_TIMEOUT, 8-16
ADMINISTER, 2-4 TDM, 8-22
CLOSE CONNECTIONS, 2-5 TDM_BIND_THREAD, 8-22
EXIT, 2-7 TDM_DATATYPE_CHECK, 8-23
HELP, 2-7 TDM_PRCP_MAX_CALL_WAIT_TIME, 8-23
QUIT, 2-8 TDM_PRCP_MAX_TXN_CALL_WAIT_TIME,
RELOAD, 2-9 8-24
RESUME GATEWAYS, 2-9 TDM_SHARED_THREADS_MAX, 8-24
SAVE_PASSWD, 2-10 TDM_SHARED_THREADS_MIN, 8-24
SET, 2-10 TDM_THREADING_MODE, 8-25
SET ASO_AUTHENTICATION_FILTER, 2-11 TRACE_FILE, 8-16
SET CONNECTION_STATISTICS, 2-12 TRACE_FILELEN, 8-17
Index-6
Index
Oracle Connection Manager parameters (continued) port 1024, 4-4

TRACE_FILENO, 8-17 port 1521, 4-4
TRACE_LEVEL, 8-17 port 1575, 4-4
TRACE_TIMESTAMP, 8-17 port 1630, 4-4
Oracle Internet Directory access, B-1 port 1646, 5-47
Oracle Names support, A-2 port 1830, 4-4
Oracle Net Connection Pooling, A-1 port 2483, 4-4
Oracle Net Listener Password, A-2 port 2484, 4-4
Oracle protocol support port numbers, allowed, 4-4
configuring addresses, 4-2 ports
Exadirect, 4-2 privileged, 4-4
IPC, 4-2 privileged ports, 4-4
Named Pipes, 4-2 protocols
SDP, 4-2 authentication ability, 5-21
TCP/IP, 4-2 configuring addresses, 4-2
TCP/IP with TLS, 4-2 Exadirect, 4-2
Oracle Real Application Clusters IPC, 4-2
connect-time failover, 6-11 Named Pipes, 4-2
FAILOVER networking parameter, 6-11 parameters, 4-2
INSTANCE_NAME networking parameter, SDP, 4-2
6-20 TCP/IP, 4-2
orclCommonContextMap attribute, C-2 TCP/IP with TLS, 4-2
orclDescList attribute, C-2
orclDescName attribute, C-2
orclLoadBalance attribute, C-2
Q
orclNetAddress object class, C-1 QUEUESIZE networking parameter, 7-5
orclNetAddressList object class, C-1 QUIT command
orclNetAddrList attribute, C-2 of Listener Control utility, 1-7
orclNetAddrString attribute, C-2 of Oracle Connection Manager Control utility,
orclNetConnParamList attribute, C-2 2-8
orclNetDescription object class, C-1
orclNetDescriptionList object class, C-1
orclNetFailover attribute, C-2 R
orclNetFailoverModeString attribute, C-2 RATE_LIMIT configuration parameter, 7-8
orclNetHostname attribute, C-2 RDB_DATABASE networking parameter, 6-21
orclNetInstanceName attribute, C-2 RECV_BUF_SIZE, 5-13
orclNetInstanceRole attribute, C-2 RECV_BUF_SIZE networking parameter, 6-11,
orclNetReceiveBufSize attribute, C-2 7-5
orclNetSdu attribute, C-2 RECV_TIMEOUT networking parameter, 6-32
orclNetSendBufSize attribute, C-2 reference
orclNetServiceAlias object class, C-1 ADR for Oracle Net Listener, 7-23
orclNetServiceName attribute, C-2 ADR for sqlnet.ora, 5-67
orclNetSourceRoute attribute, C-2 for Listener Control utility commands, 1-27
orclProtocol attribute, C-2 for listener.ora, 7-23
orclSid attribute, C-2 for Oracle Connection Manager Control utility
orclVersion attribute, C-2 commands, 2-3
outbound connect timeout interval, 5-42 for sqlnet.ora, 5-2
OUTBOUND_CONNECT_TIMEOUT networking REGISTRATION_EXCLUDED_NODES_listener_
parameter, 8-12 name control parameter, 7-15, 8-13
REGISTRATION_INVITED_NODES_listener_na
P me control parameter, 7-16, 8-13
RELOAD command, 2-9
PARAMETER_LIST networking parameter, 8-1 of Listener Control utility, 1-7
PASSWORD_instance_name networking REMOTE_REGISTRATION_ADDRESS_listener
parameter, 8-12 _name control parameter, 7-16
Index-7
Index
RESUME GATEWAYS command, 2-9 SESSION_TIMEOUT networking parameter,

RETRIES networking parameter, 6-18 8-16
RETRY_COUNT, 6-30 SET ASO_AUTHENTICATION_FILTER
RETRY_COUNT networking parameter, 6-30 command, 2-11
RETRY_DELAY, 6-31 SET command
RETRY_DELAY networking parameter, 6-31 of Listener Control utility, 1-10
RULE networking parameter, 8-14 of Oracle Connection Manager Control utility,
rules, syntax for network configuration files, 3-1 2-10
SET CONNECT_TIMEOUT command, 1-12
SET CONNECTION_STATISTICS command,
S 2-12
SAVE_CONFIG command SET CURRENT_LISTENER command, 1-12
of Listener Control utility, 1-8 SET DISPLAYMODE command
SAVE_CONFIG_ON_STOP_listener_name of Listener Control utility, 1-12
control parameter, 7-17 SET EVENT command, 2-12, 2-13
SAVE_PASSWD command, 2-10 SET IDLE_TIMEOUT command, 2-13
SDP protocol, parameters for addresses, 4-2 SET INBOUND_CONNECT_TIMEOUT
SDP.PF_INET_SDP networking parameter, 5-13 command
SDU networking parameter, 6-12, 8-15 of Listener Control utility, 1-13
SEC_USER_AUDIT_ACTION_BANNER SET INBOUND_CONNECT_TIMEOUT
networking parameter, 5-14 command, of Oracle Connection
SEC_USER_UNAUTHORIZED_ACCESS_BANN Manager Control utility, 2-14
ER networking parameter, 5-14 SET LOG_DIRECTORY command
SECURE_CONTROL_listener_name of Listener Control utility, 1-14
COST parameter, 7-33 of Oracle Connection Manager Control Utility,
SECURE_PROTOCOL_listener_name 2-14
COST parameter, 7-33 SET LOG_FILE command, 1-15
SECURE_REGISTER_listener_name SET LOG_LEVEL command, 2-15, 2-18
COST parameter, 7-31 SET LOG_STATUS command, 1-15
security SET OUTBOUND_CONNECT_TIMEOUT
database server command, 2-16
client network timeouts, 5-48, 5-49 SET PASSWORD command
connect-request timeouts, 5-15, 5-18, of Oracle Connection Manager Control utility,
5-19 2-16
listeners SET SAVE_CONFIG_ON_STOP command, 1-16
connect-request timeouts, 7-13 of Listener Control utility, 1-16
remote registration, 7-16, 8-13 SET SESSION_TIMEOUT command, 2-17
restricting runtime administration, 7-10 SET TRACE_DIRECTORY command, 2-18
SECURITY networking parameter, 6-25 SET TRACE_LEVEL command, 2-18
SEND_BUF_SIZE networking parameter, 5-15, SET TRC_DIRECTORY command, 1-17
6-13, 7-6 SET TRC_FILE command, 1-18
SERVER networking parameter, 6-23 SET TRC_LEVEL command, 1-19
server type SET USE_PLUGANDPLAY command, 1-20
dedicated, 6-23 SHOW ALL command, 2-20
pooled, 6-23 SHOW command
shared, 6-23 of Listener Control utility, 1-20
service name of Oracle Connection Manager Control utility,
character set keyword values, 3-3 2-19
SERVICE_NAME networking parameter, 6-23 SHOW CONNECTIONS command, 2-21
SERVICE_RATE networking parameter, 8-16 SHOW CURRENT_LISTENER command, 1-20
SERVICE_RATE parameter, 8-16 SHOW DEFAULTS command, 2-23
SERVICE_RATE_listener_name networking SHOW DISPLAYMODE command
parameter, 7-17 of Listener Control utility, 1-20
SERVICE_RATE_listener_name parameter, 7-17 SHOW EVENTS command, 2-24
SERVICES command, 1-9 SHOW GATEWAYS command, 2-25
Index-8
Index
SHOW INBOUND_CONNECT_TIMEOUT SQLNET.ENCRYPTION_TYPES_CLIENT

command, 1-20 networking parameter, 5-34
SHOW LOG_DIRECTORY command, 1-20 SQLNET.ENCRYPTION_TYPES_SERVER
SHOW LOG_FILE command, 1-20 networking parameter, 5-35
SHOW LOG_STATUS command, 1-20 SQLNET.EXPIRE_TIME networking parameter,
SHOW PARAMETERS command, 2-25 5-36
SHOW RAWMODE command, 1-20 SQLNET.FALLBACK_AUTHENTICATION
SHOW RULES command, 2-26 networking parameter, 5-38
SHOW SAVE_CONFIG_ON_STOP command, SQLNET.IGNORE_ANO_ENCRYPTION_FOR_T
1-20 CPS networking parameter, 5-37
SHOW SERVICES command, 2-28 SQLNET.KERBEROS5_CC_NAME networking
SHOW STATUS command, 2-28 parameter, 5-39
SHOW TRC_DIRECTORY command, 1-20 SQLNET.KERBEROS5_CLOCKSKEW
SHOW TRC_FILE command, 1-20 networking parameter, 5-39
SHOW TRC_LEVEL command, 1-20 SQLNET.KERBEROS5_CONF networking
SHOW VERSION command, 2-29 parameter, 5-40
SHUTDOWN command, 2-29 SQLNET.KERBEROS5_CONF_LOCATON
SOURCE_ROUTE networking parameter, 6-14 networking parameter, 5-41
SQLNET.ALLOWED_LOGON_VERSION_CLIEN SQLNET.KERBEROS5_KEYTAB networking
T networking parameter, 5-18 parameter, 5-41
SQLNET.ALLOWED_LOGON_VERSION_SERV SQLNET.KERBEROS5_REALMS networking
ER networking parameter, 5-19 parameter, 5-41
SQLNET.AUTHENTICATION_KERBEROS5_ SQLNET.KERBEROS5_REPLAY_CACHE
SERVICE networking parameter, 5-13 networking parameter, 5-42
SQLNET.AUTHENTICATION_SERVICES sqlnet.ora file
networking parameter, 5-25 ADR diagnostic parameters, 5-67
SQLNET.CLIENT_REGISTRATION networking configuration parameter reference, 5-2
parameter, 5-26 diagnostic parameters
SQLNET.CLOUD_USER networking parameter, ADR_BASE, 5-68
5-26 DIAG_ADR_ENABLED, 5-68
SQLNET.COMPRESSION compression LOG_DIRECTORY_CLIENT, 5-71
parameter, 5-28 LOG_DIRECTORY_SERVER, 5-72
SQLNET.COMPRESSION_ACCELERATION LOG_FILE_CLIENT, 5-72
compression parameter, 5-28 LOG_FILE_SERVER, 5-72
SQLNET.COMPRESSION_LEVELS TRACE_DIRECTORY_CLIENT, 5-73
compression parameter, 5-29 TRACE_DIRECTORY_SERVER, 5-73
SQLNET.COMPRESSION_THRESHOLD TRACE_FILE_CLIENT, 5-74
compression parameter, 5-29 TRACE_FILE_SERVER, 5-74
SQLNET.CRYPTO_CHECKSUM_CLIENT TRACE_FILEAGE_CLIENT, 5-74
networking parameter, 5-29 TRACE_FILEAGE_SERVER, 5-75
SQLNET.CRYPTO_CHECKSUM_SERVER TRACE_FILELEN_CLIENT, 5-75
networking parameter, 5-30 TRACE_FILELEN_SERVER, 5-75
SQLNET.CRYPTO_CHECKSUM_TYPE_CLIENT TRACE_FILENO_CLIENT, 5-76
networking parameter, 5-31 TRACE_FILENO_SERVER, 5-76
SQLNET.CRYPTO_CHECKSUM_TYPE_SERVE TRACE_LEVEL_CLIENT, 5-69
R networking parameter, 5-31 TRACE_LEVEL_SERVER, 5-69
SQLNET.DBFW_PUBLIC_KEY networking TRACE_TIMESTAMP_CLIENT, 5-70
parameter, 5-32 TRACE_TIMESTAMP_SERVER, 5-70
SQLNET.DOWN_HOSTS_TIMEOUT networking TRACE_UNIQUE_CLIENT, 5-77
parameter, 5-32 parameters
SQLNET.ENCRYPTION_CLIENT networking ACCEPT_MD5_CERTS, 5-6
parameter, 5-33 ACCEPT_SHA1_CERTS, 5-6
SQLNET.ENCRYPTION_SERVER networking BEQUEATH_DETACH, 5-7
parameter, 5-34 DEFAULT_SDU_SIZE, 5-7
DISABLE_OOB, 5-8
Index-9
Index
sqlnet.ora file (continued) sqlnet.ora file (continued)

parameters (continued) parameters (continued)
DISABLE_OOB_AUTO, 5-8 SQLNET.KERBEROS5_REPLAY_CACHE, 5-42
EXADIRECT_FLOW_CONTROL, 5-8 SQLNET.OUTBOUND_CONNECT_TIME, 5-42
EXADIRECT_RECVPOLL, 5-9 SQLNET.OUTBOUND_CONNECT_TIMEOUT, 5-42
HTTPS_SSL_VERSION, 5-9 SQLNET.RADIUS_ALTERNATE, 5-43
IPC.KEYPATH, 5-10 SQLNET.RADIUS_ALTERNATE_PORT, 5-43
NAMES_DIRECTORY_PATH, 5-10 SQLNET.RADIUS_ALTERNATE_RETRIES, 5-44
NAMES.DEFAULT_DOMAIN, 5-10 SQLNET.RADIUS_AUTHENTICATION, 5-44
NAMES.LADP_AUTHENTICATE_BIND, 5-11 SQLNET.RADIUS_AUTHENTICATION_INTERFACE,
NAMES.LDAP_CONN_TIMEOUT, 5-11 5-45
NAMES.LDAP_PERSISTENT_SESSION, 5-12 SQLNET.RADIUS_AUTHENTICATION_PORT, 5-45
NAMES.NIS.META_MAP, 5-12 SQLNET.RADIUS_AUTHENTICATION_RETRIES,
NAMESCTL.TRACE_UNIQUE, 5-13 5-45
RECV_BUF_SIZE, 5-13 SQLNET.RADIUS_AUTHENTICATION_TIMEOUT,
SDP.PF_INET_SDP, 5-13 5-46
SEC_USER_AUDIT_ACTION_BANNER, 5-14 SQLNET.RADIUS_CHALLENGE_RESPONSE, 5-46
SEC_USER_UNAUTHORIZED_ACCESS_BANNER, SQLNET.RADIUS_SECRET, 5-47
5-14 SQLNET.RADIUS_SEND_ACCOUNTING, 5-47
SEND_BUF_SIZE, 5-15 SQLNET.RECV_TIMEOUT, 5-48
SQLNET.ALLOWED_LOGON_VERSION_CLIENT, SQLNET.SEND_TIMEOUT, 5-49
5-18 SQLNET.URI, 5-50
SQLNET.ALLOWED_LOGON_VERSION_SERVER, SQLNET.USE_HTTPS_PROXY, 5-50
5-19 SSL_CERT_REVOCATION, 5-51
SQLNET.AUTHENTICATION_KERBEROS5_ SSL_CIPHER_SUITES, 5-53
SERVICE, 5-13 SSL_CRL_FILE, 5-52
SQLNET.AUTHENTICATION_SERVICES, 5-25 SSL_CRL_PATH, 5-53
SQLNET.CLIENT_REGISTRATION, 5-26 SSL_EXTENDED_KEY_USAGE, 5-54
SQLNET.CLOUD_USER, 5-26 SSL_SERVER_DN_MATCH, 5-55
SQLNET.COMPRESSION, 5-28 SSL_VERSION, 5-55, 7-18
SQLNET.COMPRESSION_ACCELERATION, 5-28 TCP.CONNECT_TIMEOUT, 5-56
SQLNET.COMPRESSION_LEVELS, 5-29 TCP.EXCLUDED_NODES, 5-57
SQLNET.COMPRESSION_THRESHOLD, 5-29 TCP.INVITED_NODES, 5-57
SQLNET.CRYPTO_CHECKSUM_CLIENT, 5-29 TCP.NODELAY, 5-58
SQLNET.CRYPTO_CHECKSUM_SERVER, 5-30 TCP.QUEUESIZE, 5-58
SQLNET.CRYPTO_CHECKSUM_TYPE_CLIENT, TCP.VALIDNODE_CHECKING, 5-58
5-31 TNSPING.TRACE_DIRECTORY, 5-59
SQLNET.CRYPTO_CHECKSUM_TYPE_SERVER, TNSPING.TRACE_LEVEL, 5-59
5-31 TOKEN_AUTH, 5-60, 6-26
SQLNET.DBFW_PUBLIC_KEY, 5-32 TOKEN_LOCATION, 5-62, 6-28
SQLNET.DOWN_HOSTS_TIMEOUT, 5-32 USE_DEDICATED_SERVER, 5-64
SQLNET.ENCRYPTION_SERVER, 5-34 WALLET_LOCATION, 5-64
SQLNET.ENCRYPTION_TYPES_CLIENT, 5-34 SQLNET.OUTBOUND_CONNECT_TIME
SQLNET.ENCRYPTION_TYPES_SERVER, 5-35 networking parameter, 5-42
SQLNET.ENCYRPTION_CLIENT, 5-33 SQLNET.OUTBOUND_CONNECT_TIMEOUT
SQLNET.EXPIRE_TIME, 5-36 networking parameter, 5-42
SQLNET.FALLBACK_AUTHENTICATION, 5-38 SQLNET.RADIUS_ALTERNATE networking
SQLNET.IGNORE_ANO_ENCRYPTION_FOR_TCPS, parameter, 5-43
5-37 SQLNET.RADIUS_ALTERNATE_PORT
SQLNET.KERBEROS5_CC_NAME, 5-39 networking parameter, 5-43
SQLNET.KERBEROS5_CLOCKSKEW, 5-39 SQLNET.RADIUS_ALTERNATE_RETRIES
SQLNET.KERBEROS5_CONF, 5-40 networking parameter, 5-44
SQLNET.KERBEROS5_CONF_LOCATION, 5-41 SQLNET.RADIUS_AUTHENTICATION
SQLNET.KERBEROS5_KEYTAB, 5-41 networking parameter, 5-44
SQLNET.KERBEROS5_REALMS, 5-41
Index-10
Index
SQLNET.RADIUS_AUTHENTICATION_INTERF T
ACE networking parameter, 5-45
SQLNET.RADIUS_AUTHENTICATION_PORT TAF
networking parameter, 5-45 see Transparent Application Failover (TAF),
SQLNET.RADIUS_AUTHENTICATION_RETRIE 6-17
S networking parameter, 5-45 TCP.CONNECT_TIMEOUT networking
SQLNET.RADIUS_AUTHENTICATION_TIMEOU parameter, 5-56
T networking parameter, 5-46 TCP.EXCLUDED_NODES networking parameter,
SQLNET.RADIUS_CHALLENGE_RESPONSE 5-57
networking parameter, 5-46 TCP.INVITED_NODES networking parameter,
SQLNET.RADIUS_SECRET networking 5-57
parameter, 5-47 TCP.NODELAY networking parameter, 5-58
SQLNET.RADIUS_SEND_ACCOUNTING TCP.QUEUESIZE networking parameter, 5-58
networking parameter, 5-47 TCP.VALIDNODE_CHECKING networking
SQLNET.RECV_TIMEOUT networking parameter, 5-58
parameter, 5-48 TCP/IP protocol, parameters for addresses, 4-2
SQLNET.SEND_TIMEOUT networking TCP/IP with TLS protocol, parameters for
parameter, 5-49 addresses, 4-2
SQLNET.URI networking parameter, 5-50 tdm file parameters, 8-21
SQLNET.USE_HTTPS_PROXY networking TDM networking parameter, 8-22
parameter, 5-50 TDM_BIND_THREAD networking parameter,
SQLNET.WALLET_OVERRIDE, 5-50 8-22
SRC networking parameter, 8-14 TDM_DATATYPE_CHECK networking
SRV networking parameter, 8-15 parameter, 8-23
SSL_CERT_REVOCATION networking TDM_PRCP_MAX_CALL_WAIT_TIME
parameter, 5-51 networking parameter, 8-23
SSL_CIPHER_SUITES networking parameter, TDM_PRCP_MAX_TXN_CALL_WAIT_TIME
5-53 networking parameter, 8-24
SSL_CLIENT_AUTHENTICATION control TDM_SHARED_THREADS_MAX networking
parameter, 7-18 parameter, 8-24
SSL_CRL_FILE networking parameter, 5-52 TDM_SHARED_THREADS_MIN networking
SSL_CRL_PATH networking parameter, 5-53 parameter, 8-24
SSL_EXTENDED_KEY_USAGE networking TDM_THREADING_MODE networking
parameter, 5-54 parameter, 8-25
SSL_SERVER_CERT_DN networking terminated connection detection
parameter, 6-25 EXPIRE_TIME parameter, 8-8
SSL_SERVER_DN_MATCH networking limitations, 5-36, 8-8
parameter, 5-55 SQLNET.EXPIRE_TIME parameter, 5-36
SSL_VERSION networking parameter, 5-55, tnames.ora file
7-18 parameters
START command COMPRESSION, 6-33
of Listener Control utility, 1-22 COMPRESSION_LEVELS, 6-34
STARTUP command, 2-30, 2-31 tnsnames.ora file
STATUS command parameters, 6-33
of Listener Control utility, 1-23 ADDRESS, 6-7
STOP command ADDRESS_LIST, 6-8
of Listener Control utility, 1-25 CONNECT_DATA, 6-16
Structural Object Classes, C-1 CONNECT_TIMEOUT, 6-30
SUBSCRIBE_FOR_NODE_DOWN_EVENT_liste DELAY, 6-18
ner_name control parameter, 7-19 DESCRIPTION, 6-6
SUSPEND GATEWAY command, 2-31 DESCRIPTION_LIST, 6-6
syntax ENABLE, 6-9
rules for network configuration files, 3-1 FAILOVER, 6-10, 6-11
FAILOVER_MODE, 6-17
GLOBAL_NAME, 6-18
Index-11
Index
tnsnames.ora file (continued) TRACE_FILELEN diagnostic parameter, 8-29

parameters (continued) TRACE_FILELEN networking parameter, 8-17
HS, 6-19 TRACE_FILELEN_CLIENT diagnostic
HTTPS_PROXY, 6-7 parameter, 5-75
HTTPS_PROXY_PORT, 6-8 TRACE_FILELEN_listener_name diagnostic
IGNORE_ANO_ENCRYPTION_FOR_TCPS, parameter, 7-30
6-24 TRACE_FILELEN_SERVER diagnostic
INSTANCE_NAME, 6-19 parameter, 5-75
LOAD_BALANCE, 6-11 TRACE_FILENO diagnostic parameter, 8-30
METHOD, 6-18 TRACE_FILENO networking parameter, 8-17
RDB_DATABASE, 6-21 TRACE_FILENO_CLIENT diagnostic parameter,
RECV_BUF_SIZE, 6-11 5-76
RECV_TIMEOUT, 6-32 TRACE_FILENO_listener_name diagnostic
RETRIES, 6-18 parameter, 7-30
RETRY_COUNT, 6-30 TRACE_FILENO_SERVER diagnostic
RETRY_DELAY, 6-31 parameter, 5-76
SDU, 6-12 TRACE_LEVEL diagnostic parameter, 8-27
SECURITY, 6-25 TRACE_LEVEL networking parameter, 8-17
SEND_BUF_SIZE, 6-13 TRACE_LEVEL_CLIENT diagnostic parameter,
SERVER, 6-23 5-69
SERVICE_NAME, 6-23 TRACE_LEVEL_listener_name, 7-26
SOURCE_ROUTE, 6-14 TRACE_LEVEL_SERVER diagnostic parameter,
SSL_SERVER_CERT_DN, 6-25 5-69
TOKEN_AUTH, 5-60, 6-26 TRACE_TIMESTAMP diagnostic parameter, 8-28
TOKEN_LOCATION, 5-62, 6-28 TRACE_TIMESTAMP networking parameter,
TRANSACTION, 6-18 8-17
TRANSPORT_CONNECT_TIMEOUT, 6-31 TRACE_TIMESTAMP_CLIENT diagnostic
TYPE, 6-17 parameter, 5-70
TYPE_OF_SERVICE, 6-15 TRACE_TIMESTAMP_listener_name diagnostic
TNSPING.TRACE_DIRECTORY networking parameter, 7-27
parameter, 5-59 TRACE_TIMESTAMP_SERVER diagnostic
TNSPING.TRACE_LEVEL networking parameter, 5-70
parameter, 5-59 TRACE_UNIQUE_CLIENT diagnostic parameter,
TRACE command, 1-26 5-77
TRACE_DIRECTORY diagnostic parameter, TRANSACTION networking parameter, 6-18
8-29 Transparent Application Failover (TAF)
TRACE_DIRECTORY_CLIENT diagnostic parameters, 6-17
parameter, 5-73 TRANSPORT_CONNECT_TIMEOUT networking
TRACE_DIRECTORY_listener_name diagnostic parameter, 6-31
parameter, 7-29 TYPE networking parameter, 6-17
TRACE_DIRECTORY_SERVER diagnostic TYPE_OF_SERVICE networking parameter,
parameter, 5-73 6-15
TRACE_FILE networking parameter, 8-16
TRACE_FILE_CLIENT diagnostic parameter,
5-74
U
TRACE_FILE_listener_name diagnostic Unsupported Control Utility Commands, A-2
parameter, 7-29 Unsupported Protocols, A-3
TRACE_FILE_SERVER diagnostic parameter, USE_DEDICATED_SERVER networking
5-74 parameter, 5-64
TRACE_FILEAGE_CLIENT diagnostic USE_SID_AS_SERVICE_listener_name control
parameter, 5-74 parameter, 7-20, 8-18
TRACE_FILEAGE_listener_name diagnostic
parameter, 7-29
TRACE_FILEAGE_SERVER diagnostic
parameter, 5-75
Index-12
Index
V VERSION command (continued)
VALID_NODE_CHECKING_REGISTRATION_list
ener_name, 7-20
W
VALID_NODE_CHECKING_REGISTRATION_list WALLET_LOCATION control parameter, 7-21
ener_name control parameter, 7-20, 8-18 WALLET_LOCATION networking parameter,
VERSION command 5-64, 8-19
of Listener Control utility, 1-27
Index-13

Database Net Services Reference

Uploaded by

Copyright:

Available Formats

Database Net Services Reference

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Database Net Services Reference

Uploaded by

Copyright:

Available Formats

Oracle® Database

Database Net Services Reference

Copyright © 2002, 2022, Oracle and/or its affiliates.

Primary Author: Binika Kumar

Contributing Authors: Douglas Williams, Prakash Jashnani

Changes in This Release for Oracle Database Net Services Reference

1 Listener Control Utility

2 Oracle Connection Manager Control Utility

3 Syntax Rules for Configuration Files

4 Protocol Address Configuration

5 Parameters for the sqlnet.ora File

6 Local Naming Parameters in the tnsnames.ora File

7 Oracle Net Listener Parameters in the listener.ora File

8 Oracle Connection Manager Parameters

9 Directory Usage Parameters in the ldap.ora File

A Features Not Supported in this Release

B Upgrade Considerations for Oracle Net Services

C LDAP Schema for Oracle Net Services

Access to Oracle Support

Diversity and Inclusion

Changes in This Release for Oracle

Database client. This is an optional parameter. When specified, it is used to verify if

Deprecation of Weak Native Network Encryption and Integrity Algorithms

• Listener Control Utility Overview

1.1 Listener Control Utility Overview

1.2 SET and SHOW Commands of the Listener Control

1.3 Distributed Operations

Set Up a Computer to Remotely Administer a Listener

Example 1-1 Issuing Commands Using the Listener Control Utility

LSNRCTL> SERVICES lsnr

1.4 Oracle Net Listener Security

1.5 Listener Control Utility Commands

lsnrctl HELP command

From the Listener Control utility:

LSNRCTL> HELP command

lsnrctl RELOAD [-with_ha] listener_name

From the Listener Control utility:

LSNRCTL> RELOAD [-with_ha] listener_name

lsnrctl SAVE_CONFIG listener_name

From the Listener Control utility:

LSNRCTL> SAVE_CONFIG listener_name

LSNRCTL> SAVE_CONFIG listener

lsnrctl SERVICES listener_name

From the Listener Control utility:

LSNRCTL> SERVICES listener_name

lsnrctl SET parameter

From the Listener Control utility:

LSNRCTL> SET parameter

1.5.8 SET CURRENT_LISTENER

LSNRCTL> SET CURRENT_LISTENER listener_name

LSNRCTL> SET CURRENT_LISTENER lsnr

1.5.9 SET DISPLAYMODE

LSNRCTL> SET DISPLAYMODE {compat | normal | verbose | raw}

LSNRCTL> SET DISPLAYMODE normal

1.5.10 SET INBOUND_CONNECT_TIMEOUT

LSNRCTL> SET INBOUND_CONNECT_TIMEOUT time

LSNRCTL> SET INBOUND_CONNECT_TIMEOUT 2

1.5.11 SET LOG_DIRECTORY

lsnrctl SET LOG_DIRECTORY directory