Configuration variables for migrating a z/OS stand-alone application server 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 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 stand-alone application server.

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 name 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.

The configuration file system is where the configuration for the node that is being migrated is physically stored. You can choose to use an existing Version 9.0 file system if you already have an appropriate file system on the node that is being migrated. If you choose to use an existing Version 9.0 file system, you need to ensure that the mount point that you specify here is present before you run the migration jobs that are created by using this tool. If you choose to create a new Version 9.0 file system on the node that is being migrated, the creation of the new file system does not occur until you run the optional BBOMBHFS or BBOMBZFS job during the actual migration process. In any case, you must specify the correct value here for the mount point.

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.
zmbAppMigrationPreference
How you would like to migrate your installed applications.
One of the following values:
  • D

    Install user enterprise applications in the default application installation directory as part of the migration

  • Y

    Install user enterprise applications in a directory that is specified in the following variables as part of the migration

    zmbAppInstallDirLine1
    zmbAppInstallDirLine2
    Location where WebSphere Application Server installs your enterprise applications

    This location is used when you specify that you want to migrate and install applications as your application migration preference. You can choose a customized environment-specific location or use the default location.

    If the location path length exceeds 60 characters, then it must be specified on two lines as shown; but it cannot exceed a total length of 120 characters.

    Leave these two fields blank unless you specify Y for zmbAppMigrationPreference.

  • S

    Prepare user enterprise applications for installation in the WebSphere Application Server Version 9.0 installableApps directory without installing them during migration.

    Scripts that can be used to install these applications are generated and saved in the migration backup directory. For WebSphere Application Server for z/OS, the location of this backup directory is relative to the temporary directory that you specify for the zmbTempDirectory variable. The location of the backup directory is also determined by the derived migration identifier and the type of node that is being migrated. If you specify /tmp/migrate as the temporary directory and the derived migration identifier is 55449, for example, then the location of the generated scripts is:
    /tmp/migrate/55449/nodetype_backup/
    where nodetype is dmgr, fed, or base, depending on the type of node that you are migrating.

    You can then run these files at any point and in any combination after migration completes. You can also reorganize and combine these files for better application installation efficiency. For more information, see Wsadmin tool.

  • P

    Install user enterprise applications as part of the migration, and keep the same application installation directories as the previous version.

    Restrictions: If you select this option, the location is shared by the existing WebSphere Application Server Version 7.0 or later installation and the Version 9.0 installation. If you keep the migrated applications in the same locations as those of the previous version, the following restrictions apply:
    • The WebSphere Application Server Version 9.0 mixed-node support limitations must be followed. This means that the following support cannot be used when you evoke the wsadmin command:
      • Precompile JSP
      • Use Binary Configuration
      • Deploy EJB
    • You risk losing the migrated applications unintentionally if you later delete applications from these locations when you administer your Version 7.0 or later installation.
    • Any application that is installed relative to a Version 7.0 or later variable is installed relative to the location assigned to that variable in Version 9.0. In other words, the absolute location is not preserved—the application is migrated to the relative location within the new Version 9.0 environment.
      If the binariesURL in the deployment.xml file for an application that is being migrated has a path that is relative to WebSphere Application Server—that is, it begins with $(APP_INSTALL_ROOT), $(WAS_INSTALL_ROOT), and so on—the new WebSphere Application Server variable value is used to resolve the path when the application is installed in the new location. This leads to the following results when you select this option:
      • Any application that is installed in a directory location relative to a WebSphere Application Server variable is installed under that variable value in Version 9.0.
      • Any application that is installed in a directory location that is not relative to a WebSphere Application Server variable is migrated and overwritten in that same directory. If an application is installed in the /employee_records/retrieval_Apps directory, for example, the application is migrated and overwritten in the /employee_records/retrieval_Apps directory.
  • N

    Do nothing with user enterprise applications

Note: WebSphere Application Server system applications migrate regardless of the value set here.
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 the procedures that are used by your Version 7.0 or later 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 or later 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 or later 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.
zmbInstallDefaultApp
Install the default application that contains the Snoop, Hello, and HitCount servlets
zmbInstallSamples
Specify whether to deploy the sample applications.
Note: These applications are not supported in a WebSphere Application Server, Network Deployment cell.

Install the sample applications to use the application server and evaluate the latest technological advancements. The sample applications are not recommended for deployment to production application server environments.

zmbJavaTempDirectory
A Java temporary directory that is used by the Java virtual machine to create and story temporary files during migration.
zmbManagedBaseNode
Indicates whether the source profile is registered to an administrative agent. [9.0.0.3 or later]Set to false if zmbCloneMigration is set to true.
zmbMaxHeapSize
The maximum heap size that can be allocated for the JVM heap.
zmbNewAdminAgentHostname
The host name of the source administrative agent.
zmbNewAdminAgentPassword
If security is enabled, the administrative security password for the source administrative agent.
zmbNewAdminAgentProfilePath
The file system path of the source administrative agent.
zmbNewAdminAgentSoapPort
The port that the source administrative agent used for SOAP connections.
zmbNewAdminAgentUsername
If security is enabled, the user name for the source administrative agent.
zmbOldAdminAgentHostname
The host name of the target administrative agent.
zmbOldAdminAgentPassword
If security is enabled, the administrative security password for the target administrative agent.
zmbOldAdminAgentProfilePath
The file system path of the target administrative agent.
zmbOldAdminAgentSoapPort
The port that the target administrative agent uses for SOAP connections.
zmbOldAdminAgentUsername
If security is enabled, the user name for the target administrative agent.
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. [9.0.0.3 or later]This value is not valid if zmbCloneMigration is set to true. The new profile must have different ports from the old profile after a clone migration.

  • generateNew

    Set custom values for each port in the target profile.

  • startingPort

    Generate new ports by incrementing from the specified port value. Conflicting ports are automatically resolved.

    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 saved in the default workspace user root location (D) or to migrate the settings saved in a user-defined workspace root location (U)
zmbUserWorkspaceRoot
User-defined workspace root location
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.

[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.
[9.0.0.3 or later]zmbCellShortName
[9.0.0.3 or later]The short name of the new cell. Required if zmbCloneMigration is set to true.
[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]zmbServerShortName
[9.0.0.3 or later]The short name of the first new server. Required if zmbCloneMigration is set to true.
[9.0.0.3 or later]zmbClusterShortPrefix
[9.0.0.3 or later]A prefix, up to 3 characters, used to generate unique short names for clusters and node groups in the new profile. 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 extra servers in the new profile. Required if zmbCloneMigration is set to true.

Sample of a response file for migrating a stand-alone application server

create
EnableIntermediateSymlink=false
EnableJavaTmpDir=true
intermediateSymlinkPreference=N
profileName=default
profilePath=<root>/profiles/ZMigSASrv01
templatePath=<root>/profileTemplates/zos-migStandalone
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=SAS
zmbAdjunctProcName=BBO9CRA
zmbAppInstallDirLine1=/wasv9config/AppServer/profiles/default/installedApps
zmbAppInstallDirLine2= 
zmbAppMigrationPreference=D
zmbControllerProcName=BBO9ACR
zmbDaemonProcName=BBO9DMN
zmbEnablePostUpgradeTrace=0
zmbEnablePreUpgradeTrace=0
zmbEnableProfileTrace=0
zmbEnableScriptingTrace=0
zmbFromConfigRoot=/WebSphere/V7R0
zmbFromWASHomeDir=AppServer
zmbInitialHeapSize=512
zmbInstallDefaultApp=false
zmbInstallSamples=false
zmbJavaTempDirectory=/tmp
zmbManagedBaseNode=false
zmbMaxHeapSize=768
zmbProclibName=SYS1.PROCLIB
zmbReplaceStartedProcedureNames=true
zmbResolvePortConflicts=incrementCurrent
zmbSMPEHome=/usr/lpp/WebSphere/AppServer/V9R0
zmbServantProcName=BBO9ASR
zmbSetPorts=generateNew
zmbTempDirectory=/tmp/migrate
zmbTimestamp=05160419
zmbToConfigRoot=/wasv9config
zmbToWASHomeDir=AppServer
zmbWorkspaceRootPreference=D
zmbCloneMigration=true
zmbCellShortName=MIGRCELL
zmbNodeShortName=MIGRNODE
zmbServerShortName=MIGRSRV
zmbClusterShortPrefix=V9C
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_sappservar.html