soammigrate

The command to migrate the SSM (session manager) for an application.

The cluster administrator, or the consumer administrator for the consumer associated with the IBM® Spectrum Symphony application can run this command on IBM Spectrum Symphony Advanced Edition. This command is applicable to both multidimensional scheduling based applications and slot based applications using the minimum service, proportional, priority scheduling, and hierarchy policies.

This command is not supported for IBM Spectrum Symphony Developer Edition, MapReduce applications, and recursive workload.

Synopsis

soammigrate app start application_name [-f] [-s simReconnectionTimeout] [-r resReq] [-u user_name] [-x password]

soammigrate -h

soammigrate -V

Description

Use soammigrate to migrate the SSM for an application.

There are two paths for SSM migration for an application:

Migrate the SSM from one host to another

Seamlessly migrate the SSM for an application, from one management host to another, without interrupting workload. This way, recoverable and unrecoverable sessions can be used with the new SSM after migration. During migration, you can submit new workload to the SSM, and workload is pending until migration completes. You can complete this by running the soammigrate command.

If the SOAM version in your application profile is configured to the same version of IBM Spectrum Symphony as you have installed (for example, your application profile is configured for IBM Spectrum Symphony 7.1.2, and you have IBM Spectrum Symphony 7.1.2 installed), then any running workload is never interrupted and remains running. The service instance manager sends the results to the new SSM after migration. The SSM that is being migrated can keep its existing allocated resources throughout the migration process; resources are still deserved and still required.

If the SOAM version in your application profile is configured to with a value of latest version, then the SSM starts using the latest version of IBM Spectrum Symphony that you have installed. Running workload will be interrupted; however both recoverable and unrecoverable sessions can be used with the new SSM after migration, and all workload is re-dispatched after migration.

Update applications for an upgraded product version

After you perform a rolling upgrade to IBM Spectrum Symphony 7.3.1, you must also upgrade your applications to use the upgraded version, so that the new version of the SSM starts on the local host (that is, not on another host) where you have your upgraded version of IBM Spectrum Symphony. Workload is not lost: running workload is interrupted, but rescheduled. You can complete this by running the soammigrate command with the -r local option.

-h: Prints command usage to stdout and exits.
-V: Prints product version to stdout and exits.

Options

app start application_name

Specifies the name of the application to migrate. The application name is the same as it appears in the application profile. Enclose the application name in double quotation marks (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.

You can view the application name using soamview app.

-f

Indicates that this command will be executed without a confirmation prompt.

-s simReconnectionTimeout

Specifies the timeout, in seconds, for the service instance manager to connect to the new SSM. The default value is 300 seconds.

Valid value are from 300 to 216000 seconds. If a service instance manager cannot connect to the new SSM within simReconnectionTimeout seconds after the new SSM sends out a reconnection notification (for example, after 300 seconds), that service instance manager will be terminated. SSM will re-queue the workload in it and will re-run the work later.

Additionally, a value of 0 seconds allows SSM to release all resources in it before starting another host. Running tasks no longer remain running during migration; instead, running tasks are suspended and are restarted after migration completes. Therefore, valid values for simReconnectionTimeout are either 0 seconds, or a value from 300 to 216000 seconds:

0: A value of 0 seconds means that all the resources in the previous SSM will be released, service instance managers will be stopped, workload in it will be re-queued before this SSM exits, and the new SSM will re-run the work.
300 to 216000: A value of 300 to 216000 seconds means that if a service instance manager cannot connect to the new SSM within simReconnectionTimeout seconds after the new SSM sends out a reconnection notification (for example, after 300 seconds), that service instance manager will be terminated. SSM will re-queue the workload in it and will re-run the work later.

-r resReq

A resource requirement, in string format, for the migration destination host. Note that this resource requirement only applies to migration; it does not change the SSM resource requirement in the application profile for future SSM failover.

A value of local specifies that you want the SSM migration to the same (local) host, and not to another host. Use this option if you have performed a rolling upgrade to the latest version of IBM Spectrum Symphony. Specifying this option indicates that SSM starts on the local host where you have upgraded IBM Spectrum Symphony.

If you do not specify -r resReq when running the soammigrate command, one of the following happens:

If a resource requirement (resReq) is not defined in the application profile, the soammigrate command uses select(!current_ssm_hostname).
If a resource requirement (resReq) is defined in the application profile (for example, select(A)), then the soammigrate command uses select((A) && !current_ssm_hostname).

-u user_name

Specifies the name of the user to connect to IBM Spectrum Symphony for this command. If you are already logged on to IBM Spectrum Symphony using the soamlogon command, for this command only the user name specified here overrides the user name entered in the soamlogon command.

-x password

Specifies the user password to connect to IBM Spectrum Symphony for this command. If you are already logged on to IBM Spectrum Symphony using the soamlogon command, for this command only the password specified here overrides the password entered in the soamlogon command.

Migrate the SSM for an application from one management host to another, so that the SSM starts on the other host

Migrate the session manager for application ABC to another host:

soammigrate app start ABC

Migrate the SSM for an application so that the upgraded SSM starts on the same host

After you have performed a rolling upgrade to the latest version of IBM Spectrum Symphony, migrate the SSM for application ABC to the same host, so that the SSM starts on the upgraded host for application ABC:

soammigrate app start ABC -r local