The model for GetAgentInfo is the contents of the taskResponse section.

Format


JSON

{
    "agentCommon": {
        "agentVersion": "string",
        "monitorVersion": "string",
        "operatingSystem": {
            "name": "string",
            "architecture": "string",
            "version": "string",
            "partition": "string"
        },
        "machineName": "string",
        "workingDirectory": "string"
    },
    "healthState": {
        "workingMemorySetMb": 0,
        "dataFolderSizeMb": 0,
        "availableFreeDiskSpaceGb": 0.0
    },
    "pluggedSystems": [
        {
            "name": "string",
            "version": "string",
            "instanceName": "string",
            "connectionError": "string",
            "objectIdList": [199990001,199990002],
            "isAvailable": "bool"
        }
    ],
    "plugins": [
        {
            "name": "string",
            "version": "string"
        }
    ]
}

Parameter

Parameter type

Description

Parameter

Parameter type

Description

agentCommon
Container of information about the main parameters of the agent
-agentVersionstring

Agent version information

-monitorVersionstringMonitor version information
-operatingSystem

Operating system details

--namestring

Operating system

--architecturestring

Architecture

--versionstring

Version

--partitionstring

Section

-machineNamestring

Computer name

-workingDirectorystring

Agent location

healthState
Information about the resources consumed by the agent, WSA 2 only
-workingMemorySetMbint

The size in megabytes of memory allocated to the module — Agent or Monitor

-dataFolderSizeMbint Size of data folder in megabytes — Agent and Monitor will return the same result
-availableFreeDiskSpaceGbnumberThe amount of free space in gigabytes on the disk where the data folder is located — Agent and Monitor will return the same result
pluggedSystems
Container of information to the agent about connected systems
-namestringThe name of the connected system type, for example: R-Keeper cash server
-instanceNamestring

Distinctive Name of the Connected System. Examples:

  • For MID and REF r_keeper servers, the NetName field from the response to the GetServerInfo request to them will be used
  • For StoreHouse, the Host field from the response to the GetInfo request will be utilized.
  • For SQL connections, the following pair of values ​​will be returned: "<sql server name>&<database name>"
-connectionErrorstringOptional parameter - error connecting to the system
-versionstringVersion of the connected r_keeper system
-isAvailableboolAvailability of the system. Takes a value of true or false
-objectIdListint[]List of object codes for which the connected system has been authenticated on the server
plugins
Container of information about connected WSA V2 plugins
-namestringThe name by which commands can be sent to the plugin
-versionstringPlugin build version