Try OpenEdge Now
skip to main content
Administration
Command and Utility Reference : NSMAN
 

NSMAN

Controls the operation of a configured NameServer. The utility allows you to start a NameServer, query its status, and shut down a NameServer.

Syntax

Operating system
Syntax
Windows
nsman {
{ -name nameserver
{ -kill | -start | -stop | -query | -listallprops }
[ -host host-name -user user-name| -user user-name]
[ -port port-number]
}| -help }
-name name-server
This parameter is required. It specifies the name of the NameServer.
-kill
Stops and removes the NameServer from memory, no matter what it is doing.
-start
Starts the NameServer.
-stop
Stops the NameServer.
-query
Queries the NameServer for its status.
-listallprops
Displays all active broker properties, including updated values for dynamic properties that have changed.
-host host-name
Specifies the name of the machine where the AdminServer is running. If a host name is not specified, it defaults to the local host name.
-user user-name
Specifies a user name and prompts for a password. A user name and password are required only when you use the -host parameter and specify a remote host name. If you specify a remote host name with the -host parameter but do not specify a user name with the -user parameter, you receive a prompt for a user name and password.
-port port-number
Specifies the port number of the machine where the AdminServer is running. If a port number is not specified, it defaults to 20931.
-help
Displays command-line help.

Notes

*A single NameServer can simultaneously support all of the AppServer, WebSpeed, and DataServer products.
*When you specify a user name with the -user parameter, Windows supports three different formats:
*A user name as a simple text string, such as mary, implies a local user whose user account is defined on the local server, which is the same machine that runs the AdminServer.
*A user name as an explicit local user name, in which the user account is defined on the same machine that runs the AdminServer, except the user name explicitly references the local machine domain, for example, .\mary.
*A user name as a user account on a specific NT domain. The general format is Domain\User, in which the User is a valid user account defined within the domain and the Domain is any valid NT Server, including the one where the AdminServer is running.

Example

The following table shows examples that use the NSMAN command. Assume the NameServer is NS1; the user name is tom; and the AdminServer is on the remote host finance on the port 9999.
Table 102. NSMAN command examples
Task
Command
Start a local NameServer
nsman -name NS1 -start
Start a remote NameServer1
nsman -name NS1 -host finance
-port 9999 -user tom -start
Query a local NameServer
nsman -name NS1 -query
Query a remote NameServer2
nsman -name NS1 -host finance
-port 9999 -user tom -query
Stop a local NameServer
nsman -name NS1 -stop
Stop a remote NameServer3
nsman -name NS1 -host finance
-port 9999 -user tom -stop

1 Prompts for a password.

2 Prompts for a password.

3 Prompts for a password.

For information on managing a NameServer using the NSMAN utility, see OpenEdge Getting Started: Installation and Configuration.