Service Command Reference


Table 1. STAF Service Command Reference
Command Syntax
DELAY Delay (or sleep) a number of milliseconds.

DELAY <Milliseconds>
 
HELP
DIAG Allows diagnostics to be recorded, listed, enabled, disabled, and reset.

RECORD TRIGGER <Trigger> SOURCE <Source>
 
LIST   < [TRIGGER <Trigger> | SOURCE <Source> | TRIGGERS | SOURCES]
         [SORTBYCOUNT | SORTBYTRIGGER | SORTBYSOURCE] > |
       SETTINGS
 
RESET  FORCE
 
ENABLE
 
DISABLE
 
HELP
ECHO Echo a return string from other STAF clients.

ECHO <Message>
 
HELP
FS Allows you to manipulate files and directories.

COPY   FILE <Name> [TOFILE <Name>] [TOMACHINE <Machine>]
       [TEXT [FORMAT <Format>]]
       [FAILIFEXISTS | FAILIFNEW]
 
COPY   DIRECTORY <Name> [TODIRECTORY <Name>]  [TOMACHINE <Machine>]
       [NAME <Pattern>]  [EXT <Pattern>] [CASESENSITIVE | CASEINSENSITIVE]
       [TEXTEXT <Pattern>... [FORMAT <Format>]]
       [RECURSE [KEEPEMPTYDIRECTORIES | ONLYDIRECTORIES]]
       [IGNOREERRORS] [FAILIFEXISTS | FAILIFNEW]
 
GET    FILE <Name> [[TEXT | BINARY] [FORMAT <Format>]]
 
GET    ENTRY <Name> <TYPE | SIZE | MODTIME>
 
QUERY  ENTRY <Name>
 
CREATE DIRECTORY <Name> [FULLPATH] [FAILIFEXISTS]
 
LIST   DIRECTORY <Name> [NAME <Pattern>] [EXT <Pattern>] [TYPE <Types>]
       [SORTBYNAME | SORTBYSIZE | SORTBYMODTIME]
       [CASESENSITIVE | CASEINSENSITIVE] [LONG [DETAILS]]
 
LIST   COPYREQUESTS [LONG] [INBOUND] [OUTBOUND]
       [FILE [[BINARY] [TEXT]]] [DIRECTORY]
 
LIST   SETTINGS
 
DELETE ENTRY <Name> [CHILDREN [NAME <Pattern>] [EXT <Pattern>] [TYPE <Types>]
       [CASESENSITIVE | CASEINSENSITIVE]] [RECURSE] [IGNOREERRORS] CONFIRM
 
SET    STRICTFSCOPYTRUST <Enabled | Disabled>
 
HELP
HANDLE Allows you to query information on various process handles and to manage static handles.

CREATE HANDLE NAME <Handle Name>
 
DELETE HANDLE <Number>
 
QUERY HANDLE <Handle>
 
LIST [HANDLES [NAME <Handle Name>] [PENDING]  [REGISTERED]  [INPROCESS]  [STATIC]]
 
LIST NOTIFICATIONS [HANDLE <Handle> | MACHINE <Machine>]
 
AUTHENTICATE USER <User Identifier> CREDENTIALS <Credentials>
             [AUTHENTICATOR <Authenticator Name>]
 
UNAUTHENTICATE
 
HELP
HELP List and query STAF return codes. Allows services to register their own return codes.

REGISTER   SERVICE <Name> ERROR <Number> INFO <String> DESCRIPTION <String>
 
UNREGISTER SERVICE <Name> ERROR <Number>
 
[SERVICE <Name>] ERROR <Number>
 
LIST SERVICES | [SERVICE <Name>] ERRORS
 
HELP
LOG Allows for robust data-logging and log file querying and manipulation.

LOG    <GLOBAL | MACHINE | HANDLE> LOGNAME <Logname> LEVEL <Level>
       MESSAGE <Message> [RESOLVEMESSAGE | NORESOLVEMESSAGE]
 
QUERY  <GLOBAL | MACHINE <Machine> [HANDLE <Handle>] LOGNAME <Logname>
       [LEVELMASK <Mask>] [QMACHINE <Machine>]... [QHANDLE <Handle>]...
       [NAME <Name>]... [USER <User>]... [ENDPOINT <Endpoint>]...
       [CONTAINS <String>]... [CSCONTAINS <String>]...
       [STARTSWITH <String>]... [CSSTARTSWITH <String>]...
       [FROM <Timestamp> | AFTER <Timestamp>]
       [BEFORE <Timestamp> | TO <Timestamp>]
       [FIRST <Num> | LAST <Num> | ALL] [TOTAL | STATS | LONG]
       [LEVELBITSTRING]
 
LIST   GLOBAL | MACHINES | MACHINE <Machine> [HANDLE <Handle> | HANDLES] |
       SETTINGS
 
DELETE <GLOBAL | MACHINE <Machine> [HANDLE <Handle>]>
        LOGNAME <Logname> CONFIRM
 
PURGE  <GLOBAL | MACHINE <Machine> [HANDLE <Handle>]> LOGNAME <Logname> CONFIRM
       [LEVELMASK <Mask>] [QMACHINE <Machine>]... [QHANDLE <Handle>]...
       [NAME <Name>]... [USER <User>]... [ENDPOINT <Endpoint>]...
       [CONTAINS <String>]... [CSCONTAINS <String>]...
       [STARTSWITH <String>]... [CSSTARTSWITH <String>]...
       [FROM <Timestamp> | AFTER <Timestamp>]
       [BEFORE <Timestamp> | TO <Timestamp>]
       [FIRST <Num> | LAST <Num>]
 
SET    [MAXRECORDSIZE <Size>] [DEFAULTMAXQUERYRECORDS <Number>]
       [ENABLERESOLVEMESSAGEVAR | DISABLERESOLVEMESSAGEVAR]
       [RESOLVEMESSAGE | NORESOLVEMESSAGE]
 
VERSION
 
HELP
MISC Provides miscellaneous services such as VERSION, WHOAMI, and WHOAREYOU information, and allows for listing and querying enabled interfaces.

VERSION
 
WHOAMI
 
WHOAREYOU
 
LIST  INTERFACES | SETTINGS
 
QUERY INTERFACE <Name>
 
SET   [CONNECTATTEMPTS <Number>] [CONNECTRETRYDELAY <Number>]
      [MAXQUEUESIZE <Number>] [DEFAULTINTERFACE <Name>]
      [DEFAULTAUTHENTICATOR <Name>] [RESULTCOMPATIBILITYMODE <Verbose | None>]
 
HELP
MONITOR Allows test cases the ability to log and query status messages.

LOG    MESSAGE <Message> [RESOLVEMESSAGE | NORESOLVEMESSAGE]
 
QUERY  MACHINE <Machine> HANDLE <Handle>
 
LIST   <MACHINES | [MACHINE <Machine>&.rbrk. | SETTINGS>
 
DELETE [BEFORE <Timestamp>] CONFIRM
 
SET    [RESOLVEMESSAGE | NORESOLVEMESSAGE]
       [OLDRETURNCODES | NEWRETURNCODES] [MAXRECORDSIZE <Size>]
       [ENABLERESOLVEMESSAGEVAR | DISABLERESOLVEMESSAGEVAR]
 
VERSION
 
HELP
PING Allows you to ping other STAF clients.

PING
 
HELP
PROCESS Allows you to start, stop, and manage processes.

START [SHELL [<Shell>]] COMMAND <Command> [PARMS <Parms>] [WORKDIR <Directory>]
      [VAR <Variable>=<Value>] [ENV <Variable>=<Value>] [USEPROCESSVARS]
      [WORKLOAD <Name>] [TITLE <Title>] [WAIT [Timeout] | ASYNC]
      [STOPUSING <Method>] [NEWCONSOLE | SAMECONSOLE]
      [USERNAME <User name> [PASSWORD <Password>]]
      [DISABLEDAUTHISERROR | IGNOREDISABLEDAUTH] [STATICHANDLENAME <Name>]
      [STDIN <File>] [STDOUT <File> | STDOUTAPPEND <File>]
      [STDERR <File> | STDERRAPPEND <File> | STDERRTOSTDOUT]
      [RETURNSTDOUT] [RETURNSTDERR] [RETURNFILE <File>]...
      [NOTIFY ONEND [HANDLE <Handle> | NAME <Name>]
      [MACHINE <Machine>] [PRIORITY <Priority>] [KEY <Key>]]
 
STOP  <ALL CONFIRM | WORKLOAD <Name> | HANDLE <Handle>> [USING <Method>]
 
LIST  [HANDLES] [RUNNING] [COMPLETED] [WORKLOAD <Name>] [LONG]
LIST  SETTINGS
 
QUERY HANDLE <Handle>>
 
FREE  <ALL | WORKLOAD <Name> | HANDLE <Handle>>
 
NOTIFY REGISTER   ONENDOFHANDLE <Handle> [HANDLE <Handle> | NAME <Name>]
                  [MACHINE <Machine>] [PRIORITY <Priority>]
 
NOTIFY UNREGISTER ONENDOFHANDLE <Handle> [HANDLE <Handle> | NAME <Name>]
                  [MACHINE <Machine>] [PRIORITY <Priority>]
                  
NOTIFY LIST       ONENDOFHANDLE <Handle>
 
SET   [DEFAULTSTOPUSING <Method>] [DEFAULTCONSOLE <New | Same>]
      [PROCESSAUTHMODE <Auth Mode>]
      [DEFAULTAUTHUSERNAME <User Name>] [DEFAULTAUTHPASSWORD <Password>]
      [DEFAULTAUTHDISABLEDACTION <Error | Ignore>] [DEFAULTSHELL <Shell>]
      [DEFAULTNEWCONSOLESHELL <Shell>] [DEFAULTSAMECONSOLESHELL <Shell>]
 
HELP
QUEUE Allows you to manipulate and manage queues.

QUEUE  [HANDLE <Handle>] | [NAME <Name>] [PRIORITY <Priority>] [TYPE <Type>]
       MESSAGE <Message>
 
GET    [PRIORITY <Priority>]... [MACHINE <Endpoint>]... [NAME <Name>]...
       [HANDLE <Handle>]... [USER <User>]... [TYPE <Type>]...
       [CONTAINS <String>]... [ICONTAINS <String>]...
       [WAIT [Timeout]]
 
PEEK   [PRIORITY <Priority>]... [MACHINE <Endpoint>]... [NAME <Name>]...
       [HANDLE <Handle>]... [USER <User>]... [TYPE <Type>]...
       [CONTAINS <String>]... [ICONTAINS <String>]...
       [WAIT [Timeout]]
 
DELETE [PRIORITY <Priority>]... [MACHINE <Endpoint>]... [NAME <Name>]...
       [HANDLE <Handle>]... [USER <User>]... [TYPE <Type>]...
       [CONTAINS <String>]... [ICONTAINS <String>]...
 
LIST   [HANDLE <Handle>]
 
HELP
RESPOOL Allows you to manage exclusive access to entries within resource pools.

CREATE  POOL <PoolName> DESCRIPTION <Pooltext>
 
DELETE  POOL <PoolName> CONFIRM [FORCE]
 
QUERY   POOL <PoolName>
 
REQUEST POOL <PoolName> [TIMEOUT <Timeout>] [FIRST | RANDOM]
 
RELEASE POOL <PoolName> ENTRY <Value> [FORCE]
 
ADD     POOL <PoolName> ENTRY <Value> [ENTRY <Value>]...
 
REMOVE  POOL <PoolName> ENTRY <Value> [ENTRY <Value>]... CONFIRM [FORCE]
 
LIST    [POOLS | SETTINGS]
 
VERSION
 
HELP
SEM Allows you to manipulate and manage mutex and event semephores.

REQUEST MUTEX <Name> [TIMEOUT <Timeout>]
RELEASE MUTEX <Name> [FORCE]
 
POST    EVENT <Name>
RESET   EVENT <Name>
PULSE   EVENT <Name>
WAIT    EVENT <Name>
 
DELETE  MUTEX <Name> | EVENT <Name>
QUERY   MUTEX <Name> | EVENT <Name>
LIST    MUTEX <Name> | EVENT <Name>
 
HELP
SERVICE Allows you to manage STAF services and requests.

LIST    [SERVICES | SERVICELOADERS | AUTHENTICATORS |
         REQUESTS [PENDING] [COMPLETE] [LONG]]
 
QUERY   SERVICE <Service Name> | SERVICELOADER <ServiceLoader Name> |
        AUTHENTICATOR <Authenticator Name> | REQUEST <Request Number>
 
ADD     SERVICE <Service Name> LIBRARY <Library Name>
        [EXECUTE <Executable>] [OPTION <Name=[=Value]>]...
        [PARMS <Parameters>]
 
REMOVE  SERVICE <Service Name>
 
FREE    REQUEST <Request Number> [FORCE]
 
HELP
SHUTDOWN Allows you to manage the STAFProc daemon process.

SHUTDOWN
 
NOTIFY REGISTER   [MACHINE <Machine>] [HANDLE <Handle> | NAME <Name>]
                  [PRIORITY <Priority>]
 
NOTIFY UNREGISTER [MACHINE <Machine>] [HANDLE <Handle> | NAME <Name>]
                  [PRIORITY <Priority>]
 
NOTIFY LIST
 
HELP
TRACE Allows you to turn tracing on and off at the service and tracepoint level.

ENABLE ALL  [ TRACEPOINTS | SERVICES ]
ENABLE TRACEPOINTS <Trace point list> | SERVICES <Service list>
ENABLE TRACEPOINT <Trace point> [TRACEPOINT <Trace point>]...
ENABLE SERVICE <Service> [SERVICE <Service>]...
 
DISABLE ALL  [ TRACEPOINTS | SERVICES ]
DISABLE TRACEPOINTS <Trace point list> | SERVICES <Service list>
DISABLE TRACEPOINT <Trace point> [TRACEPOINT <Trace point>]...
DISABLE SERVICE <Service> [SERVICE <Service>]...
 
SET DESTINATION TO < STDOUT | STDERR | FILE <File name> >
SET DEFAULTSERVICESTATE < Enabled | Disabled >
 
LIST [SETTINGS]
 
PURGE
 
HELP
TRUST Allows you to manipulate and manage trust levels (security).

SET < MACHINE <Machine> | USER <User> | DEFAULT > LEVEL <Level>
 
GET MACHINE <Machine> [USER <User>]
 
DELETE MACHINE <Machine> | USER <User>
 
LIST
 
HELP
VAR Allows you to manipulate and manage system, shared and process specific variable pools.

SET [SYSTEM | SHARED | HANDLE <Handle>] VAR <Name=Value> [VAR <Name=Value>]...
 
GET [SYSTEM | SHARED | HANDLE <Handle>] VAR <Name>
 
DELETE [SYSTEM | SHARED | HANDLE <Handle>] VAR <Name> [VAR <Name>]...
 
LIST [SYSTEM | SHARED | HANDLE <Handle> | ASHANDLE <Handle> | REQUEST [<Number>]]
 
RESOLVE [SYSTEM | SHARED | HANDLE <Handle> | ASHANDLE <Handle> | REQUEST [<Number>]] STRING <String> [STRING <String>]...
 
HELP
ZIP Allows for unzipping, listing, and adding/deleting entries in Zip archives which are PKZip, WinZip and Jar compatible.

UNZIP  ZIPFILE <Name> TODIRECTORY <Name>
       [FILE <Name>]... [RESTOREPERMISSION] [REPLACE]
       
ADD    ZIPFILE <Name> < FILE <Name> | DIRECTORY <Name> [RECURSE] >
       [RELATIVETO <Directory>]
 
DELETE ZIPFILE <Name> FILE <Name> [FILE <Name>]... CONFIRM
 
LIST   ZIPFILE <Name>
 
VERSION
 
HELP