soamcontrol

Controls applications and sessions.

Synopsis

soamcontrol subcommand [options]
soamcontrol -h
soamcontrol subcommand -h
soamcontrol -V

Description

Use the soamcontrol command with a subcommand to control applications, sessions, and tasks.

Symphony DE does not verify the optional user name and password. Symphony DE users can control all sessions, applications, and tasks in their environment.

In grid, the user must have the appropriate permissions to control an application, task, or session, as follows:

  • Consumer administrators have permission to use this command to control applications, sessions, and tasks in the consumers they manage

  • Cluster administrators have permission to use this command to control applications, sessions, and tasks for all consumers

  • Consumer users can use this command only to control sessions they submit

-h

Prints command usage to stdout and exits.

-V

Prints product version to stdout and exits.

Subcommand synopsis

app enable application_name [-u user_name] [-x password]
app disable application_name | all [-f] [-s] [-u user_name] [-x password]
session kill application_name [:session_ID[,session_ID]...] [-m comment] [-u user_name] [-x password]
session kill application_name [-t session_tag] [-m comment] [-u user_name] [-x password]
session suspend application_name [:session_ID[,session_ID]...] [-m comment] [-u user_name] [-x password]
session suspend application_name [-t session_tag] [-m comment] [-u user_name] [-x password]
session resume application_name [:session_ID[,session_ID]...] [-m comment] [-u user_name] [-x password]
session resume application_name [-t session_tag] [-m comment] [-u user_name] [-x password]
task kill application_name:session_ID:task_ID[,task_ID...] [-m comment] [-u user_name] [-x password]

app enable application_name [-u user_name] [-x password]

Enables an application for a consumer with no other enabled applications.

There can only be one enabled application per consumer.

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.

-u user _name

Specifies the name of the user to connect to Platform Symphony for this command. If you are already logged on to Platform 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 Symphony for this command. If you have already logged on to Symphony using soamlogon, for this command only the password you specify here overrides the password you entered in soamlogon.

Enable sampleApp application.

soamcontrol app enable sampleApp

app disable application_name | all [-f] [-s] [-u user_name] [-x password]

Disables a specific application or with the all option, disables all applications to which the specified user has access.

When issued by a cluster administrator, can disable all applications under all consumers in the cluster.

When issued by a consumer administrator, can disable all applications under the consumer this administrator administers.

When an application that has running workload is disabled, all active sessions are immediately killed and all system resources assigned to the application are released.

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.

all

Disables all applications and kills all workload.

-f

Disables the application and kills application workload without warning if there is active workload for the application.

-s

Disables the application and saves recoverable application workload. Prompts for confirmation to disable the workload. Saved workload is recovered when the application is enabled again.

-u user_name

Specifies the name of the user to connect to Platform Symphony for this command. If you have already logged on to Platform Symphony using soamlogon, for this command only the user name you specify here overrides the user name you entered in soamlogon.

-x password

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

Disable all applications

Disable all applications to which the consumer administrator has access.

soamcontrol app disable all -u consumer_admi -x passwd

Disable application and shutdown workload

Disable application sampleApp and shut down any existing workload.

soamcontrol app disable sampleApp -f

session kill application_name  [:session_ID[,session_ID]...] [-m comment] [-u user_name] [-x password]

Terminates all sessions of an application or terminates a specific session of an application. The session runtime data and its tasks (such as output data and current state) are no longer available. However, historical data can be retrieved through the soamview or the Platform Symphony GUI if session and task history is saved.

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 Platform Symphony -assigned ID of the session as reported by soamview session.

-m comment

Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, with the exception of control (Ctrl + key) and multi-byte characters. The description must be enclosed in double quotes (" ") if it contains spaces.

-u user_name

Specifies the name of the user to connect to Platform Symphony for this command. If you are already logged on to Platform 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 Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Kill all sessions

Kill all sessions of the sampleApp application.

soamcontrol session kill sampleApp

Kill specific sessions

Kill sessions 101 and 102 of the sampleApp application.

soamcontrol session kill sampleApp:101,102

session kill application_name  [-t session_tag] [-m comment] [-u user_name] [-x password]

Terminates all sessions of an application or terminates sessions that match the specified session tag of an application. The session run-time data and its tasks (such as output data and current state) are no longer available. However, historical data can be retrieved through the soamview or the Platform Symphony GUI if session and task history is saved.

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.

-t session_tag

Specifies the string that is used for identification purposes to control the session.

-m comment

Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, with the exception of control (Ctrl + key) and multi-byte characters. The description must be enclosed in double quotes (" ") if it contains spaces.

-u user_name

Specifies the name of the user to connect to Platform Symphony for this command. If you are already logged on to Platform 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 Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Kill all sessions that match the session tag

Kill all sessions of the sampleApp application that share the "myTag" session tag.

soamcontrol session kill sampleApp -t myTag

session suspend application_name  [:session_ID[,session_ID]...] [-m comment] [-u user_name] [-x password]

Suspends a session. When a session is suspended, running tasks are killed and rescheduled for rerun when the session is resumed. Pending tasks remain pending. CPU slots used by the session are freed.

Clients can continue to create sessions, send tasks, retrieve task output, and query session and task information.

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.

If specified without one or more session IDs, all sessions of the application are suspended.

session_ID

Specifies the Symphony-assigned ID of the session as reported by soamview session.

-m comment

Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, with the exception of control (Ctrl + key) and multi-byte characters. The description must be enclosed in double quotes (" ") if it contains spaces.

-u user_name

Specifies the name of the user to connect to Platform Symphony for this command. If you are already logged on to Platform 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 Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Suspend all sessions

Suspend all sessions of the sampleApp application.

soamcontrol session suspend sampleApp

Suspend specific sessions

Suspend sessions 101 and 102 of the sampleApp application, giving a reason for the suspension.

soamcontrol session suspend sampleApp:101,102 -m "network congestion"

session suspend application_name  [-t session_tag] [-m comment] [-u user_name] [-x password]

Suspends all sessions of an application or suspends sessions that match the specified session tag of an application. When a session is suspended, running tasks are killed and rescheduled for rerun when the session is resumed. Pending tasks remain pending. CPU slots used by the session are freed.

Clients can continue to create sessions, send tasks, retrieve task output, and query session and task information.

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.

If specified without one or more session IDs, all sessions of the application are suspended.

-t session_tag

Specifies the string that is used for identification purposes to control the session.

-m comment

Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, with the exception of control (Ctrl + key) and multi-byte characters. The description must be enclosed in double quotes (" ") if it contains spaces.

-u user _name

Specifies the name of the user to connect to Platform Symphony for this command. If you are already logged on to Platform 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 Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Suspend all sessions that match the session tag

Suspend all sessions of the sampleApp application that share the "myTag" session tag.

soamcontrol session suspend sampleApp -t myTag -m "network congestion"

session resume application_name [:session_ID[,session_ID...]] [-m comment] [-u user_name] [-x password]

Resumes task processing for a specific suspended session or for multiple sessions.

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.

If specified without one or more session IDs, all sessions of the application are resumed.

session_ID

Specifies the Platform Symphony -assigned ID of the session as reported by soamview session.

-m comment

Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, with the exception of control (Ctrl + key) and multi-byte characters. The description must be enclosed in double quotes (" ") if it contains spaces.

-u user _name

Specifies the name of the user to connect to Platform Symphony for this command. If you are already logged on to Platform 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 Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Resume all sessions

Resume all sessions of the sampleApp application.

soamcontrol session resume sampleApp

Resume a specific session

Resume sessions 101 and 102 of the sampleApp application, giving a reason for the resumption.

soamcontrol session resume sampleApp:101,102 -m "network problem resolved"

session resume application_name  [-t session_tag] [-m comment] [-u user_name] [-x password]

Resumes all sessions of an application or resumes sessions that match the specified session tag of an 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.

If specified without one or more session IDs, all sessions of the application are resumed.

-t session_tag

Specifies the string that is used for identification purposes to control the session.

-m comment

Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, with the exception of control (Ctrl + key) and multi-byte characters. The description must be enclosed in double quotes (" ") if it contains spaces.

-u user _name

Specifies the name of the user to connect to Platform Symphony for this command. If you are already logged on to Platform 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 Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Resume sessions that match the session tag

Resume all sessions of the sampleApp application that match the "myTag" session tag.

soamcontrol session resume sampleApp -t myTag -m "network problem resolved"

task kill application_name:session_ID:task_ID[,task_ID...] [-m comment] [-u user_name] [-x password]

Kills one or more specific tasks in a running or pending session.

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 Platform Symphony -assigned ID of the session as reported by soamview session.

task_ID

Specifies the Platform Symphony -assigned ID of the task as reported by soamview task.

-m comment

Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, with the exception of control (Ctrl + key) and multi-byte characters. The description must be enclosed in double quotes (" ") if it contains spaces.

-u user _name

Specifies the name of the user to connect to Platform Symphony for this command. If you are already logged on to Platform 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 Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Kill specified tasks in a session

Kill tasks 201 and 202 of the sampleApp application in session 101.

task kill sampleApp:101:201,202 -m "tasks hanging"