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
- 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.
- 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.
- 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 number that may be assigned as a default port number
- Highest number that may be assigned as a default port number
Target Datasets
- High-level qualifier for the target z/OS datasets that will contain
the generated jobs and instructionsWhen 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:
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
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.SYSPROG1.WAS90.TESTCELL.APPSERV.CNTL SYSPROG1.WAS90.TESTCELL.APPSERV.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:- Partitioned dataset with fixed block 80-byte records to contain customization jobs
- 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
- Home directory
- Read/write file-system directory mount point where application data and environment files are written
- Relative path name of the directory within the configuration file system in which the application server configuration resides
- Indicates whether global security is enabled on the cell containing
the application server
- User ID with full administrative privileges for the cell containing the application server
- Password for the user ID that has full administrative privileges for the cell containing the application server
- Home directory
- 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.
- Connect to the deployment manager using an RMI connection
- Connect to the deployment manager using a SOAP connection
- 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.
- Indicates whether credentials for a user with full administrative
privileges are required to connect to the deployment manager
The user ID and password are required when global security is enabled on the Network Deployment cell except in some cases when an RMI connector is used.
- User ID with full administrative privileges for the Network Deployment cell
- Password for the user ID that has full administrative privileges for the Network Deployment cell
- IP name or address of the system on which the deployment manager
server is configured
- Name of the node agent serverThis 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.
- 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.
- 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. - 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.
- 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.
- Port for secure IIOP requests (ORB_SSL_LISTENER_ADDRESS)
The default is 0, which allows the system to choose this 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)
- Defines the TCP/IP port to which the node agents listens for discovery requests that originate from the deployment manager (NODE_DISCOVERY_ADDRESS)
- 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.
- Defines the IPv6 multicast port through which the node agent sends discovery requests to its managed servers (NODE_IPV6_MULTICAST_DISCOVERY_ADDRESS)
- 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).
- Port on which the High Availability Manager listens (DCS_UNICAST_ADDRESS)
- Communications port for WebSphere Extended Deployment administrative functions (NODE_XDAGENT_PORT)
- UDP communications port for WebSphere Extended Deployment administrative functions (NODE_OVERLAY_UDP_LISTENER_ADDRESS)
- TCP communications port for WebSphere Extended Deployment administrative functions (NODE_OVERLAY_TCP_LISTENER_ADDRESS)
- Name of the node agent server
- 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 into which the node will be placed
Specify DefaultNodeGroup if the node is in the same sysplex as the deployment manager.
- Group name of the WebSphere Application Server configuration group
- User ID that owns the configuration file system
- 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.
- Indicates whether the node agent is to be started automatically after federating a 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.