Oracle Names Administrator's Guide | Library |
Product |
Contents |
Index |
You can use the Oracle Names Control Utility to perform basic management functions on one or more Names Servers. By using this tool, you can execute such commands as STARTUP, SHUTDOWN, and STATUS. Additionally, you can view and change Names Server parameter settings such as RESET_STATS_INTERVAL and TRACE_LEVEL.
NAMESCTL>
NAMESCTL START
NAMESCTL STATUS CHEDDAR.ACME
NAMESCTL @file_name
NAMESCTL NAMESCTL.TRACE_LEVEL=ADMIN
would load NAMESCTL and turn on tracing to the ADMIN level, regardless of the currently configured value of NAMESCTL.TRACE_LEVEL.
NAMESCTL> SET SERVER DOLPHIN.WORLD
NAMESCTL> SET TRACE_LEVEL ADMIN
The first modifier sets the server on which subsequent commands will perform. The second modifier sets the server DOLPHIN.WORLD's trace level. All operations that you perform after the second command will be traced at the ADMIN level.
Most commands will accept the name of a Names Server as the last argument indicating which Names Server to perform the command against. If omitted, the current Names Server is used. For example:
SHOW SYSTEM_QUERIES DOLPHIN.ACME
will display the system queries on the Names Server DOLPHIN.ACME and when they will next occur.
To perform a series of commands against an individual Names Server, type
NAMESCTL> SET SERVER server_name
then perform the commands.
You MUST perform the STARTUP command on the Names Server machine itself, not from a remote location in the network. After a Names Server has started, you can then perform all other operations, including RESTART, remotely, subject to the security restrictions below.
If you do not enter anything in the Password field on the Names Server property sheet in the Oracle Network Manager, no password is required to control any Names Server function. This would be common for a test Names Server, or an evaluation of the Names product.
If you do supply a password on the Names Server property sheet in the Network Manager, you must also set the password property in the NAMESCTL program. If this is not done, the Names Server will not respond to some NAMESCTL commands.
Initially, the value for PASSWORD is set to the value specified for the NAMESCTL.SERVER_PASSWORD parameter in the SQLNET.ORA file on the node running NAMESCTL. This would commonly be the password of the first Names Server listed in the PREFERRED_SERVERS list. The current setting for PASSWORD must match the value entered through the Network Manager, or the value in the NAMES.PASSWORD parameter in the NAMES.ORA file on the current Names Server.
If you are concerned with the security implications of explicitly putting a Names Server password in the administrator's client SQLNET.ORA file, you can omit the parameter and always use the command:
SET PASSWORD
You will be prompted for the password. When passed over the network, the password is ALWAYS encrypted, regardless of how it is set in NAMESCTL.
confirm:[yes or no]
Type "yes" to execute the command; type "no" to cancel the command.
You can turn confirmation modeoff by using by setting the parameter
NAMESCTL.NOCONFIRM = TRUE
in the SQLNET.ORA file. Note that with this parameter set to OFF, all commands execute without asking for confirmation.
Exit the NAMESCTL utility.
FLUSH
Flush all foreign names from the cache.
FLUSH_NAME
Flush an individual name from the foreign data cache.
HELP
Get brief general or specific help on commands.
LOG_STATS
Log the current statistics to the log file.
PING
Test for the existence of a Names Server, and get the time it took for the Names Server to respond.
QUERY
Query for the existence or contents of a network object name.
QUIT
Quit the NAMESCTL utility.
REGISTER
Registers a network object to a Names Server
RELOAD
Reload the local region data into the cache.
REPEAT
Perform a query repeatedly for n iterations.
RESET_STATS
Reset the current Names Server's statistics to the same state as STARTUP.
RESTART
Restart the Names Server.
SET DEFAULT_DOMAIN
Set or change the default domain for the NAMESCTL client.
SET FORWARDING_ AVAILABLE
Turn on or off name request forwarding for a Names Server.
SET LOG_STATS_INTERVAL
Changes the frequency with which statistics are logged to the log file.
SET NAMESCTL_TRACE _LEVEL
Sets level at which NAMESCTL can be traced.
SET PASSWORD
Registers password for privileged Names Server operations such as RELOAD and STOP.
SET REQUESTS_ENABLED
Determine whether the current Names Server will respond to requests.
SET RESET_STATS_ INTERVAL
Change time between statistics being reset to zero or initial values in current Names Server.
SET SERVER
Change the current Names Server.
SET TRACE_LEVEL
Changes the trace level for tracing the current Names Server.
SHOW CACHE_CHECKPOINT_ INTERVAL
Shows the frequency with which the Names Server cache is written to the checkpoint file.
SHOW FORWARDING_ AVAILABLE
Shows whether Names Server is forwarding requests or redirecting them.
SHOW DEFAULT_DOMAIN
Display default domain of current Names Server.
SHOW LOG_FILE_NAME
Shows the name of the file which the Names Server writes the logging information.
SHOW LOG_STATS_INTERVAL
Displays the frequency with which statistics are logged to the logfile.
SHOW NAMESCTL_TRACE _LEVEL
Display the current trace level of the NAMESCTL program.
SHOW REQUESTS_ENABLED
Shows whether or not the Names Server is responding to requests.
SHOW RESET_STATS_ INTERVAL
Displays the frequency with which internal statistics are reset
SHOW SERVER
Displays name and version of current Names Server.
SHOW STATUS
Displays general status information about the Names Server.
SHOW SYSTEM_QUERIES
Displays information about system queries from the Names Server.
SHOW TRACE_FILE_ NAME
Shows the name of the file where the Names Server writes the trace information.
SHOW TRACE_LEVEL
Display trace level of current Names Server.
SHOW VERSION
Displays the version banner for the Names Server
SHUTDOWN or STOP
Stop the Names Server.
START or STARTUP
Start the Names Server.
STATUS
Display the status of the current Names Server.
STOP
Stops one or more Names Servers.
TIMED_QUERY
Show all registered data in the Names Server cache.
UNREGISTER
Removes a network object from a Names Server
VERSION
Displays the version banner for the Names Server.
The EXIT command closes the NAMESCTL program.
Prerequisites:
The NAMESCTL program must be loaded.
Password Required:
No.
Syntax:
From NAMESCTL program:
EXIT
Arguments:
None.
Usage Notes:
EXIT has no effect on any Names Servers. It affects only the NAMESCTL program.
The EXIT command is the same as the QUIT command.
Example:
NAMESCTL> EXIT
NAMESCTL finished.
Drop all stored non-authoritative data from the Names Server cache.
Prerequisites:
Only relevant with distributed administration. (In central administration there is no non-authoritative data.)
Password Required:
Yes.
Syntax:
From the operating system prompt:
NAMESCTL FLUSH [server] ...
From NAMESCTL program:
FLUSH [server] ...
Arguments:
Zero or more Server names separated by a space. When no arguments are supplied, only the current Names Server's cache is flushed of foreign names.
Usage Notes:
FLUSH erases all foreign data that has been cached. Typically, you should flush the foreign data cache when:
NAMESCTL>FLUSH
Confirm [yes or no]: yes
Drop one or more specific non-authoritative names from the current Names Server's cache.
Prerequisites:
Only meaningful with distributed administration. (In central administration, there is no non-authoritative data.)
Password Required:
Yes.
Syntax:
From the operating system prompt:
NAMESCTL FLUSH_NAME name
From NAMESCTL program:
FLUSH_NAME name
Arguments:
A single name.
Usage Notes:
FLUSH_NAME erases only data cached from outside the 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. (In other words, any non-authoritative names that have been cached along the original lookup route are flushed.)
Names are flushed from the current Names Server. The current Names Server is either the default preferred Names Server or the one set by using the SET SERVER command.
Example:
NAMESCTL>FLUSH_NAME MOUNTAIN.ACME.COM
Provides details of the NAMESCTL commands.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system prompt:
NAMESCTL HELP [command]
From NAMESCTL program:
HELP [command]
Arguments:
commands
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 quit reload
repeat* reset_stats restart set*
show* shutdown start startup
status stop version
NAMESCTL> HELP PING
Sends an echo request and displays the round trip time.
Logs the current set of Names Server statistics to the configured log file for that Names Server.
Prerequisites:
None.
Password Required:
Yes.
Syntax:
From the operating system prompt:
NAMESCTL LOG_STATS [server] ...
From NAMESCTL program:
LOG_STATS [server]
Arguments:
Zero or more Names Server names separated by a space. When no arguments are supplied, only the statistics for the current 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.
Contact the current Names Server, or named server(s), and display the request/response time.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system prompt:
NAMESCTL PING [server_name] ...
From NAMESCTL program:
PING [server_name] ...
Arguments:
Zero or more Names Server names separated by a space. When no arguments are supplied, only the current Names Server is pinged.
Usage Notes:
Ping serves two basic purposes:
NAMESCTL> ping NSERVER.world
Round trip time is 0.04 seconds
Test or retrieve the contents of a network object stored in the Names Server.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system prompt:
NAMESCTL QUERY object_name [object_type] [modifiers]
From NAMESCTL program:
QUERY name [type] [modifiers]
Valid types:
A.SMD
Network addresses, as with database service definitions.
CNAME.SMD
Alias name (sometimes referred to as "canonical name").
DL.RDBMS.OMD
Database link.
NS.SMD
Names Server addresses. System data used to communicate between 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 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 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 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 NAME.WORLD 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=
(COMMUNITY=tcp)(PROTOCOL=TCP)(Host=cowboy)
(Port=1522))(CONNECT_DATA=(SID=rodeo)))
The QUIT command quits the NAMESCTL program.
Prerequisites:
The NAMESCTL program must be loaded.
Password Required:
No.
Syntax:
From NAMESCTL program:
QUIT
Arguments:
None.
Usage Notes:
QUIT has no effect on any 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
To register a network object to a Names Server
Prerequisites:
None.
Password Required:
Syntax:
From the operating system prompt:
namesctl register object_name [-t type_of_service] [-d data] [-h hostname]
Or, from the NAMESCTL program:
register object_name [-t type_of_service] [-d data]
Arguments:
Mandatory object name. The service and data 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, 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 Names Servers in the region by the current well known Names Server.
Example:
NAMESCTL> register parts -t database -d (DESCRIPTION= (ADDRESS= (PROTOCOL=TCP)(HOST=nineva) (PORT=1387))(CONNECT_DATA=(SID=db3)))
Forces the server to check immediately for data changes in its administrative region, and if there are any, reloads all database service names, global database links, and aliases.
Prerequisites:
None.
Password Required:
Yes.
Syntax:
From the operating system prompt:
NAMESCTL RELOAD [servers] ...
From NAMESCTL program:
RELOAD [servers] ...
Arguments:
Zero or more Names Server names separated by a space. When no arguments are supplied, only the current Names Server is reloaded.
Usage Notes:
All Names Servers load their data directly from the Network Manager's network definition database. You do not need to distribute any configuration files.
In distributed administration, RELOAD affects only the data for the current administrative region. All foreign data in the cache is unchanged.
Example:
NAMESCTL>RELOAD
Server reloaded.
Used to perform QUERY multiple times to compute average return rates.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system prompt:
NAMESCTL REPEAT number QUERY <type>
From 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=
(COMMUNITY=tcp)(PROTOCOL=TCP)(Host=salmon)
(Port=1522))(CONNECT_DATA=(SID=otter)))
Reset the Names Server statistics to the original values of the Names Server at startup.
Prerequisites:
None.
Password Required:
Yes.
Syntax:
From the operating system prompt:
NAMESCTL RESET_STATS [server]
From NAMESCTL program:
RESET_STATS [server]
Arguments:
Zero or more Names Server names separated by a space. When no arguments are supplied, only the current 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.
Initiate a reset of a Names Server to its original state at startup.
Prerequisites:
None.
Password Required:
Yes.
Syntax:
From the operating system prompt:
NAMESCTL RESTART [server]
From NAMESCTL program:
RESTART [server]
Arguments:
Zero or more Names Server names separated by a space. When no arguments are supplied, only the current Names Server is restarted.
Usage Notes:
RESTART is the same as STARTUP except that the Names Server is already running.
Data is reloaded, statistics are reset, and all foreign data is flushed. Valid foreign cache data (that is, data with a TTL greater than 0) is retrieved from the checkpoint files. (The TTL value must be set to more than 0.)
Example:
NAMESCTL> RESTART
Confirm [yes or no]: yes
Server restarted.
Set or change the default domain for the NAMESCTL client.
Prerequisites:
The NAMESCTL program must be loaded.
Password Required:
No.
Syntax:
From NAMESCTL program:
SET DEFAULT_DOMAIN domain_name
Arguments:
one domain name
Usage Notes:
The existence of the DEFAULT_DOMAIN parameter allows names to be partially entered 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 file.
When no arguments are specified, the default is read and assigned from the client's SQLNET.ORA file.
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"
Turns on or off name request forwarding for a Names Server.
Prerequisites:
Names Server must be running.
Password Required:
Yes.
Syntax:
From the operating system:
NAMESCTL SET FORWARDING_AVAILABLE OFF
From NAMESCTL program:
SET FORWARDING_AVAILABLE OFF
Arguments:
Time is in one of the following formats:
[[ON | OFF] [YES|NO]]
Restrictions:
Default value: 0 (ON)
Usage Notes:
This setting is intended only for Names Servers that have no local clients and are exclusively handling requests from foreign Names Servers. This usually would only apply to 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 Names Server will cut its workload in half. Rather than forward the request and return the answer the Names Server simply tells the requestor the address of the 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 Names Server to the requesting Names Server.
WARNING: If FORWARDING_AVAILABLE is set to off, any clients who rely directly on that Names Server will be unable to resolve foreign names. Clients are not capable of redirecting their requests as Names Servers would. Their requests will fail at that point, even if other Names Servers are listed in the NAMES.PREFERRED_SERVERS configuration parameter.
Example:
NAMESCTL> SET FORWARDING_AVAILABLE OFF
Request processing is now disabled.
Changes the frequency with which the statistics are logged to the log file.
Prerequisites:
None.
Password Required:
Yes.
Syntax:
From the operating system:
NAMESCTL SET LOG_STATS_INTERVAL time
From NAMESCTL program:
SET LOG_STATS_INTERVAL time
Arguments:
Time is in one of the following formats:
<seconds>
[<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 (and not specify the number of days).
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 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
Sets the level at which the NAMESCTL program can be traced.
Prerequisites:
None.
Password Required:
Yes.
Syntax:
From the operating system:
NAMESCTL SET NAMESCTL_TRACE_LEVEL [OFF|user|admin]
From NAMESCTL program:
SET NAMESCTL_TRACE_LEVEL [OFF|user|admin]
Arguments:
OFF, USER, or ADMIN
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
Register the password for privileged Names Server operations such as RELOAD and STOP.
Prerequisites:
The NAMESCTL program must be loaded.
Password Required:
N/A
Syntax:
From NAMESCTL program:
SET PASSWORD [password]
Arguments:
Text string matching the value stored in the current Names Server parameter NAMES.PASSWORD.
Usage Notes:
SET PASSWORD does not change the Names Server's password. It simply sets a NAMESCTL environment variable that is compared to the value configured for the Names Server. If they match, operations requiring passwords are allowed.
Only "privileged" operations are affected, that is, operations that alter the functioning of the 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:
Determine whether the current Names Server will respond to requests.
Prerequisites:
None.
Password Required:
Yes.
Syntax:
From the operating system:
NAMESCTL REQUESTS_ENABLED [ON|OFF]
From NAMESCTL program:
SET REQUESTS_ENABLED [ON|OFF]
Arguments:
ON or 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 a Names Server is functioning unexpectedly.
Example:
NAMESCTL> SET REQUESTS_ENABLED OFF
Confirm [yes or no]: yes
General request processing is now disabled
Changes the time between the statistics being reset to zero or initial values in the current server.
Prerequisites:
None.
Password Required:
Yes.
Syntax:
From the operating system:
NAMESCTL SET RESET_STATS_INTERVAL time
From NAMESCTL program:
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 Names Server is loaded. This command is intended to override that value during Names Server operation.
If the Stats Log Interval parameter in Network Manager is set to 0 (or if LOG_STATS_INTERVAL is set to 0), statistics are never written to the log file; they are kept in memory, and can be displayed by using the SHOW LOG_STATS_INTERVAL command.
Example:
NAMESCTL> SET RESET_STATS_INTERVAL 1 DAY
Statistic counter reset interval is now 24 hours
Change the current Names Server.
Prerequisites:
The NAMESCTL program must be loaded.
Password Required:
No.
Syntax:
From NAMESCTL program:
SET SERVER [server_name or server_address]
Arguments:
valid server name or valid server address
Usage Notes:
SET SERVER allows switching between multiple Names Servers while running the NAMESCTL utility. The qualifier can be a name where the name is defined in the memory of the current Names Server, or it can be the TNS address of any Names Server.
The Names Server name specified is resolved through the current Names Server. Another Names Server can only be set if the current Names Server knows or can retrieve its address. If no current Names Server is set, you must type a TNS address to complete this command. IF there are no arguments, use NAMES.PREFERRED_SERVERS or try the well-known Names Server.
Example:
NAMESCTL> SET SERVER SERVER1.US.ACME
Changes the TRACE_LEVEL for tracing the current Names Server.
Prerequisites:
None.
Password Required:
Yes.
Syntax:
From the operating system:
NAMESCTL SET TRACE_LEVEL [OFF|user|admin]
From NAMESCTL program:
SET TRACE_LEVEL [OFF|user|admin]
Arguments:
One of OFF, USER, or ADMIN
Usage Notes:
Tracing assists in diagnosing unexpected or unidentifiable failures in processing the current Names Server. Tracing writes a series of events from normal 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).
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.
Shows the frequency with which the Names Server's cache is written to the checkpoint file.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system:
NAMESCTL SHOW CACHE_CHECKPOINT_INTERVAL
From NAMESCTL program:
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, which was entered using Network Manager. By default, the value is 0, whci disables cache_checkpoint. Data written to the cache checkpoint file includes service names and addresses, and Names Server addresses which werelearned by the 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
Shows whether the Names Server is forwarding requests for foreign names or redirecting them.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system:
NAMESCTL SHOW FORWARDING_AVAILABLE
From NAMESCTL program:
SHOW FORWARDING_AVAILABLE
Arguments:
Zero or more 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 Names Servers forward requests for foreign names. If forwarding is disabled, then requests for foreign names will be redirected to a 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 ohter Names Servers. See also SET FORWARDING_AVAILABLE.
Example:
NAMESCTL> SHOW FORWARDING_AVAILABLE
Request forwarding is currently enabled
Display the default domain for the NAMESCTL client.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system:
SHOW DEFAULT_DOMAIN
From NAMESCTL program:
SHOW DEFAULT_DOMAIN
Arguments:
None.
Usage Notes:
The existence of the DEFAULT_DOMAIN parameter allows names to be partially entered for names in that domain. For example, with DEFAULT_DOMAIN set to ACME.WORLD the global name WIDE.ACME.WORLD 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 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 "world"
Shows the name of the file where the Names Server writes the logging information.
Prerequisites:
None
Password Required:
No
Syntax:
From the operating system:
NAMESCTL SHOW LOG_FILE_NAME
From NAMESCTL program:
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, which is entered using the Network Manager. The default value is platform-specific, but is typically NAMES.LOG and is located in the network/log subdirectory during Oracle installation. This file must be writable to the Names Server.
Example:
NAMESCTL> SHOW LOG_FILE_NAME
Log file name is currently /private/ora23/network/names.log
Displays the frequency with which the statistics are logged to the logfile.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system:
NAMESCTL SHOW LOG_STATS_INTERVAL
From NAMESCTL program:
SHOW LOG_STATS_INTERVAL
Arguments:
Zero or more 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, which is entered using the Network Manager. By default, the value is 0, or no logging. If the value is specified from the Network Manager, or from NAMESCTL SET LOG_STATS_INTERVAL, the Names Server will write a set of internal statistics to its log file with the specified frquency.
Example:
NAMESCTL> SHOW LOG_STATS_INTERVAL
Statistic counter logging is currently disabled
Displays control of the level at which the NAMESCTL program is being traced.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system:
NAMESCTL SHOW NAMESCTL_TRACE_LEVEL
From NAMESCTL program:
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. Even if NAMES.NAMESCTL_TRACE_LEVEL is configured in the Network Manager or the SQLNET.ORA configuration file, a previous call from the NAMESCTL program may have overridden it.
Example:
NAMESCTL> SHOW NAMESCTL_TRACE_LEVEL
Controller's trace level is currently 0
Shows whether or not the Names Server is responding to requests.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system:
NAMESCTL SHOW REQUESTS_ENABLED
From NAMESCTL program:
SHOW REQUESTS_ENABLED
Arguments:
Zero or more 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 Names Server will be refused. This parameter is intended for diagnostic purposes only.
Example:
NAMESCTL> SHOW REQUESTS_ENABLED
General request processing is currently enabled.
Shows whether or not the Names Server is responding to requests.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system:
NAMESCTL SHOW RESET_STATS_INTERVAL
From NAMESCTL program:
SHOW RESET_STATS_INTERVAL
Arguments:
Zero or more Names Servers separated by a space. If no names are given, then the setting is displayed for the current server.
Usage Notes:
If RESET_STATS_INTERVAL is initially set with the value in NAMES.RESET_STATS_INTERVAL in the NAMES.ORA file using the Network Manager. By default the value is set to 0, or no reset. This results in the Names Server accumulating statistics the entire time it runs. For example, if statistics are reset every day, then the statisitcs will represent totals for the day rather than the entire time the server has been running.
Example:
NAMESCTL> SHOW RESET_STATS_INTERVAL
Resetting of statistic counters is currently disabled
Display the current Names Server.
Prerequisites:
None
Password Required:
No
Syntax:
From the operating system:
NAMESCTL SHOW SERVER
From NAMESCTL program:
SHOW SERVER
Arguments:
None.
Usage Notes:
SHOW SERVER displays the current 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 2.0.0.0"
Display the general status information about the Names Server.
Prerequisites:
None
Password Required:
No
Syntax:
From the operating system:
NAMESCTL SHOW STATUS
From NAMESCTL program:
SHOW STATUS
Arguments:
Zero or more 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 a Names Server. Identical to the command STATUS.
Example:
NAMESCTL> SHOW STATUS
Version Banner is "Oracle Names for SunOS: Version 2.0.0.0" Server has been running for: 1 day 2 hours 3 minutes 35.16 seconds ....
Display 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:
No.
Syntax:
From the operating system:
NAMESCTL SHOW SYSTEM_QUERIES
From NAMESCTL program:
SHOW SYSTEM_QUERIES
Arguments:
None.
Usage Notes:
System queries are performed at intervals to keep information among 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
Displays the TRACE_LEVEL for tracing the current Names Server.
Prerequisites:
None
Password Required:
No
Syntax:
From the operating system:
NAMESCTL SHOW TRACE_FILE_NAME
From NAMESCTL program:
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, using Network Manager. The default value is platform-specific, but is typically NAMES.TRC and is located in the network/trace subdirectory during the Oracle installation. This file must be a valid filename, and the file must be writable to the 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
Displays the TRACE_LEVEL for tracing the current Names Server.
Prerequisites:
None.
Password Required:
No.
Syntax:
From the operating system:
NAMESCTL SHOW TRACE_LEVEL
From NAMESCTL program:
SHOW TRACE_LEVEL
Arguments:
None.
Usage Notes:
Tracing assists in diagnosing unexpected or unidentifiable failures in processing the current Names Server. Tracing writes a series of events from normal 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 Network Manager or the SQLNET.ORA configuration file, a previous call from the NAMESCTL program may have overridden it.
Example:
NAMESCTL> SHOW TRACE_LEVEL
Trace level is currently 0
Displays the TRACE_LEVEL for tracing the current Names Server.
Prerequisites:
None
Password Required:
No
Syntax:
From the operating system:
NAMESCTL SHOW VERSION
From NAMESCTL program:
SHOW VERSION
Arguments:
Zero or more 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 Names Server "NameServer.world" Version banner is "Oracle Names for SunOS: Version 2.0.0.0.0"
Stops one or more Names Servers.
Prerequisites:
Names Server must be started.
Password Required:
Yes
Syntax:
From the operating system:
NAMESCTL SHUTDOWN [server]
From NAMESCTL program:
SHUTDOWN [server]
Arguments:
Zero or more Names Server names separated by a space. When no arguments are supplied, only the current Names Server is shut down.
Usage Notes:
SHUTDOWN stops the current Names Server and unloads the program from memory. A Names Server should only be shut down for operational reasons like upgrades or machine maintenance. The preferred way to stop and start a 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 Names Server machine.
SHUTDOWN is identical to STOP.
Example:
NAMESCTL> SHUTDOWN
Confirm [yes or no] yes
Server shut down.
Loads the Names service program and starts loading system and local administrative region data.
Prerequisites:
Names Server must be stopped.
Password Required:
No
Syntax:
From the operating system:
NAMESCTL START
From NAMESCTL program:
NAMESCTL> START names.parameter = value
Arguments:
None.
Usage Notes:
START is the command used to initially load a Names Server into memory. At startup, the Names Server reads its configuration files to set up its operating parameters, then loads all data for the administrative region.
Security on Names Server startup is supplied through the operating system Names is installed on. Because Names must be started from a local session, network security is not an issue. See the Oracle installation manual for your platform for more details.
START is identical to STARTUP.
Starting "/oracle/bin/names"...server successfully started
Currently managing name server "NSERVER.world"
Version banner is "Oracle Names for SunOS: Version 2.0.0.0.0"
Server name: NSERVER.world
Server has been running for: 0.86 seconds
Request processing enabled: yes
Request forwarding enabled: no
Requests received: 0
Requests forwarded: 0
Data items cached: 0
Region data next checked for reload: 3 hours 59 minutes 59.77 seconds
Region data reload check failures: 0
Cache next checkpointed in: not set
Cache checkpoint interval: not set
Cache checkpoint file name: /oracle/network/names/cch003f4.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: /oracle/network/trace/names.trc
Log file name: /oracle/network/log/names.log
System parameter file name: /oracle/network/admin/names.ora
Command-line parameter file name: ""
Administrative region name: LOCAL_REGION
Administrative region description: /netadmin/inttest2.net
Loads the Names service program and starts loading system and local administrative region data.
Prerequisites:
Server must be stopped.
Password Required:
No
Syntax:
From the operating system:
NAMESCTL STARTUP names.parameter = value
From NAMESCTL program:
NAMESCTL> START names.parameter = value
Arguments:
None
Usage Notes:
STARTUP is the command used to initially load a Names Server into memory. At startup, the Names Server reads its configuration files to set up its operating parameters, then loads all data for the administrative region.
Security on Names Server startup is supplied through the operating system Names is installed on. Because Names must be started from a local session, network security is not an issue. See the Oracle installation manual for your platform for more details.
STARTUP is identical to START.
NAMESCTL> START
Starting "/oracle/bin/names"...server successfully started
Currently managing name server "NSERVER.world"
Version banner is "Oracle Names for SunOS: Version 2.0.0.0.0"
Server name: NSERVER.world
Server has been running for: 0.86 seconds
Request processing enabled: yes
Request forwarding enabled: no
Requests received: 0
Requests forwarded: 0
Data items cached: 0
Region data next checked for reload: 3 hours 59 minutes 59.77 seconds
Region data reload check failures: 0
Cache next checkpointed in: not set
Cache checkpoint interval: not set
Cache checkpoint file name: /oracle/network/names/cch003f4.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: /oracle/network/trace/names.trc
Log file name: /oracle/network/log/names.log
System parameter file name: /oracle/network/admin/names.ora
Command-line parameter file name:""
Administrative region name: LOCAL_REGION
Administrative region description: /netadmin/inttest2.net
See STATUS for more information after you start the Names Server.
Displays statistics for one or more Names Servers as well as many of its internal settings.
Prerequisites:
Names Server must be started.
Password Required:
No.
Syntax:
From the operating system:
NAMESCTL STATUS [server]
From NAMESCTL program:
STATUS [server]
Arguments:
Zero or more Names Server names separated by a space. When no arguments are supplied, status is given only for the current Names Server.
Usage Notes:
STATUS shows the activity of the Names Server over time and its state at a point in time.
NAMESCTL> STATUS
Version banner is "Oracle Names for SunOS:
2.0.0.0.0"
Server name: NSERVER.world
Server has been running for: 1 day 20 hours
59 minutes
48.06 seconds
Request processing enabled: yes
Request forwarding enabled: no
Requests received: 16
Requests forwarded: 0
Data items cached: 0
Region data next checked for reload: 3 hours 59 minutes 35.61 seconds
Region data reload check failures: 0
Cache next checkpointed in: not set
Cache checkpoint interval: not set
Cache checkpoint file name: /oracle/network/names/cch003f4.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: 12
Trace file name: /oracle/network/trace/names.trc
Log file name: /oracle/network/log/names.log
System parameter file name: /oracle/network/admin/names.ora
Command-line parameter file name: ""
Administrative region name: LOCAL_REGION
Administrative region description: /netadmin/inttest2.net
Apple Table Index 0
Contact 0
Operational Status 0
Stops one or more Names Servers.
Prerequisites:
Names Server must be started.
Password Required:
Yes
Syntax:
From the operating system:
NAMESCTL STOP [server]
From NAMESCTL program:
STOP [server]
Arguments:
Zero or more Names Server names separated by a space. When no arguments are supplied, only the current Names Server is stopped.
Usage Notes:
STOP stops the current Names Server and unloads the program from memory. A Names Server should only be shut down for operational reasons like upgrades or machine maintenance. The preferred way to stop and start a 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 Names Server machine.
STOP is identical to SHUTDOWN.
Example:
NAMESCTL> STOP
Confirm [yes or no]: yes
Server shut down
Show all registered data in the Names Server cache.
Prerequisites:
None
Password Required:
No
Syntax:
From the operating system:
NAMESCTL TIMED_QUERY
From NAMESCTL program:
timed_query [time] (for release 2.3.2 and later)
Arguments:
None at this time.
Usage Notes:
With this release, the timed_query simply returns all objects that have been registered automatically by the listener or manually through NAMESCTL. Data which was loaded from a network definition (generated by Network Manager) is not included. The time argument is supported which will return all objects registered after a given time.
Example:
NAMESCTL> timed_query
Oracle Names Control for SVR4: Version 2.0.0.0.0 - Beta on 31-AUG-95 16:35:15 Copyright (c) Oracle Corporation 1993. All rights reserved. Currently managing name server "NS7D1AA9" Version banner is "Oracle Names for SVR4: Version 2.0.0.0.0" Total response time: 0.08 seconds Response status: normal, successful completion Name: [root] data type is "ns.smd" Syntax is DOMAIN: NS7D1AA9 Name: NS7D1AA9 data type is "a.smd" Syntax is ADDR: ...(ADDRESS=(PROTOCOL=tcp)(HOST=oranamesrvr1)(PORT=1575)) Name: listener1 data type is "a.smd" Syntax is ADDR: ...(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=ipc)(DEV=7)(KEY=blackwidow1.world))(ADDRESS=(PROTOCOL=tcp)(DEV=11)(HOST=139.185.22.22)(PORT=1520)))(CONNECT_DATA=(SID=reltest))) data type is "tos.npd.omd" Syntax is CTEXT: "listener" Name: r1.world data type is "a.smd" Syntax is ADDR: ...(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=ipc)(DEV=7)(KEY=blackwidow1.world))(ADDRESS=(PROTOCOL=tcp)(DEV=11)(HOST=139.185.22.22)(PORT=1520)))(CONNECT_DATA=(SID=reltest))) data type is "tos.npd.omd" Syntax is CTEXT: "database" Last timestamp: 12201913 This shows newly registered data since 12201913 NAMESCTL> TIMED_QUERY 12201913 Name: listener2 data type is "a.smd" Syntax is ADDR: ...(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=ipc)(DEV=7)(KEY=blackwidow1.world))(ADDRESS=(PROTOCOL=tcp)(DEV=11)(HOST=139.185.22.22)(PORT=1520)))(CONNECT_DATA=(SID=reltest))) data type is "tos.npd.omd" Syntax is CTEXT: "listener" Name: r1.world data type is "a.smd" Syntax is ADDR: ...(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=ipc)(DEV=7)(KEY=blackwidow1.world))(ADDRESS=(PROTOCOL=tcp)(DEV=11)(HOST=139.185.22.22)(PORT=1520)))(CONNECT_DATA=(SID=reltest))) data type is "tos.npd.omd" Syntax is CTEXT: "database" Last timestamp: 12211915
To remove a network object from a Names Server.
Prerequisites:
None
Password Required:
No
Syntax:
From the operating system:
NAMESCTL UNREGISTER OBJECT_NAME
From NAMESCTL program:
UNREGISTER OBJECT_NAME
Arguments:
Mandatory object name.
Usage Notes:
Provides a manual mechanism for unregistering a service. The definition for that object is removed from the well known Names Server and all other well known Names Servers in the region.
Example:
NAMESCTL> UNREGISTER PARTS
Displays the TRACE_LEVEL for tracing the current Names Server.
Prerequisites:
None
Password Required:
No
Syntax:
From the operating system:
NAMESCTL VERSION
From NAMESCTL program:
VERSION
Arguments:
Zero or more 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 Names Server "NameServer.world" Version banner is "Oracle Names for SunOS: Version 2.0.0.0.0"
Prev Next |
Copyright © 1996 Oracle Corporation. All Rights Reserved. |
Library |
Product |
Contents |
Index |