Net8 Administrator's Guide
Release 8.1.6

Part Number A76933-01

Library

Product

Contents

Index

Go to previous page Go to next page

A
Control Utilities

Net8 provides control utilities to control the listener, Oracle Names and Oracle Connection Manager. This appendix lists the commands that are available with each utility, including any applicable prerequisites, passwords, syntax or argument rules, and usage notes or examples to help you use them.

The three control utilities described in this appendix are:

Operating Modes

The control utilities operate for the duration of a runtime session. You can run utilities in one of three modes:

Listener Control Utility (LSNRCTL)

You can manage the listener with the Listener Control Utility (LSNRCTL). The general syntax of the LSNRCTL is as follows:

LSNRCTL command [listener_name]

listener_name is the name of the listener defined in the listener.ora file. It is not necessary to identify the listener if you are using the default listener, named LISTENER.

LSNRCTL looks for a listener.ora file in the directory defined by the TNS_ADMIN environment variable or in $ORACLE_HOME/network/admin on UNIX and ORACLE_HOME\network\admin on Windows NT. It looks for a listener named LISTENER. If LSNRCTL cannot find an entry for a listener named LISTENER, unless specified otherwise, it assumes that the command is to be applied to the default listener--that is, a listener named LISTENER listening on TCP/IP, port 1521 and IPC, key PNPKEY.

LSNRCTL contains several types of commands:

You can use any of these commands to perform basic management functions on one or more listeners. Additionally, you can view and change listener parameter settings.

SET and SHOW Commands

You can use the SET command to change some parameter values for a listener or the LSNRCTL environment during the LSNRCTL control utility session. You can then save those values or settings with the SAVE_CONFIG command. You can use the SHOW command to display the current value of a configuration setting.

Security

If the PASSWORDS_listener_name parameter is set in the listener.ora file or the CHANGE_PASSWORD command has been used to create a new, encrypted password, the LSNRCTL control utility will require a SET PASSWORD command for any sensitive operations, such as stopping the listener.

LSNRCTL Commands

The following commands are available through the LSNRCTL:

CHANGE_PASSWORD 

Purpose: 

Enables you to dynamically change the encrypted password of a listener set with the PASSWORDS_listener_name parameter in the listener.ora file

This command does not change unencrypted passwords already established in with the PASSWORDS_listener_name parameter in the listener.ora file. It only establishes a new password, or changes a password that has been encrypted in the listener.ora file. 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL change_password [listener_name]

From the LSNRCTL utility:

LSNRCTL> change_password [listener_name]
 

Arguments: 

Listener name, if the default name of LISTENER is not used 

Usage Notes: 

The control utility prompts you for your old password, then for the new one. It asks you to re-enter the new one, then changes it. Neither the old nor the new password displays during this procedure. 

Example: 

LSNRCTL> change_password
Old password:
New password:
Reenter new password:
Connecting to (ADDRESS=(PROTOCOL=ipc)(KEY=iris))
Password changed for LISTENER
The command completed successfully
 

DBSNMP_START 

Purpose: 

Starts the SNMP subagent for an Oracle database running on the same node 

Prerequisites: 

The command must be run locally. 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL dbsnmp_start

From the LSNRCTL utility:

LSNRCTL> dbsnmp_start
 

Arguments: 

None 

Usage Notes: 

None 

Example: 

LSNRCTL> dbsnmp_start
 

DBSNMP_STATUS 

Purpose: 

Verifies whether the SNMP subagent for an Oracle database is running 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL dbsnmp_status

From the LSNRCTL utility:

LSNRCTL> dbsnmp_status
 

Arguments: 

None 

Usage Notes: 

DBSNMP STATUS must be run on the same node the Oracle database is on. 

Example: 

LSNRCTL> dbsnmp_status
 

DBSNMP_STOP 

Purpose: 

Stops the SNMP subagent for an Oracle database running on the same node 

Prerequisites: 

Must be run locally 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL dbsnmp_stop

From the LSNRCTL utility:

LSNRCTL> dbsnmp_stop
 

Arguments: 

None 

Usage Notes: 

None 

Example: 

LSNRCTL> dbsnmp_stop
 

EXIT 

Purpose: 

Quits LSNRCTL, and returns you to the operating system prompt 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL exit

From the LSNRCTL utility:

LSNRCTL> exit
 

Arguments: 

None 

Usage Notes: 

This command is identical to the QUIT command. 

Example: 

LSNRCTL> exit
 

HELP 

Purpose: 

Provides a list of all the LSNRCTL commands available. In response to one of the HELP commands, LSNRCTL displays help on how to use the command.  

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL help 
LSNRCTL help [command]

From the LSNRCTL utility:

LSNRCTL help 
LSNRCTL> help [command]
 

Arguments: 

HELP command. Commands are shown in the following example output. 

Example: 

LSNRCTL> help
The following operations are available 
An asterisk (*) denotes a modifier or extended command: 
change_password 
dbsnmp_start 
dbsnmp_stop         
dbsnmp_status
exit 
quit
reload 
services 
set* 
show*
spawn 
start                          
status 
stop 
trace          
version 
 

QUIT 

Purpose: 

Exits LSNRCTL, and returns you to the operating system prompt 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL quit

From the LSNRCTL utility:

LSNRCTL> quit
 

Arguments: 

None 

Usage Notes: 

This command is identical to the EXIT command. 

Example: 

LSNRCTL> quit
 

RELOAD 

Purpose: 

Shuts down everything except listener addresses, and re-reads the listener.ora file. This command enables you to add or change services without actually stopping the listener. 

Prerequisites: 

This will not work on valid nodes. In this case, the listener must be stopped and restarted. 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL reload [listener_name]

From the LSNRCTL utility:

LSNRCTL> reload [listener_name]
 

Arguments: 

Listener name, if the default name of LISTENER is not used 

Example: 

LSNRCTL> reload
 

SAVE_CONFIG 

Purpose: 

Compares the current configuration state of the listener, including trace level, trace file, trace directory, logging, and connect timeout, to the listener.ora file. Any changes are stored in the listener.ora, preserving formatting, comments, and case as much as possible. Prior to modification of the listener.ora file, a back up of the file, called listener.bak, is created. 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL save_config [listener_name]

From the LSNRCTL utility:

LSNRCTL> save_config [listener_name]
 

Arguments: 

Listener name, if the default name of LISTENER is not used 

Usage Notes: 

This is used by an administrator to save all on-line configuration changes to the listener configuration file. This is especially useful for saving changed encrypted passwords. 

Example: 

LSNRCTL> save_config listener
 

SERVICES 

Purpose: 

Provides detailed information about the service handlers (dispatchers, dedicated servers, and prespawned dedicated servers) the listener forwards client connection requests to, including how many connections have been established and refused 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL services [listener_name]

From the LSNRCTL utility:

LSNRCTL> services [listener_name]
 

Arguments: 

Listener name, if the default name of LISTENER is not used 

Usage Notes: 

The SET DISPLAYMODE command changes the format and the detail level of the output. 

Example: 

The example below shows SERVICES output in NORMAL mode. The output shows:

  • An instance named ORCL belongs to two services, s1 and s2, and has a total of three service handlers.

  • Service s1 is handled by one dispatcher only (and this dispatcher handles only clients requesting service s1), as specified by Relevant handlers: 1 in the output below.

  • Service s2 is handled by one dispatcher and one dedicated server, as specified by Relevant handlers: 2 in the output below.

    LSNRCTL> set displaymode normal
    LSNRCTL> services
    Connecting to 
    (DESCRIPTION=(ADDRESS=(PROTOCOL=ipc)(KEY=net)(QUEUESIZE=32))) 
    Services Summary... 
    Service "s1"            has 1 instances. 
        Instance "ORCL" 
          Status: READY  Total handlers: 3  Relevant handlers: 1 
            D000 established:0 refused:0 current:0 max:1022 
    state:ready 
            
    (ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1013.us.oracle.com)(PORT=15
    82)) 
                Session: NS 
    Service "s2"            has 1 instances. 
        Instance "ORCL" 
          Status: READY  Total handlers: 3  Relevant handlers: 2 
            D0001 established:0 refused:0 current:0 max:1022 
    state:ready 
            
    (ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1013.us.oracle.com)(PORT=53
    101)) 
                Session: NS 
            DEDICATED established:0 refused:0 current:0 max:1 
    state:ready 
                Session: NS 
    The command completed successfully
    
 

SET 

Purpose: 

Lists the available configuration commands that can be set for the current LSNRCTL session. 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL set
LSNRCTL set [command]

From the LSNRCTL utility:

LSNRCTL> set 
LSNRCTL set [command]
 

Arguments: 

SET commands. Commands are shown in the following example output. 

Example: 

LSNRCTL> set
The following operations are available with set.
An asterick (*) denotes a modifier or extended command.
connect_timeout
current_listener 
displaymode
log_file
log_directory
log_status
password 
raw_mode
save_config_on_stop 
startup_waittime 
trc_file
trc_directory
trc_level 
use_plugandplay
 

SET CONNECT_TIMEOUT 

Purpose: 

Specifies the amount of time in seconds the listener will wait for a valid connection request after a connection has been started 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL set connect_timeout {time}

From the LSNRCTL utility:

LSNRCTL> set connect_timeout {time}
 

Arguments: 

Time in seconds 

Usage Notes: 

None 

Example: 

LSNRCTL> set connect_timeout 20
Connecting to (ADDRESS=(PROTOCOL=ipc)(KEY=iris))
LISTENER parameter "connect_timeout" set to 20
The command completed successfully
 

SET CURRENT_LISTENER 

Purpose: 

Enables you to set the name of a listener that you want to set or show parameters 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL set current_listener [listener_name]

From the LSNRCTL utility:

LSNRCTL> set current_listener [listener_name]
 

Arguments: 

Listener name, if the default name of LISTENER is not used 

Usage Notes: 

When SET CURRENT_LISTENER is set, LSNRCTL commands act on the listener you set. You do not have to specify the name of the listener. 

Example: 

LSNRCTL> set current_listener [listener_name]
 

SET DISPLAYMODE 

Purpose: 

Changes the format and level of detail for the LSNRCTL SERVICES and LSNRCTL STATUS commands 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL set displaymode [argument]

From the LSNRCTL utility:

LSNRCTL> set displaymode [argument]
 

Arguments: 

COMPAT (default) - Displays output that is compatible with older versions of the listener

NORMAL - Displays output in a formatted and descriptive output. Oracle recommends this mode

VERBOSE - Displays all data received from the listener in a formatted and descriptive output

RAW - Displays all data received from the listener without any formatting. This output should only be used if recommended by Oracle WorldWide Support. 

Example: 

LSNRCTL> set displaymode normal
 

SET LOG_DIRECTORY 

Purpose: 

Sets the directory where the listener log file is written. By default, the log files are written to $ORACLE_HOME/network/log on UNIX and ORACLE_HOME/network/log on Windows NT. 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL set log_directory {directory}

From the LSNRCTL utility:

LSNRCTL> set log_directory {directory}
 

Arguments: 

Directory path 

Example: 

LSNRCTL> set log_directory /usr/oracle/admin 
Connecting to (ADDRESS=(PROTOCOL=ipc)(KEY=iris))LISTENER 
parameter "log_directory" set to /usr/oracle/admin
The command completed successfully
 

SET LOG_FILE 

Purpose: 

Sets the name for the listener log file. By default, the log file name is listener.log

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL set log_file {file_name}

From the LSNRCTL utility:

LSNRCTL> set log_file {file_name}
 

Arguments: 

File name 

Example: 

LSNRCTL> set log_file list.log
Connecting to (ADDRESS=(PROTOCOL=ipc)(KEY=iris))LISTENER 
parameter "log_file" set to list.log
The command completed successfully
 

SET LOG_STATUS 

Purpose: 

Turns listener logging on or off 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL set set log_status [argument]

From the LSNRCTL utility:

LSNRCTL> set set log_status [argument]
 

Arguments: 

ON | OFF (default) 

Example: 

LSNRCTL> set log_status on
 

SET PASSWORD 

Purpose: 

Sets the password for privileged LSNRCTL utility commands, such as SAVE_CONFIG and STOP

The password entered should match one set for the PASSWORDS_listener_name parameter in the listener.ora file or the LSNRCTL utility's CHANGE_PASSWORD command. 

Syntax: 

From the operating system:

LSNRCTL set password

From the LSNRCTL utility:

LSNRCTL> set password

The syntax for unencrypted passwords is:

set password password
 

Arguments: 

Password 

Usage Notes: 

You can enter this command when you start up the shell or any time during your session. (You must enter the SET PASSWORD command before you can stop the listener.)

The preferred, secure way to enter your password is in interactive mode.  

Example: 

LSNRCTL> set password
enter listener password: password
 

SET SAVE_CONFIG_ON_STOP 

Purpose: 

Specifies whether or not changes made by the LSNRCTL SET commands are saved to the listener.ora file after the LSNRCTL session has ended

The saving of all values occurs right before the LSNRCTL session exits, taking as much care as possible to preserve the formatting, comments, and letter case. To have all parameters saved right away, use the SAVE_CONFIG command.

Any changes are stored in the listener.ora file, preserving formatting, comments, and case as much as possible. Prior to modification of the listener.ora file, a back up of the file, called listener.bak, is created. 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL set save_config_on_stop  [argument]

From the LSNRCTL utility:

LSNRCTL> set save_config_on_stop  [argument]
 

Arguments: 

ON | OFF (default) 

Example: 

LSNRCTL> set save_config_on_stop on
 

SET STARTUP_WAITTIME 

Purpose: 

Sets the amount of time the listener sleeps before responding to a START command 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL set startup_waittime [time]

From the LSNRCTL utility:

LSNRCTL> set startup_waittime [time]
 

Arguments: 

Time in seconds 

Example: 

LSNRCTL> set startup_waittime 10
Connecting to (ADDRESS=(PROTOCOL=ipc)(KEY=iris))LISTENER 
parameter "startup_waittime" set to 10
The command completed successfully
 

SET TRC_DIRECTORY 

Purpose: 

Sets the directory where the listener trace file is written. By default, the trace file(s) are written to $ORACLE_HOME/network/trace on UNIX and ORACLE_HOME/network/trace on Windows NT. 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL set trc_directory {directory}

From the LSNRCTL utility:

LSNRCTL> set trc_directory {directory}
 

Arguments: 

Directory path 

Example: 

LSNRCTL> set trc_directory /usr/oracle/admin
Connecting to (ADDRESS=(PROTOCOL=ipc)(KEY=iris))
LISTENER parameter "trc_directory" set to /usr/oracle/admin
The command completed successfully
 

SET TRC_FILE 

Purpose: 

Sets the name for the listener trace file. By default, the trace file name is listener.trc

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL set trc_file {file_name}

From the LSNRCTL utility:

LSNRCTL> set trc_file {file_name}
 

Arguments: 

File name 

Example: 

LSNRCTL> set trc_file list.trc
Connecting to (ADDRESS=(PROTOCOL=ipc)(KEY=iris))
LISTENER parameter "trc_file" set to list.trc
The command completed successfully
 

SET TRC_LEVEL 

Purpose: 

Sets tracing for the listener at a specific level 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL set trc_level {level}

From the LSNRCTL utility:

LSNRCTL> set trc_level {level}
 

Arguments: 

Trace level:

  • OFF - No trace output

  • USER - User trace information

  • ADMIN - Administration trace information

  • SUPPORT - WorldWide Customer Support trace information

 

Usage Notes: 

This command has the same functionality as TRACE. 

Example: 

LSNRCTL> set trc_level admin
 

SET USE_PLUGANDPLAY 

Purpose: 

Instructs the listener to register its database information with an Oracle Names server 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL set use_plugandplay [argument]

From the LSNRCTL utility:

LSNRCTL> set use_plugandplay [argument]
 

Arguments: 

ON | OFF (default) 

Example: 

LSNRCTL> set use_plugandplay on
 

SHOW  

Purpose: 

Lists the available commands that can be shown for the current LSNRCTL session. In response to one of the SHOW commands, LSNRCTL displays the current setting of the listener for that parameter.

All of the SET commands listed except SET PASSWORD have equivalent SHOW commands.  

Prerequisites: 

None 

Password required if one has been set: 

Yes for SHOW SAVE_CONFIG_ON_STOP and SHOW USE_PLUGANDPLAY

If a password is set, the SET PASSWORD command must be issued prior to these commands. 

Syntax: 

From the operating system:

LSNRCTL show 
LSNRCTL show [listener_name] [command]

From the LSNRCTL utility:

LSNRCTL> show

LSNRCTL> show [listener_name] [command]
 

Arguments: 

  • Listener name, if the default name of LISTENER is not used

  • SHOW command. Commands are shown in the following example output.

 

Example: 

LSNRCTL> show
The following properties are available with SHOW:
An asterisk (*) denotes a modifier or extended command:
connect_timeout
current_listener 
displaymode
log_file
log_directory
log_status
password 
raw_mode
save_config_on_stop 
startup_waittime 
trc_file
trc_directory
trc_level 
use_plugandplay
 

SPAWN 

Purpose: 

Starts a program stored on the machine on which the listener is running, and which is listed with an alias in the listener.ora file 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL spawn [listener_name] alias (arguments=arg1,arg2,)

From the LSNRCTL utility:

LSNRCTL> spawn [listener_name] alias (arguments=arg1,arg2,)
 

Arguments: 

  • Listener name, if the default name of LISTENER is not used

  • Alias name of the program as listed in the listener.ora file

  • Arguments sent to the program that is to be spawned

 

Example: 

LSNRCTL> spawn nstest_alias (ARGUMENTS='')
 

START 

Purpose: 

Starts the named listener 

Prerequisites: 

Listener must not already be running. 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL start [listener_name] 

From the LSNRCTL utility:

LSNRCTL> start [listener_name] 
 

Arguments: 

Listener name, if the default name of LISTENER is not used 

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 

Or, from the LSNRCTL utility prompt, enter:

LSNRCTL> start tcp_lsnr
 

Example: 

LSNRCTL> start
Starting /private/dsteiner/sales/bin/tnslsnr: please wait...

TNSLSNR for Solaris: Version 8.1.6.0.0
System parameter file is 
/private/dsteiner/sales/network/admin/listener.ora
Log messages written to 
/private/dsteiner/sales/network/log/listener.log
Trace information written to 
/private/dsteiner/sales/network/trace/listener.trc
Listening on: 
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=dlsun1770)(PORT=152
1))(PROTOCOL_STACK=(PRESENTATION=TTC)(SESSION=NS)))

Connecting to 
(ADDRESS=(PROTOCOL=TCP)(HOST=dlsun1770)(PORT=1521))
STATUS of the LISTENER
------------------------
Alias                     LISTENER
Version                   TNSLSNR for Solaris: Version 
8.1.6.0.0 
Start Date                08-JUL-99 15:50:10
Uptime                    0 days 0 hr. 0 min. 0 sec
Trace Level               user
Security                  OFF
SNMP                      OFF
Listener Parameter File   
/private/dsteiner/sales/network/admin/listener.ora
Listener Log File         
/private/dsteiner/sales/network/log/listener.log
Listener Trace File       
/private/dsteiner/sales/network/trace/listener.trc
Services Summary...
  PLSExtProc            has 1 service handler(s)
The command completed successfully
 

STATUS  

Purpose: 

Displays basic status information about a listener, including:

  • Version of listener

  • Start time and up time

  • Tracing level

  • Current setting of the logging and tracing options

  • listener.ora being used

  • Whether a password is encrypted in listener.ora file

  • Whether the network listener can respond to queries from an SNMP-based network management system

  • The list of database services registered with this listener

  • The address(es) the listener is listening on

 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL status [listener_name]

From the LSNRCTL utility:

LSNRCTL> status [listener_name] 
 

Arguments: 

Listener name, if the default name of LISTENER is not used 

Usage Notes: 

The SET DISPLAYMODE command changes the format and level of the detail of the output. 

Example: 

The example below shows STATUS output in NORMAL mode. The output contains:

  • Listening endpoints summary

  • Services summary, which is an abbreviated version of LSNRCTL SERVICES output

    LSNRCTL> set displaymode normal
    LSNRCTL> status
    Connecting to 
    (DESCRIPTION=(ADDRESS=(PROTOCOL=ipc)(KEY=net)(QUEUESIZE=32))) 
    STATUS of the LISTENER 
    ------------------------ 
    Alias                     LISTENER 
    Version                   TNSLSNR for Solaris: Version 
    8.1.6.0.0 - 
    Development 
    Start Date                08-SEP-1999 10:52:32 
    Uptime                    0 days 0 hr. 0 min. 54 sec 
    Trace Level               support 
    Security                  OFF 
    SNMP                      OFF 
    Listener Parameter File   /listener.ora 
    Listener Log File         /vobs/oracle/network/log/listener.log 
    Listener Trace File       
    /vobs/oracle/network/trace/listener.trc 
    Listening Endpoints Summary... 
      (DESCRIPTION=(ADDRESS=(PROTOCOL=ipc)(KEY=net))) 
      
    (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1013.us.oracle.c
    om)(PORT=1521))) 
        
    (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1013.us.oracle.c
    om)(PORT=5522
    ))(PRESENTATION=GIOP)) 
      
    (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1013.us.oracle.c
    om)(PORT=5523
    ))(PRESENTATION=oracle.aurora.net.Echo)) 
      
    (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1013.us.oracle.c
    om)(PORT=8080
    ))(PRESENTATION=oracle.aurora.net.BabyHttp2)) 
    Services Summary... 
    Service "s1"            has 1 instances. 
        Instance "ORCL" 
          Status: READY  Total handlers: 3  Relevant handlers: 1 
    Service "s2"            has 1 instances. 
        Instance "ORCL" 
          Status: READY  Total handlers: 3  Relevant handlers: 2 
    The command completed successfully 
    
    
 

STOP 

Purpose: 

Stops the named listener 

Prerequisites: 

The listener must be running. 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL stop [listener_name] 

From the LSNRCTL utility:

LSNRCTL> stop [listener_name] 
 

Arguments: 

Listener name, if the default name of LISTENER is not used 

Usage Notes: 

Be careful when stopping a listener. On some platforms and with some protocols, when a listener is stopped any Net8 connections currently running are shut down. In some situations the connections continue, but it is then not possible to start the listener again until the running processes have been closed. It is good practice to send a warning message to all network users before stopping a listener.  

Example: 

LSNRCTL> stop
 

TRACE 

Purpose: 

Turns on tracing for the listener 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

LSNRCTL trace level [listener_name] 

From the LSNRCTL utility:

LSNRCTL> trace level [listener_name] 
 

Arguments: 

Trace level:

  • OFF - No trace output

  • USER - User trace information

  • ADMIN - Administration trace information

  • SUPPORT - WorldWide Customer Support trace information

Listener name, if the default name of LISTENER is not used 

Usage Notes: 

This command has the same functionality as SET TRC_LEVEL. 

Example: 

LSNRCTL> trace admin listener
 

VERSION 

Purpose: 

Displays the current LSNRCTL version 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

LSNRCTL version [listener_name] 

From the LSNRCTL utility:

LSNRCTL> version [listener_name] 
 

Arguments: 

Listener name, if the default name of LISTENER is not used. 

Example: 

LSNRCTL> version listener1
 

Oracle Names Control Utility (NAMESCTL)

The Oracle Names Control Utility (NAMESCTL) is a tool that you run from the operating system prompt to start and control Oracle Names servers. The general syntax of the NAMESCTL is as follows:

NAMESCTL command 

It contains several types of commands:

You can use any of these commands to perform basic management functions on one or more Oracle Names server. Additionally, you can view and change parameter settings.

SET and SHOW Commands

You can use the SET command to change some parameter values for an Oracle Names server or the NAMESCTL environment during the NAMESCTL control utility session. You can then save those values or settings with the SET SAVE_CONFIG_ON_STOP command or the SET SAVE_CONFIG_INTERVAL command. You can use the SHOW command to display the current value of a configuration setting.

Security

If the NAMES.PASSWORD parameter is set in the names.ora, the NAMESCTL control utility will require a SET PASSWORD command for any sensitive operations, such as stopping the Oracle Names server.

If NAMESCTL.SERVER_PASSWORD parameter is set in the sqlnet.ora file on the node running NAMESCTL, you will not be prompted to use the SET PASSWORD command each time a secure operation is performed.

If you are concerned with the security implications of explicitly putting an Oracle Names server password in the client sqlnet.ora file, you can omit the NAMESCTL.SERVER_PASSWORD parameter and always use the command:

NAMESCTL> set password

When passed over the network, the password is encrypted regardless of how it set in the names.ora file unless the NAMESCTL.INTERNAL_ENCRYPT_PASSWORD is set to FALSE in the sqlnet.ora file. If this parameter is set to FALSE, the password is not encrypted.

NAMESCTL's Distributed Operation

The Oracle Names Control Utility operates on an Oracle Names server on the same machine as any other Oracle Names servers in the network. This is very useful when a single administrator is managing all of the Oracle Names servers in a region, or wants to check the availability of a specific Oracle Names server.

Most commands accept the name of an Oracle Names server as the last argument indicating which Oracle Names server to perform the command against. If omitted, the current SET Oracle Names server is used. For example:

show system_queries dolphin.acme

will display the system queries on the Oracle Names server dolphin.acme and when they will next occur. Prior to performing a series of commands against an individual Oracle Names server, enter

NAMESCTL> set server onames_server

Confirmation Mode in NAMESCTL

Some of the NAMESCTL commands require your confirmation before they are executed. When you issue the command, you are prompted:

confirm:[yes or no]

Enter "yes" to execute the command; enter "no" to cancel the command.

You can turn confirmation mode off by using by setting the parameter NAMESCTL.NOCONFIRM to TRUE in the sqlnet.ora file.

NAMESCTL Commands

The following commands are available through the Oracle Names Control Utility (NAMESCTL):

DELEGATE_DOMAIN   

Purpose: 

Defines a domain as the start of a subregion of the current administrative region 

Prerequisites: 

none 

Password required if one has been set: 

No 

Syntax: 

From the operating system prompt:

NAMESCTL delegate_domain {domain}{names_server} 
{(address=...)}

From the NAMESCTL utility:

delegate_domain {domain}{names_server}{(address=...)}
 

Arguments: 

{domain} - Specifies the domain name.

{onames_server} - Specifies the Oracle Names server name.

{(address=...)} - Specifies the Oracle Names server protocol address.

See Also: Appendix B, "Protocol Addresses", for further information about defining protocol addresses 

Usage Notes: 

This command provides a dynamic way to subdivide the namespace.

Unless a domain is delegated from a region, the Oracle Names servers in that region will assume authority over all sub-domains. In order to delegate a domain, you must first create a new region.

Once a domain is delegated, the Oracle Names servers in the current region will forward subsequent operations to the sub-region where the domain is administered by Oracle Names servers. 

Examples: 

NAMESCTL> delegate_domain webwidgets.acme.com 
ns1.webwidgets.acme.com (address=(protocol=tcp) 
(host=fred.webwidgets.acme.com)(port=1575))
 

DOMAIN_HINT   

Purpose: 

Enables you to specify domain hints for requests for data from remote regions. A domain hint contains the name of a remote domain and at least one address of an Oracle Names server in that domain. This enables the Oracle Names server to forward the request to a specific address, reducing network traffic is reduced.

Without a domain hint, an Oracle Names server forwards a request on to whatever remote Oracle Names servers it knows, who then forwards the request to the root Oracle Names server in its region. The root Oracle Names server will forward the request to the Oracle Names servers which has information on the domain that the request refers to.  

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL domain_hint{domain}{names_server}{(address=...)}

From the NAMESCTL utility:

domain_hint {domain}{names_server}{(address=...)}
 

Arguments: 

{domain} - Specifies the domain name.

{onames_server} - Specifies the Oracle Names server name.

{(address=...)} - Specifies the Oracle Names server protocol address.

See Also: Appendix B, "Protocol Addresses", for further information about defining protocol addresses 

Usage Notes: 

Any region that is not the root region will need at least the root region defined using this command in order to find objects in any other region. You can provide additional hints as optimizations to provide local Oracle Names servers with direct access to certain other regions. 

Examples: 

NAMESCTL> domain_hint acme.com ns0.acme.com 
(address=(protocol=tcp) (host=top.acme.com)(port=1575))
 

DUMP_LDAP   

Purpose: 

Queries all the authoritative data in a domain or region and exports the data to a LDAP-compliant directory service or into LDAP Data Interchange Format (LDIF) file, which can later be loaded into a directory 

Prerequisites: 

The directory must already have an Oracle Context and Oracle schema. 

Password required if one has been set: 

A password for the directory may be required. 

Syntax:  

Exporting Data to an LDIF File

NAMESCTL> dump_ldap [source] [destination] [options] {-f filename}


Exporting Data To a Directory

NAMESCTL> dump_ldap [source] [destination] [options] {-h host} {-p port} {-D user_dn} {-w password

Arguments: 

[source]= {domain} [-R]

{domain} - Specifies the domain's objects to be migrated. The default domain is the root. The operation is forwarded to a server who is authoritative for that domain if the server which the client contacts is not authoritative.

[-R] - Specifies that all authoritative subdomains of the given domain should also be migrated.  

 

[destination] - Specifies the DN in the directory where objects should be placed in the DIT

A DN can be specified in one of following ways:

  • A complete DN that includes all the tree levels. For example, (dn:cn=OracleContext,dc=com,dc=acme) specifies that object be exported to cn=OracleContext under acme.com.

  • A template to accommodate the full-intended depth of the tree by using wildcards for RDNs. For example, (dn:o,ou,dc) maps to a DIT structure that contains an Organization (o), and OrganizationUnit (ou), and a domain component (dc).

    Note: If the directory's DIT contains an cn=OracleContext RDN, use the -x option when using a RDN template. This way, a database service and net service names will be mapped under cn=OracleContext.

The -R (recursive) argument in the source specification determines how the destination DN is mapped to the directory's DIT.

  • If -R is not specified in the source, the source domain specified maps directly into the DIT specified by the destination DN.

  • If the -R argument is used, then data will be exported from all subdomains starting at the given domain. Any subdomains map to the destination RDNs specified. If RDNs in the destination DN are wildcarded--that is, specified without a value--subdomains are mapped to the RDN type with their own value.

    Note: If the DIT contains an cn=OracleContext RDN for each sub-domain, use the -x option. This way, database services and net service names will be mapped under cn=OracleContext for each subdomain.

Note: If no DN is specified, domains will be mapped to domain components (dc) in the DIT.  

 

[options] - Arguments that specify how the export of data is to occur:

-a - Specifies that all objects are to be added to the DIT. If an object already exists in the DIT, an error occurs. If this option is not specified, existing objects are modified, but no additions are made.

-c - Specifies that the export should continue on error

-n - Does not perform an actual export. This argument enables you to perform a test run

-q - Runs the operation in quiet mode

-x - Adds cn=OracleContext to the destination DN. 

 

{-f filename} - Specifies that the migrated objects be dumped into an LDIF file, which can later be loaded into a directory. The default file names is onames.ldif

 

These arguments specify the directory server location:

[-h host] - Specifies the host name of the directory server

[-p port] - Specifies the port number the directory is configured to listen on. The default TCP/IP port number is 389 

 

These arguments specify the authentication credentials:

[-D user_dn] - Specifies a directory administrator that has been given add and modify privilege in the form of a DN. For example, c=us,o=acme,ou=admin,cn=scott is the DN for an administrator named Scott.

[-w password] -Specifies the password for the directory administrator 

Usage Notes: 

See Also: "Exporting Network Objects from an Oracle Names Server" 

Examples: 

Exporting Data to a LDIF File

NAMESCTL> dump_ldap sj.us.sczi.com - R 
(dn:cn=OracleContext,ou=sj,dc=us,dc=sczi,dc=com) -f 
test.ldif
Exporting Data Directly Into a Directory

NAMESCTL> dump_ldap sj.us.sczi.com - R 
(dn:cn=OracleContext,ou=sj,dc=us,dc=sczi,dc=com) -a -h 
dlsun1598 -p 389 -D cn=orcladmin -w welcome
 

DUMP_TNSNAMES   

Purpose: 

Writes the names and addresses of all address defined in the local region into a tnsnames.ora file 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL dump_tnsnames

From the NAMESCTL utility:

dump_tnsnames
 

Arguments: 

None 

Usage Notes: 

Writes the name and address of all addresses defined in the local region into tnsnames.ora (everything with an address-type record (A.SMD)).

The command creates or partially overwrites the tnsnames.ora file. Any entries in the existing tnsnames.ora which are not defined in the Oracle Names servers will remain. Any definitions in tnsnames.ora which are also defined in the Oracle Names servers will be overwritten. Entries which are defined in the Oracle Names servers but not in the tnsnames.ora will be added.  

Examples: 

NAMESCTL> dump_tnsnames
 

EXIT 

Purpose: 

Exits from the NAMESCTL utility 

Prerequisites: 

The NAMESCTL utility must be loaded. 

Password required if one has been set: 

No 

Syntax: 

From the NAMESCTL utility: EXIT 

Arguments: 

None 

Usage Notes: 

EXIT has no effect on any Oracle Names servers.

It affects only the NAMESCTL utility.

This command is identical to the QUIT command. 

Example: 

namsctl> exit
NAMESCTL finished. 
 

FLUSH 

Purpose: 

Instructs the Oracle Names server to clear all remote region information from its local cache checkpoint file, which has a default of ckpcch.ora 

Prerequisites: 

Only relevant with an environment with multiple regions. (In central administration there is no non-authoritative data.)  

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system prompt:

NAMESCTL flush [onames_server] [onames_server]*

From the NAMESCTL utility:

flush [onames_server] [onames_server]*
 

Arguments: 

Zero or more Oracle Names servers separated by a space. When no arguments are supplied, only the current Oracle Names server's cache is flushed of the foreign names 

Usage Notes: 

FLUSH erases all remote data that has been cached. Typically, you should flush the foreign data cache when:

  • A large volume of data changes in the network and the normal TTL aging mechanism will take too long.

  • When unidentifiable errors in name resolution of cached foreign data are occurring. Flushing all foreign data from the cache forces it to be looked up again when it is requested the next time.

Names are flushed from the current Oracle Names server. The current Oracle Names server is either the default preferred Oracle Names server or the one set by using the SET SERVER command. 

Examples: 

NAMESCTL> flush
Confirm [yes or no]: yes
 

FLUSH_NAME 

Purpose: 

Instructs the Oracle Names server to clear a specific region's information from its local cache checkpoint file, which has a default of ckpcch.ora 

Prerequisites: 

This parameter is only meaningful for an environment with multiple regions. (In central administration, there is no non-authoritative data.) 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system prompt:

NAMESCTL flush_name {domain}

From the NAMESCTL utility:

flush_name {domain}
 

Arguments: 

A single domain name 

Usage Notes: 

FLUSH_NAME erases only data cached from outside the Oracle Names server's region (that is, non-authoritative data). It is typically flushed when a name is behaving unusually, suggesting the source copy may have changed.

Names are flushed from the current Oracle Names server. The current Oracle Names server is either the default preferred Oracle Names server or the one set by using the SET SERVER command. 

Examples: 

NAMESCTL> flush_name mountain.acme.com
 

HELP 

Purpose: 

Provides a list of all the NAMESCTL commands available. In response to one of the HELP commands, NAMESCTL displays help on how to use the command.  

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL help 
NAMESCTL help [command]

From the NAMESCTL utility:

NAMESCTL help 
NAMESCTL> help [command]
 

Arguments: 

Help command. Commands are shown in the following example output. 

Example: 

NAMESCTL> help
The following operations are available:
An asterisk (*) denotes a modifier or extended command:
exit
flush
flush_name
log_stats
ping
query
quitreload
repeat*
reset_stats
restart 
set*
show
shutdown
start
startup
status
stop 
version
 

LIST_DELEGATED   

Purpose: 

Lists all the delegated domains for the root region or a specified domain 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL list_delegated [domain]

From the NAMESCTL utility:

NAMESCTL> list_delegated [domain]
 

Arguments: 

Domain name 

Usage Notes: 

This command is intended to help you understand the current domain structure before exporting data from Oracle Names to an LDAP-compliant directory.

See Also: "Exporting Network Objects from an Oracle Names Server" 

Examples: 

NAMESCTL> list_delegated
europe.acme.com
asia.acme.com
africa.acme.com
 
9

LIST_DOMAINS   

Purpose: 

Lists all the domains in the root region or subdomains for a specified domain 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL _list_domain [domain]

From the NAMESCTL utility:

NAMESCTL _list_domain [domain]
 

Arguments: 

domain name 

Usage Notes: 

This command is intended to help you understand the current domain structure before exporting data from Oracle Names to an LDAP-compliant directory.

See Also: "Exporting Network Objects from an Oracle Names Server" 

Examples: 

NAMESCTL> list_domains
com
sczi.com
us.sczi.com
sj.us.sczi.com
 

LIST_OBJECTS   

Purpose: 

Lists all the network objects for the root region or a specified domain 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL list_domain [-R] [domain]

From the NAMESCTL utility:

NAMESCTL> list_domain [-R] [domain]
 

Arguments: 

[-R] - Specifies that all authoritative subdomains of the given domain be listed.

[domain] - Specifies the domain name. 

Usage Notes: 

This command is intended to help you understand the current domain structure before exporting data from Oracle Names to an LDAP-compliant directory.

See Also: "Exporting Network Objects from an Oracle Names Server" 

Examples: 

NAMESCTL> list_obmects
partsdb.widgets.acme.com
toolsdb.widgets.acme.com
partsdb.components.widgets.acme.com
sparepartsdb.gadgets.widgets.acme.com
 

LOAD_TNSNAMES 

Purpose: 

Loads all net service names and addresses defined in one or more tnsnames.ora files into an Oracle Names server. 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system prompt:

NAMESCTL load_tnsnames {tnsnames.ora} [tnsnames.ora]

From the NAMESCTL utility:

load_tnsnames {tnsnames.ora}[tnsnames.ora] 
 

Arguments: 

One or more tnsnames.ora files 

Usage Notes: 

This command would typically be used once when a site begins using Oracle Names after having used tnsnames.ora files. Run this command once per region. The names defined during this operation will be defined permanently and will be propagated from one Oracle Names server to all the rest in the region. 

Example: 

NAMESCTL>load_tnsnames network/admin/tnsnames.ora
	Name:                  koala.lab.npd.us.oracle.com 
	Response status:       normal, successful completion 
	Name:                  devdd.rdbms.us.oracle.com 
	Response status:       normal, successful completion 
	Name:                  envyd.lab.npd.us.oracle.com 
	Response status:       normal, successful completion 
	Name:                  stealth.npd.us.oracle.com 
	Response status:       normal, successful completion 
	Name:                  null.us.oracle.com 
	Response status:       normal, successful completion 
	Name:                  slime.lab.npd.us.oracle.com 
	Response status:       normal, successful completion 
	Name:                  felix.hp.us.oracle.com 
	Response status:       normal, successful completion 
	Name:                  dtnet1.dec.oracle.com 
	Response status:       normal, successful completion 
	Name:                  devds.rdbms.us.oracle.com 
	Response status:       normal, successful completion 
 

LOG_STATS 

Purpose: 

Logs the current set of statistics to the configured log file for that Oracle Names server. The log file has a default of names.log

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system prompt:

NAMESCTL log_stats [onames_server] [onames_server]*

From the NAMESCTL utility:

log_stats [onames_server] [onames_server]*
 

Arguments: 

Zero or more Oracle Names server names separated by a space. When no arguments are supplied, only the statistics for the current Oracle Names server are reset.  

Usage Notes: 

Statistics may be logged if the STATUS command or other behavior indicates some data that you would like to capture in the log. LOG_STATS does not affect the current log statistics interval. 

Example: 

NAMESCTL> log_stats
Statistics counters logged.
 

PASSWORD 

Purpose: 

Sets an encrypted password for privileged NAMESCTL utility commands, such as STOP, RESTART and RELOAD.  

Prerequisites: 

The NAMESCTL utility must be loaded. 

Password required if one has been set: 

N/A 

Syntax: 

From the NAMESCTL utility:

password [password]
 

Arguments: 

Text string matching the value encrypted in the NAMES.PASSWORD parameter in the names.ora file. 

Usage Notes: 

This command does not change a password already established with the NAMES.PASSWORD parameter in the names.ora file. It simply sets a NAMESCTL variable. Then, the value stored is sent from NAMESCTL with any command request to the Oracle Names server, and the value is compared to the value configured on the Oracle Names server. If they match, operations requiring passwords are allowed.

Only "privileged" operations are affected, that is, operations that alter the functioning of the Oracle Names server. Operations such as SHOW or STATUS are not considered privileged, and do not require a password.

The password can either be passed as an argument of the PASSWORD command, or if no argument is given, it will be prompted for. Note that the input is not displayed on the screen as it is typed.

When passed over the network the password is always encrypted, regardless of how it is set. 

Example: 

NAMESCTL> password open_sesame
NAMESCTL> password
Enter name server password: 
 

PING 

Purpose: 

Contacts the current Oracle Names server, or named Oracle Names servers, and displays the request/response time 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system prompt:

NAMESCTL ping [onames_server] [onames_server]*

From the NAMESCTL utility:

ping [onames_server] [onames_server]*
 

Arguments: 

Zero or more Oracle Names server names separated by a space. When no arguments are supplied, only the current Oracle Names server is pinged.  

Usage Notes: 

Ping ensures that an Oracle Names server is functioning and shows typical response times from the location of the NAMESCTL user to an Oracle Names server.  

Example: 

NAMESCTL> ping nserver.com
Round trip time is 0.04 seconds
 

QUERY 

Purpose: 

Retrieves the contents of a network object stored in the Oracle Names server 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax 

From the operating system prompt:

NAMESCTL query object_name [object_type] [modifiers]

From the NAMESCTL utility:

query object_name [object_type] [modifiers]

COMMON OBJECT TYPES:

  • A.SMD--Network addresses, as with database service definitions or net service names

  • CNAME.SMD--Aliases (sometimes referred to as "canonical name")

  • DL.RDBMS.OMD--Global database links

  • DLCR.RDBMS.OMD--Global database link qualifiers

  • NS.SMD--Oracle Names server addresses. System data used to communicate between Oracle Names servers

  • V1ADD.NPO.OMD--SQL*Net Version 1 connect string

VALID MODIFIERS:

  • AUTHORITY--Forces the query to be resolved at the source of the data (in the administrative region where the data is considered local) even if the data is in the local cache. This could be used if the administrator suspects that the data has changed at the source.

  • NOFORWARD--Query for the data, but don't forward the request. When the data is not local, and noforward is specified, the query will not be resolved.

  • TRACE--Enables a trace of the path to the answer. This is useful whenever you want to find out which Oracle Names servers the request went to

 

Arguments: 

Mandatory network object name and network object type 

Usage Notes: 

QUERY can be used to test that a defined piece of data can be found, and that the contents are correct.

The QUERY command always operates on the current Oracle Names server, either the default, or as specified using the SET SERVER command.

If the QUERY command is used with just a name as a parameter, the Oracle Names server responds with the number of pieces of data with that name, and the time required to complete the operation.

If the QUERY command is used with the name and type supplied as arguments; the specific name is looked up and returned to the user.

The QUERY command can take multiple arguments if appropriate. For example:

query sales.com a.smd authority trace
 

Example: 

NAMESCTL> query bones.dem.medicine a.smd
Total response time:0.04 seconds
Response status:normal, successful completion
Authoritative answer:yes
Number of answers:1
Canonical name:bones.dem.medicine
TTL: 1 day
Alias translations:
    from:bones.dem.medicine
    to: bones.dem.medicine
Answers:
    data type is "a.smd"
        Syntax is ADDR:...(DESCRIPTION=(ADDRESS=
(PROTOCOL=TCP)(Host=bones-pc)
(Port=1521))(CONNECT_DATA=(SERVICE_NAME=bones.dem.medicine)))
 

QUIT 

Purpose: 

Quits the NAMESCTL utility 

Prerequisites: 

The NAMESCTL utility must be loaded. 

Password required if one has been set: 

No 

Syntax: 

From the NAMESCTL utility:

QUIT
 

Arguments: 

None 

Usage Notes: 

QUIT has no effect on any Oracle Names servers. It affects only the NAMESCTL utility.

The QUIT command is functionally equivalent to the EXIT command. 

Example: 

NAMESCTL> quit
nl-00851: NAMESCTL finished
 

REGISTER 

Purpose: 

Registers a network object to an Oracle Names server 

Password required if one has been set: 

No 

Syntax: 

From the NAMESCTL utility:

register object_name [-t service_type] 
[-d [(description=](address=(protocol_address_
information))[)]] [-h onames_server]
[-l listener_name]

TYPE OF SERVICE:

  • ORACLE_DATABASE

  • ORACLE_LISTENER

  • ORACLE_NAMESERVER

See Also: Appendix B, "Protocol Addresses" for further information about protocol addresses and parameters 

Arguments: 

Mandatory object name. The service, address data, and host are not necessary to make the registration process appear to work. However, they are necessary to make the registration useful. In other words, an object name registered without an address cannot be used.  

Usage Notes: 

Provides a manual mechanism for registering a service, its type, its hostname, and its address. Both the type of service and the data can be any valid string, but the typical registration has either "database" or "listener" as type of service, and the TNS address as the data.

The object registration is propagated to all other well known Oracle Names servers in the region. 

Example: 

NAMESCTL> register parts -t oracle_database -d (DESCRIPTION= 
(ADDRESS= (PROTOCOL=TCP)(HOST=nineva)(PORT=1575)) (CONNECT_
DATA=(SERVICE_NAME=db3)))
 

RELOAD 

Purpose: 

Forces the Oracle Names server to check immediately for data changes in its administrative region. If there are any changes, the Oracle Names server reloads all database service names, net service names, global database links, and aliases. 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system prompt:

NAMESCTL reload [onames_server] [onames_server]*

From the NAMESCTL utility:

reload [onames_server] [onames_server]*
 

Arguments: 

Zero or more Oracle Names server names separated by a space. When no arguments are supplied, only the current Oracle Names server is reloaded. 

Usage Notes: 

All Oracle Names servers load their data directly from the database specified by the NAMES.ADMIN_REGION configuration parameter in the names.ora file.

In an environment with multiple regions, RELOAD affects only the data for the current administrative region. All foreign data in the cache is unchanged. 

Example: 

NAMESCTL> reload
Server reloaded.
 

REORDER_NS 

Purpose: 

Creates the file which lists local Oracle Names servers and their listening addresses 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system prompt:

NAMESCTL reorder_ns [(description=](address=(protocol_
address_information))[)] 

From the NAMESCTL utility:

reorder_ns [(description=](address=(protocol_address_
information))[)] 

See Also: Appendix B, "Protocol Addresses" for further information about protocol addresses and parameters 

Arguments: 

An optional Oracle Names server address will be used as the initial server to contact. 

Usage Notes: 

This command generates the file which defines Oracle Names server names and addresses to enable clients to contact Oracle Names servers for name lookup.

The REORDER_NS command performs the following tasks;

  1. Finds an Oracle Names server: 1. It looks in the sqlnet.ora for a preferred Oracle Names server parameter, 2. tries calling a well-known servers, 3. tries locating a local Oracle Names server using TCP/IP on port 1575.

  2. Sends a query for all the Oracle Names servers in the local region

  3. Sends a PING to each of these servers

  4. Sorts the list of servers by increasing order of response time

  5. Writes an Oracle Names server List with the sorted list of names and addresses

 

Example: 

NAMESCTL> reorder_ns (address= 
(protocol=tcp)(host=nineva)(port=1575))
 

REPEAT 

Purpose: 

Performs QUERY, REGISTER, TIMED_QUERY, or UNREGISTER multiple times to compute average return rates 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system prompt:

NAMESCTL repeat number query type

From the NAMESCTL utility:

repeat number query type 
 

Arguments: 

number - Integer

type - Object types, as specified in the QUERY command 

Usage Notes: 

Repeat is useful for understanding the average response time over a number of requests.

Do not specify too large a number here; while the number of iterations are occurring, the NAMESCTL utility cannot do anything else. 

Example: 

NAMESCTL> repeat 10 query manatee a.smd
Number of requests: 10
Average response time: 0.01 seconds
Minimum response time: 0.01 seconds
Maximum response time:0.04 seconds
Total response time:0.14 seconds
Response status:normal, successful completion
Authoritative answer:yes
Number of answers: 1
TTL: 1 day
Answers:
    data type is "a.smd"
        Syntax is ADDR:(DESCRIPTION=(ADDRESS=
(PROTOCOL=TCP)(Host=salmon)
(Port=1522))(CONNECT_DATA=(SID=otter)))
 

RESET_STATS 

Purpose: 

Resets the Oracle Names server statistics to the original values of the Oracle Names server at startup 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system prompt:

NAMESCTL reset_stats [onames_server] [onames_server]*

From the NAMESCTL utility:

reset_stats [onames_server] [onames_server]*
 

Arguments: 

Zero or more Oracle Names server names separated by a space. When no arguments are supplied, only the current Oracle Names server's statistics are reset. 

Usage Notes: 

RESET_STATS has the same effect as waiting for the RESET_STATS_INTERVAL to conclude, except that it happens immediately. 

Example: 

NAMESCTL> reset_stats
Confirm [yes or no]: yes
Server statistics reset.
 

RESTART 

Purpose: 

Initiates a reset of an Oracle Names server to its original state at startup 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system prompt:

NAMESCTL restart [onames_server] [onames_server]*

From the NAMESCTL utility:

restart [onames_server] [onames_server]*
 

Arguments: 

Zero or more Oracle Names server names separated by a space. When no arguments are supplied, only the current Oracle Names server is restarted. 

Usage Notes: 

RESTART is the same as STARTUP except that the Oracle Names server is already running.

Data is reloaded, statistics are reset, and all foreign data is flushed. Valid foreign cache data (that is, data with a TTL greater than 0) is retrieved from the checkpoint files. (The TTL value must be set to more than 0.)  

Example: 

NAMESCTL> restart
Confirm [yes or no]: yes
Server restarted.
 

SET 

Purpose: 

Lists the available configuration commands that can be set for the current NAMESCTL session  

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL set
NAMESCTL set [command]

From the LSNRCTL utility:

NAMESCTL> set 
NAMESCTL set [command]
 

Arguments: 

SET commands. Commands are shown in the following example output. 

Example: 

NAMESCTL> set
The following operations are available after set
An asterisk (*) denotes a modifier or extended command:
cache_checkpoint_interval
default_domain
forwarding_available
log_file_name
log_stats_interval
NAMESCTL_trace_level
password
requests_enabled
reset_stats_interval
save_config_interval
save_config_on_stop
server
trace_file_name
trace_level
 

SET CACHE_CHECKPOINT_INTERVAL 

Purpose: 

Sets how often all collected information about remote regions is saved in the local cache file, which as a default of ckpcch.ora 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL set cache_checkpoint_interval time

From NAMESCTL utility:

set cache_checkpoint_interval time
 

Arguments: 

Time is in seconds

For example, to increase the CACHE_CHECKPOINT_INTERVAL to 36 hours, the following can be set:

set cache_checkpoint_interval 129600
 

Usage Notes 

Minimum: 10 seconds

Maximum: 259200 (3 days)

Default: 0 (disabled) 

Example: 

NAMESCTL> set cache_checkpoint_interval 10
 

SET DEFAULT_DOMAIN 

Purpose: 

Sets the domain from which the NAMESCTL client most often looks up names resolution requests, or changes the domain specified by the NAMES.DEFAULT_DOMAIN in the sqlnet.ora file 

Prerequisites: 

The NAMESCTL utility must be loaded. 

Password required if one has been set: 

No 

Syntax: 

From the NAMESCTL utility:

set default_domain domain_name
 

Arguments: 

Domain name 

Usage Notes: 

When a default domain is set, it is automatically appended to any unqualified net service name or service name. For example, if the default domain is set to us.acme, the global name sales.us.acme could be queried using:

NAMESCTL> query sales
 

Example: 

NAMESCTL> set default_domain us.acme.com
Default domain is now "US.ACME.COM"
 

SET FORWARDING_AVAILABLE 

Purpose: 

Turns on or off forwarding to remote Oracle Names servers for client name requests 

Prerequisites: 

Oracle Names server must be running. 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

NAMESCTL set forwarding_available on|off|yes|no

From the NAMESCTL utility:

set forwarding_available off
 

Arguments: 

ON | OFF | YES | NO 

Default Value: 

OFF 

Usage Notes: 

This setting is intended only for Oracle Names servers that have no local clients and are exclusively handling requests from remote Oracle Names servers. This usually would only apply to Oracle Names servers in the root region when the root is configured without clients or services. If such an Oracle Names server is a performance bottleneck in cross-region request processing, then disabling forwarding in that Oracle Names server will cut its workload in half. Rather than forward the request and return the answer, the Oracle Names server simply tells the requestor the address of the Oracle Names server that can answer the request. Note that there is no overall reduction in work; the work is simply displaced from the non-forwarding Oracle Names server to the requesting Oracle Names server.

WARNING: If SET FORWARDING_AVAILABLE is set to off, any clients who rely directly on that Oracle Names server will be unable to resolve remote names. Clients are not capable of redirecting their requests as Oracle Names servers are. Their requests will fail at that point, even if other Oracle Names servers are listed in the NAMES.PREFERRED_SERVERS configuration parameter.  

Example: 

NAMESCTL> set forwarding_available off 
Request processing is now disabled. 
 

SET LOG_FILE_NAME 

Purpose: 

Sets the name for the Oracle Names server's log file. By default, the log file name is names.log

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

NAMESCTL set log_file_name file_name

From the NAMESCTL utility:

set log_file_name file_name
 

Arguments: 

file name of the log file. 

Usage Notes: 

The LOG_FILE_NAME changes the destination of all logging messages.  

Example: 

NAMESCTL> set log_file_name namesvr1
 

SET LOG_STATS_INTERVAL 

Purpose: 

Changes the frequency with which the statistics are logged to the log file, which has a default of names.log 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

NAMESCTL set log_stats_interval time

From the NAMESCTL utility:

NAMESCTL> set log_stats_interval time
 

Arguments: 

Time is in seconds or [<n> DAY[S]] [<hh>:<mi>:<ss>]

For example, to increase the LOG_STATS_INTERVAL to 36 hours, both of the following can be set:

set log_stats_interval 129600
set log_stats_interval 1 day 12:00:00

You can specify any valid combination, such as the number of days combined with number of hours, minutes, and seconds; or just the number in hours. 

Restrictions: 

Minimum Value: 10 seconds

Maximum Value: no maximum

Special Value: 0 (which means never reset)

Default value: 0 (no logging)  

Usage Notes: 

The LOG_STATS_INTERVAL value is initially set based on the value configured in NAMES.LOG_STATS_INTERVAL parameter in the sqlnet.ora file when the Oracle Names server is loaded. By default, the value is 0 (no logging). This command is intended to override that value during server operation. 

Example: 

NAMESCTL> set log_stats_interval 7200
Statistic counter logging interval is now 2 hours
 

SET NAMESCTL_TRACE_LEVEL 

Purpose: 

Sets the level at which the NAMESCTL utility can be traced 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

NAMESCTL set NAMESCTL_trace_level level

From the NAMESCTL utility:

NAMESCTL> set NAMESCTL_trace_level level
 

Arguments: 

OFF - Tracing is not set

USER - Tracing is set to identify user-induced error conditions

ADMIN - Tracing is set to identify installation-specific problems

SUPPORT - Tracing is set to a level appropriate for support 

Usage Notes: 

Tracing assists in diagnosing unexpected or unidentifiable failures in processing the NAMESCTL utility. Tracing writes a series of events from normal NAMESCTL processing to an operating system file for review by the administrator.

Tracing output is at three levels OFF (none), USER (basic information), or ADMIN.

When no arguments are supplied, the setting is reset to the value in the client's sqlnet.ora file. The default setting is OFF. 

Example: 

NAMESCTL> set NAMESCTL_trace_level admin
Controller's local trace level changed from 0 to 4
 

SET PASSWORD 

Purpose: 

Sets the password for privileged NAMESCTL utility commands, such as STOP, RESTART and RELOAD.

The password entered should match the one set for the NAMES.PASSWORD parameter in the names.ora file. 

Prerequisites: 

The NAMESCTL utility must be loaded. 

Password required if one has been set: 

Not applicable 

Syntax: 

From the NAMESCTL utility:

NAMESCTL> set password [password]
 

Arguments: 

Text string matching the value stored in the current Oracle Names server parameter NAMES.PASSWORD 

Usage Notes: 

SET PASSWORD does not change the Oracle Names server's password. It simply sets a NAMESCTL variable that is sent over to the Oracle Names server with any NAMESCTL command and is compared to the value configured on the Oracle Names server. If they match, operations requiring passwords are allowed.

Only "privileged" operations are affected, that is, operations that alter the functioning of the Oracle Names server. Operations such as SHOW or STATUS are not considered privileged, and do not require a password.

The password can either be passed as an argument of the SET PASSWORD command, or if no argument is given, it will be prompted for. Note that the input is not displayed on the screen as it is typed.

When passed over the network the password is always encrypted, regardless of how it is set. 

Example: 

NAMESCTL> set password open_sesame
NAMESCTL> set password
enter name server password: 
 

SET REQUESTS_ENABLED 

Purpose: 

Determines whether the current Oracle Names server will respond to requests 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

NAMESCTL requests_enabled on|off

From the NAMESCTL utility:

NAMESCTL> set requests_enabled on|off
 

Arguments: 

ON | OFF 

Usage Notes: 

Setting this property to OFF will send refusals to all clients that approach with names resolution requests. This is primarily useful for diagnostics when an Oracle Names server is functioning unexpectedly. 

Example: 

NAMESCTL> set requests_enabled off
Confirm [yes or no]: yes
General request processing is now disabled
 

SET RESET_STATS_INTERVAL 

Purpose: 

Changes the time between the statistics being reset to zero or initial values in the current server. 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

NAMESCTL set reset_stats_interval time

From the NAMESCTL utility:

NAMESCTL> set reset_stats_interval time
 

Arguments: 

Time is in seconds or [n DAY[S]] [hh:mi:ss]

For example, to increase the RESET_STATS_INTERVAL to 72 hours, the following can be set:

set reset_stats_interval 259200
set reset_stats_interval 3 days
 

Restrictions: 

Minimum Value: 10 seconds

Maximum Value: no maximum

Default value: 0 (never reset) 

Usage Notes: 

The RESET_STATS_INTERVAL value is initially set based on the NAMES.RESET_STATS_INTERVAL parameter when the Oracle Names server is loaded. This command is intended to override that value during Oracle Names server operation.  

Example: 

NAMESCTL> set reset_stats_interval 1 day
Statistic counter reset interval is now 24 hours
 

SET SAVE_CONFIG_INTERVAL 

Purpose: 

Saves any changes made by NAMESCTL SET commands to the names.ora at an interval 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

NAMESCTL set save_config_interval time

From NAMESCTL utility:

set save_config_interval time
 

Arguments: 

Time is in seconds 

Example: 

NAMESCTL> set save_config_interval 10
 

SET SAVE_CONFIG_ON_STOP 

Purpose: 

Specifies whether or not changes made by the NAMESCTL SET commands are saved to the names.ora file after the NAMESCTL session has ended.

The saving of all values occurs right before the NAMESCTL session exits, taking as much care as possible to preserve the formatting, comments, and letter case.  

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

NAMESCTL set save_config_on_stop on|off

From the NAMESCTL utility:

NAMESCTL> set save_config_on_stop on|off
 

Arguments: 

ON | OFF 

Example: 

NAMESCTL> set save_config_on_stop on
 

SET SERVER 

Purpose: 

Sets the name of the Oracle Names server 

Prerequisites: 

The NAMESCTL utility must be loaded 

Password required if one has been set: 

No 

Syntax: 

From the NAMESCTL utility:

NAMESCTL> set server [onames_server]
[(description=](address=(protocol_address_information))[)] 

See Also: Appendix B, "Protocol Addresses" for further information about protocol addresses and parameters 

Arguments: 

Valid Oracle Names server or valid Oracle Names server address

If there are no arguments, use the values set by the NAMES.PREFERRED_SERVERS parameter in the sqlnet.ora file. 

Usage Notes: 

SET SERVER enables switching between multiple Oracle Names servers while running the NAMESCTL utility. The qualifier can be a name where the name is defined in the memory of the current Oracle Names server, or it can be the TNS address of any Oracle Names server.

The Oracle Names server name specified is resolved through normal name lookup. Another Oracle Names server can only be set if the current Oracle Names server knows or can retrieve its address. If no current Oracle Names server is set, you must enter an address to complete this command.  

Example: 

NAMESCTL> set server server1.us.acme
 

SET TRACE_FILE_NAME 

Purpose: 

Sets the name for the Oracle Names server's trace file. By default, the trace file name is names.trc

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL set trace_file_name file_name

From NAMESCTL utility:

NAMESCTL> set trace_file_name file_name
 

Arguments: 

file name 

Example: 

NAMESCTL> set trace_file_name namesvr1
 

SET TRACE_LEVEL 

Purpose: 

Sets tracing for the Oracle Names server at a specific level. 

Prerequisites: 

None 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

NAMESCTL set trace_level level

From the NAMESCTL utility:

NAMESCTL> set trace_level level
 

Arguments: 

Trace level:

  • OFF- No trace output

  • USER - User trace information

  • ADMIN - Administration trace information

  • SUPPORT - WorldWide Customer Support trace information

 

Usage Notes: 

Tracing assists in diagnosing unexpected or unidentifiable failures in processing the current Oracle Names server. Tracing writes a series of events from normal Oracle Names server processing to an operating system file for review by the administrator.

After the TRACE_LEVEL is set, tracing begins immediately. All operations are traced until it is reset to trace level OFF.

Trace files can grow very large. Remember to turn trace level off after diagnosing the problem.  

Example: 

NAMESCTL> set trace_level admin
Trace level is now 6. 
 

SHOW 

Purpose: 

Lists the available commands that can be shown for the current NAMESCTL session. In response to one of the SHOW commands, NAMESCTL displays the current setting for that parameter.

All of the SET commands listed except SET PASSWORD have equivalent SHOW commands.  

Prerequisites: 

None 

Syntax: 

From the operating system:

NAMESCTL show 
NAMESCTL show [command]

From the NAMESCTL utility:

NAMESCTL> show

NAMESCTL> show [command]
 

Arguments: 

NAMESCTL> show
The following operations are available after show

An asterisk (*) denotes a modifier or extended command:

cache_checkpoint_interval
default_domain
forwarding_available
log_file_name
log_stats_interval
NAMESCTL_trace_level
requests_enabled
reset_stats_interval
save_config_interval
save_config_on_stop
server
status
system_queries
trace_file_name
trace_level
version
 

Example: 

CMCTL> show trace_level
 

SHOW CACHE_CHECKPOINT INTERVAL 

Purpose: 

Shows the frequency with which the Oracle Names server's cache is written to the cache checkpoint file, which as a default of ckpcch.ora 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show cache_checkpoint_interval

From the NAMESCTL utility:

NAMESCTL> show cache_checkpoint_interval
 

Arguments: 

None 

Usage Notes: 

The CACHE_CHECKPOINT_INTERVAL is initially set with the value in NAMES.CACHE_CHECKPOINT_INTERVAL in the names.ora file. By default, the value is 0, which disables cache checkpointing. Data written to the cache checkpoint file includes net service names and addresses, and Oracle Names server addresses which were learned by the Oracle Names server as a result of forwarding a query to a foreign region on behalf of the client. 

Example: 

NAMESCTL> show cache_checkpoint_interval
Cache checkpoint interval is currently 8 minutes 20 seconds
 

SHOW DEFAULT_DOMAIN 

Purpose: 

Shows the domain set by the SET DEFAULT_DOMAIN or the NAMES.DEFAULT_DOMAIN in the sqlnet.ora file 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show default_domain

From the NAMESCTL utility:

NAMESCTL> show default_domain
 

Arguments: 

None 

Usage Notes: 

When a default domain is set, it is automatically appended to any unqualified net service name or service name. For example, if the default domain is set to us.acme, the global name sales.us.acme could be queried using:

NAMESCTL> query sales
 

Example: 

NAMESCTL> show default_domain
Current default domain is "com"
 

SHOW FORWARDING_AVAILABLE 

Purpose: 

Shows whether the Oracle Names server is forwarding client requests to remote Oracle Names servers 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show forwarding_available

From the NAMESCTL utility:

NAMESCTL> show forwarding_available
 

Arguments: 

Zero or more Oracle Names servers separated by a space. If no names are given, then the setting is displayed for the current server. 

Usage Notes: 

By default, all Oracle Names servers forward requests to remote Oracle Names servers. If forwarding is disabled, then requests to remote Oracle Names server will be redirected to an Oracle Names server in the region which is authoritative to the requested name.

Disabling forwarding can reduce the load on a particular Oracle Names server, but makes it impossible to direct clients to remote Oracle Names servers.

Use the SET FORWARDING_AVAILABLE command to turn forwarding on or off. 

Example: 

NAMESCTL> show forwarding_available
Request forwarding is currently enabled
 

SHOW LOG_FILE_NAME 

Purpose: 

Shows the name of the file where the Oracle Names server writes logging information 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show log_file_name

From the NAMESCTL utility:

NAMESCTL> show log_file_name
 

Arguments: 

None 

Usage Notes: 

The log file name is initially set with the value in NAMES.LOG_FILE in the names.ora file.The default file name is names.log

Example: 

NAMESCTL> show log_file_name
Log file name is currently 
/private/ora23/network/names.log
 

SHOW LOG_STATS_INTERVAL 

Purpose: 

Displays the frequency with which the statistics are logged to the log file 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show [onames_server] [onames_server]*
log_stats_interval

From NAMESCTL utility:

NAMESCTL> show [onames_server] [onames_server]*
log_stats_interval
 

Arguments: 

Zero or more Oracle Names servers separated by a space. If no names are given, then the setting is displayed for the current server. 

Usage Notes: 

The LOG_STATS_INTERVAL is initially set with the value in NAMES.LOG_STATS_INTERVAL in the names.ora file. By default, the value is 0, or no logging. 

Example: 

NAMESCTL> show log_stats_interval
Statistic counter logging is currently disabled
 

SHOW NAMESCTL_TRACE_LEVEL 

Purpose: 

Displays the level at which the NAMESCTL utility is being traced 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show NAMESCTL_trace_level

From the NAMESCTL utility:

NAMESCTL> show NAMESCTL_trace_level
 

Arguments: 

None 

Usage Notes: 

Tracing assists in diagnosing unexpected or unidentifiable failures in processing the NAMESCTL utility. Tracing writes a series of events from normal NAMESCTL processing to an operating system file for review by the administrator.

Tracing output is at three levels OFF (none), USER (basic information), or ADMIN (maximum amount of information).  

Example: 

NAMESCTL> show NAMESCTL_trace_level
Controller's trace level is currently 0
 

SHOW REQUESTS_ENABLED 

Purpose: 

Shows whether or not the Oracle Names server is responding to requests 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show [onames_server] [onames_server]*
requests_enabled

From the NAMESCTL utility:

NAMESCTL> show [onames_server] [onames_server]*
requests_enabled
 

Arguments: 

Zero or more Oracle Names servers separated by a space. If no names are given, then the setting is displayed for the current server. 

Usage Notes: 

If requests are disables, all requests to the Oracle Names server will be refused.  

Example: 

NAMESCTL> show requests_enabled
General request processing is currently enabled
 

SHOW RESETS_STATS_INTERVAL 

Purpose: 

Shows the interval set on how often the statistics are dumped to the log file 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show reset_stats_interval

From the NAMESCTL utility:

NAMESCTL> show reset_stats_interval
 

Usage Notes: 

If RESET_STATS_INTERVAL is initially set with the value in NAMES.RESET_STATS_INTERVAL. By default the value is set to 0, or no reset. This results in the Oracle Names server accumulating statistics the entire time it runs. For example, if statistics are reset every day, then the statistics will represent totals for the day rather than the entire time the server has been running. 

Example: 

NAMESCTL> show reset_stats_interval
Statistic counter reset interval is currently 5 minutes
 

SHOW SAVE_CONFIG_INTERVAL 

Purpose: 

Displays the interval in seconds that the SET command is scheduled to save to the names.ora file 

Prerequisites: 

The command only displays an interval if the SET SAVE_CONFIG_INTERVAL command was set. 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show save_config_interval

From NAMESCTL utility:

show save_config_interval
 

Example: 

NAMESCTL> set save_config_interval 10
 

SHOW SAVE_CONFIG_ON_STOP 

Purpose: 

Indicates whether NAMESCTL SET command is scheduled to save its changes to the names.ora file 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show save_config_on_stop

From the NAMESCTL utility:

NAMESCTL> show save_config_on_stop
 

Arguments: 

None 

Example: 

NAMESCTL> show save_config_on_stop
 

SHOW SERVER 

Purpose: 

Displays the current Oracle Names server name 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show server

From the NAMESCTL utility:

NAMESCTL> show server
 

Arguments: 

None 

Usage Notes: 

SHOW SERVER displays the current Oracle Names server that commands will operate on 

Example: 

NAMESCTL> show server
currently managing name server "NameServer.us.oracle.com
Version banner is "Oracle Names for SunOS: Version 8.1.6.0.0" 
 

SHOW STATUS 

Purpose: 

Displays the general status information about the Oracle Names server 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show [onames_server] [onames_server]*
status

From the NAMESCTL utility:

NAMESCTL> show [onames_server] [onames_server]*
status
 

Arguments: 

Zero or more Oracle Names servers separated by a space. If no names are given, then the setting is displayed for the current server. 

Usage Notes: 

Shows the current state of an Oracle Names server.

This command is identical to the STATUS command. 

Example: 

NAMESCTL> show status
Version Banner is "Oracle Names for SunOS: Version 8.1.6.0.0" 
Server has been running for:1 day 2 hours 3 minutes 35.16 
seconds....
 

SHOW SYSTEM_QUERIES 

Purpose: 

Displays the next occurrence of all system queries 

Prerequisites: 

This is only relevant for distributed configurations. There are no system queries with only one administrative region.  

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show system_queries

From the NAMESCTL utility:

NAMESCTL> show system_queries
 

Arguments: 

None 

Usage Notes: 

System queries are performed at intervals to keep information among Oracle Names servers current.

There is no specific action that can change the activities listed as system queries. Being able to show them gives the administrator an understanding of when a system change will occur, and can assist in a decision to RESTART.  

Example: 

NAMESCTL> show system_queries
System query index number:1
Query ID:49824
Query next issued in:2 hours 55 min 3.84 seconds
Query state:2
Name:""
Desired data type:ns.smd
 

SHOW TRACE_FILE_NAME 

Purpose: 

Displays the trace file name and path for the current Oracle Names server 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show trace_file_name

From the NAMESCTL utility:

NAMESCTL> show trace_file_name
 

Arguments: 

None 

Usage Notes: 

The trace file name is initially set with the value in the NAMES.TRACE_FILE in the names.ora file.The default value is names.trc. This file must be a valid file name, and the file must be writable to the Oracle Names server.  

Example: 

NAMESCTL> show trace_file_name
Trace file name is currently 
/private/ora23/network/names.trc
 

SHOW TRACE_LEVEL 

Purpose: 

Displays the trace level for tracing the current Oracle Names server 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show trace_level

From the NAMESCTL utility:

NAMESCTL> show trace_level
 

Arguments: 

None 

Usage Notes: 

Tracing assists in diagnosing unexpected or unidentifiable failures in processing the current Oracle Names server. Tracing writes a series of events from normal Oracle Names server processing to an operating system file for review by the administrator.

Tracing output is at three levels OFF (none), USER (basic information), or ADMIN (maximum amount of information).  

Example: 

NAMESCTL> show trace_level
Trace level is currently 0
 

SHOW VERSION 

Purpose: 

Displays the current version and name of the Oracle Names server 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL show [onames_server] [onames_server]*
version

From the NAMESCTL utility:

NAMESCTL> show [onames_server] [onames_server]*
version
 

Arguments: 

Zero or more Oracle Names servers separated by a space. If no names are given, then the setting is displayed for the current server. 

Usage Notes: 

This banner identifies the server by name and version. This can be useful when clearing up minor difficulties. This command is enabled every time you connect NAMESCTL to a server. 

Example: 

NAMESCTL> show version
Currently managing Oracle Names server "NameServer.com"
Version banner is "Oracle Names for SunOS: Version 8.1.6.0.0"
 

SHUTDOWN 

Purpose: 

Stops one or more Oracle Names servers. 

Prerequisites: 

The Oracle Names server(s) must be started. 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

NAMESCTL shutdown [onames_server] [onames_server]*

From the NAMESCTL utility:

NAMESCTL> shutdown [onames_server] [onames_server]*
 

Arguments: 

Zero or more Oracle Names server names separated by a space. When no arguments are supplied, only the current Oracle Names server is shut down. 

Usage Notes: 

SHUTDOWN stops the current Oracle Names server and unloads the program from memory. an Oracle Names server should only be shut down for operational reasons like upgrades or machine maintenance. The preferred way to stop and start an Oracle Names server is using the RESTART command because you can perform it from anywhere in the network. If SHUTDOWN and START are processed individually, they must occur on the Oracle Names server machine.

This command is identical to the STOP command. 

Example: 

NAMESCTL> shutdown
Confirm [yes or no] yes
Server shut down.
 

START 

Purpose: 

Loads the Oracle Names service program and starts loading system and local administrative region data 

Prerequisites: 

Oracle Names server must be stopped. 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL start  

From the NAMESCTL utility:

NAMESCTL> start
 

Arguments: 

None 

Usage Notes: 

START is the command used to initially load an Oracle Names server into memory. At startup, the Oracle Names server reads its configuration files to set up its operating parameters, then loads all data for the administrative region.

Security on Oracle Names server startup is supplied through the operating system Oracle Names is installed on. Because an Oracle Names server must be started from a local session, network security is not an issue.

This command is identical to the STARTUP command. 

Example: 

NAMESCTL> start
Starting "/private/dsteiner/sales/bin/names"...server 
successfully started

Currently managing name server "namesrv1.us.oracle.com"
Version banner is "Oracle Names for Solaris: Version 
8.1.6.0.0"

Server name:                              
namesrv1.us.oracle.com
Server has been running for:              0.16 seconds
Request processing enabled:               yes
Request forwarding enabled:               yes
Requests received:                        0
Requests forwarded:                       0
Foreign data items cached:                0
Region data next checked for reload in:   not set
Region data reload check failures:        0
Cache next checkpointed in:               not set
Cache checkpoint interval:                not set
Cache checkpoint file name:               
/private/dsteiner/sales/network/names/ckpcch.ora
Statistic counters next reset in:         not set
Statistic counter reset interval:         not set
Statistic counters next logged in:        not set
Statistic counter logging interval:       not set
Trace level:                              0
Trace file name:                          
/private/dsteiner/sales/network/trace/names_10841.trc
Log file name:                            
/private/dsteiner/sales/network/log/names.log
System parameter file name:               
/private/dsteiner/sales/network/admin/names.ora
Command-line parameter file name:         ""
Administrative region name:               ""
Administrative region description:        ""
ApplTable Index:                          0
Contact                                   ""
Operational Status                        0
Save Config on Stop                       yes
 

START_CLIENT_CACHE 

Purpose: 

Starts the client cache daemon process 

Prerequisites: 

The client cache daemon process must be stopped.

An Oracle Names server List must exist before you run the client cache daemon process. 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL start_client_cache 

From the NAMESCTL utility:

NAMESCTL> start_client_cache
 

Arguments: 

None 

Usage Notes: 

Once started, the client cache daemon process will store all information received from an Oracle Names server, making lookup faster. 

Example: 

NAMESCTL> start_client_cache
 

STARTUP 

Purpose: 

Loads the Oracle Names service program and starts loading system and local administrative region data 

Prerequisites: 

Oracle Names server must be stopped. 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL startup 

From the NAMESCTL utility:

NAMESCTL> startup 
 

Arguments: 

None 

Usage Notes: 

This command is identical to the START command. 

Example: 

See example for START. 

STATUS 

Purpose: 

Displays statistics for one or more Oracle Names servers as well as many of its internal settings 

Prerequisites: 

Oracle Names server must be started. 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL status [onames_server] [onames_server]*

From NAMESCTL utility:

NAMESCTL> status [onames_server] [onames_server]*
 

Arguments: 

Zero or more Oracle Names server names separated by a space. When no arguments are supplied, status is given only for the current Oracle Names server.  

Usage Notes: 

STATUS shows the activity of the Oracle Names server over time and its state at a point in time. 

Example: 

NAMESCTL> status
Version banner is "Oracle Names for SunOS: 
8.1.6.0.0"
Server name:NSERVER.com
Server has been running for:1 day 20 hours ........
 

STOP 

Purpose: 

Stops one or more Oracle Names servers 

Prerequisites: 

Oracle Names server must be started. 

Password required if one has been set: 

Yes

If a password is set, the SET PASSWORD command must be issued prior to this command. 

Syntax: 

From the operating system:

NAMESCTL stop  [onames_server] [onames_server]*

From the NAMESCTL utility:

NAMESCTL> stop  [onames_server] [onames_server]*
 

Arguments: 

Zero or more Oracle Names server names separated by a space. When no arguments are supplied, only the current Oracle Names server is stopped. 

Usage Notes: 

STOP stops the current Oracle Names server and unloads the program from memory. an Oracle Names server should only be shut down for operational reasons like upgrades or machine maintenance. The preferred way to stop and start an Oracle Names server is using the RESTART command because you can issue it from anywhere in the network. If STOP and START are processed individually, they must occur on the Oracle Names server machine.

This command is identical to the SHUTDOWN command.  

Example: 

NAMESCTL> stop
Confirm [yes or no]: yes
Server shut down
 

TIMED_QUERY 

Purpose: 

Show all data in the Oracle Names server cache 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL timed_query

From the NAMESCTL utility:

NAMESCTL> timed_query [time] 
 

Arguments: 

Time in seconds 

Usage Notes: 

TIMED_QUERY returns all data since time. The time argument returns all objects registered after a given time. To use the time argument, the first TIMED_QUERY dumps out all information available since startup. At the end of the first dump is a "last timestamp" number which gives a bookmark as to where the last dump of information ended. To see all logged data since that point, provide the "last timestamp" number in the time argument. 

UNREGISTER 

Purpose: 

Removes a network object from an Oracle Names server 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system

NAMESCTL unregister object_name  [-d
[(description=](address=(protocol_address_information))[)]] 
[-h hostname] [-l listener_name]

From the NAMESCTL utility:

NAMESCTL> unregister object_name [-d
[(description=](address=(protocol_address_information))[)]] 
[-l listener_name]

See Also: Appendix B, "Protocol Addresses" for further information about protocol addresses and parameters 

Arguments: 

Mandatory object name and the address, listener, or hostname that it was registered with. 

Usage Notes: 

Provides a manual mechanism for unregistering a service. The definition for that object is removed from the Oracle Names servers in the region. If the object was registered with an address, listener name, or a hostname, the address, listener name, or hostname must be provided on the command line in order to unregister the object. 

Example: 

NAMESCTL> unregister parts -t oracle_database -d 
(description= (address= (protocol=tcp)(host=nineva)(port=1575)) (connect_ data=(service_name=db3)))
 

VERSION 

Purpose: 

Displays the current version and name of the Oracle Names server 

Prerequisites: 

None 

Password required if one has been set: 

No 

Syntax: 

From the operating system:

NAMESCTL version

From the NAMESCTL utility:

NAMESCTL> version
 

Arguments: 

Zero or more Oracle Names servers separated by a space. If no names are given, then the setting is displayed for the current server 

Usage Notes: 

This banner identifies the server by name and version. This can be useful when clearing up minor difficulties. This command is enabled every time you connect NAMESCTL to a server. 

Example: 

NAMESCTL> version
Currently managing Oracle Names server "NameServer.com"
Version banner is "Oracle Names for SunOS: Version 8.1.6.0.0"
 

Oracle Connection Manager Control Utility (CMCTL)

The Oracle Connection Manager Control Utility (CMCTL) is a tool that you run from the operating system prompt to start and control Oracle Connection Manager. The general syntax of CMCTL is as follows:

CMCTL command [process_type]

process_type is the names of process that the command is being executed on. The choices are:

For example, to start both the gateway and administration processes, you would execute the following:

The CMCTL utility contains several types of commands:

SET and SHOW Commands

You can use the SET command to change some parameter values for an Oracle Connection Manager or the CMCTL environment during a CMCTL control utility session. These settings are only valid for the current CMCTL session. You cannot save parameter settings to the cman.ora file.

You can use the SHOW command to display the current value of a configuration setting.

Shutdown Commands

When shutting down Oracle Connection Manager, Oracle recommends using SHUTDOWN rather than STOP and STOPNOW. SHUTDOWN offers all the functionality of STOP and STOPNOW.

CMCTL Commands

The following commands are available through CMCTL:

ACCEPT_CONNECTIONS 

Purpose: 

Enables or disables Oracle Connection Manager to accept new connections 

Prerequisites: 

Oracle Connection Manager must be running. 

Syntax: 

From the operating system:

CMCTL accept_connections [argument]

From the CMCTL utility:

CMCTL> accept_connections [argument]
 

Arguments: 

ON (default) - Enables Oracle Connection Manager to accept new connections.

OFF - Rejects new connections to Oracle Connection Manager 

Usage Notes: 

If set to OFF, existing connections are not affected. 

Example: 

CMCTL> accept_connections off
Profile of the CMAN
-----------------------------------------
Current state             offline
 

CLOSE_RELAY 

Purpose: 

Enables a connection identified by relay number to be shut down

Note: Use the SHOW RELAY command to obtain the relay numbers for connections. 

Prerequisites: 

Oracle Connection Manager must be running. 

Syntax: 

From the operating system:

CMCTL close_relay [argument]

From the CMCTL utility:

CMCTL> close_relay [argument]
 

Arguments: 

relay_num - Specifies the relay number of the connection to terminate immediately.

ALL - Immediately terminates all connections 

Usage Notes: 

Use this command with caution. From the time the SHOW RELAY command is executed to the time this command is executed, the same relay may have been reused by another connection. 

Example: 

CMCTL> close_relay 0
Relay is not active

CMCTL> close_relay 0
The command completed successfully
 

EXIT 

Purpose: 

Exits the CMCTL utility program. 

Prerequisites: 

None 

Syntax: 

From the operating system:

CMCTL exit

From the CMCTL utility:

CMCTL> exit
 

Usage Notes: 

This command is identical to QUIT command. 

HELP 

Purpose: 

Provides a list of all the CMCTL commands available. In response to one of the HELP commands, CMCTL displays help on how to use the command.  

Prerequisites: 

None 

Syntax: 

From the operating system:

CMCTL help

CMCTL help [command]

From the CMCTL utility:

CMCTL> help

CMCTL> help [command]
 

Arguments: 

HELP command. Commands are shown in the following example output. 

Example: 

CMCTL> help
The following operations are available 
An asterisk (*) denotes a modifier or extended command: 
accept_connections     
close_relay 
exit 
quit   
set*   
show*             
shutdown               
start                 
stats                  
status                 
stop                   
stopnow                
version                
 

QUIT 

Purpose: 

Quits CMCTL, and returns you to the operating system prompt. 

Prerequisites: 

None 

Syntax: 

From the operating system:

CMCTL quit

From the CMCTL utility:

CMCTL> quit
 

Usage Notes: 

This command is identical to the EXIT command. 

SET 

Purpose: 

Lists the available configuration commands that can be set for the current CMCTL session. 

Prerequisites: 

None 

Syntax: 

From the operating system:

CMCTL set 
CMCTL set [command]

From the CMCTL utility:

CMCTL set 
CMCTL> set [command]
 

Arguments: 

SET commands. Commands are shown in the following example output. 

Example: 

CMCTL> set 
The following operations are available 
An asterisk (*) denotes a modifier or extended command: 
authentication_level
displaymode
log_level
relay_statistics
 

SET AUTHENTICATION_LEVEL 

Purpose: 

Sets the level of security for the Oracle Connection Manager 

Prerequisites: 

Oracle Connection Manager must be running. 

Syntax: 

From the operating system:

CMCTL set authentication_level level

From the CMCTL utility:

CMCTL> set authentication_level level
 

Arguments: 

Authentication level:

0 (default) - No authenticating is required for client connections.

1 - Rejects connections that are not employing Secure Network Service (SNS) to perform client authentication

Note: SNS is included with Oracle Advanced Security 

Example: 

CMCTL> authentication_level 0
Profile of the CMAN
-----------------------------------------
AUTHENTICATION_LEVEL   = 0
 

SET DISPLAYMODE 

Purpose: 

Changes the output of CMCTL START, CMCTL STATS, CMCTL STATUS, CMCTL STOP, CMCTL VERSION commands 

Prerequisites: 

None 

Syntax: 

From the operating system:

CMCTL set displaymode [argument]

From the CMCTL utility:

CMCTL> set displaymode [argument]
 

Arguments: 

COMPAT (default) - Displays output that is compatible with older versions of Oracle Connection Manager.

VERBOSE (recommended) - Displays a formatted and descriptive output.  

Example: 

CMCTL> set displaymode compat
Current display mode is COMPATible
 

SET LOG_LEVEL 

Purpose: 

Sets the log level for the Oracle Connection Manager 

Prerequisites: 

Oracle Connection Manager must be running. 

Syntax: 

From the operating system:

CMCTL set log_level [level]

From the CMCTL utility:

CMCTL> set log_level [level]
 

Arguments: 

0 through 4:

  • level 0 (default) - no logging

  • level 1 - basic reporting

  • level 2 - RULE_LIST matching lookup reporting

  • level 3 - relay blocking reporting

  • level 4 - relay I/O counts reporting

 

Example: 

CMCTL> set log_level 0

Profile of the CMAN
-----------------------------------------
LOG_LEVEL              = 0
 

SET RELAY_STATISTICS 

Purpose: 

Turns statistic collection pertaining to the I/O of connections of the Oracle Connection Manager on or off

When a relay closes and this command is set to ON, the following statistics are recorded in the appropriate LOG_RECORD of the cman_pid.log file on UNIX and cmanpid.log file on Windows NT:

  • Number of IN bytes

  • Number of OUT bytes

  • Number of IN packets

  • Number of OUT packets

 

Prerequisites: 

Oracle Connection Manager must be running. 

Syntax: 

From the operating system:

CMCTL set relay_statistics [argument]

From the CMCTL utility:

CMCTL> set relay_statistics [argument]
 

Arguments: 

ON

OFF (default) 

Example: 

CMCTL> set relay_statistics off

Profile of the CMAN
-----------------------------------------
RELAY_STATISTICS       = no
 

SHOW 

Purpose: 

Lists the available commands that can be shown for the current CMCTL session. In response to one of the SHOW commands, CMCTL displays the current setting for that parameter.  

Prerequisites: 

None 

Syntax: 

From the operating system:

CMCTL show 
CMCTL show [command]

From the LSNRCTL utility:

CMCTL> show

CMCTL> show [command]
 

Arguments: 

SHOW command. Commands are shown in the following example output. 

Example: 

CMCTL> show 
The following operations are available 
An asterisk (*) denotes a modifier or extended command: 
address
ALL
displaymode
profile
relay
rules
 

SHOW ADDRESS 

Purpose: 

Lists the listening protocol address of the Oracle Connection Manager 

Prerequisites: 

None 

Syntax: 

From the operating system:

CMCTL show address

From the CMCTL utility:

CMCTL> show address
 

Arguments: 

None 

Usage Notes: 

The address is set with the CMAN parameter in the cman.ora file.  

Example: 

CMCTL> show address

Address List
-----------------------------------------
(ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1594)(PORT=1630)(QUEUESIZE=3
2))
(ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1594)(PORT=1631)(QUEUESIZE=3
2))
 

SHOW ALL 

Purpose: 

Displays output for SHOW ADDRESS, SHOW PROFILE and SHOW RULES commands 

Prerequisites: 

None 

Syntax: 

From the operating system:

CMCTL show all

From the CMCTL utility:

CMCTL> show all
 

Arguments: 

None 

Example: 

CMCTL> show all
Address List
-----------------------------------------
(ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1594)(PORT=1630)(QUEUESIZE=3
2))
(ADDRESS=(PROTOCOL=tcp)(HOST=dlsun1594)(PORT=1631)(QUEUESIZE=3
2))

Profile of the CMAN
-----------------------------------------
MAXIMUM_RELAYS         = 2048
RELAY_STATISTICS       = yes
AUTHENTICATION_LEVEL   = 0
LOG_LEVEL              = 4
ANSWER_TIMEOUT         = 0
MAXIMUM_CONNECT_DATA   = 1024
USE_ASYNC_CALL         = yes
TRACING                = yes
TRACE_DIRECTORY        = default
MAX_FREELIST_BUFFERS   = 0
REMOTE_ADMIN           = no

Rule List
-----------------------------------------
(rule=(src=144.25.185.60)(dst=x)(srv=x)(act=accept))
(rule=(src=sguan-pc)(dst=x)(srv=x)(act=accept))
 

SHOW DISPLAYMODE 

Purpose: 

Shows the current display mode used for the CMCTL START, CMCTL STATS, CMCTL STATUS, CMCTL STOP, CMCTL VERSION commands

COMPAT (default) - Displays output that is compatible with older versions of Oracle Connection Manager.

VERBOSE - Displays a formatted and descriptive output. 

Syntax: 

From the operating system:

CMCTL show displaymode

From the CMCTL utility:

CMCTL> show displaymode
 

Example: 

CMCTL> show displaymode
Current display mode is VERBose
 

SHOW PROFILE 

Purpose: 

Lists the current parameter settings for the Oracle Connection Manager. Information is obtained from the CMAN_PROFILE parameters in the cman.ora file and any changes made with the CMCTL SET command. 

Syntax: 

From the operating system:

CMCTL show profile

From the CMCTL utility:

CMCTL> show profile
 

Example: 

CMCTL> show profile
Profile of the CMAN
-----------------------------------------
MAXIMUM_RELAYS         = 2048
RELAY_STATISTICS       = yes
AUTHENTICATION_LEVEL   = 0
LOG_LEVEL              = 4
SHOW_TNS_INFO          = yes
ANSWER_TIMEOUT         = 0
MAXIMUM_CONNECT_DATA   = 1024
USE_ASYNC_CALL         = yes
TRACING                = yes
TRACE_DIRECTORY        = default
MAX_FREELIST_BUFFERS   = 0
REMOTE_ADMIN           = no
 

SHOW RELAY 

Purpose: 

Displays the current status of a selected relay (connection) or all active relays for the Oracle Connection Manager 

Prerequisites: 

Oracle Connection Manager must be running. 

Syntax: 

From the operating system:

CMCTL show relay {argument}

From the CMCTL utility:

CMCTL> show relay {argument}
 

Arguments: 

relay_num - Shows the status information for a specific relay.

ACTIVE - Shows the list of active relays. 

Usage Notes: 

For active relays, only relay numbers are shown. For a given relay number, the following information is displayed:

  • Relay number

  • Source address (client-side endpoint)

  • Destination address (server-side endpoint)

  • Number of IN bytes

  • Number of IN packets

  • Number of IN DCD probes

  • Number of OUT bytes

  • Number of OUT packets

  • Number of OUT DCD probes

 

Example: 

CMCTL> show relay active

Active Relays
-----------------------------------------
0000 0001
CMCTL> show relay 0

Relay Information
-----------------------------------------
Relay number              0
Start-up time             22-JUL-1999 19:47:17
Src                       
(ADDRESS=(PROTOCOL=tcp)(HOST=144.25.185.60)(PORT=35279))
Dest                      
(ADDRESS=(PROTOCOL=tcp)(HOST=144.25.185.60)(PORT=1521))
Number of IN bytes        438
Number of IN packets      7
Number of IN DCD probes   0
Number of OUT bytes       364
Number of OUT packets     7
Number of OUT DCD probes  0
 

SHOW RULES 

Purpose: 

Lists the current Net8 access rules used by the Oracle Connection Manager. 

Prerequisites: 

Oracle Connection Manager must be running. 

Syntax: 

From the operating system:

CMCTL show rules

From the CMCTL utility:

CMCTL> show rules
 

Arguments: 

None 

Usage Notes: 

Rules are set with the CMAN_RULES parameter in the cman.ora file. 

Example: 

CMCTL> show rules

Rule List
-----------------------------------------
(rule=(src=144.25.185.60)(dst=x)(srv=x)(act=accept))
(rule=(src=sguan-pc)(dst=x)(srv=x)(act=accept))
 

SHUTDOWN 

Purpose: 

Shuts down the Oracle Connection Manager processes  

Prerequisites: 

None 

Syntax: 

From the operating system:

CMCTL shutdown [argument] [cman]

From the CMCTL utility:

CMCTL> shutdown [argument] [cman]
 

Arguments: 

NORMAL (default) - No new connections will be accepted and the Oracle Connection Manager terminates after all existing connections close.

ABORT - The Oracle Connection Manager shuts down immediately, closing down all open connections.

cman - Starts both CMGW and CMADMIN processes. NORMAN and ABORT use this argument. Therefore, it is not necessary to explicitly specify it. 

Example: 

CMCTL> shutdown

The command completed successfully

CMCTL> shutdown abort

The command completed successfully
 

START 

Purpose: 

Starts Oracle Connection Manager 

Prerequisites: 

Oracle Connection Manager using the same listening address must not be running. 

Syntax: 

From the operating system:

CMCTL start [process_type]

From the CMCTL utility:

CMCTL start [process_type]
 

Arguments: 

cman (default) - Starts both CMGW and CMADMIN processes.

cm - Starts the CMGW process. 

Usage Notes: 

The SET DISPLAYMODE command changes the format and the level of detail of the output. 

Example: 

COMPAT Mode:

CMCTL> start cman
ADMIN Status:
(STATUS=(VERSION=8.1.6.0.0)(STARTED=22-JUL-1999 
19:34:15)(STATE=RUNNING))
CMAN Status:
(STATUS=(VERSION=8.1.6.0.0)(STARTED=22-JUL-1999 
19:34:17)(STATE=running))

VERBOSE Mode:

CMCTL> start cman

Starting /vobs/oracle/bin/cmadmin: please wait...
STATUS of the cman_admin
-----------------------------------------
ADMIN Version             8.1.6.0.0
Start-up time             22-JUL-1999 19:40:00
Current state             RUNNING


Starting /vobs/oracle/bin/cmgw: please wait...
STATUS of the cman
-----------------------------------------
CMAN  Version             8.1.6.0.0
Start-up time             22-JUL-1999 19:40:02
Current state             running
 

STATS  

Purpose: 

Displays statistical information for the Oracle Connection Manager 

Prerequisites: 

Oracle Connection Manager must be running. 

Syntax: 

From the operating system:

CMCTL stats [process_type]

From the CMCTL utility:

CMCTL stats [process_type]
 

Arguments: 

cman (default) - Displays statistics for the CMGW process.

cm - Displays statistics for the CMGW process. 

Usage Notes: 

The following statistics are displayed:

  • TOTAL_RELAYS (COMPAT) | Total number of connections handled (VERBOSE)

    The total number of connections the Oracle Connection Manager has established since it started.

  • ACTIVE_DELAYS (COMPAT) | Number of currently active relays (VERBOSE)

    The number of currently active connections.

  • MOST_RELAYS (COMPAT) | Peak active relays (VERBOSE)

    The maximum number of concurrent connections the Oracle Connection Manager has ever held since it started.

  • OUT_OF_RELAY (COMPAT) | Total refusals due to max_relays exceeded (VERBOSE)

    The total number of connect request refusals due to out-of-relay since the Oracle Connection Manager started.

  • TOTAL_REFUSED (COMPAT) | Total number of connections refused (VERBOSE)

    The total number of connect request refusals since the Oracle Connection Manager started.

 

Usage Notes: 

The SET DISPLAYMODE command changes the format and the level of detail of the output. 

Example: 

COMPAT Mode:

CMCTL> stats
CMAN Status:
(STATISTICS=(TOTAL_RELAYS=0)(ACTIVE_RELAYS=0)(MOST_
RELAYS=0)(OUT_OF_RELAY=0)(TOTAL_REFUSED=0))

VERBOSE Mode:

CMCTL> stats

STATISTICS of CMAN
-----------------------------------------
Total number of connections handled               0
Number of currently active relays                 0
Peak active relays                                0
Total refusals due to max_relays exceeded         0
Total number of connections refused               0
 

STATUS  

Purpose: 

Displays basic status information, including version, start time and current statistics 

Prerequisites: 

None 

Syntax: 

From the operating system:

CMCTL status [process_type]

From the CMCTL utility:

CMCTL status [process_type]
 

Arguments: 

cman (default) - Display status information for both the CMGW and CMADMIN processes.

cm - Displays status information for the CMGW process. 

Usage Notes: 

The SET DISPLAYMODE command changes the format and the level of detail of the output. 

Example: 

COMPAT Mode:

CMCTL> status
CMAN Status:
(STATUS=(VERSION=8.1.6.0.0)(STARTED=22-JUL-1999 
19:34:17)(STATE=running))
ADMIN Status:
(STATUS=(VERSION=8.1.6.0.0)(STARTED=22-JUL-1999 
19:34:15)(STATE=RUNNING))

VERBOSE Mode:

CMCTL> status
STATUS of the cman
-----------------------------------------
CMAN  Version             8.1.6.0.0
Start-up time             22-JUL-1999 19:40:02
Current state             running

STATUS of the cman_admin
-----------------------------------------
ADMIN Version             8.1.6.0.0
Start-up time             22-JUL-1999 19:40:00
Current state             RUNNING
 

STOP 

Purpose: 

Shuts down Oracle Connection Manager immediately, prompting you if there are open connections 

Prerequisites: 

Oracle Connection Manager must be running. 

Syntax: 

From the operating system:

CMCTL stop [process_type]

From the CMCTL utility:

CMCTL stop [process_type]
 

Arguments: 

cman (default) - Stops both CMGW and CMADMIN processes.

cm - Stops both CMGW and CMADMIN processes. 

Usage Notes: 

Oracle recommends the SHUTDOWN command to this command.

If you issue a stop command while connections remain active, you will be prompted to confirm the stop.

The SET DISPLAYMODE command changes the format and the level of detail of the output. 

Example: 

COMPAT Mode:

CMCTL> stop
The command completed successfully.

VERBOSE Mode:

CMCTL> stop
 

STOPNOW 

Purpose: 

Shuts down Oracle Connection Manager immediately, closing down all open connections without warning 

Prerequisites: 

Oracle Connection Manager must be running. 

Syntax: 

From the operating system:

CMCTL stopnow

From the CMCTL utility:

CMCTL stopnow
 

Arguments: 

cman (default) - Stops both CMGW and CMADMIN processes.

cm - Stops both CMGW and CMADMIN processes. 

Usage Notes: 

Oracle recommends the SHUTDOWN command to this command. 

Example: 

CMCTL> stopnow
 

VERSION 

Purpose: 

Displays the current version and name of the CMCTL utility. 

Prerequisites: 

None 

Syntax: 

From the operating system:

CMCTL version

From the CMCTL utility:

CMCTL> version
 

Usage Notes: 

The SET DISPLAYMODE command changes the format of the output. 

Example: 

COMPAT Mode:

CMCTL> version
CMCTL Version             8.1.6.0.0

VERBOSE Mode:

CMCTL> version
CMCTL Version             8.1.6.0.0
CMAN  Version             8.1.6.0.0
 


Go to previous page Go to next page
Oracle
Copyright © 1996-2000, Oracle Corporation.

All Rights Reserved.

Library

Product

Contents

Index