This is an archive version of the document. To get the most up-to-date information, see the current version.

Schema

The ManagementAgent JSON schema is supported to describe management agent entities in Veeam Service Provider Console RESTful API.

Property

Type

Attributes

Description

instanceUid

String (uuid)

Read-only

UID assigned to a management agent.

locationUid

String (uuid)

UID assigned to a location to which a management agent belongs.

organizationUid

String (uuid)

UID assigned to an organization to which a management agent belongs.

hostName

String

Read-only, nullable

Name of a computer on which a management agent is deployed.

lastHearbeatTime

String (date-time)

Read-only

Date and time when a management agent on a computer sent the latest heartbeat.

Date and time string is formatted in accordance RFC 3339

version

String

Read-only

Version of a management agent deployed on a computer.

discoveryTime

String (date-time)

Read-only

Date and time when a computer was discovered.

Date and time string is formatted in accordance RFC 3339

customNotes

String

Nullable

Additional information.

status

String

Read-only

Status of a management agent.

Possible values:

  • unknown
  • healthy
  • inaccessible
  • warning
  • updating
  • error
  • restarting
  • installation
  • failedToUpdate

type

String

Read-only

Role of a management agent.

Possible values:

  • unknown
  • cloudConnect
  • client

computerInfo

Subschema (ComputerInfo)

Read-only, nullable

Information about a computer on which a management agent is deployed.

connectionStatus

String

Read-only

Connction status of a management agent.

Possible values:

  • unknown
  • online
  • inaccessible
  • rejected

isRebootRequired

Boolean

Read-only

Indicates whether computer reboot is required.

connectionAcount

String (uuid)

Read-only, nullable

Company owner user name that is used to connect a management agent to a cloud gateway.

versionStatus

String

Read-only

Status of a management agent version.

Possible values:

  • unknown
  • upToDate
  • outOfDate
  • patchAvailable

role

String

Read-only

Role of a management agent.

Possible values:

  • unknown
  • master
  • client

ComputerInfo

Property

Type

Attributes

Description

uniqueUid

String (uuid)

UID assigned to a computer.

biosUuid

String (uuid)

UUID in Win32_ComputerSystem WMI class.

hostName

String

Name of a computer.

fqdn

String

FQDN of a computer.

guestOs

String

Guest OS installed on a computer.

guestOsType

String

Type of a guest OS installed on a computer.

Possible values:

  • unknown
  • workstation
  • domainController
  • server

guestOsVersion

String

Version of a guest OS installed on a computer.

guestOsSku

Integer (int32)

Nullable

SKU of a guest OS installed on a computer.

platformType

String

Type of a computer platform.

Possible values:

  • unknown
  • windows
  • hyperV
  • linux
  • vSphere
  • azure
  • amazon
  • other

ipAddresses

Array of strings

Computer IP addresses.

macAddresses

Array of strings

Computer MAC addresses.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.