Variables for federating application servers using the zpmt command

The zpmt command uses the values that you specify for the variables defined in a response file to create customization data and instructions for federating an application server.

Tip: See the sample response file in the app_server_root/zOS-config/zpmt/samples directory.

Action

create
Action to be taken

Federation information

Profile name (profileName)
The profile name is default.
Profile path (profilePath)
Profile path
Template path (templatePath)
Template path
Target operating system (targetOS)
Target operating system
High-level qualifier (zTargetHLQ)
High-level qualifier for the target z/OS datasets that will contain the generated jobs and instructions
When a customization definition is uploaded to the target z/OS system, the customization jobs and files are written to a pair of partitioned datasets. While is it possible to reuse these datasets, it is safest to create separate datasets for each WebSphere Application Server for z/OS configuration. The best practice is to use the customization dataset name prefix (sometimes referred to as config_hlq) to indicate the version and release of WebSphere Application Server for z/OS, the task that you are performing, and the cell (as well as the node name in some cases) that you are configuring. For example, you might use the following dataset name prefix for configuring a standalone WebSphere Application Server cell named TESTCELL for Version 9.0:
SYSPROG1.WAS90.TESTCELL.APPSERV
In this example, the following two datasets will be created when the customization definition is uploaded to the target z/OS system:
SYSPROG1.WAS90.TESTCELL.APPSERV.CNTL
SYSPROG1.WAS90.TESTCELL.APPSERV.DATA
The CNTL dataset will be a partitioned dataset (PDS) with fixed block 80-byte records that will contain the customization jobs. The DATA dataset will be a PDS with variable length data to contain the other customization data.
Rule: The high-level qualifier can consist of multiple qualifiers (up to 39 characters).
The generated batch jobs and instructions will be uploaded to two z/OS partitioned datasets:
HLQ.CNTL
Partitioned dataset with fixed block 80-byte records to contain customization jobs
HLQ.DATA
Partitioned dataset with variable-length data to contain other data contained in the customization definition
Tip: A multilevel high-level qualifier can be specified as the dataset high-level qualifier.
Configuration group name (zConfigurationGroup)
Group name of the WebSphere Application Server configuration group
Configuration user ID (zAdminUserid)
User ID that owns the configuration file system
Mount point (zConfigMountPoint)
Read/write file system directory mount point where application data and environment files are written

The customization process creates this mount point if it does not already exist.

Directory path name relative to mount point (zWasServerDir)
Name of the directory where WebSphere® Application Server for z/OS® files reside after installation

See Product file system for more information.

Node host name or IP address (zFederateDmaNodeHostname)
TCP/IP node name of the deployment manager for the Network Deployment cell
Deployment manager JMX connection type (zFederateDmaPortType)
RMI
Connect to the deployment manager using an RMI connection
SOAP
Connect to the deployment manager using a SOAP connection
Deployment manager JMX port (zFederateDmaPort)
JMX (Java Management Extensions) SOAP (Simple Object Access Protocol) connector port that the add-node request uses to connect to the deployment manager

It provides the federation process with knowledge of which deployment manager is the target of the federation.

Deployment manager security is enabled (zFederateDmaSecurity)
Specify true if administrative security is enabled on the Network Deployment cell and the deployment manager.
User ID (zFederateDmaSecurityUserID)
User ID with full administrative privileges for the Network Deployment cell

This is the security domain administrator user ID and cannot be changed.

Password (zFederateDmaSecurityPassword)
Password for user ID
Application Server security enabled (zFederateAppServerSecurity)
This is required if global security is enabled on the cell containing the node that is being federated.
User ID (zFederateAppServerSecurityUserID
User ID with full administrative privileges for the cell containing the application server
Password (zFederateAppServerSecurityPassword)
Password for user ID
Include applications? (zFederateIncludeApps)
Specify true if you want to include applications with your deployment manager node. Enabling this option instructs the addNode program to include applications from the node, as it would remove them prior to federation otherwise. If the application already exists in the cell, a warning is printed and the application is not installed into the cell.
Note: You must use this option to migrate all the applications to the new cell. Federating the node to a cell using the addNode command does not merge any cell-level configuration information, including that from virtualHost.
Node group name (zNodeGroupName)
Node group into which the node will be placed.

Specify DefaultNodeGroup if the node is in the same sysplex as the deployment manager.

ORB listener IP name (zFederateOrbListenerHostName)
IP address on which the server's ORB listens for incoming IIOP requests

The default is *, which instructs the ORB to listen on all available IP addresses.

ORB listener port (zFederateOrbPortName)
Port for IIOP requests that acts as the bootstrap port for the server and also as the port through which the ORB accepts IIOP requests
Rule: Value cannot be 0.
ORB SSL listener port (zFederateOrbSslPortName)
Port for secure IIOP requests

The default is 0, which allows the system to choose this port.

Short node agent server name (zFederateServerShortName)
Name of the node agent server

This is the server's job name, as specified in the MVS™ START command JOBNAME parameter. This value identifies the server to z/OS facilities such as SAF.

Rule: Name must usually contain seven or fewer all-uppercase characters.
Long node agent server name (zFederateServerName)
Name of the node agent and the primary external identification of the node agent server

This name identifies the server as displayed through the administrative console . The node agent server long name is set to the fixed value of nodeagent.

JMX SOAP connector port (zFederateJmxSoapConnectorPort)
Port number for the JMX HTTP connection to this server based on the SOAP protocol

JMX is used for remote administrative functions and is invoked through scripts such as wsadmin.sh.

Rule: Value cannot be 0.
Node discovery port (zFederateNodeDiscoveryPort)
Defines the TCP/IP port to which the node agents listens for discovery requests that originate from the deployment manager
Node multicast discovery port (zFederateNodeMulticastDiscoveryPort)
Defines the multicast port through which the node agent sends discovery requests to its managed servers

The multicast IP address on which the discovery port is opened is defaulted by WebSphere Application Server for z/OS to 232.133.104.73. This default address can be changed using the administrative console. This is a CLASS D address. The valid IP range is from 224.0.0.0 to 239.255.255.255.

Node IPv6 multicast discovery port (zFederateNodeIPv6MulticastDiscoveryPort)
Defines the IPv6 multicast port through which the node agent sends discovery requests to its managed servers (NODE_IPV6_MULTICAST_DISCOVERY_ADDRESS)
Administrative local port (zFederateAdminLocalPort)
Port for the JMX connector that listens on the loopback adapter (IPC_CONNECTOR_ADDRESS)

The connector uses local comm communications protocol, which means that the port is used only for communications that are local to the z/OS system image (or sysplex).

High Availability Manager communication port (zFederateHamCommPort)
Port on which the High Availability Manager listens (DCS_UNICAST_ADDRESS)
Node middleware agent RPC port (zMiddlewareAgentPort)
Communications port for WebSphere Extended Deployment administrative functions (NODE_XDAGENT_PORT)
Node administration overlay UDP port (zAdminOverlayUDPPort)
UDP communications port for WebSphere Extended Deployment administrative functions (NODE_OVERLAY_UDP_LISTENER_ADDRESS)
Node administration overlay TCP port (zAdminOverlayTCPPort)
TCP communications port for WebSphere Extended Deployment administrative functions (NODE_OVERLAY_TCP_LISTENER_ADDRESS)
Launch the node agent after node federation (zFederateNodeAgentAfterFederation)
Specify true if you want the node agent to be started automatically after federating a node. Otherwise, specify false.
Application server ORB listener port (zFederateAppServerOrbPort)
Port for IIOP requests that acts as the bootstrap port for this server and also as the port through which the ORB accepts IIOP requests
Rule: Value cannot be 0.
Note: The add node operation creates the node agent administrative server with a default ORB listener port equivalent to the INS CosNaming default bootstrap port. Because this same port was previously used by the node's initial standalone server, the initial standalone server's ORB listener port must change to a new port value. The default value to which the application server's ORB listener port is set is 9810. If you configure multiple cells that intersect the same systems, use of the default value will cause a port conflict between these cells. This option helps you set the port number in case port 9810 was previously assigned.
Federate service integration busses that exist on this node? (zFederateFederateSib)
Specify true to federate service integration busses that exist on this node. Otherwise, specify false.

Job statement customization

Job statement 1 (zJobStatement1)
Job statement 2 (zJobStatement2)
Job statement 3 (zJobStatement3)
Job statement 4 (zJobStatement4)

Icon that indicates the type of topic Reference topic



Timestamp icon Last updated: March 5, 2017 23:57
File name: rins_defvar5def_cmdl.html