API Documentation

Last Update: 28 December 2022

GET api/VMware



Request Information


URI Parameters

None.


Body Parameters

None.

Response Information


Resource Description
Collection of VMware
Name Description Type Additional information
ID

integer

None.

ReportDate

date

None.

VMID

string

None.

MoRefID

integer

None.

Name

string

None.

HostID

integer

None.

GuestOSName

string

None.

GuestHostname

string

None.

Version

string

None.

State

string

None.

Status

string

None.

Heartbeat

string

None.

OperationalStatus

integer

None.

ResourcePoolName

string

None.

ResourcePool

string

None.

NestedHVEnabled

string

None.

VPMCEnabled

string

None.

Firmware

string

None.

ChangeTrackingEnabled

string

None.

Datastore

string

None.

DatastoreUrl

string

None.

LatencySensitivityLevel

string

None.

VMLatencySensitivity

integer

None.

MaxMksConnections

integer

None.

FaultToleranceState

string

None.

CleanPowerOff

string

None.

ConsolidationNeeded

string

None.

VMPath

string

None.

SnapshotDirectory

string

None.

SuspendDirectory

string

None.

LogDirectory

string

None.

ProcessorCount

integer

None.

CoresPerSocket

integer

None.

SocketCount

integer

None.

CPUShare

integer

None.

CPUShareLevel

string

None.

CPUReservation

integer

None.

CPULimit

integer

None.

CPUHotAddEnabled

string

None.

CPUHotRemoveEnabled

string

None.

MemoryCount

integer

None.

MemoryShare

integer

None.

MemoryShareLevel

string

None.

MemoryReservation

integer

None.

MemoryLimit

integer

None.

MemoryOverheadLimit

integer

None.

MemoryHotAddEnabled

string

None.

MemoryInitialMemoryReservation

integer

None.

MemoryInitialSwapReservation

integer

None.

MemoryHotPlugMemoryLimit

integer

None.

MemoryHotPlugMemoryIncrementSize

integer

None.

ToolsStatus

string

None.

ToolsVersion

string

None.

ToolsVersionStatus

string

None.

ToolsUpgradePolicy

string

None.

ToolsSyncTimeWithHost

string

None.

ToolsAfterPowerOn

string

None.

ToolsAfterResume

string

None.

ToolsBeforeGuestStandby

string

None.

ToolsBeforeGuestShutdown

string

None.

ToolsBeforeGuestReboot

string

None.

Uptime

string

None.

CreationTime

date

None.

HasDVDDrive

string

None.

DVDDriveHasImage

string

None.

DVDDriveImage

string

None.

FloppyDriveHasImage

string

None.

FloppyDriveImage

string

None.

HasSnapshot

string

None.

HasVHBA

string

None.

ConsoleStateString

string

None.

ConsoleStateValue

integer

None.

Notes

string

None.

IPInfo

string

None.

IsTemplate

boolean

None.

ParentType

string

None.

ParentValue

string

None.

RecordStatus

integer

None.

Response Formats
application/json, text/json
Sample:
[
  {
    "$id": "1",
    "ID": 1,
    "ReportDate": "2024-10-31T04:11:15.0061269+00:00",
    "VMID": "sample string 3",
    "MoRefID": 4,
    "Name": "sample string 5",
    "HostID": 6,
    "GuestOSName": "sample string 7",
    "GuestHostname": "sample string 8",
    "Version": "sample string 9",
    "State": "sample string 10",
    "Status": "sample string 11",
    "Heartbeat": "sample string 12",
    "OperationalStatus": 13,
    "ResourcePoolName": "sample string 14",
    "ResourcePool": "sample string 15",
    "NestedHVEnabled": "sample string 16",
    "VPMCEnabled": "sample string 17",
    "Firmware": "sample string 18",
    "ChangeTrackingEnabled": "sample string 19",
    "Datastore": "sample string 20",
    "DatastoreUrl": "sample string 21",
    "LatencySensitivityLevel": "sample string 22",
    "VMLatencySensitivity": 23,
    "MaxMksConnections": 24,
    "FaultToleranceState": "sample string 25",
    "CleanPowerOff": "sample string 26",
    "ConsolidationNeeded": "sample string 27",
    "VMPath": "sample string 28",
    "SnapshotDirectory": "sample string 29",
    "SuspendDirectory": "sample string 30",
    "LogDirectory": "sample string 31",
    "ProcessorCount": 32,
    "CoresPerSocket": 33,
    "SocketCount": 34,
    "CPUShare": 35,
    "CPUShareLevel": "sample string 36",
    "CPUReservation": 37,
    "CPULimit": 38,
    "CPUHotAddEnabled": "sample string 39",
    "CPUHotRemoveEnabled": "sample string 40",
    "MemoryCount": 41,
    "MemoryShare": 42,
    "MemoryShareLevel": "sample string 43",
    "MemoryReservation": 44,
    "MemoryLimit": 45,
    "MemoryOverheadLimit": 46,
    "MemoryHotAddEnabled": "sample string 47",
    "MemoryInitialMemoryReservation": 48,
    "MemoryInitialSwapReservation": 49,
    "MemoryHotPlugMemoryLimit": 50,
    "MemoryHotPlugMemoryIncrementSize": 51,
    "ToolsStatus": "sample string 52",
    "ToolsVersion": "sample string 53",
    "ToolsVersionStatus": "sample string 54",
    "ToolsUpgradePolicy": "sample string 55",
    "ToolsSyncTimeWithHost": "sample string 56",
    "ToolsAfterPowerOn": "sample string 57",
    "ToolsAfterResume": "sample string 58",
    "ToolsBeforeGuestStandby": "sample string 59",
    "ToolsBeforeGuestShutdown": "sample string 60",
    "ToolsBeforeGuestReboot": "sample string 61",
    "Uptime": "sample string 62",
    "CreationTime": "2024-10-31T04:11:15.0061269+00:00",
    "HasDVDDrive": "sample string 64",
    "DVDDriveHasImage": "sample string 65",
    "DVDDriveImage": "sample string 66",
    "FloppyDriveHasImage": "sample string 67",
    "FloppyDriveImage": "sample string 68",
    "HasSnapshot": "sample string 69",
    "HasVHBA": "sample string 70",
    "ConsoleStateString": "sample string 71",
    "ConsoleStateValue": 72,
    "Notes": "sample string 73",
    "IPInfo": "sample string 74",
    "IsTemplate": true,
    "ParentType": "sample string 76",
    "ParentValue": "sample string 77",
    "RecordStatus": 78
  },
  {
    "$ref": "1"
  }
]