Controls applications and sessions.
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
Enables an application for a consumer with no other enabled applications.
There can only be one enabled application per consumer.
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.
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.
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.
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.
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.
Disables the application and kills application workload without warning if there is active workload for the application.
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.
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.
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.
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.
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.
Specifies the Platform Symphony -assigned ID of the session as reported by soamview session.
Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), or control characters (Ctrl + key). The description must be enclosed in double quotes (" ") if it contains spaces.
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.
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.
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.
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.
Specifies the string that is used for identification purposes to control the session.
Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), or control characters (Ctrl + key). The description must be enclosed in double quotes (" ") if it contains spaces.
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.
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.
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.
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.
Specifies the Symphony-assigned ID of the session as reported by soamview session.
Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), or control characters (Ctrl + key). The description must be enclosed in double quotes (" ") if it contains spaces.
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.
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.
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.
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.
Specifies the string that is used for identification purposes to control the session.
Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), or control characters (Ctrl + key). The description must be enclosed in double quotes (" ") if it contains spaces.
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.
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.
Resumes task processing for a specific suspended session or for multiple sessions.
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.
Specifies the Platform Symphony -assigned ID of the session as reported by soamview session.
Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), or control characters (Ctrl + key). The description must be enclosed in double quotes (" ") if it contains spaces.
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.
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.
Resumes all sessions of an application or resumes sessions that match the specified session tag of an application.
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.
Specifies the string that is used for identification purposes to control the session.
Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), or control characters (Ctrl + key). The description must be enclosed in double quotes (" ") if it contains spaces.
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.
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.
Kills one or more specific tasks in a running or pending session.
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.
Specifies the Platform Symphony -assigned ID of the session as reported by soamview session.
Specifies the Platform Symphony -assigned ID of the task as reported by soamview task.
Specifies a reason why this action was requested. The reason can comprise up to 256 alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), single quote (’) on Windows, or control characters (Ctrl + key). The description must be enclosed in double quotes (" ") if it contains spaces.
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.
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.