soamview

The command to display information about applications, sessions, and tasks, and display 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.

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 IBM Spectrum 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 quotation marks (" ").
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 | -w] [-u user_name] [-x password]

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

package application_name [-r host_name] [-s downloading|finish|error|all] [-t time_length] [-w] [-u user_name] [-x password]

policy application_name:[tag_path] [-M][-r] [-u user_name] [-x password]

resource application_name [-a] [-M] [-g resource_group] [-f slot_definition_name] [-s occupied|standby|releasing|all] [-u user_name] [-x password]

resource application_name:[host_name] [-a] [-g resource_group] [-f slot_decinition_name] [-soccupied|standby|releasing|all] [-u user_name] [-x password]

rg application_name [-a [-g resource_group_filter] [-s sessionId|""]] [-M] [-u user_name] [-x password]

service application_name:[service_name] [-r host] [-i session_ID] [-s "Active|Standby|In-active|Backfill"] [-n counter] [-l] [-u user_name] -x password

service application_name:[service_name] -b [-r host] [-n counter] [-u user_name] [-x password]

session application_name:session_ID [-a [-M]|-r|-l] [-u user_name] [-x password]

session application_name [-c create_time_interval] [-e end_time_interval] [-s "all|open|closed|suspended|aborted"] [-t session_tag] [-U submission_user] [-S session_name] [-n counter] [-d] [-r] [-u user_name] [-x password] [-l [-F "attribute1,attribute2,…"]] [-G global_ID]

session application_name [-a [-M]|-r] [-n counter] [-u user_name] [-x password]

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

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

app `application_name` [-l|-p|-w] [-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 quotation marks (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
-l: Provides detailed information. Do not combine with the -w option.
-p: Displays the application profile in XML format. Do not combine with the -w option.
-w: Displays output in a wide format to show any truncated values. Do not combine with the -l and -p options.
-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.

View information for an application

Display summary and brief information for the sampleApp application:

soamview app sampleApp

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

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

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

In IBM Spectrum 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 quotation marks (" ") 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.

To displays information for both enabled and disabled applications, enclose both states in double quotation marks (" ") and use | as a separator. For example:

-s enabled|disabled

-s disabled

Displays information for all disabled applications.

To displays information for both enabled and disabled applications, enclose both states in double quotation marks (" ") and use | as a separator. For example:

-s enabled|disabled

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

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

package `application_name` [-r `host_name`] [-s downloading|finish|error|all] [-t `time_length`] [-w] [-u `user_name`] [-x `password`]

Displays service package download details.

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 quotation marks (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
-r host_name: Displays the package download details of the specified hosts.
-s downloading: Displays the details for packages that are in the process of being downloaded.
-s finish: Displays the details for package downloads that have finished.
-s error: Displays the details for package downloads that have received error messages.
-s all: Displays package download details for the specified application in all states.
-t time_length: Specifies a duration, in seconds, to query package downloads which are either finished or still in progress within the time_length until now.
-w: Specifies wider fields for the host name and package name.
-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.

Display package download details

Display package download summary with wide fields for the specified application:

soamview package app -w

policy `application_name`:[`tag_path`] [-M] [-r] [-u `user_name`] [-x `password`]

Displays all of the active policy tag paths in the scheduling tree for the specified application. It also allows you to see what policy tags have been dynamically created, as in the case of wildcard configuration.

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 quotation marks (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
tag_path: Specifies a specific policy branch or tag path. The output shows how resources are allocated among users of the application.
-M: Displays the priority, demanded metric, deserved metric, and assigned metric for multidimensional resource scheduling at the session level.
-r: When specified, the output not only displays the resource allocation of the specified tag path, but also displays the resource allocation of all its descendants.
-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.

Display all of the active policy tag paths

Display all the active policy tag paths in the scheduling tree for the specified application:

soamview policy app

Display resource usage for a specific policy tag path

Display resource usage for a specific policy branch or tag path in the scheduling tree for the specified application:

soamview policy app:/Project2/UserGroup3

Display resource usage for a specific policy tag path and its descendents

Display resource usage for a specific policy branch or tag path and all its descendents in the scheduling tree for the specified application:

soamview policy app:/Project2/UserGroup3 -r

resource `application_name` [-a] [-M] [-g `resource_group`] [-f `slot_definition_name`] [-s occupied|standby|releasing|all] [-u `user_name`] [-x `password`]

Displays information about host, slots, resource groups, allocation status, and slot definition name of an application.

Note: If the display shows slots in the occupied 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.

The number of slots displayed is the sum of map and reduce slots even though map slots and reduce slots are separate for MapReduce workload.
The service-to-slot ratio displayed is the value of reduceServiceToSlotRatio in the SessionTypes section of the application profile.

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 quotation marks (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
-a: Displays the host, slot, resource group, allocation status, and slot definition name information of the application.
-M: Displays the host, multidimensional resource scheduling metrics, and allocation status of the application.
-g resource_group: Specifies a resource group to filter the results.
-f slot_definition_name: Displays resource allocation information filtered by the name of the slot definition in the multidimensional resource plan.
-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 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.

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

resource `application_name`:`host_name` [-a] [-g `resource_group`] [-f `slot_definition_name`] [-s occupied|standby|releasing|all] [-u `user_name`] [-x `password`]

Displays information about host, slots, resource groups, allocation status, and slot definition name of an application.

The number of slots displayed is the sum of map and reduce slots even though map slots and reduce slots are separate for MapReduce workload.
The service-to-slot ratio displayed is the value of reduceServiceToSlotRatio in the SessionTypes section of the application profile.

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 quotation marks (" ") 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 host, slot, resource group, allocation status, and slot definition name information.
-g resource_group: Specifies a resource group to filter the results.
-f slot_definition_name: Displays resource allocation information filtered by the name of the slot definition in the multidimensional resource plan.
-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 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.

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

rg `application_name` [-a [-g `resource_group_filter`] [-s `sessionId`|""] [-M] [-u `user_name`] [-x `password`]

When no options are specified, the command displays slot use and demand information of each resource group specified in the resource group filter for an application.

When options are specified, the command displays slot use and demand information for each session including the resource group filter, assigned slots, and unmet demand. For slots that cannot be used by any session when the SSM holds them due to "exclusive allocation", the command also displays unassigned slots.

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 quotation marks (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
-a: Displays the resource group filter, assigned and unassigned slots, unmet demand, and slot definition name, at the session level.
-g resource_group_filter: Specifies a resource group to filter the results.
-s sessionId: Specifies a session ID to filter the results.
-s "": Specifies that you want to filter the result for slots that are not allocated to any sessions.
-M: Displays the priority, rank, demanded metric, deserved metric, and assigned metric for multidimensional resource scheduling at the session level.
-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.

Display session-level slot use and demand information for a specific resource group filter

Display slot use and demand information for each open session that uses the ComputeHosts resource group filter:

soamview rg sampleApp -a -g ComputeHosts

service `application_name` [:`service_name`] [-r `host`] [-i `sessionId`] [-s Active|Standby|In-active|Backfill] [-n `counter`] [-l] [-u `user_name`] [-x `password`]

Displays service information, including service name, PID, session ID, task, host, slots, status, and slot definition name, for 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 quotation marks (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
service_name: Specifies the service name defined in the application profile.
-r host: Displays all service instances running on the host. If you do not specify a host name, displays all service instances of all hosts.
-i sessionId: Specifies a session ID to filter the results. Only service instances running for the specified session are displayed. If a session ID is not specified, all service instances are displayed.
-s status: Specifies a service status to filter the results. Only service instances that have the specified status are displayed. To specify multiple statuses, enclose the statuses in double quotation marks (" ") and use | as a separator. For example, -s "Active|Backfill".
-n counter: Returns the maximum number of records specified.
-l: Provides detailed information.
-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.

Display information for service instances running on a host

Display information for all service instances that are running on a specific host:

soamview service sampleApp -r computeHostA

service `application_name` [:`service_name`] -b [-r `host`] [-n `counter`] [-u `user_name`] [-x `password`]

Displays a list of blocked hosts at the service level for 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 quotation marks (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
service_name: Specifies the service name defined in the application profile. The blocked host list for the specified service is displayed. If the service name is not specified, the blocked host list for all services of an application is displayed.
-b: Specifies to display a list of blocked hosts at the service level.
-r host: Specifies the name of a blocked host.
-n counter: Returns the maximum number of records specified.
-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.

Display blocked hosts at the service level without specifying the service name

Display blocked hosts at the service level for any service:

soamview service sampleApp -b

Display services that are blocked on a specific host

Display services that are blocked on host2:

soamview service symping7.1 –b –r host2

session `application_name`:`session_ID` [-a [-M]|-r|-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 quotation marks (" ") 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.
-a: Displays the priority, rank, demanded resources, deserved resources, assigned resources, ratio, resource group, and slot definition name information at the session level.
-M: Displays the priority, rank, demanded metric, deserved metric, and assigned metric for multidimensional resource scheduling at the session level.
-r: Specifies the number of tasks in the Yielded and Resuming states for the session.
-l: Provides detailed information.
-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.

Display information for a specific session of an application

Display detailed information for a specific session of the sampleApp application. This detailed information can include the number of done, error, and canceled tasks the client receives within a session:

soamview session sampleApp:101 -l

session `application_name` [-c `create_time_interval`] [-e `end_time_interval`] [-s all|open|closed|suspended|aborted] [-t `session_tag`] [-U `submission_user`] [-S `session_name`] [-n `counter`] [-d] [-u `user_name`] [-x `password`] [-l [-F `attribute1,attibute2`,…]] [-G `global_ID`]

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 quotation marks (" ") 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.

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.

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

-s all|open|closed|suspended|aborted

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 quotation marks (" ") 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:

all: Specifies that information for sessions in all states is required.
open: Specifies a session that is open.
clsd: Specifies a session that is closed.
susp: Specifies a session that is suspended.
abrt: Specifies a session that is aborted

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.

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

Note: Wildcard characters must be surrounded by quotation marks.

"*"

Represents 0 or more characters.

For example, to display all sessions in the open state (including sessions with and without tags), run:

soamview session symping -t "*" -s open

"?"

Represents a single character.

For example, to display only sessions in the open state that have tags, run:

soamview session symping -t "?*" -s open

"!"

Represents no sessions. For example, to display all sessions in open state that do not have tags, run:

soamview session symping -t "!" -s open

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

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

-d

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

-r

Specifies the number of tasks in the Yielded and Resuming states for the session.

-u user_name

-x password

[-l [-F "attribute1,attribute2,..."]]

If you specify only the -l option, lists detailed information for sessions, such as the session ID, name, and tag.

If you specify the -l option with the -F option and attributes (-l -F "attribute1,attribute2,..."), combines the two options: lists detailed information for sessions, such as the session ID, name, and tag; and works as a filter to only show specific information for sessions (such as to show only the session ID and session name attributes). Valid values are the session attribute names from the command soamview session application_name:sessionID -l.

[-G global_ID]

Applicable to workload placement in IBM Spectrum Symphony Advanced Edition with the multicluster feature (SMC_GLOBAL_PLACEMENT=enabled).

Finds strings that match the specified global session ID. You can use wildcard characters, as follows:

*

Represents 0 or more characters.

For example, to display only sessions with a global ID that starts with 000123, run:

soamview session symping -G 000123-* -s all

?

Represents a single character.

For example, to display only sessions with a global ID that starts with 000123-4567, run:

soamview session symping -G 000123-4567? -s all

!

Represents no global IDs. For example, to display only sessions that do not have global IDs, run:

soamview session symping -G ! -s all

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

Display detailed information for sessions

Display detailed session information for application sampleApp, to list the session ID, name, tag, status, and priority:

soamview session sampleApp -l

If you have IBM Spectrum Symphony Advanced Edition with the multicluster feature and workload placement enabled (SMC_GLOBAL_PLACEMENT=enabled), also shows the global session ID.

Display only specific session information

Display only the session IDs and session names for application sampleApp:

soamview session sampleApp -l -F "Session ID,Session name"

Display only the global session ID for application sampleApp:

Applicable to workload placement in IBM Spectrum Symphony Advanced Edition with the multicluster feature (SMC_GLOBAL_PLACEMENT=enabled).

soamview session sampleApp -l -F "Global Session ID"

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:00 AM January 21, 2009 and 2:00 PM 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

Display sessions with a specific global ID

Applicable to workload placement in IBM Spectrum Symphony Advanced Edition with the multicluster feature (SMC_GLOBAL_PLACEMENT=enabled).

Display sessions with global session ID 000123-4567:

soamview session sampleApp -G 000123-4567

Display sessions by searching by global ID

Applicable to workload placement in IBM Spectrum Symphony Advanced Edition with the multicluster feature (SMC_GLOBAL_PLACEMENT=enabled).

Display sessions with a global session ID that starts with 000123:

soamview session sampleApp -G 000123-* -s all

session `application_name` [-a [-M]|-r] [-n `counter`] [-u `user_name`] [-x `password`]

Displays priority, rank, demanded resources, deserved resources, assigned resources, ratio, resource group, and slot definition name information at the session level for slot based scheduling sessions. Displays priority, rank, demanded metric, deserved metric, and assigned metric for multidimensional resource scheduling 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 quotation marks (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.
-a: Displays the priority, rank, demanded resources, deserved resources, assigned resources, ratio, resource group, and slot definition name information at the session level.
-M: Displays the priority, rank, demanded metric, deserved metric, and assigned metric for multidimensional resource scheduling at the session level.
-r: Specifies the number of tasks in the Yielded and Resuming states for the session.
-n counter: Returns the maximum number of records specified.
-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.

Display information for a slot based scheduling session

Display information for 40 slot base scheduling sessions for the sampleApp application:

soamview session sampleApp -a -n 40

Display information for a multidimensional resource scheduling session

Display information for 40 multidimensional resource scheduling sessions for the sampleApp application:

soamview session sampleApp -M -n 40

task`application_name`:`session_ID`:`task_ID` [-l|-C|-S] [-u `user_name`] [-x `password`]

Displays brief and summary information for a specific task.

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 quotation marks (" ") 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.
-l: Provides detailed information.
-C: Species child sessions associated with a specified task.
-S: Specifies how the resources are used by child tasks of the specified task.
-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.

Display information for a specific task

Display summary and brief information for task ID 4899:

soamview task sampleApp:101:4899

Display information for a specific task, including whether tasks are received by the client

Display summary and detailed information for task ID 4899, including whether or not done, error, and canceled tasks are received by the client:

soamview task sampleApp:101:4899 -l

task `application_name`:`session_ID` [-c `submit_time_interval`] [-b `start_time_interval`] [-e `end_time_interval`] [-s "pending|running|done|error|canceled|yielded|resuming"] [-t `task_tag`] [-n `counter`] [-d] [-C|-S] [-u `user_name`] [-x `password`] [-r `host_name`] [-l [-F `attribute1,attibute2`,…]] [-G `global_ID`]

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

application_name

session_ID

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

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

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

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

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

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

"*"

Represents 0 or more characters.

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

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

"?"

Represents a single character.

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

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

"!"

Represents no tasks. For example, to display all tasks in done state that do not have tags, run:

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.

-d

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

-C

Specifies the child sessions associated with all tasks in a specified session.

-S

Specifies how the resources are used by child tasks of each original (parent) task in a specified session.

-u user_name

-x password

-r host_name

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

[-l [-F "attribute1,attribute2,..."]]

If you specify only the -l option, lists detailed information about tasks for the session, such as the task ID, tag, and status.

If you specify the -l option with the -F option and attributes (-l -F "attribute1,attribute2,..."), combines the two options: lists detailed information about tasks for the session, such as the task ID, tag, and status; Works as a filter to only show specific information for tasks (such as to show only the task ID and task name attributes). Valid values are the task attribute names from the command soamview task application_name:sessionID:taskID -l.

[-G global_ID]

Applicable to workload placement in IBM Spectrum Symphony Advanced Edition with the multicluster feature (SMC_GLOBAL_PLACEMENT=enabled).

Finds strings that match the specified global task ID. You can use wildcard characters, as follows:

*

Represents 0 or more characters.

For example, to display only tasks with a global ID that starts with 000123, run:

soamview task symping -G 000123-* -s all

?

Represents a single character.

For example, to display only tasks with a global ID that starts with 000123-4567, run:

soamview task symping -G 000123-4567? -s all

!

Represents no global IDs. For example, to display only tasks that do not have global IDs, run:

soamview task symping -G ! -s all

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

Display detailed information for tasks

Display detailed task information for application sampleApp for session 101, to list the task ID, tag, status, application, and session ID:

soamview task sampleApp:101 -l

If you have IBM Spectrum Symphony Advanced Edition with the multicluster feature and workload placement enabled (SMC_GLOBAL_PLACEMENT=enabled), also shows the global task ID.

Display only specific task information

Display only the task ID and task tag for application sampleApp for session 101:

soamview task sampleApp:101 -l -F "Task ID,Task tag"

Display only the global task ID for application sampleApp for session 101:

Applicable to workload placement in IBM Spectrum Symphony Advanced Edition with the multicluster feature (SMC_GLOBAL_PLACEMENT=enabled).

soamview task sampleApp:101 -l -F "Global Task ID"

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:00 AM January 21, 2009 and 2:00 PM January 22, 2009 for session 101:

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

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 .

Display tasks with a specific global ID

Applicable to workload placement in IBM Spectrum Symphony Advanced Edition with the multicluster feature (SMC_GLOBAL_PLACEMENT=enabled).

Display tasks with global task ID 123EF2-00001-00001:

soamview task sampleApp:101 -G 123EF2-00001-00001

Display tasks by searching by global ID

Applicable to workload placement in IBM Spectrum Symphony Advanced Edition with the multicluster feature (SMC_GLOBAL_PLACEMENT=enabled).

Display tasks with a global task ID that starts with 123EF2:

soamview task sampleApp:101 -G 123EF2-* -s all

taskattempt `application_name`:`session_ID`:`task_ID`:`attempt_ID` [-l] [-u `user_name`] [-x `password`]

Displays brief and summary information for a specific incomplete attempt.

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 quotation marks (" ") 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.
attempt_ID: Specifies the IBM Spectrum Symphony-assigned ID of the incomplete attempt as reported by soamview taskattempt.
-l: Provides detailed information.
-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.

Display information for a specific incomplete attempt

Display summary and brief information for the third attempt at task 4899 on application sampleApp, using session 101:

soamview taskattempt sampleApp:101:4899:3

taskattempt `application_name`:`session_ID`:`task_ID` [-s All|Retried|Preempted|Reclaimed|RetriedWithoutPenalty|SessionSuspended|SimCommunicationLost|] [-n `counter`] [-d] [-u `user_name`] [-x `password`] [-r `host_name`]

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

application_name

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.

Displays incomplete attempts by retry reason. By default, this is set to All to display incomplete attempts for any retry reason.

You can also filter this to only display the incomplete attempts by a particular retry reason:

Retried
Preempted
Reclaimed
RetriedWithoutPenalty
SessionSuspended
SimCommunicationLost

The retry reasons are not case-sensitive.

-n counter

Returns the maximum number of records specified.

-d

Specifies the reverse order for record retrieval starting with the oldest records being displayed first. By default, incomplete attempts are displayed from newest to oldest.

-u user_name

-x password

-r host_name

Specifies the name of a specific compute host on which the incomplete attempts were running.

The host name is not case-sensitive.

Display information for incomplete attempts for a specific task ID, that matches the specified task retry reason on a specific host

Display summary and brief task information for incomplete attempts for task 4899, for compute host myhost.ibm.com that were retried because the tasks were previously preempted:

soamview taskattempt sampleApp:4899 -s Preempted -r myhost.ibm.com

taskattempt `application_name`:`session_ID` [-s All|Retried|Preempted|Reclaimed|RetriedWithoutPenalty|SessionSuspended|SimCommunicationLost] [-t `task_tag`] [-n `counter`] [-d] [-u `user_name`] [-x `password`] [-r `host_name`]

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

application_name

session_ID

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

Displays incomplete attempts by retry reason. By default, this is set to All to display incomplete attempts for any retry reason.

You can also filter this to only display the incomplete attempts by a particular retry reason:

Retried
Preempted
Reclaimed
RetriedWithoutPenalty
SessionSuspended
SimCommunicationLost

The retry reasons are not case-sensitive.

-t task_tag

Displays information for all incomplete attempts 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 quotation marks.

"*"

Represents 0 or more characters.

For example, to display all incomplete attempts (including incomplete attempts with and without tags), run:

soamview taskattempt sampleApp:101 -t "*"

"?"

Represents a single character.

For example, to display only incomplete attempts that have tags, run:

soamview taskattempt sampleApp:101 -t "?*"

"!"

Represents no tasks. For example, to display all incomplete attempts that do not have tags, run:

soamview taskattempt sampleApp:101 -t "!"

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.

-d

Specifies the reverse order for record retrieval starting with the oldest records being displayed first. By default, incomplete attempts are displayed from newest to oldest.

-u user_name

-x password

-r host_name

Specifies the name of a specific compute host on which the incomplete attempts were running.

The host name is not case-sensitive.

Display information for incomplete attempts for tasks with tags that match the specified task retry reason on a specific host

Display summary and brief task information for incomplete attempts on compute host myhost.ibm.com that were retried because the tasks were previously preempted, and to display only task that have tags:

soamview taskattempt sampleApp:101 -s Preempted -t "?*" -r myhost.ibm.com

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: A four-digit number representing the calendar year.
month: A number from 1 to 12, where 1 is January and 12 is December.
day: A number from 1 to 31, representing the day of the month.
hour: An integer from 0 to 23, representing the hour of the day on a 24-hour clock.
minute: 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, 5/ specifies the month of May, starting from May 1 at 00:00 AM and ending at the last possible minute in May (that is, May 31 at midnight).

Absolute time examples

Using the example of the current time as May 9 17:06 2008, here are some absolute time examples and their meanings:

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/: February 1 00:00 2008 to February 28 23:59 2008.
/12:: May 9 12:00 2008 to May 9 12:59 2008.
2/1: February 1 00:00 2008 to Feb 1 23:59 2008.
2/1,: February 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 December 31, 2001 00:00:00 to May 1, 2008 23:59:59.

Relative time examples

Here are some relative time examples and their meanings:

.-9,: April 30 17:06 2008 to the current time.
,.-2/: The time of the first occurrence to March 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,
```

soamview

Synopsis

Description

Subcommand synopsis

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

View information for an application

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

Display information for all applications in the consumer

package application_name [-r host_name] [-s downloading|finish|error|all] [-t time_length] [-w] [-u user_name] [-x password]

Display package download details

policy application_name:[tag_path] [-M] [-r] [-u user_name] [-x password]

Display all of the active policy tag paths

Display resource usage for a specific policy tag path

Display resource usage for a specific policy tag path and its descendents

resource application_name [-a] [-M] [-g resource_group] [-f slot_definition_name] [-s occupied|standby|releasing|all] [-u user_name] [-x password]

Display session-level host and slots allocation for an application

resource application_name:host_name [-a] [-g resource_group] [-f slot_definition_name] [-s occupied|standby|releasing|all] [-u user_name] [-x password]

Display host and slots allocation for an application

Display session-level host and slots allocation for an application

rg application_name [-a [-g resource_group_filter] [-s sessionId|""] [-M] [-u user_name] [-x password]

Display session-level slot use and demand information for a specific resource group filter

service application_name [:service_name] [-r host] [-i sessionId] [-s Active|Standby|In-active|Backfill] [-n counter] [-l] [-u user_name] [-x password]

Display information for service instances running on a host

service application_name [:service_name] -b [-r host] [-n counter] [-u user_name] [-x password]

Display blocked hosts at the service level without specifying the service name

Display services that are blocked on a specific host

session application_name:session_ID [-a [-M]|-r|-l] [-u user_name] [-x password]

Display information for a specific session of an application

session application_name [-c create_time_interval] [-e end_time_interval] [-s all|open|closed|suspended|aborted] [-t session_tag] [-U submission_user] [-S session_name] [-n counter] [-d] [-u user_name] [-x password] [-l [-F attribute1,attibute2,…]] [-G global_ID]

Display detailed information for sessions

Display only specific session information

Display information for sessions submitted by a specific user

Display information for sessions that match the session tag

Display information for sessions with the specified session name

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

Display information for sessions that were created during a specified interval

Display sessions with a specific global ID

Display sessions by searching by global ID

session application_name [-a [-M]|-r] [-n counter] [-u user_name] [-x password]

Display information for a slot based scheduling session

Display information for a multidimensional resource scheduling session

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

Display information for a specific task

Display information for a specific task, including whether tasks are received by the client

Display detailed information for tasks

Display only specific task information

Display information for specific tasks that match a task tag

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

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

Display tasks with a specific global ID

Display tasks by searching by global ID

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

Display information for a specific incomplete attempt

taskattempt application_name:session_ID:task_ID [-s All|Retried|Preempted|Reclaimed|RetriedWithoutPenalty|SessionSuspended|SimCommunicationLost|] [-n counter] [-d] [-u user_name] [-x password] [-r host_name]

Display information for incomplete attempts for a specific task ID, that matches the specified task retry reason on a specific host

taskattempt application_name:session_ID [-s All|Retried|Preempted|Reclaimed|RetriedWithoutPenalty|SessionSuspended|SimCommunicationLost] [-t task_tag] [-n counter] [-d] [-u user_name] [-x password] [-r host_name]

Display information for incomplete attempts for tasks with tags that match the specified task retry reason on a specific host

Time interval format

Absolute time examples

Relative time examples

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

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

package `application_name` [-r `host_name`] [-s downloading|finish|error|all] [-t `time_length`] [-w] [-u `user_name`] [-x `password`]

policy `application_name`:[`tag_path`] [-M] [-r] [-u `user_name`] [-x `password`]

resource `application_name` [-a] [-M] [-g `resource_group`] [-f `slot_definition_name`] [-s occupied|standby|releasing|all] [-u `user_name`] [-x `password`]

resource `application_name`:`host_name` [-a] [-g `resource_group`] [-f `slot_definition_name`] [-s occupied|standby|releasing|all] [-u `user_name`] [-x `password`]

rg `application_name` [-a [-g `resource_group_filter`] [-s `sessionId`|""] [-M] [-u `user_name`] [-x `password`]

service `application_name` [:`service_name`] [-r `host`] [-i `sessionId`] [-s Active|Standby|In-active|Backfill] [-n `counter`] [-l] [-u `user_name`] [-x `password`]

service `application_name` [:`service_name`] -b [-r `host`] [-n `counter`] [-u `user_name`] [-x `password`]

session `application_name`:`session_ID` [-a [-M]|-r|-l] [-u `user_name`] [-x `password`]

session `application_name` [-c `create_time_interval`] [-e `end_time_interval`] [-s all|open|closed|suspended|aborted] [-t `session_tag`] [-U `submission_user`] [-S `session_name`] [-n `counter`] [-d] [-u `user_name`] [-x `password`] [-l [-F `attribute1,attibute2`,…]] [-G `global_ID`]

session `application_name` [-a [-M]|-r] [-n `counter`] [-u `user_name`] [-x `password`]

task`application_name`:`session_ID`:`task_ID` [-l|-C|-S] [-u `user_name`] [-x `password`]

taskattempt `application_name`:`session_ID`:`task_ID`:`attempt_ID` [-l] [-u `user_name`] [-x `password`]

taskattempt `application_name`:`session_ID`:`task_ID` [-s All|Retried|Preempted|Reclaimed|RetriedWithoutPenalty|SessionSuspended|SimCommunicationLost|] [-n `counter`] [-d] [-u `user_name`] [-x `password`] [-r `host_name`]

taskattempt `application_name`:`session_ID` [-s All|Retried|Preempted|Reclaimed|RetriedWithoutPenalty|SessionSuspended|SimCommunicationLost] [-t `task_tag`] [-n `counter`] [-d] [-u `user_name`] [-x `password`] [-r `host_name`]