IOMOPERATE Procedure

LIST Statement

Lists to the console various attributes of the connected server.
CONNECT and LIST Examples Using a Spawner

LIST TYPES Example

Syntax

Optional Arguments

ABANDONED SERVERS
lists servers that were abandoned by the object spawner. You can use ABANDONED SERVERS only when you are connected to an object spawner.
ABANDONED SERVERS returns the logical name, server component name, server class UUID, process owner user ID, and the unique ID of the server as known by the spawner.
FILTER=
specifies a substring that is matched against logical name and server component name.
The LIST statement returns only those servers with logical or component names matched by the filter.
string
is an alphanumeric string that attempts to match server logical or component names.
Note The filter does not support wildcard characters. The search is case-insensitive.
OUT=
writes LIST statement output to a SAS data set.
data-set-name
is the name of a valid SAS data set or the form libname.data-set-name. data-set-name can be a regular data set name or take the form: libname.datasetname.
SAS creates the data set if it does not exist and overwrites it if it does exist. There is no requirement on location. If you can successfully reference the data set in a SAS DATA STEP statement, then you can use the data set here.
Requirement You must have the proper permissions to write the data set.
Note There is no requirement about where the data set is located.
Alias ABANDONED
ATTRIBUTES
lists the attributes of the connected server.
CATEGORY=
specifies an attribute category used to match a list of server attributes
category
is an alphanumeric, case-sensitive string that represents a valid attribute category.
Alias CAT=
Default Appenders, Counters, Information, Loggers, and Properties.
Note You must also specify a category when using NAME=.
Example
list attrs cat = "Counters";
NAME=
specifies a name used to match a specific attribute name.
name
is an alphanumeric, case-sensitive string that represents a valid attribute name.
Note You must also specify a category when using NAME=.
Example
list attrs cat = "Information" name = "Server.ProcessIdentifier";
FILTER=
specifies a string used to match a specific attribute name.
string
is an alphanumeric, case-sensitive string that attempts to match server attribute categories.
Notes For all categories, the filter only returns a match if the specified string ends with a period. For example, the filter string App will return a match for App.Program.
FILTER attempts to match attributes across all categories, unless you also specify CATEGORY= to narrow the match to one category.
Example
list attrs filter = "Server.";
VERBOSE
indicates that type, description, and the writability of the attribute should be returned in addition to attribute name and value.
Alias ATTRS
Requirement You must be the owner of the server or cluster process or have the administer permission in SAS metadata for the server to see all attributes.
CATEGORIES
lists the attribute categories that are supported by the connected server.
CLASSIDS
lists the class UUIDs supported by the connected server.
Alias CLSIDS
CLIENTS
lists the clients that are currently connected to the server.
CLUSTERS
lists the load-balanced clusters defined in the connected server.
COMMANDS
lists all of the commands that are available based on the IOM interfaces supported by the connected server.
CONTROL INFORMATION
lists some of the operations supported by the connected server.
Alias CONTROL INFO
DEFINED
lists the servers defined in the connected server. If connected to an object spawner, this argument lists the servers that the spawner can launch.
FILTER=
specifies a substring that is matched against logical name and server component name.
string
is an alphanumeric string that attempts to match server logical or component names.
Note The filter does not support wildcard characters. The search is case-insensitive.
Alias SERVERS, DEFINED SERVERS
DNSNAME
lists the domain name service (DNS) facility of the connected server.
INFORMATION
lists some information about the connected server.
Alias INFO
LOG
attempts to list the current log from the connected server.
FILTER=
specifies the filter with which a match is attempted.
If no filter is specified, then "columns=message" is used as the default.
"filter"
is a series of name-value pairs that are delimited by spaces. Valid name-value pairs are as follows:
name=logger-name
specifies a logger.
Default When name= is not specified, all loggers are listed.
Example
list log filter=’name=App.Server.Logger’
start=ddmmmyyyy:hh:mm:ss
specifies the starting date and time of log entries to be listed.
Example
list log filter="start=01aug2011:08:00:00 name=App.Server.Logger"
end=ddmmmyyyy:hh:mm:ss
specifies the ending date and time of log entries to be listed.
Default When end= is not specified, the current date and time is used.
Example
list log filter='end=31aug2011:17:00:00 name=App.Server.Logger'
level=<TRACE>, <DEBUG>, <INFO>, <WARN>, <ERROR>, <FATAL>
specifies the log level of log entries to list.
Default When level= is not specified, all levels are listed.
Example
LIST LOG filter="level=warn,error name=App.Server.Logger"
threshold=<TRACE> | <DEBUG> | <INFO> | <WARN> | <ERROR> | <FATAL>
specifies the minimum level of log entries to list.
Note The value level= takes precedence over threshold=. When threshold= is not used, all levels are listed.
Example
list log filter="threshold=error name=App.Server.Logger"
"columns=(<name>, <level>, <message>, <datetime>)"
specifies one or more logger columns to list.
Default When no column name is specified, message is the default.
Example
list log filter='columns=(name,datetime) name=App.Server.Logger'
LOG CONFIGURATION
lists the baseline configuration being used by the logging system in the connected server.
LOG CONFIGURATION does not list modifications that might have been made by code or by submitting a partial configuration file.
Alias LOG CONFIG, LOG CFG
Note The configuration is transcoded into the current session locale and, if it is printing to the log, the output is in XML format.
NAME
lists the name of the connected server.
PERFORMANCE
lists the following performance metrics for the connected server:
TotalRealExecutionTime total time spent on calls.
TotalSystemCPUTime total system CPU time spent on calls.
TotalUserCPUTime total user CPU time spent on calls.
TotalCalls total calls to the server.
ElapsedObjectTime elapsed time since the server object was launched.
ElapsedServerTime elapsed time since the server object was last started.
Status current state of server. The potential states are:
NotStarted
0
Server is still being configured by an administrator.
StartPending
1
Server has received start command but has not finished processing it.
Running
2
Server has been started and is accepting all requests.
PausePending
3
Server has received pause command but has not finished processing it.
Paused
4
Server has been paused and is not accepting new work.
ContiuePending
5
Server has received continue command but has not finished processing it.
DeferredStop
6
Server is not accepting new sessions and will stop when all client work is complete.
StopPending
7
Server is not accepting new work and is in the process of shutting down.
Stopped
8
Server is down.
Alias PERF
SERVERTIME
lists the current time as it is known by the connected server.
Alias STIME
SESSIONS
lists the active sessions in the connected server.
SPAWNED SERVERS
lists the servers that have been spawned by this spawner. This option is supported only when the specified server is connected to an object spawner.
FILTER=
specifies a substring that is matched against logical name and server component name. The LIST statement returns only those servers with logical or component names matched by the filter.
string
is an alphanumeric string that attempts to match server logical or component names.
Note The filter does not support wildcard characters. The search is case-insensitive.
Alias SPAWNED, LAUNCHED
STATE
lists the state of the connected server.
TYPES
lists the server types known to IOMOPERATE.
LIST TYPES prints the server name, short name, and class UUID for each server known by IOMOPERATE. Any of these can be passed as the TYPE= parameter when connecting to a server.
Note LIST TYPES does not require a connection. It is a client-side operation and only lists the server types that PROC IOMOPERATE knows about.
UNIQUEID
lists the UUID for the server.