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