z/OS customization variables: Federating application servers

Specify values for the variables in the Profile Management Tool to create customization data and instructions that you can use to federate an application server.

The Profile Management Tool creates customization data and instructions that are used to configure a WebSphere Application Server for z/OS runtime environment. A z/OS runtime profile is not created, however, until the actions listed in the generated instructions are performed on the target z/OS system.

Customization Definition Name

Customization definition name
Name that identifies the customization definition

This name is used on the workstation to identify the customization data and instructions that are created. The name chosen has no effect on the WebSphere Application Server for z/OS configuration.

Response file path name (optional)
Full path name of a response file that contains the default values to be used

When this value is specified, the input fields are preloaded with the values in the response file.

Tip: A response file is written each time that a customization definition is created. This response file contains all of the variable data that was used to create the customization definition, and it can be used to preload the default values when defining a similar customization definition. Normally, you should specify a response file from a customization definition of the same type as the definition that you are about to define; however, you can use a response file of a different customization-definition type to preload most of the default values for a similar type.

Default Values

Options for generating default values for this customization definition

If you specified a response file for setting default values, any default selected here will override the corresponding response file values.

Port defaults
Select default port values from the following port range

When this option is not selected, each port value defaults to an IBM-provided number. When this option is selected, each port default value is selected from the following port number range.

The port range must contain at least 10 ports.

Lowest default port number
Lowest number that may be assigned as a default port number
Highest default port number
Highest number that may be assigned as a default port number

Target Datasets

High-level qualifier (HLQ)
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 8.0:
SYSPROG1.WAS80.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.WAS80.TESTCELL.APPSERV.CNTL
SYSPROG1.WAS80.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.

Federate Application Server

Application server access
WebSphere® Application Server home directory path name
Home directory
Configuration file system mount point
Read/write file-system directory mount point where application data and environment files are written
Directory path name relative to mount point
Relative path name of the directory within the configuration file system in which the application server configuration resides
Application server security is enabled
Indicates whether global security is enabled on the cell containing the application server
User ID
User ID with full administrative privileges for the cell containing the application server
Password
Password for the user ID that has full administrative privileges for the cell containing the application server
Deployment manager access
Node host name or IP address
IP name or address of the system on which the deployment manager server is configured

This value, equivalent to "cell host" in addNode.sh, is used by other WebSphere Application Server for z/OS functions to connect to this server in order to federate the designated node into the deployment manager cell.

The node host name must always resolve to an IP stack on the system where the deployment manager runs. The node host name cannot be a DVIPA or a DNS name that, in any other way, causes the direction of requests to more than one system.

Deployment manager JMX connection type
RMI
Connect to the deployment manager using an RMI connection
SOAP
Connect to the deployment manager using a SOAP connection
Deployment manager JMX port
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 connection requires security information
Indicates whether a user ID (and associated password) with full administration privileges is required to connect to the deployment manager

The user ID and password are required when global security is enabled on the Network Deployment cell unless an RMI connector is being used. If an RMI connector is being used, the identity information will be extracted from the thread of execution of the addNode job if the user ID and password are not specified.

User ID
User ID with full administrative privileges for the Network Deployment cell
Password
Password for the user ID that has full administrative privileges for the Network Deployment cell
Node agent definitions
Server name (short)
Name of the node agent server
This is the server's jobname, as specified in the MVS START command JOBNAME parameter. This value identifies the server to certain z/OS facilities used by WebSphere Application Server for z/OS (SAF for example).
Rule: Name must contain seven or fewer all-uppercase characters.
Server name (long)
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
Port number for the JMX HTTP connection to this server based on the SOAP protocol (SOAP_CONNECTOR_ADDRESS)

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

Rule: Value cannot be 0.
ORB listener IP address
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 port
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 (BOOTSTRAP_ADDRESS and ORB_LISTENER_ADDRESS)
Rule: Value cannot be 0.
ORB SSL port
Port for secure IIOP requests (ORB_SSL_LISTENER_ADDRESS)

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

Node discovery port
Defines the TCP/IP port to which the node agents listens for discovery requests that originate from the deployment manager (NODE_DISCOVERY_ADDRESS)
Node multicast discovery port
Defines the multicast port through which the node agent sends discovery requests to its managed servers (NODE_MULTICAST_DISCOVERY_ADDRESS)

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
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
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 (DCS)
Port on which the High Availability Manager listens (DCS_UNICAST_ADDRESS)
Application server's new ORB port
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

This user ID also owns all of the configuration file systems.

Rule: Value cannot be 0.
Node group name
Node group into which the node will be placed

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

Configuration group name
Group name of the WebSphere Application Server configuration group
Configuration user ID
User ID that owns the configuration file system
Include apps
Indicates whether to include applications with your deployment manager node

Enabling this option instructs the addNode command to include applications from the node; otherwise, it would remove them prior to federation. If the application already exists in the cell, a warning is printed and the application is not installed into the cell.

You must use this option to migrate all of 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.

Launch the node agent after node federation
Indicates whether the node agent is to be started automatically after federating a node
Federate service integration busses that exist on this node
Indicates whether to federate service integration busses that exist on this node

Job Statement Definition

All the customization jobs that will be tailored for you will need a job statement. Enter a valid job statement for your installation. The customization process will update the job name for you in all the generated jobs, so you need not be concerned with that portion of the job statement. If continuation lines are needed, replace the comment lines with continuation lines.




Related concepts
z/OS application server naming conventions
z/OS basic naming convention
z/OS standard naming convention
Related reference
z/OS customization worksheet: Federating application servers for Version 7.0
Reference topic Reference topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Feb 6, 2014 11:24:07 PM CST
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=matt&product=was-nd-zos&topic=rins_defvar5def
File name: rins_defvar5def.html