soammod

The command to modify session and task priorities to enable high priority workload to finish faster.

Synopsis

soammod subcommand [options]

soammod -h

soammod subcommand -h

soammod -V

Description

Use soammod session to change the priority of one session, all sessions, or sessions that match the session tag of an application. IBM® Spectrum Symphony increases or decreases the amount of resources assigned to a session depending on session priority.

Any priority changes made are applied at a time determined by the Consumer > sessionSchedulingInterval attribute of the application profile. When IBM Spectrum Symphony next checks the workload to determine if it must reassign resources, it examines any session priority changes and reallocates resources accordingly.

Changing the priority of a session does not affect running tasks. The system waits for the task to finish before reassigning the resource.

IBM Spectrum Symphony Developer Edition does not verify the optional user name and password. IBM Spectrum Symphony Developer Edition users can control all sessions and applications in their environment.

In the IBM Spectrum Symphony environment:

Consumer users can only change sessions they submitted.
Consumer administrators can change sessions of all applications under that consumer.
Cluster administrators can change all sessions under all consumers in the cluster.

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

Subcommand synopsis

session application_name [-u user_name] [-x password] -p priority_number

session application_name:session_ID [-u user_name] [-x password] -p priority_number

session application_name [-u user_name] [-x password] -p priority_number -t session_tag [-f]

session application_name [-u user_name] [-x password] -r "priority" -t session_tag

task application_name:session_ID:task_ID -p priority_number

session `application_name` [-u `user_name`] [-x `password`] -p `priority_number`

Changes the priority of all sessions for the application.

application_name: Specifies the name of the application. The application name is the same as it appears in the application profile. Enclose the application name in double quotes (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
-p priority_number: Specifies the priority number to assign to all sessions of the specified application. The priority number range is from 1 to 10,000, where priority 1 is the lowest priority.
-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 soamlogon, for this command only the user name specified here overrides the user name entered in soamlogon.
-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 soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Change the priority of all sessions

Change the priority of all sampleApp sessions to 10.

soammod session sampleApp -p 10

session `application_name`:`session_ID` [-u `user_name`] [-x `password`] -p `priority_number`

Changes the priority of a specific session for the application.

application_name: Specifies the name of the application. The application name is the same as it appears in the application profile. Enclose the application name in double quotes (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
session_ID: Specifies the IBM Spectrum Symphony-assigned ID of the session as reported by soamview session.
-p priority_number: Specifies the priority number to assign to the specified session of the specified application. The priority number range is from 1 to 10,000, where priority 1 is the lowest priority.
-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 soamlogon, for this command only the user name specified here overrides the user name entered in soamlogon.
-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 soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Change the priority of a specific session.

Change the priority of the specific session to 100.

soammod session sampleApp:101 -p 100

session `application_name` [-u `user_name`] [-x `password`] -p `priority_number` -t `session_tag` [-f]

Changes the priority of all sessions for the application that share the specified session tag.

application_name: Specifies the name of the application. The application name is the same as it appears in the application profile. Enclose the application name in double quotes (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
-p priority_number: Specifies the priority number to assign to all current sessions of the specified application that share the given session tag. The priority number range is from 1 to 10,000, where priority 1 is the lowest priority.
-t session_tag: Specifies the string that is used for identification purposes to control the session.
-f: Specifies that future sessions created with the given session tag will inherit the specified priority, rather than get their priority from the application profile. The -f flag can only be used when the -t session_tag option and the -p priority option are both specified. If the -f flag is not specified, the priority change applies only to current sessions that share the given session tag.
-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 soamlogon, for this command only the user name specified here overrides the user name entered in soamlogon.
-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 soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Change the priority of current and future sessions

Change the priority of all current and future sampleApp sessions that share the "myTag" session tag to 10.

soammod session sampleApp -p 10 -t myTag -f

session `application_name` [-u `user_name`] [-x `password`] -r `"priority`" -t `session_tag`

Resets the priority of all future sessions for the application that share the specified session tag.

application_name: Specifies the name of the application. The application name is the same as it appears in the application profile. Enclose the application name in double quotes (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
-r "priority": Resets the priority change that was previously specified with the -f flag for future sessions. Future sessions that are created with the matching session tag will use the priority from the application profile.
-t session_tag: Specifies the string that is used for identification purposes to control the session.
-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 soamlogon, for this command only the user name specified here overrides the user name entered in soamlogon.
-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 soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Reset the priority of future sessions

Reset the priority of future sampleApp sessions created with the "myTag" session tag. Future sessions created with the "myTag" session tag will get their priority from the application profile.

soammod session sampleApp -t myTag -r "priority"

task `application_name`:`session_ID`:`task_ID` -p `priority_number`

Updates the priority of a specific task belonging to a specific session for the application.

application_name: Specifies the name of the application. The application name is the same as it appears in the application profile. Enclose the application name in double quotes (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
session_ID: Specifies the IBM Spectrum Symphony-assigned ID of the session as reported by soamview session.
task_ID: Specifies the IBM Spectrum Symphony-assigned ID of the task as reported by soamview task.
-p priority_number: Specifies the priority number to assign to the specified task of the specified session and application. The priority number range is from 1 to 10, where priority 1 is the lowest priority.

Change the priority of a specific task

Change the priority of the specific task to 10.

soammod task sampleApp:1201:17 -p 10