deregisterNode command
Use the deregisterNode command to unregister a node from an administrative agent so that we can use the node stand-alone, register the node with another administrative agent, or federate the node with the deployment manager.
Run the deregisterNode command from the bin directory of the administrative agent. The node must have been previously registered with the administrative agent. When you unregister a node, the node configuration is retained, but is marked as not registered with the administrative agent.
When you run the deregisterNode command, the command stops all running application servers on the node. We can optionally stop application servers on the node that you are unregistering prior to running the deregisterNode command.
If the node that you unregister had the console or management EJB applications installed prior to registering the node, they are re-enabled.
Syntax
The deregisterNode command syntax is as follows:
- deregisterNode [options]
Parameters
The following options are available for the deregisterNode command:
- -conntype<JSR160RMI|IPC|RMI|SOAP>
- The optional connector type used to connect to the administrative agent to initiate node deregistration. The default is SOAP.
Deprecated feature: You should eventually switch from the RMI connector to the JSR160RMI connector because support for the RMI connector is deprecated.depfeat
- -host host
- An optional parameter that specifies the host name of the administrative agent.
- -nodepassword node_password
- An optional parameter that specifies the password of the node that you are unregistering. Specify this parameter if security is on at the node and the password is different than the administrative agent password. Use this parameter with the -nodeusername parameter. The -nodeusername and -nodepassword parameters are used to stop all servers on the node.
- -nodeusername node_user_name
- An optional parameter that specifies the use name of the node that you are unregistering. Specify this parameter if security is on at the node and the user name is different than the administrative agent user name. Use this parameter with the -nodepassword parameter. The -nodeusername and -nodepassword parameters are used to stop all servers on the node.
- -port port_number
- An optional parameter that specifies the port number of the administrative agent connector port.
The default port number is 8878 for the default SOAP port of the administrative agent. SOAP is the default JMX (JMX) connector type for the command. If we have multiple product installations or multiple profiles, the SOAP port might be different than 8878. Examine the administrative agent SystemOut.log file to see the current ports in use.
This topic references one or more of the application server log files. As a recommended alternative, we can configure the server to use the High Performance Extensible Logging (HPEL) log and trace infrastructure instead of using SystemOut.log , SystemErr.log, trace.log, and activity.log files on distributed and IBM i systems. We can also use HPEL in conjunction with the native z/OS logging facilities. If we are using HPEL, we can access all of the log and trace information using the LogViewer command-line tool from the server profile bin directory. See the information about using HPEL to troubleshoot applications for more information on using HPEL.
- -profilePath profile_path
- A required parameter that specifies the path to the profile of the base node to be unregistered.
- -trace
- An optional parameter that provides tracing output for the deregisterNode command.
- -profileName profile_name
- An optional parameter that specifies the profile name of the administrative agent.
- -username username
- An optional parameter that specifies the user ID of the node to be unregistered.
- -password password
- An optional parameter that specifies the password of the node to be unregistered.
- -help
- An optional parameter that prints a usage statement.
- -?
- An optional parameter that prints a usage statement.
Usage scenarios
The following examples demonstrate correct syntax. Commands are split on multiple lines for printing purposes.
(zos)
- deregisterNode.sh -conntype SOAP -port 8878 -profilePath app_server_root/profiles/AppSrv01
- deregisterNode.bat -conntype SOAP -port 8878 -profilePath app_server_root\profiles\AppSrv01
(iseries)
- deregisterNode -conntype SOAP -port 8878 -profilePath user_data_root/profiles/AppSrv01
Related tasks