The stopNode script

The stopNode script reads the configuration file for the network deployment node agent process. It sends a Java Management Extensions (JMX) command to the node agent that tells the node agent to shut down

Product

The stopNode script is available in the WebSphere Application Server product only.

Authority

To run this script, your user profile must have *ALLOBJ authority. For information on setting explicit authorities for a user profile that does not have *ALLOBJ authority, see Set explicit authorities for the startServer and stopServer scripts.

Syntax

The syntax of the stopNode script is:

stopNode [ -instance instance ] [ -nowait ] [ -quiet ] [ -logfile filename ]
  [ -replacelog ] [ -trace ] [ -timeout seconds ] [ -statusport statusportnumber ]
  [ -port portnumber ] [ -username username ] [ -password password ]
  [ -conntype type ] [ -stopservers ] [ -help | -? ]

Parameters

The parameters of the stopNode script are:

• -instance
  Optional. The value instance specifies the name of the instance for which you want to stop the node agent. The default value is default.

• -nowait
  Optional. If you specify this parameter, the script returns control to the user without waiting for the node agent to stop successfully. The default is to wait for the node agent to stop successfully.

• -quiet
  Optional. If you specify this parameter, the script does not display informational messages. The default is to display informational messages while the script runs.

• -logfile
  Optional. The value filename specifies the location and name of the log file for the script. The default value is /QIBM/UserData/WebAS5/Base/instance/logs/nodeagent/stopServer.log where instance is the name of the instance for which you want to stop the node agent.

• -replacelog
  Optional. If you specify this parameter, the script replaces the log file if it exists. By default the script appends to the log file if it exists.

• -trace
  Optional. If you specify this parameter, the script outputs additional trace information to the log file for the script. You should only specify this parameter if errors occur when you try to stop a node agent. The default is to not log additional trace information.

• -timeout
  Optional. The value seconds specifies the amount of time in seconds to wait for the node agent to stop before returning control to the caller. The default is to wait until the node agent has stopped successfully.

• -statusport
  Optional. The value statusportnumber specifies the port on which to listen for the status of the node agent while it is stopping. The default is to use the next available port.

• -port
  Optional. The value portnumber specifies the SOAP or RMI port for the node agent. If you specify this parameter, the stopNode script sends the stop command directly to node agent. If you specify the RMI port value for this parameter, specify the -conntype parameter. By default, the script reads the configuration files to obtain the information that is necessary to stop the node agent.

• -conntype
  Optional. If you specify the -port parameter, the -conntype parameter specifies the connector type to use. Valid values are SOAP or RMI. The default value is SOAP.

• -username
  This parameter is required if security is enabled for the server. The value username specifies the user name for authentication.

• -password
  This parameter is required if security is enabled for the server. The value password specifies the password for authentication.

  Note: If you are running in a secure environment but do not provide a user ID and password, this error message is displayed:

  ADMN0022E: Access denied for the stop operation on Server MBean due
    to insufficient or empty credentials.

  Run the command again with the -username and -password parameters.

• -stopservers
  This parameter is supported in versions 5.0.2 and later. Optional. If you specify this parameter, the script stops all of the application servers that are running on the node.

• -help or -?
  This optional paramter prints the usage statement for the script.

  Note: When you request help for the stopNode script, a reference to the stopServer script is displayed. All of the options displayed for the stopServer script also apply to the stopNode script.

Examples

These examples demonstrate correct syntax:

stopNode

This example stops the node agent for the default instance.

stopNode -instance myNode -nowait

This example stops the node agent associated with the myNode instance and returns control to the user without waiting for the node agent process to stop completely.

stopNode -instance myNode -stopservers

This example stops the node agent associated with the myNode instance and stops all of the application servers that are running on the node.