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]
resource application_name [:host_name] [-a] [-g resource_group] [-s allocated|standby|all] [-u user_name] [-x password]
session application_name [-c create_time_interval] [-e end_time_interval] [-d] [-s "all|open|closed|suspended|aborted"] [-t session_tag] [-U submission_user] [-S session_name] [-n counter] [-u user_name] [-x password]
session application_name:session_ID [-l] [-u user_name] [-x password]
task application_name:session_ID [-b start_time_interval] [-c submit_time_interval] [-d] [-e end_time_interval] [-s "task_state"] [-t task_tag] [-n counter] [-r host_name] [-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

resource application_name [: host_name] [-a] [-g resource_group] [-s allocated|standby|all] [-u user_name] [-x password]

Displays information about host slots and allocation status of an application.

Note:

If the display shows slots in the allocated state without an associated session, this means that the slots are allocated to the SSM but are not bound to any session.

Slots in the standby state are always displayed without an associated session since these slots are not allocated to 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.

host_name

Displays the allocation of the specified host.

-a

Displays the hosts and slots allocation information at the session level.

-g resource_group

Specifies a resource group to filter the results.

-s slot_state

Specifies that information for slots in the given state is required.

-s all

Specifies that information for slots in all states is required.

-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 host and slots allocation for an application

Display allocation information of the hosts and slots for the sampleApp application.

Note:

If the -s option is not specified, only allocated hosts and slots are displayed.

soamview resource sampleApp -s all

Display session-level host and slots allocation for an application

Display allocation information for each open session of the sampleApp application.

soamview resource sampleApp -a -s all

session application_name [-c create_time_interval] [-e end_time_interval] [-d] [-s "all | open | closed | suspended | aborted"] [-t session_tag] [-U submission_user] [-S session_name] [-n counter] [-u user_name] [-x password]

Displays information for sessions in various states. By default, sessions are displayed from newest to oldest. 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.

-c create_time_interval

Specifies the interval for the session creation time. If you specify the session creation time interval without an end time, the interval end time is considered the time at which you entered the command.

Specify the time in the format "[[yyyy/][mm/][dd/]hh:mm], [[yyyy/][mm/][dd/]hh:mm]". Do not specify spaces in the time interval string. For more specific syntax and examples of time formats, refer to Time interval format.

Note:

(If the interval for session creation time is not specified, the default is anytime.

-e end_time_interval

Specifies the interval for the session end time. If you specify the session end time interval without a session creation time interval, the system retrieves all relevant records prior to the session end time.

Specify the time interval in the format "[[yyyy/][mm/][dd/]hh:mm], [[yyyy/][mm/][dd/]hh:mm]". Do not specify spaces in the time interval string. For more specific syntax and examples of time formats, refer to Time interval format.

Note:

(If the interval for session end time is not specified, the default is anytime.

-d

Specifies the reverse order for record retrieval starting with the oldest records being displayed first.

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

Note:

If the session state is not specified, the default state is open|suspended.

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

-S session_name

Displays information for sessions with the specified session name.

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

Display information for sessions with the specified session name

Display information for sessions with the "mySession" session name.

soamview session sampleApp -s "open|closed" -S mySession

Display information for sessions that match the specified session state during a specified time interval

Display information for sessions that were running during the specified interval. In this example, the system will return all sessions that were open or suspended between 10:00am January 21, 2009 and 2:00pm January 22, 2009.

soamview session sampleApp -s "all" -c ,2009/01/22/14:00 -e 2009/01/21/10:00,-

Display information for sessions that were created during a specified interval

Display information for all sessions that were created during the specified interval.

soamview session sampleApp -s "all" -c 2009/01/21/10:00, 2009/01/23/10:00

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 [-b start_time_interval] [-c submit_time_interval] [-d] [-e end_time_interval] [-r host_name] [-s "task_state"] [-t task_tag] [-n counter] [-u user_name] [-x password]

Displays brief and summary task information for tasks of an application. By default, tasks are displayed from newest to oldest.

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.

-b start_time_interval

Specifies the interval for when the task started to run.

Note:

In cases where the task has been restarted, the start time represents the last time the task started to run.

Specify the time interval in the format "[[yyyy/][mm/][dd/]hh:mm], [[yyyy/][mm/][dd/]hh:mm]". Do not specify spaces in the time interval string. For more specific syntax and examples of time formats, refer to Time interval format.

-c submit_time_interval

Specifies the interval for the task submit time. If you specify the task submit time interval without an interval end time, the interval end time is considered the time at which you entered the command.

Specify the time interval in the format "[[yyyy/][mm/][dd/]hh:mm], [[yyyy/][mm/][dd/]hh:mm]". Do not specify spaces in the time interval string. For more specific syntax and examples of time formats, refer to Time interval format.

-d

Specifies the reverse order for record retrieval starting with the oldest records being displayed first.

-e end_time_interval

Specifies the interval for the task end time. If you specify the task end time without a task submit time, the system retrieves all relevant records prior to the task end time.

Specify the time interval in the format "[[yyyy/][mm/][dd/]hh:mm], [[yyyy/][mm/][dd/]hh:mm]". Do not specify spaces in the time interval string. For more specific syntax and examples of time formats, refer to Time interval format.

-r host_name

Specifies the name of a specific compute host that the tasks were running on.

-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 that match a task tag

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

soamview task sampleApp:101 -s running -t myTask

Display information for tasks that match a specified task state and submission time

Display summary and brief task information for currently running tasks that were submitted during the specified interval.

soamview task sampleApp:101 -s running -c 2009/01/21/10:00, 2009/01/21/11:00

Display information for tasks that match the specified task state during a specified time interval

Display summary and brief task information for tasks that were running during the specified interval. In this example, the system will return all tasks that were running between 10:00am January 21, 2009 and 2:00pm January 22, 2009 for session 101.

Note:

To locate the relevant session IDs, you should first display the sessions that were running during the specific interval and take note of the IDs .

soamview task sampleApp:101 -s running -c ,2009/01/22/14:00 -e 2009/01/21/10:00,-

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

Time interval format

You use the time interval to define a start and end time for collecting the data to be retrieved and displayed. While you can specify both a start and an end time, you can also let one of the values default. You can specify either of the times as an absolute time, by specifying the date or time, or you can specify them relative to the current time.

Specify the time interval as follows:

start_time,end_time|start_time,-|-,end_time|start_time

Specify start_time or end_time in the following format:

[[year/][month/][day]/hour:minute]

Where:

  • year is a four-digit number representing the calendar year.

  • month is a number from 1 to 12, where 1 is January and 12 is December.

  • day is a number from 1 to 31, representing the day of the month.

  • hour is an integer from 0 to 23, representing the hour of the day on a 24-hour clock.

  • minute is an integer from 0 to 59, representing the minute of the hour.

start_time,end_time

Specifies both the start and end times of the interval.

start_time,-

Specifies a start time, and lets the end time default to now.

,end_time

Specifies to start with the first logged occurrence, and end at the time specified.

start_time

Starts at the beginning of the most specific time period specified, and ends at the maximum value of the time period specified. For example, 2/ specifies the month of February—start February 1 at 00:00 a.m. and end at the last possible minute in February: February 28th at midnight.

Absolute time examples

Assume the current time is May 9 17:06 2008:

2008/5/8/13: = May 8 13:00 to May 8 13:59

2008/5/8/13:, = May 8 13:00 to the current time

2008/5/8/13:30 = May 8 13:00:00 to May 8 13:30:59

2008/5/8/13:30, = May 8 13:00:00 to the current time

1,8 = May 1 00:00 2008 to May 8 23:59 2008

,4 = the time of the first occurrence to May 4 23:59 2008

6 = May 6 00:00 2008 to May 6 23:59 2008

2/ = Feb 1 00:00 2008 to Feb 28 23:59 2008

/12: = May 9 12:00 2008 to May 9 12:59 2008

2/1 = Feb 1 00:00 2008 to Feb 1 23:59 2008

2/1, = Feb 1 00:00 to the current time

,2/10: = the time of the first occurrence to May 2 10:59 2008

2001/12/31,2008/5/1 = from Dec 31, 2001 00:00:00 to May 1st 2008 23:59:59

Relative time examples

.-9, = April 30 17:06 2008 to the current time

,.-2/ = the time of the first occurrence to Mar 7 17:06 2008

.-9,.-2 = nine days ago to two days ago (April 30, 2008 17:06 to May 7, 2008 17:06)

Here are some relative time examples expressed in a command string:

  • Display sessions that were created 1 minute ago:

    soamview session sampleApp -c .-:1,

  • Display sessions that were created 2 hours ago:

    soamview session sampleApp -c .-2:,

  • Display sessions that were created 3 days ago:

    soamview session sampleApp -c .-3,