soamview

Displays information about applications, sessions, and tasks, and displays the application profile.

Synopsis

soamview subcommand [options]
soamview subcommand -h
soamview -h | -V

Description

Use soamview to view information about applications, sessions, and tasks, and to view the application profile.

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

In Symphony, the information soamview displays depends on your user ID authorization, as follows:

  • The cluster administrator can view all information.

  • The consumer administrator can view information for all applications associated with that consumer. To specify an absolute consumer name that contains spaces, enclose the name in double quotes (" ").

  • Users can view information for only those applications their user privileges allow, the applications they submitted.

To view large amounts of information (when output exceeds one screen), pipe or redirect the command output to a file.

The application totals displayed by soamview reflect the values of counters that start when the application is enabled or when a new session manager starts for this application (in a failover event). These counters are reset when the application is disabled or the session manager exits. The session and task totals soamview displays reflect counters in session and task runtime and historical data.

Note:

The information listed for SI startup failures lists the last five hosts on which a service instance failed to start. If more than five hosts experienced SI startup failures, only the last five hosts are listed.

-h

Prints command usage to stdout and exits.

-V

Prints product version to stdout and exits.

Subcommand synopsis

app application_name [-l | -p] [-u user_name] [-x password]
app [-c consumer_ID] [-s "all|disabled|enabled"] [-u user_name] [-x password]
session application_name [-s "all|open|closed|suspended|aborted"] [-t session_tag] [-U submission_user] [-n counter] [-u user_name] [-x password]
session application_name:session_ID [-l] [-u user_name] [-x password]
task application_name:session_ID [-s "task_state"] [-t task_tag] [-n counter] [-u user_name] [-x password]
task application_name:session_ID:task_ID [-l] [-u user_name] [-x password]

app application_name [-l | -p] [-u user_name] [-x password]

Displays brief and summary information for a specific 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.

-l

Provides detailed information.

-p

Displays the application profile in XML format.

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

View information for an application

Display summary and brief information for the sampleApp application.

soamview app sampleApp

app [-c consumer_ID] [-s "all | disabled | enabled"] [-u user_name] [-x password]

Displays information about all enabled and disabled applications the user manages.

In Symphony DE, users have access to information on all applications and do not need to supply the application name, consumer ID, user name, or password.

In Platform Symphony, users without cluster or consumer privileges must provide an application name. Users can view information only for applications, sessions, and tasks they submitted.

-c consumer_ID

Specifies the consumer ID. The consumer ID is the same as it appears in the application profile. Enclose the consumer ID in double quotes (" ") if it contains spaces. The consumer ID starts with a forward slash.

-s all

Displays information for all applications in all states.

-s enabled

Displays information for all enabled applications.

-s disabled

Displays information for all disabled applications.

-s "enabled | disabled"

Displays information for all enabled and disabled applications. Enclose the states in double quotes (" ") and use | as a separator. For example, -s "enabled|disabled".

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

Display information for all applications in the consumer

Display summary and brief information for all applications in the /SampleApplications/SOATesting consumer.

soamview app -c /SampleApplications/SOATesting -s all

session application_name [-s "all | open | closed | suspended | aborted"] [-t session_tag] [-U submission_user] [-n counter] [-u user_name] [-x password]

Displays information for sessions in various states. When used without the -s option, displays only information for open 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.

-s all

Specifies that information for sessions in all states is required.

-s session_state

Specifies that information for all sessions in one or more of the specified states is required. To specify multiple states, enclose the states in double quotes (" ") and use | as a separator. For example, -s "open|suspended".

Only the first three letters of the state need to be specified.

You can specify an abbreviated form of the session state:

  • aborted—abrt

  • open—open

  • suspended—susp

  • closed—clsd

Tip:

The soamview session -s aborted command displays information only for sessions that were aborted during the time period specified by lastingPeriod in the application profile.

-t session_tag

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

-U submission_user

Displays information for sessions submitted by the user specified.

-n counter

Returns the maximum number of records specified.

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

Display session information for sessions submitted by a specific user

Display information for 40 open or suspended sessions for the sampleApp application that were submitted by userabc.

soamview session sampleApp -s "open|susp" -U userabc -n 40

Display session information for sessions that match the session tag

Display information for open or closed sessions for the sampleApp application that match the "myTag" session tag.

soamview session sampleApp -s "open|closed" -t myTag

session application_name:session_ID [-l ] [-u user_name] [-x password]

Displays brief and summary information for a specific session 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.

session_ID

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

-l

Provides detailed information.

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

Display information for a specific session of an application

Display detailed information for a specific session of the sampleApp application.

soamview session sampleApp:101 -l

task application_name: session_ID [-s "task_state"] [-t task_tag] [-n counter] [-u user_name] [-x password]

Displays brief and summary task information for a specific task 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.

session_ID

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

-s task_state

Displays information for all tasks in the state specified.

’You can specify the full task state name or the first three letters of the task state:

  • pending

  • running

  • done

  • error

  • canceled

-t task_tag

Displays information for all tasks that match the task tag.

The task tag supports the use of wildcard characters to represent specific string patterns, as follows:

Note:

Wildcard characters must be surrounded by quotes.

  • "*" represents 0 or more characters

    For example, to display all tasks in the done state (including tasks with and without tags), enter:

    soamview task symping:901 -t "*" -s done

  • "?" represents 1 character

    For example, to display only tasks in the done state that have tags, enter:

    soamview task symping:901 -t "?*" -s done

The task tag also supports the use of reserved character "!" to indicate no task tag. For example, to display all tasks in the done state that do not have tags, enter:

soamview task symping:901 -t "!" -s done

Note:

The "!" tag is a standalone reserved character and cannot be used to negate a regular expression.

-n counter

Returns the maximum number of records specified.

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

Display information for specific tasks

Display summary and brief task information for running tasks tagged as myTask.

soamview task sampleApp:101 -s running -t myTask

task application_name: session_ID:task_ID [-l ] [-u user_name] [-x password]

Displays brief and summary information for a specific task.

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.

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.

-l

Provides detailed information.

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

Display information for a specific task

Display summary and brief information for task ID 4899.

soamview task sampleApp:101:4899