A
Control Utilities for the Listener, Oracle Names Server, and Oracle Connection Manager

Purpose:  

Allows you to dynamically change the encrypted password of a listener. This will not change unencrypted passwords already established in a listener configuration file. It only establishes a new password, or changes a password that has been encrypted in the listener configuration 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 program:

lsnrctl> change_password [listener name]

Arguments:  

[listener_name]

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

Purpose:  

Starts 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_start

From the LSNRCTL program:

lsnrctl> dbsnmp_start

Arguments:  

None  

Usage Notes:  

None  

Example:  

lsnrctl> dbsnmp_start

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 program:

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

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 program:

lsnrctl> dbsnmp_stop

Arguments:  

None  

Usage Notes:  

None  

Example:  

lsnrctl> dbsnmp_stop

Purpose:  

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

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 exit

From the LSNRCTL program:

lsnrctl> exit

Arguments:  

None  

Usage Notes:  

This command is identical to QUIT  

Example:  

lsnrctl> exit

Purpose:  

Provides a list of all the LSNRCTL commands available.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl help [command]

From the LSNRCTL program:

lsnrctl> help [command]

Arguments:  

help command  

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 

Purpose:  

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

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 quit

From the LSNRCTL program:

lsnrctl> quit

Arguments:  

None  

Usage Notes:  

This command is identical to EXIT  

Example:  

lsnrctl> quit

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 program:

lsnrctl> reload [listener name]

Arguments:  

listener name  

Usage Notes:  

If there are any passwords in the listener configuration file, you must use the SET PASSWORD command before you can use the RELOAD command.

You must set the password from within the LSNRCTL program; you cannot set it from the operating system command line. The method for setting the password depends on whether you are using the encrypted password feature. If you are not using an encrypted password, enter the password on the LSNRCTL command line.  

Example:  

lsnrctl> reload

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, a backup of LISTENER.ORA, 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 program:

lsnrctl> save_config [listener name]

Arguments:  

listener name  

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

Purpose:  

Provides detailed information about the services the listener listens for. For example, how many connections have been established, how many refused. It displays three different types of services (dedicated servers from LISTENER.ORA, dispatcher information, and prespawned shadows.)  

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 program:

lsnrctl> services [listener name]

Arguments:  

listener name  

Usage Notes:  

This is used by a database administrator to get information about the services of the listener.

The SET DISPLAY and SET RAWMODE commands change the format of the output.  

Example:  

lsnrctl> services listener name

The output of a LSNRCTL SERVICES command follows:

Connecting to (ADDRESS=(PROTOCOL=IPC)(KEY=EXTPROC0))
Services Summary...
  PLSExtProc            has 1 service handler(s)
    DEDICATED SERVER established:0 refused:0
      LOCAL SERVER
  db1           has 3 service handler(s)
    DEDICATED SERVER established:0 refused:0
      LOCAL SERVER
    DISPATCHER established:0 refused:0 current:0 max:254 
state:ready
      D000 <machine: dlsun1770, pid: 1289>
      
(ADDRESS=(PROTOCOL=tcp)(DEV=14)(HOST=144.25.17.193)(PORT=2222
))
    DISPATCHER established:0 refused:0 current:0 max:254 
state:ready
      D001 <machine: dlsun1770, pid: 1291>
      
(ADDRESS=(PROTOCOL=tcp)(DEV=14)(HOST=144.25.17.193)(PORT=2223
))
The command completed successfully

Purpose:  

Lists the parameter values that can be set using the SET 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 [command]

From the LSNRCTL program:

lsnrctl> set [command]

Arguments:  

set command  

Usage Notes:  

You must have set a valid password to be able to use this command if one is listed in the listener configuration parameter, PASSWORDS_listener_name.

If there are any passwords in the listener configuration file, you must use the SET PASSWORD command before you can use the SET command.

You must set the password from within the LSNRCTL program; you cannot set it from the operating system command line. The method for setting the password depends on whether you are using the encrypted password feature. If you are not using an encrypted password, enter the password on the LSNRCTL command line.  

Example:  

lsnrctl> set

The following operations are available after set.

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

Purpose:  

Determines the amount of time 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 program:

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

Purpose:  

Sets or shows parameters for multiple listeners.  

Prerequisites:  

You must enter SET CURRENT_LISTENER from within the LSNRCTL utility  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl set current_listener [listener name]

From the LSNRCTL program:

lsnrctl> set current_listener [listener name]

Arguments:  

listener name  

Default Argument  

LISTENER  

Usage Notes:  

If there is more than one listener on a node, any LSNRCTL command acts on the default listener (LISTENER) unless another listener has been set.

Any subsequent LSNRCTL commands within the same LSNRCTL session would then apply to the second listener, unless CURRENT_LISTENER were reset.

You can also display the current listener by using the LSNRCTL SHOW CURRENT_LISTENER command.

You must enter SET CURRENT_LISTENER from within the LSNRCTL utility. When you exit the utility, the setting will be lost.  

Example:  

lsnrctl> set current_listener [listener name]

Purpose:  

Changes the output of LSNRCTL SERVICE and LSNRCTL STATUS commands with additional information.  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl set displaymode argument

From the LSNRCTL program:

lsnrctl> set displaymode argument

Arguments:  

RAW (same as SET RAWMODE) | COMPAT (for older versions) | NORMAL | VERBOSE (for support)

Note: NORMAL and VERBOSE are not fully functional in this release  

Example:  

lsnrctl> set displaymode compat
lsnrctl> status
Connecting to (ADDRESS=(PROTOCOL=IPC)(KEY=EXTPROC0))
STATUS of the LISTENER
------------------------
Alias                     LISTENER
Version                   TNSLSNR for Solaris: Version 
8.1.5.0.0
Start Date                07-DEC-98 14:28:23
Uptime                    0 days 0 hr. 30 min. 16 sec
Trace Level               off
Security                  OFF
SNMP                      OFF
Listener Parameter File   
/private/dsteiner/installtest2/network/admin/listener.ora
Listener Log File         
/private/dsteiner/installtest2/network/log/listener.log
Services Summary...
PLSExtProc   has 1 service handler(s)
sales        has 3 service handler(s)
The command completed successfully

Purpose:  

Allows you to change the default directory where log files for the listener process are written.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl set log_directory [directory]

From the LSNRCTL program:

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

Purpose:  

Sets a non-default name for the log file.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl set log_file [file_name]

From the LSNRCTL program:

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

Purpose:  

Turns listener logging on or off.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl set set log_status [on | off]

From the LSNRCTL program:

lsnrctl> set set log_status [on | off]

Arguments:  

ON | OFF  

Example:  

lsnrctl> set log_status on

Purpose:  

Changes the password sent from the LSNRCTL utility to the listener process for authentication purposes only. To change the password on the listener itself, use the CHANGE_PASSWORD command.  

Syntax:  

From the operating system:

lsnrctl set password

From the LSNRCTL program:

lsnrctl> set password

The syntax for unencrypted passwords is:

set password password

Arguments:  

password  

Usage Notes:  

You may 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. The listener supports encrypted and unencrypted passwords.  

Example:  

lsnrctl> set password
enter listener password: password

Purpose:  

Changes the output of LSNRCTL SERVICE and LSNRCTL STATUS commands with additional information.  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl set rawmode argument

From the LSNRCTL program:

lsnrctl> set rawmode argument

Arguments:  

ON | OFF  

Example:  

lsnrctl> set rawmode on
lsnrctl> status
Connecting to (ADDRESS=(PROTOCOL=IPC)(KEY=EXTPROC0))
STATUS of the LISTENER
-----------------------------------------------
Alias             LISTENER
Version                TNSLSNR for Solaris: Version 8.1.5.0.0
Start Date        07-DEC-98 14:28:23
Uptime            0 days 0 hr. 9 min. 6 sec
Trace Level       off
Security          OFF
SNMP              OFF
Listener Parameter File   
/private/dsteiner/installtest2/network/admin/listener.ora
Listener Log File         
/private/dsteiner/installtest2/network/log/listener.log
Services Summary
(SERVICE=(SERVICE_NAME=PLSExtProc)(INSTANCE=(INSTANCE_
NAME=PLSExtProc)(NUM=1)(INSTANCE_CLASS=ORACLE)))
(SERVICE=(SERVICE_NAME=dlsun17)(INSTANCE=(INSTANCE_
NAME=db1)(NUM=3)(INSTANCE_CLASS=ORACLE)))
The command completed successfully

Purpose:  

Saves any changes made by the LSNRCTL SET command to the LISTENER.ORA if parameter is ON. The saving of all parameters occurs right before the listener 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.  

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 save_config_on_stop [on | off]

From the LSNRCTL program:

lsnrctl> set save_config_on_stop [on | off]

Arguments:  

ON | OFF  

Example:  

lsnrctl> set save_config_on_stop on

Purpose:  

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

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl set startup_waittime [time]

From the LSNRCTL program:

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  

Purpose:  

Allows you to change the default location where trace files for the listener process will be written.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl set trc_directory [directory]

From the LSNRCTL program:

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

Purpose:  

Sets a non-default name for the trace file  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl set trc_file [file_name]

From the LSNRCTL program:

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

Purpose:  

This command turns on tracing for the listener.  

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 program:

lsnrctl> set trc_level level

Arguments:  

OFF | USER | ADMIN | SUPPORT | 0 | 4 | 10 | 16

• OFF | 0 - No trace output

• USER | 4 - User trace information

• ADMIN | 10 - Administration trace information

• SUPPORT | 16 - WorldWide Customer Support trace information

Usage Notes:  

Selecting USER provides a limited level of tracing; ADMIN provides a more detailed trace. This command overrides the setting in the LISTENER.ORA file.

You must have set a valid password, if one is listed in the LISTENER.ORA file parameter PASSWORDS_listener_name to be able to use this command

This command is identical to TRACE.  

Example:  

lsnrctl> set trc_level admin

Purpose:  

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

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 use_plugandplay [on | off]

From the LSNRCTL program:

lsnrctl> set use_plugandplay [on | off]

Arguments:  

ON | OFF  

Example:  

lsnrctl> set use_plugandplay on

Purpose:  

All of the SET commands listed except SET PASSWORD have equivalent SHOW commands. In response to one of the SHOW commands, LSNRCTL displays the current setting of the listener for that parameter.  

Prerequisites:  

None  

Password required if one has been set:  

see equivalent SET commands  

Syntax:  

From the operating system:

lsnrctl show [listener_name] [command]

From the LSNRCTL program:

lsnrctl> show [listener_name] [command]

Arguments:  

listener name, show command  

Usage Notes:  

The SHOW parameter can be shown, but not set, through LSNRCTL:

show [listener name] snmp_visible

displays whether the listener is accessible to SNMP clients  

Example:  

lsnrctl> show

The following operations are available after 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

Purpose:  

Starts a program stored on the machine on which the listener runs, and which is listed with an alias in the LISTENER.ORA file.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl spawn [listener name] alias (arguments=arg1,arg2,)

From the LSNRCTL program:

lsnrctl> spawn [listener name] alias (arguments=arg1,arg2,)

Arguments:  

• listener name

• the alias of the program as listed in the listener configuration file

• the arguments sent to the program that is to be spawned

Example:  

lsnrctl> spawn nstest_alias (ARGUMENTS='')

Purpose:  

Starts the named listener.  

Prerequisites:  

Listener must be stopped  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl start [listener name] 

From the LSNRCTL program:

lsnrctl> start [listener name] 

Arguments:  

listener name

If no listener name is entered, LISTENER is started by default.  

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 program prompt, enter:

lsnrctl> start tcp_lsnr

Example:  

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

TNSLSNR for Solaris: Version 8.1.4.0.0 - Beta
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.4.0.0 - Beta
Start Date                08-JAN-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

Purpose:  

Displays basic information: version, start time, uptime, what LISTENER.ORA file is used, and whether tracing is turned on.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl status [listener name]

From the LSNRCTL program:

lsnrctl> status [listener name] 

Arguments:  

listener name  

Usage Notes:  

The status command allows you to perform the following:

• check the current setting of the logging and tracing options.

• the list of database SIDs available through this listener. These are defined in the SID mapping in LISTENER.ORA.

• whether a password is encrypted in LISTENER.ORA. (If you encrypt the listener password you can have only one password.)

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

• the address(es) the TNSLSNR is listening on

The SET DISPLAY and SET RAWMODE commands change the format of the output.  

Example:  

lsnrctl> status
STATUS of the LISTENER
-----------------------------------------------
Alias             LISTENER
Version                TNSLSNR for Solaris: Version 8.1.5.0.0
Start Date        07-DEC-98 14:28:23
Uptime            0 days 0 hr. 9 min. 6 sec
Trace Level       off
Security          OFF
SNMP              OFF
Listener Parameter File   
/private/dsteiner/installtest2/network/admin/listener.ora
Listener Log File         
/private/dsteiner/installtest2/network/log/listener.log
Services Summary...
  PLSExtProc    has 1 service handler(s)
  db1           has 3 service handler(s)
The command completed successfully

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 program:

lsnrctl> stop [listener name] 

Arguments:  

listener name  

Usage Notes:  

If you have configured passwords, you must use the SET PASSWORD command before you can use the STOP command.

You must set the password from within the LSNRCTL program; you cannot set it from the operating system command line. The method for setting the password depends on whether you are using the encrypted password feature. If you are not using an encrypted password, enter the password on the LSNRCTL command line.

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

Purpose:  

Turns on tracing for the listener.  

Prerequisites:  

valid password required  

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 off|user|admin|support [listener name] 

From the LSNRCTL program:

lsnrctl> trace off|user|admin|support  [listener name] 

Arguments:  

[OFF | USER | ADMIN | SUPPORT] [listener name]

• OFF- No trace output

• USER - User trace information

• ADMIN - Administration trace information

• SUPPORT - WorldWide Customer Support trace information

Usage Notes:  

USER provides a limited level of tracing. ADMIN provides a more detailed trace. This command overrides the setting in the LISTENER.ORA file.

This command has the same functionality as SET TRC_LEVEL.  

Example:  

lsnrctl> trace admin listener

Purpose:  

Displays the current TNS listener, and protocol version.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

lsnrctl version [listener name] 

From the LSNRCTL program:

lsnrctl> version [listener name] 

Arguments:  

listener name  

Example:  

lsnrctl> version listener1

Purpose:  

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

Prerequisites:  

none  

Password required if one has been set:  

No  

Syntax:  

From the operating system prompt:

namesctl delegate_domain domain_name onames_server 
[description=(address_list=](address= (protocol_address_information))[))]

From the NAMESCTL program:

delegate_domain domain_name onames_server 
[(description=address_list=] (address= (protocol_
address_information))[))]

Arguments:  

domain_name, onames_server and the address are mandatory. domain_name and onames_server must be legal domain names. The address must be a legal TNS address.  

Usage Notes:  

This command provides a dynamic way to subdivide the namespace.

The domain domain_name is defined with onames_server as the name of the Oracle Names server. onames_server is defined with its address.

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))

Purpose:  

If the Oracle Names server is not in the root region, identifies the location of an Oracle Names server in the root region.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

namesctl domain_hint domain_name onames_server 
[description=(address_list=(address= (protocol_address_information))))

From the NAMESCTL program:

domain_hint domain_name onames_server 
[description=(address_list=(address= (protocol_address_information))))

Arguments:  

domain_name, onames_server and the address are mandatory. domain_name and onames_server must be legal domain names. The address must be a legal TNS address.  

Usage Notes:  

This command provides a dynamic way to define the path to other regions in the namespace.

The domain domain_name is defined with onames_server as the name of its Oracle Names server. onames_server is defined with its address.

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 may 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))

Purpose:  

Writes the names and address of all address defined in the local region into the TNSNAMES.ORA file.

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

namesctl dump_tnsnames

From the NAMESCTL program:

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 will create or partially overwrite 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. And entries which are defined in the Oracle Names servers but not in the TNSNAMES.ORA will be added.  

Examples:  

namesctl> dump_tnsnames

Purpose:  

The EXIT command closes the NAMESCTL program.  

Prerequisites:  

The NAMESCTL program must be loaded.  

Password required if one has been set:  

No  

Syntax:  

From the NAMESCTL program: EXIT  

Arguments:  

None  

Usage Notes:  

EXIT has no effect on any Oracle Names servers.

It affects only the NAMESCTL program.

The EXIT command is identical to the QUIT command.  

Example:  

namsctl> exit
namesctl finished. 

Purpose:  

Drops all stored non-authoritative data from the Oracle Names server cache.  

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] ...

From the NAMESCTL program:

flush [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 foreign 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.  

Examples:  

namesctl>flush
Confirm [yes or no]: yes

Purpose:  

Drops one or more specific non-authoritative names from the current Oracle Names server's cache.  

Prerequisites:  

Only meaningful 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_name name

From the NAMESCTL program:

flush_name name

Arguments:  

A single 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.

FLUSH_NAME removes the name from the current foreign data cache as well as any other Servers between the current region and the authoritative region.

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

Purpose:  

Provides details of the NAMESCTL commands.  

Prerequisites:  

None.  

Password required if one has been set:  

No  

Syntax:  

From the operating system prompt:

namesctl help [command]

From the NAMESCTL program:

help [command]

Arguments:  

help command  

Usage Notes:  

Help provides brief reminders of the function of each command in NAMESCTL. When no arguments are supplied, help shows the list of valid commands.

When you supply an argument, a one line description of that command's function is displayed.  

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

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 file_name [file_name ] ...

From the NAMESCTL program:

load_tnsnames file_name [file_name ] ...

Arguments:  

One or more file names containing 'name = address' definitions in a TNSNAMES.ORA format.  

Usage Notes:  

This command would typically be used once when a site begins using Oracle Names after having used TNSNAMES.ORA files. It is an alternative to upgrading the database tables which were maintained by Oracle Network Manager. Run this command once per region. The names defined during this operation will be defined permanently and will be propagated from one 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 

Purpose:  

Logs the current set of statistics to the configured log file for that Oracle Names 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 prompt:

namesctl log_stats [onames_server] ...

From the NAMESCTL program:

log_stats [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_STATS_INTERVAL.  

Example:  

namesctl> log_stats
Statistics counters logged.

Purpose:  

Registers the password for privileged Oracle Names server operations, such as RELOAD and STOP.  

Prerequisites:  

The NAMESCTL program must be loaded.  

Password required if one has been set:  

N/A  

Syntax:  

From the NAMESCTL program:

password [password]

Arguments:  

Text string matching the value encrypted in the NAMES.PASSWORD parameter in NAMES.ORA.  

Usage Notes:  

PASSWORD does not change the Oracle Names server's password. 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: 

Purpose:  

Contacts the current Oracle Names server, or named server(s), and display the request/response time.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system prompt:

namesctl ping [onames_server] ...

From the NAMESCTL program:

ping [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

Purpose:  

Tests or 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 program:

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--Allows 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)))

Purpose:  

Quits the NAMESCTL program.  

Prerequisites:  

The NAMESCTL program must be loaded.  

Password required if one has been set:  

No  

Syntax:  

From the NAMESCTL program:

QUIT

Arguments:  

None  

Usage Notes:  

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

The QUIT command is functionally equivalent to the EXIT command.  

Example:  

namesctl> quit
nl-00851: namesctl finished

Purpose:  

Registers a network object to an Oracle Names server  

Password required if one has been set:  

No  

Syntax:  

From the NAMESCTL program:

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

TYPE OF SERVICE:

• ORACLE_DATABASE

• ORACLE_LISTENER

• ORACLE_NAMESERVER

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 may 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)))

Purpose:  

Forces the server to check immediately for data changes in its administrative region, and if there are any, 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] ...

From the NAMESCTL program:

reload [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.

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_list= (address= 
(protocol_address_information))))]

From the NAMESCTL program:

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

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 does the following;

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, tries locating a local Oracle Names server using TCP/IP on port 1575. It uses the address argument if it is present.

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))

Purpose:  

Used to perform 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 program:

repeat number query type 

where number is an integer and type is as shown in the QUERY command.  

Arguments:  

None  

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 program 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)))

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] ...

From the NAMESCTL program:

reset_stats [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.

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] ...

From the NAMESCTL program:

restart [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.

Purpose:  

Lists the parameter values that can be set using the SET 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:  

namesctl> set

Arguments:  

None  

Usage Notes:  

You must have set a valid password to be able to use this command if one is listed in the listener configuration parameter, PASSWORDS_listener_name.

If there are any passwords in the listener configuration file, you must use the SET PASSWORD command before you can use the SET command.

You must set the password from within the LSNRCTL program; you cannot set it from the operating system command line. The method for setting the password depends on whether you are using the encrypted password feature. If you are not using an encrypted password, enter the password on the LSNRCTL command line.  

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

Purpose:  

Sets how often all collected information about foreign regions is saved in the Oracle Names server cache file.  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

namesctl set cache_checkpoint_interval time

From NAMESCTL program:

set cache_checkpoint_interval time

Arguments:  

Time is in seconds

For example, to increase the CACHE_CHECKPOINT_INTERVAL to 36 hours, the following will work:

set cache_checkpoint_interval 129600

Usage Notes  

Minimum: 10 seconds

Maximum: 259200 (3 days)

Default: 0 (disabled)  

Example:  

namesctl> set cache_checkpoint_interval 10

Purpose:  

Sets or changes the default domain for the NAMESCTL client.  

Prerequisites:  

The NAMESCTL program must be loaded.  

Password required if one has been set:  

No  

Syntax:  

From the NAMESCTL program:

set default_domain domain_name

Arguments:  

one domain name  

Usage Notes:  

The existence of the DEFAULT_DOMAIN parameter allows names to be unqualified for names in that domain. For example, with DEFAULT_DOMAIN set to US.ACME the global name WIDE.US.ACME could be queried using:

namesctl> query wide

The initial value of DEFAULT_DOMAIN is set when the NAMESCTL program is started from the NAMES.DEFAULT_DOMAIN parameter in the SQLNET.ORA.

When no arguments are specified, the default is read and assigned from the SQLNET.ORA.

SET DEFAULT_DOMAIN could be used to simplify working on a set of names within a single domain, then a set in another.  

Example:  

namesctl> set default_domain us.acme
Default domain is now "US.ACME"

Purpose:  

Turns on or off name request forwarding for an Oracle Names server  

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 program:

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 foreign 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 a 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 foreign names. Clients are not capable of redirecting their requests as Oracle Names servers would. 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. 

Purpose:  

Changes the log file name.The default names 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 program:

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

Purpose:  

Changes the frequency with which the statistics are logged to the log 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:

namesctl set log_stats_interval time

From the NAMESCTL program:

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, either of the following will work:

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 the Oracle Network Manager, or the value in NAMES.LOG_STATS_INTERVAL 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

Purpose:  

Sets the level at which the NAMESCTL program 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 off|user|admin|support

From the NAMESCTL program:

namesctl> set namesctl_trace_level off|user|admin|support

Arguments:  

OFF | USER | ADMIN | SUPPORT  

Usage Notes:  

Tracing assists in diagnosing unexpected or unidentifiable failures in processing the NAMESCTL program. 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

Purpose:  

Register the password for privileged Oracle Names server operations such as RELOAD and STOP.  

Prerequisites:  

The NAMESCTL program must be loaded.  

Password required if one has been set:  

N/A  

Syntax:  

From the NAMESCTL program:

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: 

Purpose:  

Determine 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 program:

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 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

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 program:

namesctl> set reset_stats_interval time

Arguments:  

Time is in one of the following formats:

seconds

[n DAY[S]] [hh:mi:ss]

For example, to increase the RESET_STATS_INTERVAL to 72 hours, either of the following will work:

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

Purpose:  

Saves any changes made by the NAMESCTL SET command 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 program:

set save_config_interval time

Arguments:  

Time is in seconds  

Example:  

namesctl> set save_config_interval 10

Purpose:  

Saves any changes made by the NAMESCTL SET command to the NAMES.ORA if parameter is ON. The saving of all parameters occurs right before NAMESCTL 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 program:

namesctl> set save_config_on_stop on|off

Arguments:  

ON | OFF  

Example:  

namesctl> set save_config_on_stop on

Purpose:  

Change the current Oracle Names server.  

Prerequisites:  

The NAMESCTL program must be loaded  

Password required if one has been set:  

No  

Syntax:  

From the NAMESCTL program:

namesctl> set server [onames_server]
[description=(address_list= (address= (protocol_address_
information))))]

Arguments:  

valid Oracle Names server or valid Oracle Names server address  

Usage Notes:  

SET SERVER allows 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 type a TNS address to complete this command. IF there are no arguments, use NAMES.PREFERRED_SERVERS.  

Example:  

namesctl> set server server1.us.acme

Purpose:  

Changes the trace destination file name  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

namesctl set trace_file_name file_name

From NAMESCTL program:

namesctl> set trace_file_name file_name

Arguments:  

file name  

Example:  

namesctl> set trace_file_name namesvr1

Purpose:  

Changes the TRACE_LEVEL for tracing the current Oracle Names 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 trace_level off|user|admin|support

From the NAMESCTL program:

namesctl> set trace_level off|user|admin|support 

Arguments:  

OFF | USER | ADMIN | SUPPORT

• 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.

Tracing output is at three levels OFF (none), USER (basic information), ADMIN (information required for administrator), or SUPPORT (information required for customer support).

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. 

Purpose:  

Shows the frequency with which the Oracle Names server's cache is written to the checkpoint file.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

namesctl show cache_checkpoint_interval

From the NAMESCTL program:

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_checkpoint. 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

Purpose:  

Shows whether the Oracle Names server is forwarding requests for foreign names or redirecting them.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

namesctl show forwarding_available

From the NAMESCTL program:

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 for foreign names. If forwarding is disabled, then requests for foreign names 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 server, and will also make it impossible for direct clients of that server to resolve foreign names. Clients cannot be redirected, only other Oracle Names servers. See also SET FORWARDING_AVAILABLE.  

Example:  

namesctl> show forwarding_available
Request forwarding is currently enabled

Purpose:  

Displays the default domain for the NAMESCTL client.  

Prerequisites:  

None  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

namesctl show default_domain

From the NAMESCTL program:

namesctl> show default_domain

Arguments:  

None  

Usage Notes:  

The existence of the DEFAULT_DOMAIN parameter allows names to be unqualified for names in that domain. For example, with DEFAULT_DOMAIN set to ACME.COM, the global name WIDE.ACME.COM could be queried using:

namesctl> query wide
Total response time:   0.20 seconds
Response status: normal, successful completion
Authoritative answer:  yes
Number of answers:     0
TTL:                   1 day

The initial value of DEFAULT_DOMAIN is set when the NAMESCTL program is started from the NAMES.DEFAULT_DOMAIN parameter in the SQLNET.ORA file.

SHOW DEFAULT_DOMAIN is used when the user is unsure of the current default domain, or wants to know the default for the current configuration.  

Example:  

namesctl> show default_domain
Current default domain is "com"

Purpose:  

Shows the name of the file where the Oracle Names server writes the 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 program:

namesctl> show log_file_name

Arguments:  

None  

Usage Notes:  

The LOG_FILE_NAME is initially set with the value in NAMES.LOG_FILE_NAME in the NAMES.ORA file.The default value is NAMES.LOG and is located in the $ORACLE_HOME/network/trace on UNIX and ORACLE_HOME\network\trace on Windows NT.This file must be writable to the Oracle Names server.  

Example:  

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

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] ...
log_stats_interval

From NAMESCTL program:

namesctl> show [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

Purpose:  

Displays control of the level at which the NAMESCTL program 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 program:

namesctl> show namesctl_trace_level

Arguments:  

None  

Usage Notes:  

Tracing assists in diagnosing unexpected or unidentifiable failures in processing the NAMESCTL program. 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).

SHOW NAMESCTL_TRACE_LEVEL is the only guaranteed source of what the current tracing level is.  

Example:  

namesctl> show namesctl_trace_level
Controller's trace level is currently 0

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] ...
requests_enabled

From the NAMESCTL program:

namesctl> show [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_ENABLED is off, all requests to the Oracle Names server will be refused. This parameter is intended for diagnostic purposes only.  

Example:  

namesctl> show requests_enabled
General request processing is currently enabled

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 program:

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

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 program:

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.5.0.0" 

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] ...
status

From the NAMESCTL program:

namesctl> show [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.

Identical to the command STATUS.  

Example:  

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

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 program:

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 may assist in a decision to RESTART, thus forcing system data to be reloaded sooner.  

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

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 program:

namesctl> show trace_file_name

Arguments:  

None  

Usage Notes:  

The TRACE_FILE_NAME is initially set with the value in the NAMES.TRACE_FILE_NAME in the NAMES.ORA file.The default value is NAMES.TRC and is located in the $ORACLE_HOME/network/trace on UNIX and ORACLE_HOME\network\trace on Windows NT. This file must be a valid file name, and the file must be writable to the Oracle Names server.

This file is only used if tracing is enabled using the NAMES.TRACE_LEVEL.  

Example:  

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

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 program:

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).

SHOW TRACE_LEVEL is the only guaranteed source of what the current tracing level is. Even if the TRACE_LEVEL is configured in the Oracle Names server configuration file, a previous call from the NAMESCTL program may have overridden it.  

Example:  

namesctl> show trace_level
Trace level is currently 0

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] ...
version

From the NAMESCTL program:

namesctl> show [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.5.0.0"

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 shutdown [onames_server] ...

From the NAMESCTL program:

namesctl> shutdown [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.

SHUTDOWN is identical to STOP.  

Example:  

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

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 program:

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.

START is identical to STARTUP.  

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.5.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

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 program:

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

Purpose:  

This command is identical to START  

Prerequisites:  

Oracle Names server must be stopped.  

Password required if one has been set:  

No  

Syntax:  

From the operating system:

namesctl startup names.parameter = value

From the NAMESCTL program:

namesctl> start names.parameter = value

Arguments:  

None  

Usage Notes:  

STARTUP is identical to START.  

Example:  

See example for START.  

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] ...

From NAMESCTL program:

namesctl> status [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.5.0.0"
Server name:NSERVER.com
Server has been running for:1 day 20 hours ........

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] ...

From the NAMESCTL program:

namesctl> stop  [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.

STOP is identical to SHUTDOWN.  

Example:  

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

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 program:

namesctl> timed_query [time] 

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.  

Purpose:  

To remove 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_list= (address= (protocol_address_
information)))) [-h hostname] [-l listener_name]

From the NAMESCTL program:

namesctl> unregister object_name (-d address_data) [-h 
hostname] [-l listener_name]

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)))

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 program:

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.5.0.0"

Purpose:  

To exit out of the CMCTL utility program.  

Prerequisites:  

None  

Example:  

cmctl> exit

Purpose:  

To start Oracle Connection Manager.  

Prerequisites:  

Oracle Connection Manager must not be running.  

Arguments:  

cman - start both the CMGW and CMADMIN processes (default)

cm - start only the CMGW process

adm - start only the CMADMIN process  

Example:  

cmctl> start cm

Purpose:  

To display basic statistical information including total relays, active relays, most relays out of total, total refused.  

Prerequisites:  

None  

Arguments:  

cman - display statistics for both the CMGW and CMADMIN processes (default)

cm - display statistics for the CMGW process

adm - display statistics for the CMADMIN process  

Example:  

cmctl> stats
(statistics=(total_relays=8)(active_delays=4)(most_
relays=6)(out_of_relay=5)(total_refused=5)

• TOTAL_RELAYS: the total number of connections the Oracle Connection Manager has established since it started

• ACTIVE_DELAYS: the number of currently active connections

• MOST_RELAYS: the maximum number of concurrent connections the Oracle Connection Manager has ever held since it started

• OUT_OF_RELAY: the total number of connect request refusals due to out-of-relay since the Oracle Connection Manager started

• TOTAL_REFUSED: the total number of connect request refusals since the Oracle Connection Manager started

Purpose:  

To display basic information: version, start time, uptime.  

Prerequisites:  

None  

Arguments:  

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

cm - display status information the CMGW process

adm - display status information for the CMADMIN process  

Example:  

cmctl> status
CMAN status:
status=(version=8.1.5.0.0)(started=01-DEC-98 
11:41:33)(state-running)
ADMIN status:
status=(version=8.1.5.0.0)(started=01-DEC-98 
11:41:29)(state-running)

Purpose:  

To stop Oracle Connection Manager processes in interactive mode.  

Prerequisites:  

Oracle Connection Manager must be running.  

Arguments:  

cman - stop both the CMGW and CMADMIN processes (default)

cm - stop only the CMGW process

adm - stop only the CMADMIN process  

Usage Notes:  

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

Example:  

cmctl> stop cm

Purpose:  

To stop all Oracle Connection Manager processes. If processes are running, no prompt will confirm termination.  

Prerequisites:  

Oracle Connection Manager must be running.  

Arguments:  

None  

Example:  

cmctl> stop now