Configuration variables for migrating a z/OS federated node by using the zmmt command

Before you migrate WebSphere® Application Server for z/OS®, you must create Job Control Language (JCL) jobs (CNTL and DATA datasets) that you run during the actual migration. You can use the zmmt command with a response file to create the appropriate migration jobs. The migration response file contains a set of configuration variables that you use to create jobs for migrating a federated node.

Supported configurations Supported configurations:

This article is about profile configuration migration. To migrate your applications to the latest version, use the WebSphere Application Server Migration Toolkit. For more information, see the Migration Toolkit on WASdev.

sptcfg

Response-file variables

create
Required keyword to indicate the creation of a new migration definition.
intermediateSymlinkPreference
Whether to set up an intermediate symbolic link.

If you specify an intermediate symbolic link, symbolic links are created from the configuration file system to the intermediate symbolic link; otherwise, they are created directly to the product file system.

IntermediateSymlink
Path name of intermediate symbolic link.

This link is created by the customization jobs, pointing to the product file system directory.

profileName
Name of the profile that is created during migration.

This is always default on the z/OS platform.

profilePath
Fully qualified path where the generated migration definition output is written.
templatePath
Template path.
One of the following values:
  • zos-migDmgr

    Migrate a deployment manager

  • zos-migFederated

    Migrate a federated node

  • zos-migStandalone

    Migrate a stand-alone application server

zConfigHfsName
Name of the MVS™ dataset that contains the configuration file system.

This name is used as input to the migration job that creates the configuration file system.

zConfigHfsPrimaryCylinders
Number of primary cylinders that are allocated to the configuration file system.

In an application server, the total space that is needed for this dataset increases with the size and number of installed applications.

Recommendation: The minimum suggested size is 420 cylinders.
zConfigHfsSecondaryCylinders
Number of secondary cylinders that are allocated to the configuration file system.
Recommendation: The minimum suggested size is 100 cylinders.
zConfigHfsVolume
DASD volume serial number to contain the dataset, or "*" to let SMS select a volume.

Using "*" requires that SMS automatic class selection (ACS) routines be in place to select the volume. If you do not have SMS set up to handle dataset allocation automatically, list the volume explicitly.

zConfigMountPoint
File system directory mount point where application data and environment files are written.
zFilesystemType
Type of file system.
One of the following values:
  • HFS

    Allocate and mount your configuration file system dataset by using the Hierarchical File System

  • ZFS

    Allocate and mount your configuration file system dataset by using the zSeries File System

zJobStatement1 . . . n
Customizable JOB statements that are used for the generated migration jobs.

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

zTargetHLQ
High-level qualifier for the target z/OS datasets that contain the generated jobs and instructions.
Note: A multilevel high-level qualifier can be specified as the dataset high-level qualifier.
zmbAdminUserid
User ID of an administrator that is used to manage the node that is being migrated.

This is required to perform required administrative actions during the migration process.

zmbAdminPassword
Password for the user ID of the administrator that is used to manage the node that is being migrated.

This is required to perform required administrative actions during the migration process.

zmbControllerProcName
Name of the JCL started procedure that is used to start the migrated controllers.

When you migrate to Version 9.0, you must upgrade your JCL started procedures. A new started procedure is generated for you during migration. You can specify a new name for the controller procedure or use the old one.

zmbServantProcName
Name of the JCL started procedure that is used to start the migrated servants.

When you migrate to Version 9.0, you must upgrade your JCL started procedures. A new started procedure is generated for you during migration. You can specify a new name for the servant procedure or use the old one.

zmbDaemonProcName
Name of the JCL started procedure that is used to start the migrated daemon.

When you migrate to Version 9.0, you must upgrade your JCL started procedures. A new started procedure is generated for you during migration. You can specify a new name for the daemon procedure or use the old one.

zmbAdjunctProcName
Name of the JCL started procedure that is used to start the migrated adjunct.

When you migrate to Version 9.0, you must upgrade your JCL started procedures. A new started procedure is generated for you during migration. You can specify a new name for the adjunct procedure or use the old one.

zmbReplaceStartedProcedureNames
Whether to update the START commands in the configuration with the new names specified (true) or to preserve the same names (false).

If you specified new names for your JCL procedures, then the corresponding START commands in the WebSphere Application Server configuration must be updated to match the new procedure names. Specify true for this variable to perform this configuration update. [9.0.0.3 or later]You must provide unique names and specify true if you specified a clone migration. The new environment requires unique procedure names to coexist with the old environment.

If you choose to use the same procedure names, then specify false for this variable. If you are not using consistent procedure names for all the servers of a given process type (all servants for example) for the node that you are migrating, then it is recommended that you specify false for this variable. In this case, you need to keep the same START commands and manually replace the procedures by using the procedure that is generated during migration as a template.

Notes:
  • Your Version 9.0 configuration must use different JCL procedures from those procedures that are used by your Version 7.0 configuration. The migration process creates new Version 9.0 JCL procedures by using the procedure names specified here.
  • If you use the same names as you used in your Version 7.0 configuration, the migration process overlays the existing procedures. If you are using the same names, make sure that you back up the existing Version 7.0 procedures before you run the migration jobs in case you need to roll back later.
zmbEnablePostUpgradeTrace
Enable (true) or disable (false) trace during the WASPostUpgrade process.
zmbEnablePreUpgradeTrace
Enable (true) or disable (false) trace during the WASPreUpgrade process.
zmbEnableProfileTrace
Enable (true) or disable (false) trace during profile creation.
zmbEnableScriptingTrace
Enable (true) or disable (false) trace of the home creation, profile and migration tooling invocation, and final processing phases of migration.
zmbFromConfigRoot
Mount point of the configuration from which you are migrating.
zmbFromWASHomeDir
Home directory of the configuration from which you are migrating.
zmbInitialHeapSize
The initial memory that is allocated for the JVM heap.
zmbJavaTempDirectory
A Java temporary directory that is used by the Java virtual machine to create and story temporary files during migration.
zmbMaxHeapSize
The maximum heap size that can be allocated for the JVM heap.
zmbProclibName
Existing procedure library to which the WebSphere Application Server for z/OS cataloged procedures are to be copied.
zmbResolvePortConflicts
Define how to handle port conflicts by specifying one of the following values.
  • incrementCurrent

    If a port conflict is detected, the port value is incremented from the conflicting port to the next available port value.

  • startingPort
    If a port conflict is detected, the port value is incremented from the specified value to the next available port value.
    Note: If both zmbResolvePortConflicts and zmbSetPorts are set to startingPort, the zmbResolvePortConflicts variable is ignored.
    zmbStartingPort
    The starting port value from which new ports are generated.
zmbSetPorts
Define which port values to use in the new profile by specifying one of the following values.
  • useOld

    Reuse the port values that are defined in the source profile.

  • startingPort

    Generate new ports by incrementing from the specified port value. Conflicting ports are automatically resolved. [9.0.0.3 or later]If you specified a clone migration, you must specify startingPort. No other port option is valid for cloning a federated node.

    zmbStartingPort
    The starting port value from which new ports are generated.
zmbSMPEHome
Location of your WebSphere Application Server Version 9.0 installed product file system.
zmbTempDirectory
The directory where the backup of your previous configuration and the migration trace is written.

During migration, a backup copy of the previous version's configuration is required. The default location of this backup is /tmp/migrate. If the /tmp file system does not have adequate space to store the backup configuration, you can specify another location. If you choose to override the default location of the backup copy, the best practice is to keep the same naming convention and replace the /tmp portion with another path, /myTemp/migrate for example.

zmbTimestamp
Identifier that is used to create a directory under the temporary directory that contains the temporary migration datasets and backup configuration data.
zmbToConfigRoot
Mount point of the configuration to which you are migrating.

This is the same value that is specified for the zConfigMountPoint variable.

zmbToWASHomeDir
Home directory of the configuration to which you are migrating.
zmbWorkspaceRootPreference
Whether to migrate the administrative console customized "My tasks" settings that are saved in the default workspace user root location (D) or to migrate the settings that are saved in a user-defined workspace root location (U).
zmbUserWorkspaceRoot
User-defined workspace root location.
[9.0.0.3 or later]zmbCloneMigration
[9.0.0.3 or later]Specifies whether to perform a clone migration, true, or standard migration, false, of the old profile. If you cloned the deployment manager, to which you intend to federate this node, you must also clone this node.
[9.0.0.3 or later]zmbCloneDmgrHostname
[9.0.0.3 or later]The hostname of the deployment manager in the new environment to which the new node is federated. Required if zmbCloneMigration is set to true.
[9.0.0.3 or later]zmbCloneDmgrSoapPort
[9.0.0.3 or later]The SOAP port of the deployment manager. Either the SOAP or RMI port of the new deployment manager is required if zmbCloneMigration is set to true. If both are specified, a connection to the RMI port is attempted if an attempt to connect with the SOAP port fails.
[9.0.0.3 or later]zmbCloneDmgrRmiPort
[9.0.0.3 or later]The RMI port of the deployment manager. Either the SOAP or RMI port of the new deployment manager is required if zmbCloneMigration is set to true. If both are specified, a connection to the RMI port is attempted if an attempt to connect with the SOAP port fails.
[9.0.0.3 or later]zmbNodeShortName
[9.0.0.3 or later]The short name of the new node. Required if zmbCloneMigration is set to true.
[9.0.0.3 or later]zmbServerShortPrefix
[9.0.0.3 or later]A prefix, up to 3 characters, used to generate unique short names for all the servers in the new profile. Required if zmbCloneMigration is set to true.

Sample of a response file for migrating a federated node

create
EnableIntermediateSymlink=false
EnableJavaTmpDir=false
intermediateSymlinkPreference=N
profileName=default
profilePath=<root>/profiles/ZMigFed01
templatePath=<root>/profileTemplates/zos-migFederated
zConfigHfsName=OMVS.WAS90.CONFIG.HFS
zConfigHfsPrimaryCylinders=420
zConfigHfsSecondaryCylinders=100
zConfigHfsVolume=*
zConfigMountPoint=/wasv9config
zFilesystemType=HFS
zJobStatement1=(ACCTNO,ROOM),'USERID',CLASS=A,REGION=0M
zJobStatement2=//*
zJobStatement3=//*
zJobStatement4=//*
zTargetHLQ=FED
zmbAdjunctProcName=BBO9CRA
zmbAdminPassword=XXXXXXXX
zmbAdminUserid=XXXXXXXX
zmbControllerProcName=BBO9ACR
zmbDaemonProcName=BBO89MN
zmbEnablePostUpgradeTrace=0
zmbEnablePreUpgradeTrace=0
zmbEnableProfileTrace=0
zmbEnableScriptingTrace=0
zmbFromConfigRoot=/WebSphere/V7R0
zmbFromWASHomeDir=AppServer
zmbInitialHeapSize=512
zmbMaxHeapSize=768
zmbProclibName=SYS1.PROCLIB
zmbReplaceStartedProcedureNames=true
zmbResolvePortConflicts=incrementCurrent
zmbSMPEHome=/usr/lpp/WebSphere/AppServer/V9R0
zmbServantProcName=BBO9ASR
zmbSetPorts=startingPort
zmbStartingPort=18000
zmbTempDirectory=/tmp/migrate
zmbTimestamp=05173538
zmbToConfigRoot=/wasv9config
zmbToWASHomeDir=AppServer
zmbWorkspaceRootPreference=D
zmbCloneMigration=true
zmbCloneDmgrHostname=example.com
zmbCloneDmgrSoapPort=8879
zmbCloneDmgrRmiPort=8880
zmbNodeShortName=MIGRNODE
zmbServerShortPrefix=V9S

Icon that indicates the type of topic Concept topic



Timestamp icon Last updated: March 6, 2017 0:04
File name: cmig_zmmt_cmd_fednodevar.html