Contents

Summary

Alphabetic listing of Agent methods. Under this page are separate pages with full details for each function.

This documentation refers to the Tachyon Agent, which is the old name for Tachyon client features of the 1E Client. In Tachyon 4.1 the Tachyon Agent was renamed as the 1E Client, which also provides client modules for Nomad, PXE Everywhere, Shopping/WSA, and WakeUp. The Nomad client module has some methods available for use in SCALE also documented here.

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.

Please refer to the parent page Functions and Methods Reference to know the earliest version of the Agent in which a method was implemented, and which platforms they are supported.

Modules

Agent module

  • Page:
    Agent.CheckForUpdates Check whether extensibility (module and provider) updates are available, and if so to download and install them.
  • Page:
    Agent.Echo — Return the specified text.
  • Page:
    Agent.GetConnectionInformation — Returns Switch connection and Background Channel information.
  • Page:
    Agent.GetDiagnostics — Uses performance counters to get various stats.
  • Page:
    Agent.GetExtensibility — Get the list of extensibility modules and providers currently loaded by the agent.
  • Page:
    Agent.GetInstructionStatistics — Returns execution statistics for instructions that the agent has processed since the last time it was started/restarted.
  • Page:
    Agent.GetKeyFiles — Returns names and paths of key files relating to the execution of the Tachyon Agent.
  • Page:
    Agent.GetSummary — Returns high-level information about the device the Agent is running on.
  • Page:
    Agent.Log — Write a message to the Tachyon Agent log file.
  • Page:
    Agent.Sleep — Pause for the specified number of seconds.
  • Page:
    Agent.Stagger — Delay for a random amount of time up to a limit.

ContentDistribution module

Device module

Discovery module

FileContent module

FileSystem module

Http module

  • Page:
    Http.Post — Send the supplied Body text via a HTTP request to the specified Uri endpoint to consume and return the response if completed. This Method is primarily for use with Splunk Event Collectors, but it might support other similar Web APIs.

Interaction module

Inventory module

Other methods used by the Tachyon Activity Record feature are not exposed for use in SCALE.

Mobile module

NativeServices module

Network module

Nomad module

  • Page:
    Nomad.CachedPkgStatus — Get the percentage of the specified content in the local Nomad cache.
  • Page:
    Nomad.CancelJob — Cancels download job with the given ID and removes it from Nomad’s job queue.
  • Page:
    Nomad.FindBestPkgCache — Find the device that has the greatest percentage of the specified content in its Nomad cache.
  • Page:
    Nomad.GetCachedPkgDetails — Gets details about a package cached in Nomad.
  • Page:
    Nomad.GetCachePath — Gets the path on disk where Nomad’s cache is located.
  • Page:
    Nomad.GetCmContentLocations — Find the Configuration Manager locations (on distribution points - DPs) that have the specified content.
  • Page:
    Nomad.GetVariable — Gets the value of the given Nomad "variable".
  • Page:
    Nomad.JobsStatus — List active Nomad jobs.
  • Page:
    Nomad.Pause — Pause any currently-executing Nomad job. Has no effect if no job is currently running.
  • Page:
    Nomad.PauseJobQueue — Pause the Nomad job queue so that no jobs will run.
  • Page:
    Nomad.Resume — Resume any currently-paused Nomad job. Has no effect if no job is currently paused.
  • Page:
    Nomad.ResumeJobQueue — Resume the currently-paused Nomad job queue. Has no effect if the job queue is not currently paused.
  • Page:
    Nomad.RunPkgStatusRequest — Test whether any other SSD (single site download) device has more content than the local Nomad cache.
  • Page:
    Nomad.RunSsdQuery — Use Nomad's SSD (single site download) feature to find on which devices the specified content is cached.
  • Page:
    Nomad.Status — Get the status and version of the Nomad service.
  • Page:
    Nomad.Stop — Stop any currently-executing Nomad job. Has no effect if no job is currently running.

OperatingSystem module

Patch module

  • Page:
    Patch.Deploy — Deploy (i.e. download and by default install) either all available patches or specific patches to this device.
  • Page:
    Patch.GetStatus — Report how updates are configured for the device.
  • Page:
    Patch.List — List the status of patches.
  • Page:
    Patch.TestConnection — Check that the source for patches is accessible.

Scripting module

Security module

  • Page:
    Security.CheckSimpleIoc — Evaluates an IOC (indicator of compromise) definition on a device.
  • Page:
    Security.DeleteCertificates — Deletes every certificate in the local machine cert store (as the agent is run as Local System) with the specified thumbprint.
  • Page:
    Security.GetCertificates — Returns every certificate in the local machine cert store (as the agent is run as Local System).
  • Page:
    Security.GetQuarantineStatus — Gets the current quarantine status of the device.
  • Page:
    Security.ModifyQuarantineWhitelist — Allows connections from additional specified IP addresses to an already-quarantined device. This allows security tools other than Tachyon to diagnose and protect the device.
  • Page:
    Security.QuarantineDevice — Attempts to force the device to only communicate using Tachyon.
  • Page:
    Security.UnquarantineDevice — Allows devices to communicate with devices other than the Tachyon Switch and Background channel servers.

Shopping module

No methods in this module are exposed for use in SCALE.

Software module

  • Page:
    Software.GetInstallations — Gets a list of the installed software available to all users, optionally filtered by product and/or publisher.
  • Page:
    Software.GetUserInstallations — Gets a list of the software installed for specific users, optionally filtered by product and/or publisher.
  • Page:
    Software.Uninstall — Uninstall the specified software item.

Storage module

  • Page:
    Storage.Check — Tests the existence of a user defined persistent storage table.
  • Page:
    Storage.Delete — Removes an existing user defined persistent storage table.
  • Page:
    Storage.Get — Indicate whether a persistent storage table of the specified name is present and return its contents if present.
  • Page:
    Storage.Set — Set or change the value of the named persistent storage table.

Tagging module

  • Page:
    Tagging.Check — Tests the existence of a named tag of a specified type, optionally with the specified value.
  • Page:
    Tagging.Clear — Delete all tags of the specified type.
  • Page:
    Tagging.Count — Get the quantity of tags of the specified type.
  • Page:
    Tagging.Delete — Delete the named tag of the specified type, and indicate if it originally existed.
  • Page:
    Tagging.Get — Indicate whether a named tag of the specified type is present and return its value if present.
  • Page:
    Tagging.GetAll — Fetch the tag list (containing all tags) of the specified type.
  • Page:
    Tagging.Set — Set (or change if already set) the named tag of the specified type to the specified value.

Users module

Utilities module

  • Page:
    Utilities.GenerateSequence — Build a sequence of numeric values, starting at 1 up to and including the value of a specified limit.
  • Page:
    Utilities.JsonFromTable — Serializes a table variable into a JSON string
  • Page:
    Utilities.SplitLines — Convert a delimited fragment of text into multiple rows.
  • Page:
    Utilities.TableFromJson — Deserializes a correctly escaped JSON string that represents a two dimensional set of data with consistent columns and rows into a table variable.

WakeUp module

No methods in this module are exposed for use in SCALE.

Modules