Description | Example | Return Message | Group

SDF_RM

Return information about STK Data Federate (SDF) servers and resources.

Syntax

SDF_RM <ApplicationPath> {Option}

Related Commands

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 Return a list of servers.
GetActiveServers Return a list of the active servers.
GetServerInfo ServerName <ServerName> Return detailed information about the specified server.

Return data is in the following form:

"ServerName","URL","DefaultFolder","Description","EncryptedUserName","EncryptedPassword","Active","LastFolder","TrustedServer"

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.

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

Example

To return a list of all active servers:

SDF_RM / GetActiveServers

ReturnMessage

Connect returns the active server names:
ServerA
Test1

Example

To return information about a server:

SDF_RM / GetServerInfo ServerName ServerA

ReturnMessage

Connect returns information about the specified server:
"ServerA","http://sdf.mydomain.com","","My Data Federate Server","V1hZWE9bWUNF","","Yes","","Yes"

Example

To return the last modified time of the specified resource:

SDF_RM / GetResourceLastModifiedTime ResourcePath "/Users/john/MySatellite.sa" ServerName ServerA

ReturnMessage

Connect returns the last modified time, in UNIX time:
1333381862

Example

To return the full name of revision 3 of the specified resource:

SDF_RM / GetResourceFullName ResourcePath "/Users/john/DirecTv.sa" Revision 3

ReturnMessage

Connect returns the full name:
https://adf9.agi.com/content/files/Users/john/DirecTv.sa?ver=3

Group Membership

This command belongs to the following group(s):

Application Options

Version

11

STK Programming Interface 11.0.1