Skip to main content

1E 8.1 (on-premises)

Agent.GetSummary

Method

GetSummary

Module

Agent

Library

Core

Action

Returns high-level information about the device the Agent is running on.

Parameters

(None)

Return values

TimeZone (int): The device's current timezone offset from UTC in minutes (positive or negative).

Note

This is based on timezone, not UTC bias. In other words, this value will not be affected by daylight savings.

Manufacturer (string): The hardware manufacturer of the device's chassis.

OsType: (string): The type of operating system family running on the device. The values are:

      • "Linux"

      • "MacOS" (N.B. not "macOS")

      • "Windows"

OsArchitecture: (string): The processor architecture of the operating system. The values depend on the OsType as follows:

      • Linux: "x86" (32-bit) or "x86_64"; same as the result of the "uname -m" command.

      • MacOS: "arm64", "x86" (32-bit) or "x64".

      • Windows: "x86" (32-bit) or "x64".

OsVersionText: (string): The caption of the operating system running on the device - a more descriptive version of OsType.

Version: (string): The Agent version number in four-part dotted representation (e.g. "23.1.0.23").

VirtualizationPlatform: (string): The type of virtualization technology on which the device's operating system is running (if any).

Example

 Agent.GetSummary();

Platforms

  • Windows

  • Linux

  • MacOS

Notes

See also Device.GetSummary