stopNode command
The stopNode command reads the configuration file for the 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. For more information about where to run this command, see Using command-line tools.
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
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 <fileName>
- Specifies the location of the log file to which trace information is written. By default, the log file is named stopServer.log and is created in the logs directory of the profile for the node being stopped.
- -replacelog
- Replaces the log file instead of appending to the current log.
- -trace
- Generates trace information into a file for debugging purposes. The trace output is written to the was_jobname-jobuser-jobnum.log file which is located in the profile_root/logs directory.
- -timeout <seconds>
- Specifies the waiting time for the agent to shut down before timing
out and returning an error.Supported configurations: The timeout parameter is used to stop one server at a time. If you use the timeout parameter with the stopservers parameter, the timeout parameter value is ignored.
- -statusport <portNumber>
- An optional parameter that allows an administrator to set the port number for node agent status callback. The tool opens this port and waits for status callback from the node agent just before the node agent has completely stopped. If the parameter is not set, an unused port is automatically allocated.
- -stopservers [-saveNodeState]
- Stops all application servers on the node before stopping the
node agent.
Use the -saveNodeState option to save the server restart state so that you can start the application servers based on the previous state using the startNode command.
- -conntype <type>
- Specifies the Java Management Extensions (JMX) connector type to use for connecting to the deployment manager. Valid types are 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)