AboutInfo

AboutInfo
AboutInfo

This data object type describes system information including the name, type, version, and build number.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "name": "string",
    "fullName": "string",
    "vendor": "string",
    "version": "string",
    "patchLevel": "string",
    "build": "string",
    "localeVersion": "string",
    "localeBuild": "string",
    "osType": "string",
    "productLineId": "string",
    "apiType": "string",
    "apiVersion": "string",
    "instanceUuid": "string",
    "licenseProductName": "string",
    "licenseProductVersion": "string"
}
string
name
Required

Short form of the product name.

string
fullName
Required

The complete product name, including the version information.

string
vendor
Required

Name of the vendor of this product.

string
version
Required

Dot-separated product version string.

For example, "10.0.2.0".

string
patchLevel
Optional

Patch level for the server.

Since: vSphere API Release 7.0.2.0

string
build
Required

Build string for the server on which this call is made.

For example, x.y.z-num. This string does not apply to the API.

string
localeVersion
Optional

Version of the message catalog for the current session's locale.

string
localeBuild
Optional

Build number for the current session's locale.

Typically, this is a small number reflecting a localization change from the normal product build.

string
osType
Required

Operating system type and architecture.

Examples of values are:

  • "win32-x86" - For x86-based Windows systems.
  • "linux-x86" - For x86-based Linux systems.
  • "vmnix-x86" - For the x86 ESX Server microkernel.
  • "vmnix-arm64" - For the arm64 ESX Server microkernel.
string
productLineId
Required

The product ID is a unique identifier for a product line.

Examples of values are:

  • "gsx" - For the VMware Server product.
  • "esx" - For the ESX product.
  • "embeddedEsx" - For the ESXi product.
  • "esxio" - For the ESXio product.
  • "vpx" - For the VirtualCenter product.
string
apiType
Required

Indicates whether or not the service instance represents a standalone host.

If the service instance represents a standalone host, then the physical inventory for that service instance is fixed to that single host. VirtualCenter server provides additional features over single hosts. For example, VirtualCenter offers multi-host management.

Examples of values are:

  • "VirtualCenter" - For a VirtualCenter instance.
  • "HostAgent" - For host agent on an ESX Server or VMware Server host.
string
apiVersion
Required

The newest long-term supported API version provided by the server.

The version format is "x.y.z.a", where "x", "y", and "z" are numbers that do not exceed 99, and "a" does not exceed 9999.

string
instanceUuid
Optional

A globally unique identifier associated with this service instance.

string
licenseProductName
Optional

The license product name

string
licenseProductVersion
Optional

The license product version

Property Of