WebSphere Express Command Line Reference

Command Line Reference

startServer command

Syntax

The command syntax is as follows:

startServer <server> [options]where server is the name of the application server you want to start. This argument is required.

Parameters

The following options are available for the startServer command:

-nowait
Tells the startServer command not to wait for successful initialization of the launched server process.
-quiet
Suppresses the progress information that the startServer command prints in normal mode.
-logfile <fileName>
Specifies the location of the log file to which information is written.
-replacelog
Replaces the log file instead of appending to the current log.
-trace
Generates trace information to the log file for debugging purposes.
-timeout <seconds>
Specifies the waiting time before server initialization times out and returns an error.
-statusport <portNumber>
Specifies that an administrator can set the port number for server status callback.
-script [<script fileName>] -background
Generates a launch script with the startServer command instead of launching the server process directly. The launch script name is an optional argument. If you do not supply the launch script name, the default script file name is start_<server> based on the <server> name passed as the first argument to the startServer command. The -background parameter is an optional parameter that specifies that the generated script will run in the background when you execute it.

-J <java_option>
Specifies options to pass through to the Java interpreter.
-help
Prints a usage statement.
-?
Prints a usage statement.
Usage scenario

The following examples demonstrate correct syntax:

startServer server1

startServer server1 -script (produces the start_server1.sh or .bat files)

startServer server1 -trace (produces the startserver.log file)

stopServer command

The stopServer command reads the configuration file for the specified server process. This command sends a Java Management Extensions (JMX) command to the server telling it to shut down. By default, the stopServer command does not return control to the command line until the server completes the shut down process. There is a -nowait option to return immediately, as well as other options to control the behavior of the stopServer command. You can run this command from the install_root/bin directory of a WebSphere Application Server installation or a Network Deployment installation.

Syntax

The command syntax is as follows:

stopServer <server> [options]where server is the name of the configuration directory of the server you want to stop. This argument is required.

Parameters

The following options are available for the stopServer command:

-nowait
Tells the stopServer command not to wait for successful shutdown of the server process.
-quiet
Suppresses the progress information that the stopServer command prints in normal mode.
-logfile <fileName>
Specifies the location of the log file to which information is written.
-replacelog
Replaces the log file instead of appending to the current log.
-trace
Generates trace information into a file for debugging purposes.
-timeout <seconds>
Specifies the time to wait for server shutdown before timing out and returning an error.
-statusport <portNumber>
Supports an administrator in setting the port number for server status callback.
-conntype <type>
Specifies the Java Management Extensions (JMX) connector type to use for connecting to the deployment manager. Valid types are Simple Object Access Protocol (SOAP), or Remote Method Invocation (RMI).
-port <portNumber>
Specifies the server Java Management Extensions (JMX) port to use explicitly, so that you can avoid reading the configuration files to obtain the information.
-username <name>
Specifies the user name for authentication if security is enabled in the server. Acts the same as the -user option.
-user <name>
Specifies the user name for authentication if security is enabled in the server. Acts the same as the -username option.
-password <password>
Specifies the password for authentication if security is enabled in the server.
Note: If you are running in a secure environment but have not provided a user ID and password, you will receive the following error message:

ADMN0022E: Access denied for the stop operation on Server MBean due
to insufficient or empty credentials.To solve this problem, provide the user ID and password information.

-help
Prints a usage statement.
-?
Prints a usage statement.
Usage scenario

The following examples demonstrate correct syntax:

stopServer server1

stopServer server1 -nowait

stopServer server1 -trace (produces the stopserver.log file)

startManager command

The startManager command reads the configuration file for the Network Deployment manager process and constructs a launch command. Depending on the options you specify, the startManager command launches a new Java virtual machine (JVM) API to run the manager process, or writes the launch command data to a file. You must run this command from the install_root/bin directory of a Network Deployment installation.

Syntax

The command syntax is as follows:

startManager [options]
Parameters

The following options are available for the startManager command:

-nowait
Tells the startManager command not to wait for successful initialization of the deployment manager process.
-quiet
Suppresses the progress information that the startManager command prints in normal mode.
-logfile <fileName>
Specifies the location of the log file to which information gets written.
-replacelog
Replaces the log file instead of appending to the current log.
-trace
Generates trace information into a file using the startManager command for debugging purposes.
-timeout <seconds>
Specifies the waiting time before deployment manager initialization times out and returns an error.
-statusport <portNumber>
Specifies that an administrator can set the port number for deployment manager status callback.
-script [<script fileName>] -background
Generates a launch script with the startManager command instead of launching the deployment manager process directly. The launch script name is an optional argument. If you do not provide the launch script name, the default script file name is <start_dmgr>. The -background parameter is an optional parameter that specifies that the generated script will run in the background when you execute it.
-J-<java_option>
Specifies options to pass through to the Java interpreter.
-help
Prints a usage statement.
-?
Prints a usage statement.
Usage scenario

The following examples demonstrate correct syntax:

startManager

startManager -script (produces the start_dmgr.sh or .bat file)

startManager -trace (produces the startmanager.log file)

stopManager command

The stopManager command reads the configuration file for the Network Deployment manager process. It sends a Java Management Extensions (JMX) command to the manager telling it to shut down. By default, the stopManager command waits for the manager to complete the shutdown process before it returns control to the command line. There is a -nowait option to return immediately, as well as other options to control the behavior of the stopManager command. You must run this command from the install_root/bin directory of a Network Deployment installation.

Syntax

The command syntax is as follows:

stopManager [options]
Parameters

The following options are available for the stopManager command:

-nowait
Tells the stopManager command not to wait for successful shutdown of the deployment manager process.
-quiet
Suppresses the progress information that the stopManager command prints in normal mode.
-logfile <fileName>
Specifies the location of the log file to which information is written.
-replacelog
Replaces the log file instead of appending to the current log.
-trace
Generates trace information to a file for debugging purposes.
-timeout <seconds>
Specifies the waiting time for the manager to complete shutdown before timing out and returning an error.
-statusport <portNumber>
Specifies that an administrator can set the port number for server status callback.
-conntype <type>
Specifies the Java Management Extensions (JMX) connector type to use for connecting to the deployment manager. Valid types are Simple Object Access Protocol (SOAP) or Remote Method Invocation (RMI).
-port <portNumber>
Specifies the deployment manager JMX port to use explicitly, so that you can avoid reading the configuration files to obtain information.
-username <name>
Specifies the user name for authentication if security is enabled in the deployment manager. Acts the same as the -user option.
-user <name>
Specifies the user name for authentication if security is enabled in the deployment manager. Acts the same as the -username option.
-password <password>
Specifies the password for authentication if security is enabled in the deployment manager.
Note: If you are running in a secure environment but have not provided a user ID and password, you receive the following error message:

ADMN0022E: Access denied for the stop operation on Server MBean due
to insufficient or empty credentials.To solve this problem, provide the user ID and password information.

-help
Prints a usage statement.
-?
Prints a usage statement.
Usage scenario

The following examples demonstrate correct syntax:

stopManager

stopManager -nowait

stopManager -trace (produces the stopmanager.log file)

startNode command

The startNode command reads the configuration file for the node agent process and constructs a launch command. Depending on the options that you specify, the startNode command creates a new Java virtual machine (JVM) API to run the agent process, or writes the launch command data to a file. You must run this command from the install_root/bin directory of a WebSphere Application Server installation.

Syntax

The command syntax is as follows:

startNode [options]
Parameters

The following options are available for the startNode command:

-nowait
Tells the startNode command not to wait for successful initialization of the node agent process.
-quiet
Suppresses the progress information that the startNode command prints in normal mode.
-logfile <fileName>
Specifies the location of the log file to which information gets written.
-replacelog
Replaces the log file instead of appending to the current log.
-trace
Generates trace information into a file for debugging purposes.
-timeout <seconds>
Specifies the waiting time before node agent initialization times out and returns an error.
-statusport <portNumber>
Specifies that an administrator can set the port number for node agent status callback.
-script [<script fileName>] -background
Generates a launch script with the startNode command instead of launching the node agent process directly. The launch script name is an optional argument. If you do not provide the launch script name, the default script file name is start_<nodeName>, based on the name of the node. The -background parameter is an optional parameter that specifies that the generated script will run in the background when you execute it.
-J-<java_option>
Specifies options to pass through to the Java interpreter.
-help
Prints a usage statement.
-?
Prints a usage statement.
Usage scenario

The following examples demonstrate correct syntax:

startNode

startNode -script (produces the start_node.bat or .sh file)

startNode -trace (produces the startnode.log file)

stopNode command

stopNode command
The stopNode command reads the configuration file for the Network Deployment node agent process and sends a Java Management Extensions (JMX) command telling the node agent to shut down. By default, the stopNode command waits for the node agent to complete shutdown before it returns control to the command line. There is a -nowait option to return immediately, as well as other options to control the behavior of the stopNode command. You must run this command from the install_root/bin directory of a WebSphere Application Server installation.

If you stop the server before stopping the node agent using the stopserver -servers command, the server will not restart when you issue a startserver command.

Syntax

The command syntax is as follows:

stopNode [options]
Parameters

The following options are available for the stopNode command:

-nowait
Tells the stopNode command not to wait for successful shutdown of the node agent process.
-quiet
Suppresses the progress information that the stopNode command prints in normal mode.
-logfile <fileNname>
Specifies the location of the log file to which information gets written.
-replacelog
Replaces the log file instead of appending to the current log.
-trace
Generates trace information into a file for debugging purposes.
-timeout <seconds>
Specifies the waiting time for the agent to shut down before timing out and returning an error.
-statusport <portNumber>
Specifies that an administrator can set the port number for server status callback.
-stopservers
Stops all application servers on the node before stopping the node agent.
-conntype <type>
Specifies the Java Management Extensions (JMX) connector type to use for connecting to the deployment manager. Valid types are Simple Object Access Protocol (SOAP) or Remote Method Invocation (RMI).
-port <portNumber>
Specifies the node agent JMX port to use explicitly, so that you can avoid reading configuration files to obtain the information.
-username <name>
Specifies the user name for authentication if security is enabled in the node agent. Acts the same as the -user option.
-user <name>
Specifies the user name for authentication if security is enabled in the node agent. Acts the same as the -username option.
-password <password>
Specifies the password for authentication if security is enabled in the node agent.
Note: If you are running in a secure environment but have not provided a user ID and password, you receive the following error message:

ADMN0022E: Access denied for the stop operation on Server MBean due
to insufficient or empty credentials.To solve this problem, provide the user ID and password information.

-help
Prints a usage statement.
Note: When requesting help for the usage statement for the stopNode command, a reference to the stopServer command displays. All of the options displayed for this usage statement apply to the stopNode command.

-?
Prints a usage statement.
Note: When requesting help for the usage statement for the stopNode command, a reference to the stopServer command displays. All of the options displayed for this usage statement apply to the stopNode command.

Usage scenario

The following examples demonstrate correct syntax:

stopNode

stopNode -nowait

stopNode -trace (produces the stopnode.log file)

addNode command
serverStatus command
removeNode command
cleanupNode command
syncNode command
backupConfig command
restoreConfig command
EARExpander command
createmq command
deletemq command
GenPluginCfg command
wsinstance command