miscsrv.script

Software Testing Automation Framework (STAF)的开发代码

:li.On successful return from a :xph.LIST SETTINGS:exph. request, the result
buffer will contain a marshalled
:xph.<List> of <Map&colon.STAF/Service/Misc/Settings>:exph.
representing the current operational settings for STAF.
The map is defined as follows:
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Misc/Settings
:tnote text='Description'.This map class represents the operational
settings for STAF.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.connectAttempts
:c.Connection Attempts
:c.&stringObj.
:c.
:row.
:c.connectRetryDelay
:c.Connect Retry Delay
:c.&stringObj.
:c.
:row.
:c.interfaceCycling
:c.Interface Cycling
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.maxQueueSize
:c.Maximum Queue Size
:c.&stringObj.
:c.
:row.
:c.initialThreads
:c.Initial Threads
:c.&stringObj.
:c.
:row.
:c.threadGrowthDelta
:c.Thread Growth Delta
:c.&stringObj.
:c.
:row.
:c.dataDir
:c.Data Directory
:c.&stringObj.
:c.
:row.
:c.defaultInterface
:c.Default Interface
:c.&stringObj.
:c.
:row.
:c.defaultAuthenticator
:c.Default Authenticator
:c.&stringObj.
:c.
:row.
:c.resultCompatibilityMode
:c.Result Compatibility Mode
:c.&stringObj.
:c.:xph.'Verbose' | 'None':exph.
:etable.
:p.
:li.On successful return from a :xph.LIST ENDPOINTCACHE:exph. request, the
result buffer will contain a marshalled
:xph.<List> of <Map&colon.STAF/Service/Misc/EndpointCache>:exph.
representing the contents of the endpoint cache used by automatic
interface cycling.
The map is defined as follows:
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Misc/EndpointCache
:tnote text='Description'.This map class represents an cached endpoint.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.endpoint
:c.Endpoint
:c.&stringObj.
:c.
:row.
:c.interface
:c.Interface
:c.&stringObj.
:c.
:row.
:c.createdTimestamp
:c.Date-Time
:c.&stringObj.
:c.&timestampFormat.
:tnote text='Notes'.
:ol compact.
:li.The "Date-Time" value contains the timestamp for when the
entry was added to the endpoint cache.
:eol.
:etnote.
:etable.
:eul.
:p.
:h4.Examples
:p.
:ul.
:li.:hp2.Goal::ehp2. List all enabled interfaces.
:p.:hp2.Syntax::ehp2.
:p.:xph.LIST INTERFACES:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in verbose format, could look like:
:xmp.
[
  {
    Interface Name: local
    Library       : STAFLIPC
    Options       : {
      IPCName: STAF
    }
  }
  {
    Interface Name: tcp
    Library       : STAFTCP
    Options       : {
      ConnectTimeout: 5000
      Port          : 6500
      Protocol      : IPv4
    }
  }
  {
    Interface Name: alt-tcp
    Library       : STAFTCP
    Options       : {
      ConnectTimeout: 30000
      Port          : 6502
      Protocol      : IPv6
    }
  }
]
:exmp.
:p.
:li.:hp2.Goal::ehp2. Show the operational settings for STAF.
:p.:hp2.Syntax::ehp2.
:p.:xph.LIST SETTINGS:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
Connection Attempts      : 2
Connect Retry Delay      : 1000
Interface Cycling        : Enabled
Maximum Queue Size       : 10000
Initial Threads          : 10
Thread Growth Delta      : 1
Data Directory           : c:\STAF\data\STAF
Default Interface        : tcp
Default Authenticator    : none
Result Compatibility Mode: Verbose
:exmp.
:p.
:li.:hp2.Goal::ehp2. Show the cached endpoints used by automatic
interface cycling, if it is enabled.
:p.:hp2.Syntax::ehp2.
:p.:xph.LIST ENDPOINTCACHE:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in tabular format, could look like:
:xmp.
Endpoint             Interface Date-Time
-------------------- --------- -----------------
machine1             tcp2      20051101-16:42:41
machine1.company.com tcp2      20051102-11:11:37
machine2.company.com tcp3      20051101-15:23:59
machine3             tcp2      20051102-09:05:34
:exmp.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.QUERY
:i3.misc service
:h3.QUERY
:p.QUERY allows you to obtain detailed information about an enabled interface
(aka connection provider).

:h4.Syntax
:xmp.
QUERY INTERFACE <Name>
:exmp.
:p.:xph.INTERFACE:exph. specifies the name of the interface you want
information on.  &varres.

:h4.Security
:p.&seclvl. 2.

:h4.Return Codes
:p.All return codes from QUERY are documented in :hdref refid=retcode..

:h4.Results
:p.
On successful return, the result buffer for a :xph.QUERY INTERFACE:exph.
request will contain a marshalled
:xph.<Map&colon.STAF/Service/Misc/Interface>:exph.
representing the specified interface (aka connection provider).
The map is defined as follows:
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Misc/Interface
:tnote text='Description'.This map class represents an interface.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.name
:c.Interface Name
:c.&stringObj.
:c.
:row.
:c.library
:c.Library
:c.&stringObj.
:c.
:row.
:c.optionMap
:c.Options
:c.:xph.<Map>:exph. of &stringObj.
:c.
:tnote text='Notes'.
:ol compact.
:li.The option names are the keys in the option map.
:li.Valid option names for TCP interfaces are:  :xph.Port:exph.,
:xph.Protocol:exph., and :xph.ConnectTimeout:exph.
:li.Valid option names for the local interface are:  :xph.IPCName:exph.
:eol.
:etnote.
:etable.
:p.
:h4.Examples
:p.
:ul.
:li.:hp2.Goal::ehp2. Query the tcp interface.
:p.:hp2.Syntax::ehp2.
:p.:xph.QUERY INTERFACE tcp:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
{
  Interface Name: tcp
  Library       : STAFTCP
  Options       : {
    ConnectTimeout: 5000
    Port          : 6500
    Protocol      : IPv4
  }
}  
:exmp.
:p.
:li.:hp2.Goal::ehp2. Query the local interface.
:p.:hp2.Syntax::ehp2.
:p.:xph.QUERY INTERFACE local:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
{
  Interface Name: local
  Library       : STAFLIPC
  Options       : {
    IPCName: STAF
  }
}
:exmp.
:eul.
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.SET
:i3.misc service
:h3 id=miscset.SET
The SET command allows you to change the operational parameters for STAF
dynamically (without stopping/restarting STAF) which is important for
STAF machines that must be continuously available.
:p.
Note that to make these settings permanent (e.g. if you want these changes
to apply once STAF is stopped and restarted), you'll need to update the
STAF configuration file with these new settings.

:h4.Syntax
:xmp.
SET  &lbrk.CONNECTATTEMPTS <Number>&rbrk. &lbrk.CONNECTRETRYDELAY <Number>&rbrk.
     &lbrk.MAXQUEUESIZE <Number>&rbrk.    &lbrk.INTERFACECYCLING <Enabled | Disabled>&rbrk.
     &lbrk.DEFAULTINTERFACE <Name>&rbrk.  &lbrk.DEFAULTAUTHENTICATOR <Name>&rbrk.
     &lbrk.RESULTCOMPATIBILITYMODE <Verbose | None>&rbrk.
:exmp.
:p.See section :hdref refid=opparms. for a description of these options.
:h4.Security
:p.&seclvl. 5.
:h4.Return Codes
:p.All return codes from :xph.SET:exph. are documented in :hdref refid=retcode..
:h4.Results
:p.The result buffer will contain no data on return from a successful SET command.
:h4.Examples
:ul.
:li.:hp2.Goal::ehp2. Change the maximum queue size to 10000.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.SET MAXQUEUESIZE 50:exph.
:p.
:li.:hp2.Goal::ehp2. Change two operational parameters for STAF.  Change the 
maximum number of times to attempt to connect to a remote system to 5 and
change the maximum time in milliseconds to wait after a failed connection
attempt to a remote system before trying to connect again to 2 seconds.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.SET CONNECTATTEMPTS 5 CONNECTRETRYDELAY 2000:exph.
:p.
:li.:hp2.Goal::ehp2. Disabled automatic interface cycling.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.SET INTERFACECYCLING Disabled:exph.
:p.
:li.:hp2.Goal::ehp2.  Set the default interface to be 'tcp'.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.SET DEFAULTINTERFACE tcp:exph.
:eul.

.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.PURGE
:i3.misc service
:h3 id=miscpurge.PURGE
The PURGE command allows you to purge one or more (or all) of the endpoints
from the endpoint cache used by automatic interface cycling.

:h4.Syntax
:xmp.
PURGE ENDPOINTCACHE <ENDPOINT <Endpoint>... | CONFIRM>
:exmp.
:p.:xph.ENDPOINTCACHE:exph. indicates that you want to purge one or
more endpoints from the endpoint cache.
:p.:xph.ENDPOINT:exph. specifies the endpoint that you want to purge.
&varres.
:p.:xph.CONFIRM:exph. indicates that you really want to purge the entire
contents of the endpoint cache.

:h4.Security
:p.&seclvl. 5.

:h4.Return Codes
:p.All return codes from :xph.PURGE:exph. are documented in :hdref refid=retcode..

:h4.Results
:p.
If successful, the result buffer will contain a marshalled
:xph.<Map&colon.STAF/Service/Misc/PurgeStats>:exph., representing the number
of endpoints that were purged and the number of endpoints remaining in the
endpoint cache. The map is defined as follows: 
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Misc/PurgeStats
:tnote text='Description'.This map class represents the purge statistics
for the endpoint cache.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.numPurged
:c.Purged Endpoints
:c.&stringObj.
:c.
:row.
:c.numRemaining
:c.Remaining Endpoints
:c.&stringObj.
:c.
:etable.

:h4.Examples
:ul.
:li.:hp2.Goal::ehp2. Remove endpoints 'client1' and 'client1.company.com' from
the endpoint cache..
:p.:hp2.Syntax::ehp2.&nbsp; :xph.PURGE ENDPOINTCACHE ENDPOINT client1 ENDPOINT client1.company.com:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in tabular format, could look like:
:xmp.
Purged Endpoints   : 2
Remaining Endpoints: 8
:exmp.
:p.
:li.:hp2.Goal::ehp2. Purge all entries from the endpoint cache.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.PURGE ENDPOINTCACHE CONFIRM:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in tabular format, could look like:
:xmp.
Purged Endpoints   : 8
Remaining Endpoints: 0
:exmp.
:eul.
.*
.*---------------------------------------------------------------------
.*