Contents
Summary
Tables showing the earliest version of the Agent in which a function or method was implemented, and on which OS, with links to full details.This page is regularly updated and includes details of functions and methods that are planned for future versions, which may be withdrawn before actual release.
Parameters are mandatory unless specified as optional. The default values for a string, int and boolean are the empty string, 0 and false respectively.
In this section...
Page last updated on:
On this page:
Version tables:
Agent built-in functions
The Agent language includes some cross-platform built-in functions – think of them like methods available in a “global” module. The names of built-in functions are case-sensitive.
| Built-in Function | All OS |
|---|---|
| HttpGetFile | 1.0 |
| IsUndefined | 3.1 |
| Raise (not public) | 5.0 |
Agent built-in keywords
Keywords are reserved, and should not be used as names of variables or columns.
| Keyword | All OS |
|---|---|
| ERROR | 3.3 |
| EVALUATE | 1.0 |
| FOREACH IN DO DONE | 3.0 |
| IF ELSE ENDIF | 3.3 |
| NOCONTENT | 3.3 |
| NOTIMPLEMENTED | 3.3 |
| RETURN | 3.3 |
| true false | 1.0 |
Agent SQL functions
In addition to SQLite functions, the Agent language takes advantage of SQLite extensibility by providing "application defined functions" for use in SELECT statements. SQL keywords and function names are not case-sensitive, but convention is to write them in UPPERCASE.
| SQL Function | All OS |
|---|---|
| BASENAMEFROMPATH | 3.2 |
| COMBINEPATHS | 3.2 |
| COMPAREVERSIONS | 3.3 |
| DATETRUNC | 3.0 |
| DIRECTORYFROMPATH | 3.2 |
| EPOCHTOJSON | 3.0 |
| 3.3 | |
| IPINRANGE | 3.2 |
| IPV4STRTOINT | 3.0 |
| REGEXP | 2.0 |
| REGEXPCAPTURE | 2.0 |
| REGEXPREPLACE | 2.0 |
Agent modules and methods
The names of modules and methods, and the names of their parameters, are case-sensitive.
A module library is represented by a file in the Agent installation Extensibility folder called Tachyon.<module>.library.dll or
Tachyon.<module>.library.so
depending on the O/S.
Modules marked with * are currently used internally to the Tachyon Agent and do not have exposed methods (for example WakeUp). Some modules were introduced without exposed methods, but had exposed methods added later (for example, Inventory and Shopping).
The table below lists the methods alphabetically by their module and method names. A full alphabetic listing is provided on the Tachyon Agent Methods page, with a brief description of each method, with links to full details of each method.
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
|---|---|---|---|---|---|---|---|
Agent(Core) | CheckForUpdates | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 |
| Echo | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| GetConnectionInformation | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| GetDiagnostics | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| GetExtensibility | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| GetInstructionStatistics | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| GetKeyFiles | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | |
| GetSummary | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| Log | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | |
| Sleep | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| Stagger | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
ContentDistribution(Core) | Stage | 1.5 | 1.5 (no Nomad) | 1.5 (no Nomad) | 2.0 (no Nomad) | 2.1 (no Nomad) | n/a |
| StageAndExecute | 1.5 | 1.5 (no Nomad) | 1.5 (no Nomad) | 2.0 (no Nomad) | 2.1 (no Nomad) | n/a | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Device(Core) | GetCriticality | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 |
| GetDisks | 8.0 | 8.0 | 8.0 | n/a | n/a | n/a | |
| GetInboundMappedDriveHistory | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| GetInboundPrinters | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| GetLocation | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | |
| GetOutboundMappedDriveHistory | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| GetOutboundPrinters | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| GetProcessors | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | n/a | |
| GetSummary | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| SetCriticality | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | |
| SetLocation | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Discovery(Discovery) | LookupNetBiosNames | 3.2 | n/a | n/a | n/a | n/a | n/a |
| ScanPortsOnDevices | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | n/a | |
| SendArpRequest | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
FileContent(FileContent) | AppendText | 3.3 | 3.3 | 3.3 | 3.3 | 3.3 | n/a |
| FindAndAppend | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | n/a | |
| FindAndDelete | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | n/a | |
| FindAndReplace | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | n/a | |
| GetTorrentAnnounceUris | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | n/a | |
| GetTorrentDescribedFiles | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | n/a | |
| GetTorrentInfo | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | n/a | |
| WriteText | 3.3 | 3.3 | 3.3 | 3.3 | 3.3 | n/a | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
FileSystem(Core) | CreateTempFile | 3.3 | 3.3 | 3.3 | 3.3 | 3.3 | 3.3 |
| DeleteFileByName | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| FindDirectoryByName | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | |
| FindFileByName | 1.5 | 3.0 | 3.0 | 3.0 | 3.0 | n/a | |
| FindFileBySizeAndHash | 1.5 | 3.1 | 3.1 | 3.1 | 3.1 | n/a | |
| GetDigitalSignature | 2.1 | n/a | n/a | n/a | n/a | n/a | |
| GetDirectoryHash | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | n/a | |
| GetFile | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | n/a | |
| GetFileByLine | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | n/a | |
| GetFileDetails | 3.2 | 3.2 | 3.2 | n/a | n/a | n/a | |
| GetFileHash | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | n/a | |
| GetFilePermissions | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | |
| GetFilesInDirectory | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | |
| GetFilesInFolder (deprecated) | 1.5 | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | |
| GetHash (deprecated) | 2.1 | 2.1 | 2.1 | 2.1 | 2.1 | 2.1 | |
| GetVersionInfo | 2.1 | n/a | n/a | n/a | n/a | n/a | |
| PathExists | 8.0 | 8.0 | 8.0 | 8.0 | 8.0 | n/a | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Http(Core) | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Interaction(Interaction) | 5.1 | n/a | n/a | n/a | n/a | n/a | |
| 5.1 | n/a | n/a | n/a | n/a | n/a | ||
| 5.1 | n/a | n/a | n/a | n/a | n/a | ||
| 5.1 | n/a | n/a | n/a | n/a | n/a | ||
| 5.1 | n/a | n/a | n/a | n/a | n/a | ||
| 5.1 | n/a | n/a | n/a | n/a | n/a | ||
| 5.1 | n/a | n/a | n/a | n/a | n/a | ||
| ShowAnnouncement | 8.0 | n/a | n/a | n/a | n/a | n/a | |
| 5.1 | n/a | n/a | n/a | n/a | n/a | ||
| 5.1 | n/a | n/a | n/a | n/a | n/a | ||
| 5.1 | n/a | n/a | n/a | n/a | n/a | ||
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Inventory(Inventory) | 5.2 | 5.2 | 5.2 | 5.2 | 5.2 | n/a | |
Please also refer to the Tachyon Activity Record feature. | 3.0 | 3.0 | 3.0 | 3.0 | 3.0 | n/a | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Mobile(Core) | GetEmailAddress | n/a | n/a | n/a | n/a | n/a | 3.1 |
| GetEncryptionStatus | n/a | n/a | n/a | n/a | n/a | 3.1 | |
| GetLocation | n/a | n/a | n/a | n/a | n/a | 3.1 | |
| GetMobileSummary | n/a | n/a | n/a | n/a | n/a | 3.1 | |
| GetPasswordQuality | n/a | n/a | n/a | n/a | n/a | 3.1 | |
| IsGPSEnabled | n/a | n/a | n/a | n/a | n/a | 3.1 | |
| IsPrintingSupported | n/a | n/a | n/a | n/a | n/a | 3.1 | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
NativeServices(Core) | GetWmiNames | 3.3 | n/a | n/a | n/a | n/a | n/a |
| RegistryDeleteKey | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistryDeleteUserKey | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistryDeleteUserValues | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistryDeleteValue | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistryEnumerateKeys | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| RegistryEnumerateUserKeys | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| RegistryEnumerateUserValues | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistryEnumerateValues | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistryGetUserValues | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistryGetValue | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistryKeyExists | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistrySetUserValues | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistrySetValue | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistryUserKeyExists | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistryUserValueExists | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RegistryValueExists | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RunCommand | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| RunWmiInstanceMethod | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RunWmiQuery | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| RunWmiStaticMethod | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Network(Core) | GetArpEntries | 2.1 | n/a | n/a | n/a | n/a | n/a |
| GetConnections | 2.1 | 2.1 | 2.1 | n/a | n/a | n/a | |
| GetDnsEntriesByAddress | 1.5 | n/a | 3.2 | n/a | n/a | n/a | |
| GetIpAddress (deprecated) | 1.5 | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | |
| GetIpAddresses | 1.5 | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | |
| GetListeningEndpoints | 2.1 | 2.1 | 2.1 | n/a | n/a | n/a | |
| GetNetworkSummary | n/a | n/a | n/a | n/a | n/a | 1.5 | |
| GetWiFiNetworks | 5.2 | n/a | n/a | n/a | n/a | n/a | |
| SetAirplaneMode | n/a | n/a | n/a | n/a | n/a | 3.1 | |
| SetBlueToothMode | n/a | n/a | n/a | n/a | n/a | 3.1 | |
| SetWiFiMode | n/a | n/a | n/a | n/a | n/a | 3.1 | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Nomad(was named 1E up to v4.0,and then Nomad from v4.1) | CachedPkgStatus | 3.2 | n/a | n/a | n/a | n/a | n/a |
| CancelJob | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| FindBestPkgCache | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| GetCachedPkgDetails | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| GetCachePath | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| GetCmContentLocations | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| GetVariable | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| JobsStatus | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| Pause | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| PauseJobQueue | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| Resume | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| ResumeJobQueue | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| RunPkgStatusRequest | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| RunSsdQuery | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| Status | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| Stop | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
OperatingSystem(Core) | ControlService | 1.5 | 3.2 | 3.2 | 3.2 | 3.2 | n/a |
| GetInstalledUpdates | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| GetProcesses | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| GetRunningApps | n/a | n/a | n/a | n/a | n/a | 1.5 | |
| GetServiceInfo | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| GetSummary | 1.5 | 4.0 | 4.0 | 4.0 | 4.0 | n/a | |
| GetUpdatesPendingReboot | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| GetUpdateSummary | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| KillProcess | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | n/a | |
| KillProcesses | 1.5 | 1.5 | n/a | 2.0 | 2.1 | n/a | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Patch(Core) | Deploy | 4.0 | n/a | n/a | n/a | n/a | n/a |
| GetStatus | 4.0 | n/a | n/a | n/a | n/a | n/a | |
| List | 4.0 | n/a | n/a | n/a | n/a | n/a | |
| TestConnection | 4.0 | n/a | n/a | n/a | n/a | n/a | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Scripting(Scripting) | Run | 1.5 (for PowerShell) | 1.5 (for bash) | 1.5 (for bash) | 2.0 (for bash) | 2.1 (for bash) | 3.0 (for bash) |
| RunText | 3.3 (for PowerShell) | 3.3 (for bash) | 3.3 (for bash) | 3.3 (for bash) | 3.3 (for bash) | 3.3 (for bash) | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Security(Security) | CheckSimpleIoc | 2.1 | n/a | n/a | n/a | n/a | n/a |
| DeleteCertificates | 2.1 | n/a | n/a | n/a | n/a | n/a | |
| GetCertificates | 2.1 | n/a | n/a | n/a | n/a | n/a | |
| GetQuarantineStatus | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| ModifyQuarantineWhitelist | 5.1 | n/a | n/a | n/a | n/a | n/a | |
| QuarantineDevice | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| UnquarantineDevice | 3.1 | n/a | n/a | n/a | n/a | n/a | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Shopping*(Shopping) | No methods are exposed in this module. Also includes Windows Servicing Assistant (WSA) methods. | 3.2 | n/a | n/a | n/a | n/a | n/a |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Software(Core) | GetInstallations | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 |
| GetUserInstallations | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| Uninstall | 1.5 | 1.5 | n/a | 2.0 | 2.1 | 1.5 | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Storage(Core) | Check | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 |
| Delete | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | |
| Get | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | |
| GetRemote | 8.0 | 8.0 | 8.0 | 8.0 | 8.0 | 8.0 | |
| Set | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Tagging(Core) | Check | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 |
| Clear | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| Count | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| Delete | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| Get | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| GetAll | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| Set | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Users(Core) | FindLocalGroupMember | 1.5 | n/a | n/a | n/a | n/a | n/a |
| GetInboundConnectionHistory | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| GetLocalGroupMembers | 1.5 | n/a | n/a | n/a | n/a | n/a | |
| GetLoggedOnUsers | 1.5 | 1.5 | 1.5 | 2.0 | 2.1 | 1.5 | |
| GetOutboundConnectionHistory | 3.2 | n/a | n/a | n/a | n/a | n/a | |
| GetPrimaryUser | 5.1 | 5.1 | 5.1 | 5.1 | 5.1 | n/a | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
Utilities(Core) | GenerateSequence | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 |
| JsonFromTable | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | 4.0 | |
| SplitLines | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | 3.1 | |
| TableFromJson | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | 3.2 | |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |
WakeUp*(WakeUp) | No methods are exposed in this module. | 3.3 | n/a | n/a | n/a | n/a | n/a |
| Module (Library) | Method | Windows | Linux | Mac OSX | Solaris Intel | Solaris SPARC | Android |