SDF_RM
Return information about STK Data Federate (SDF) servers and resources.
Syntax
SDF_RM <ApplicationPath> {Option}
Related commands
Your SDF Authentication Credentials are required to access specific locations on the STK Data Federate (SDF).
Description
The SDF_RM connect command returns information about the STK Data Federate (SDF) servers and resources in STK.
The following table describes {Option} values for returning Server information:
| {Option} | Description |
|---|---|
| GetServerList | Returns a list of servers. |
| GetActiveServers | Returns a list of the active servers. |
| GetServerProps | Returns detailed information about the specified server.
The data returned by this parameter is dependent upon server version. Pre-SEDS servers (2.0): "ServerName","URL","PortNumber","ServerVersion","Description","EncryptedUserName","EncryptedPassword","DefaultFolder","LastFolder","Active" SEDS servers (3.0 and newer): "ServerName","URL","PortNumber","ServerVersion","DefaultFolder","LastFolder","Active" The "PortNumber" value may be empty for earlier versions of SDF. This parameter requires the user to parse the returned data dependent upon the "ServerVersion". |
The SDF_RM command can also return information for SDF resources. The syntax for these options is:
SDF_RM <ApplicationPath> {Option} ResourcePath "<ResourcePath>" [ServerName <"ServerName">] [Revision <RevisionNumber>]
The ResourcePath "<ResourcePath>" specifies the file.
Paths to SDF resources are case-sensitive.
The Revision <RevisionNumber> parameter is optional and only applies if the specified resource is under revision control. If a revision number is not specified and the specified resource is under revision control, the information for the latest revision will be returned.
Use ServerName <ServerName> to specify the server. This option is required if more than one server is available.
The following table describes {Option} values for returning Resource information:
| {Option} | Description |
|---|---|
| GetResourceName | Returns the name of the specified resource. |
| GetResourceFullName | Returns the full name (URL) of the specified resource. |
| GetResourceCurrentVersion | Returns the revision number for the latest (head) revision of the specified resource.
The [<RevisionNumber>] parameter should not be included for this option. |
| GetResourceRevisionComments | Returns the comments associated with the specified revision. |
| GetResourceCreatedByUser | Returns the user who created the specified resource. |
| GetResourceCreationTime | Returns the creation time of the specified resource. The value returned is a UNIX time value (the number of seconds elapsed since 00:00 hours, January 1st, 1970 UTC). |
| GetResourceLastModifiedTime | Returns the last modified time of the specified resource. The value returned is a UNIX time value (the number of seconds elapsed since 00:00 hours, January 1st, 1970 UTC). |
| GetResourceIsRevisionControlled | Returns TRUE if the specified resource is under revision control and FALSE if it is not.
The [<RevisionNumber>] parameter should not be included for this option. |
| GetResourceSize | Returns the size (in bytes) of the specified resource. |
Examples
To return a list of all active servers:
Return message
Connect returns the active server names:AGI SEDS SDF My Onsite SDF
Examples
To return information about a server:
Return message
Connect returns information about the specified server:"AGI SEDS SDF","http://sdf.agi.com","443","3.2.0","","","Yes"
Examples
To return the last modified time of the specified resource:
Return message
Connect returns the last modified time, in UNIX time:1333381862
Examples
To return the full name of revision 3 of the specified resource:
Return message
Connect returns the full name:"AGI SEDS SDF" optimizedcommlink.vdf
Group membership
This command belongs to the following group(s):
Version
11.5