addNode command

The addNode command incorporates a WebSphere Application Server installation into a cell.

Depending on the size and location of the new node you incorporate into the cell, this command can take a few minutes to complete.

Your user profile must have *ALLOBJ authority or must have read and execute authority to the addNode Qshell script.

The node agent server is automatically started as part of the addNode command unless you specify the -noagent option. If you recycle the system that hosts an application server node, and did not set up the node agent to act as an operating system daemon, issue a startNode command to start the node agent before starting any application servers. The following items are new in V6.1:

• Ports generated for the node agent are unique for all the profiles in the installation. For development purposes, you can create multiple profiles on the same installation and add them to one or more cells without worrying about ports conflicts.

• If you want to specify the ports that the node agent uses, specify it in a file with the file name passed with the -portprops option. The format of the file is key=value pairs, one on each line, with the key being the same as the port name in the serverindex.xml file.

• If you want to use a number of sequential ports, the -startingport option works the same as it does in V5.x. This means that port conflicts with other profiles will not be detected.

Syntax

The command syntax is as follows:

addNode dmgr_host [dmgr_port] [-profileName profilename]
[-conntype type] [-includeapps] [-startingport portnumber] 
[-portprops qualified_filename] [-nodeagentshortname name] 
[-nodegroupname name] [-includebuses name]
[-registerservice] [-serviceusername name] [-servicepassword password]
[-coregroupname name] [-noagent] [-statusport port] [-quiet] [-nowait] 
[-logfile filename] [-replacelog] [-trace] [-username uid] 
[-password pwd] [-localusername localuid]
[-localpassword localpwd] [-help]

The dmgr_host argument is required. All of the other arguments are optional. The default port number is 8879 for the default SOAP port of the deployment manager. SOAP is the default JMX connector type for the command. If you have multiple WebSphere Application Server installations or multiple profiles, the SOAP port may be different than 8879. Examine the deployment manager SystemOut.log to see the current ports in use.

Parameters

The following options are available for the addNode command:

-conntype <type>

Specifies the JMX connector type to use for connecting to the deployment manager. Valid types are SOAP or RMI, which stands for Remote Method Invocation.

-includeapps

By default the addNode command does not carry over applications from the stand-alone servers on the new node to the cell. In general, you should install applications using the deployment manager. The -includeapps option tells the addNode command to carry over the applications from a node. If the application already exists in the cell, a warning is printed and the application does not install in the cell.

The applications will be mapped to the server that you federated using the addNode command. When the addNode command operation completes, the applications will run on that server when the server is started. Since these applications are part of the network deployment cell, you can map them to other servers and clusters in the cell using the administrative console. See the Mapping modules to servers article for more information.

You should not use the -includeapps option if your node to be federated includes WebSphere Application Server supplied applications, such as the samples. If you do, the second node to be federated that includes these applications will be rejected because the applications already exist in the cell and application merge is not supported.

If you use the -includeapps option on a node that includes a large number of applications, the timeout for the administrative connector needs to be extended to account for the additional time required to transfer all of the applications to the deployment manager during addNode and to remotely install them into the cell. The -includeapps option is not a recommended approach unless only a few unique applications exist on the node.

By default, during application installation, application binaries are extracted in the profile_root/installedApps/cellName directory. After the addNode command, the cell name of the configuration on the node that you added changes from the base cell name to the deployment manager cell name. The application binaries are located where they were before the addNode command ran, for example, profile_root/installedApps/old_cellName. If the application was installed by explicitly specifying the location for binaries as the following example:

${app_server_root}/${CELL}

where the variable ${CELL}, specifies the current cell name, then when the addNode command runs, the binaries are moved to the following directory:

${app_server_root}/currentCellName

Federating the node to a cell using the addNode command does not merge any cell level configuration, including virtual host information. If the virtual host and aliases for the new cell do not match WebSphere Application Server, you cannot access the applications running on the servers. You have to manually add all the virtual host and host aliases to the new cell, using the administrative console running on the deployment manager.

-profileName

Defines the profile of the Application Server process in a multi-profile installation. The -profileName option is not required for running in a single profile environment. The default for this option is the default profile. If you are adding a non-default profile to the deployment manager cell, this parameter is required.

-user <name> or -username <name>

User name for authentication if security is enabled. Acts the same as the -user option. The user name that you choose must be a pre-existing user name.

-nowait

Tells the addNode command not to wait for successful initialization of the launched node agent process.

-quiet

Suppresses the progress information that the addNode command prints in normal mode.

-logfile <filename>

Location of the log file to which trace information is written. By default, the log file is called addNode.log and is created in the logs directory of the profile for the node being added.

-trace

Generates additional trace information in the log file for debugging purposes.

-replacelog

Replaces the log file instead of appending to the current log. By default, the addNode command appends to the existing trace file. This option causes the addNode command to overwrite the trace file.

-noagent

Tells the addNode command not to launch the node agent process for the new node.

-password <password>

Password for authentication if security is enabled. The password that you choose must be one that is associated with a pre-existing user name.

-startingport <portNumber>

Supports the specification of a port number to use as the base port number for all node agent and Java Messaging Service (JMS) server ports created during the addNode command. With this support you can control which ports are defined for these servers, rather than using the default port values. The starting port number is incremented by one to calculate the port number for every node agent port and JMS server port configured during the addNode command.

If multiple node agents exist on the same physical server, you can define the base port number for each by using the -startingport parameter prior to federation, or by modifying the ports in the node agent section of serverindex.xml.

-registerservice

(Windows only) Registers the node agent as a Windows service.

-statusport

Specifies that an administrator can set the port number for node agent status callback.

-serviceusername <user>

(Windows only) Use the given user name as the Windows service user.

-servicepassword <password>

(Windows password) Use the given password as the Windows service password.

-portprops <filename>

Passes the name of the file that contains key-value pairs of explicit ports that you want the new node agent to use. For example, to set your SOAP and RMI ports to 3000 and 3001, create a file with the following two lines and pass it as the parameter:

SOAP_CONNECTOR_ADDRESS=3000
BOOTSTRAP_ADDRESS=3001

-coregroupname <name>

The name of the core group in which to add this node. If you do not specify this option, the node will be added to the DefaultCoreGroup.

-nodegroupname <name>

The name of the node group in which to add this node. If you do not specify, the node is added to the DefaultNodeGroup.

-includebuses

Copies the buses from the node to be federated to the cell. This parameter will also attempt to copy the service integration bus configuration of the remote node into the cell. If the destination cell already contains a bus with the same name as any bus at the remote node, the add node will fail. To prevent this problem, there are actions you can take before using the addNode command. You can delete the bus with that name in the destination cell, rename the bus to be added to the cell, or manually configure the bus already located in the cell.

-nodeagentshortname <name>

The shortname to use for the new node agent.

-localusername <name>

User name for authentication for existing application servers on the node that you want to federate. This parameter is only applicable if security is enabled for the application server.

-localpassword <password>

Password for authentication for existing application servers on the node that you want to federate. The password that you choose must be one that is associated with a preexisting user name. This parameter is only applicable if security is enabled for the application server.

-help

Prints a usage statement.

-?

Prints a usage statement.

Usage scenario

addNode testhost 8879 (adds an application server to the deployment manager)

addNode deploymgr 8879 -trace (produces the addNode.log file)

addNode host25 8879 -nowait (does not wait for a node agent process)

addNode mydmgr 11383 -profileName mynode (adds profile mynode to the Network 
Deployment cell managed by profile mydmgr, which listens on SOAP port 11383)

Sub-topics

Related tasks

Related information

Reference topic