Version: 16
restore

Contents

Check whether extensibility (module and provider) updates are available, and if so to download and install them.

 Click here to expand...

    MultiExcerpt named 'method' was not found
The page: Agent.CheckForUpdates was found, but the multiexcerpt named 'method' was not found. Please check/update the page name used in the 'multiexcerpt-include macro.

Method

CheckForUpdates

ModuleAgent
LibraryCore
Action


Check whether extensibility (module and provider) updates are available, and if so to download and install them.
Parameters(None)
Return values

Status (string): e.g. "Checking for updates"

OperatingSystem (string): e.g. "Windows" or "Linux"

Architecture (string): e.g. "x64"

Example
 Agent.CheckForUpdates();
Platforms
  • Windows
  • Linux
  • MacOS
  • Solaris Intel
  • Solaris Sparc
  • Android
Notes

The method name is slightly misleading because it does not just check for updates but if there are updates available it also downloads and applies them.

Because of the way that updates are applied, the method completes before this happens. Therefore if, for example, download of the updates then fails for some reason, the method appears to succeed. To verify that the updates have been applied, run the GetExtensibility method afterwards.

If NomadContentDownloadEnabled is set to true in the Agent's configuration file, this method will attempt to use Nomad if it is running. Nomad v6.1.100 or later is supported because of the need to download files as well as directories. It cannot use v6.0.100 because it can only download directories. Prior versions of Nomad are not supported at all.

If Nomad is not available or fails then the Agent falls back to its internal HTTP provider.