Description | Example | Return Message | Group

ADF_RM

Return information about ADF servers and resources (Deprecated Command)

Syntax

ADF_RM <ApplicationPath> {Option}

ATTENTION: THIS COMMAND IS DEPRECATED and has been replaced by:

SDF_RM

Description

Note: This command was deprecated in STK 10, it should no longer be used. This command has been replaced by the SDF_RM command.

The ADF_RM connect command returns information about the AGI Data Federate (ADF) servers and resources in STK.

The following table describes {Option} values for returning Server information:

{Option} Description
GetServerList Return a list of servers.
GetActiveServer Return the name of the active server.
GetServerInfo <ServerName> Return detailed information about the specified server.

Return data is in the following form:

"ServerName","URL","DefaultFolder","Description","UserName","Password","SaveCredentials","Active","AutoLogin","LastFolder"

The ADF_RM command can also return information for ADF resources. The syntax for these options is:

ADF_RM <ApplicationPath> {Option} "<ResourcePath>" [<RevisionNumber>]

The "<ResourcePath>" specifies the file.

The <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.

Note: Paths to ADF resources are case-sensitive.

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 the name of the active server:

ADF_RM / GetActiveServer

ReturnMessage

Connect returns the active server name:
ServerA

Example

To return information about the server:

ADF_RM / GetServerInfo ServerA

ReturnMessage

Connect returns information about the specified server:
"ServerA","C:\Program Files\AGI\Test1","","Testing the ADF server","","","Yes","Yes","Yes",""

Example

To return the last modified time of the specified resource:

ADF_RM / GetResourceLastModifiedTime "/Users/john/MySatellite.sa"

ReturnMessage

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

Example

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

ADF_RM / GetResourceFullName "/Users/john/DirecTv.sa" 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

Deprecated Commands

Version

10

STK Programming Interface 11.0.1