ManagedMachineDataV3

ManagedMachineDataV3
ManagedMachineDataV3

Information related to Managed machines.

JSON Example
{
    "base_vm_id": "vm-23",
    "base_vm_snapshot_id": "snapshot-2",
    "clone_error_message": "Timeout expired trying to clone a virtual machine.",
    "clone_error_time": 1575285661395,
    "create_time": 1575285661395,
    "datastore_ids": [
        "datastore1",
        "datastore2"
    ],
    "host_name": "WD332H5",
    "image_management_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
    "image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
    "in_hold_customization": false,
    "in_maintenance_mode": false,
    "last_maintenance_time": 1587081283000,
    "logoff_policy": "FORCE_LOGOFF",
    "memory_mb": 1024,
    "missing_in_vcenter": false,
    "network_labels": [
        {
            "network_label_name": "example-network",
            "nic_name": "network1"
        }
    ],
    "operation": "REFRESH",
    "operation_state": "AVAILABLE",
    "path": "/path/host",
    "pending_base_vm_id": "vm-8",
    "pending_base_vm_snapshot_id": "snapshot-7",
    "pending_image_management_stream_id": "ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25",
    "pending_image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
    "persistent_disk_ids": [
        "c1d5aec7-2126-3c55-aefa-11949003c9c2"
    ],
    "storage_accelerator_state": "CURRENT",
    "virtual_center_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
    "virtual_disks": [
        {
            "capacity_mb": 102400,
            "datastore_path": "datastore1",
            "path": "/path/host"
        }
    ],
    "virtual_machine_power_state": "POWERED_ON",
    "vm_moid": "vm-123"
}
string
base_vm_id
Optional

The base VM id.
Supported Filters : 'Equals'.

string
base_vm_snapshot_id
Optional

The base VM snapshot id.
Supported Filters : 'Equals'.

string
clone_error_message
Optional

Cloning error message for this machine. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.

integer As int64 As int64
clone_error_time
Optional

Cloning error time for this machine in milliseconds. Measured as epoch time. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.

integer As int64 As int64
create_time
Optional

Time at which the machine was created in milliseconds. Measured as epoch time. This property can be used for sorting.

array of string
datastore_ids
Optional

The ids of the datastores.

string
host_name
Optional

The name of the host on which this virtual machine is registered.

string
image_management_stream_id
Optional

The id of the image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.

string
image_management_tag_id
Optional

The id of the image management tag. This will be populated only for instant clone machines provisioned from pools created using image catalog.

boolean
in_hold_customization
Optional

This condition determines if this virtual machine should be on hold before customization is started.
Supported Filters : 'Equals'. This property can be used for sorting.

boolean
in_maintenance_mode
Optional

Indicates whether the Machine is in maintenance mode.

integer As int64 As int64
last_maintenance_time
Optional

The time of the last maintenance operation. This property can be used for sorting.

string
logoff_policy
Optional

The user log off behavior at the time of maintenance. This property can be used for sorting.

  • FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.
  • WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
Possible values are : FORCE_LOGOFF, WAIT_FOR_LOGOFF,
integer As int32 As int32
memory_mb
Optional

The virtual machine physical memory in MB.

boolean
missing_in_vcenter
Optional

This condition determines if the virtual machine is missing in vCenter Server.
Supported Filters : 'Equals'. This property can be used for sorting.

network_labels
Optional

The network label(s) associated with this Machine.
This information will only be populated if a network label is explicitly assigned to this machine.
Otherwise, the machine inherits these properties from the parent virtual machine.

string
operation
Optional

The current maintenance operation on the machine.
Supported Filters : 'Equals'. This property can be used for sorting.

  • ARCHIVE: An archive operation.
  • ATTACH: A persistent disk attach operation.
  • DETACH: A persistent disk detach operation.
  • PUSH_IMAGE: A push image operation.
  • TAGGING: A tagging operation.
Possible values are : ARCHIVE, ATTACH, DETACH, PUSH_IMAGE, TAGGING,
string
operation_state
Optional

The state of the current maintenance operation on the machine.
Supported Filters : 'Equals'. This property can be used for sorting.

  • CANCELLING: The operation has been cancelled.
  • COMPLETED: The operation has completed.
  • CREATE: The operation is being initiated.
  • FAULT: The operation has encountered an error.
  • HOLDING: The operation has been paused.
  • PROGRESSING: The operation is in progress.
  • SCHEDULED: The operation is scheduled for future execution.
  • STANDBY: The operation is on standby for a selective resync.
  • UNDEFINED: The operation state is unrecognized.
Possible values are : CANCELLING, COMPLETED, CREATE, FAULT, HOLDING, PROGRESSING, SCHEDULED, STANDBY, UNDEFINED,
string
path
Optional

The virtual machine path.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path. This property can be used for sorting.

string
pending_base_vm_id
Optional

The pending base VM id.
Supported Filters : 'Equals'.

string
pending_base_vm_snapshot_id
Optional

The pending base VM snapshot id.
Supported Filters : 'Equals'.

string
pending_image_management_stream_id
Optional

The id of the pending image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.

string
pending_image_management_tag_id
Optional

The id of the pending image management tag. This will be populated only for machines belonging to Instant Clone farms created using image catalog.

array of string
persistent_disk_ids
Optional

The persistent disk(s) attached to this machine.

string
storage_accelerator_state
Optional

The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.
Supported Filters : 'Equals'. This property can be used for sorting.

  • CURRENT: The machine cached data is updated.
  • ERROR: The Storage Accelerator has encountered an error.
  • OFF: The Storage Accelerator is off.
  • OUT_OF_DATE: The machine cached data is not updated and requires regeneration.
Possible values are : CURRENT, ERROR, OFF, OUT_OF_DATE,
string
virtual_center_id
Optional

The ID of the Virtual Center managing this machine.
Supported Filters : 'Equals'.

virtual_disks
Optional

The virtual disks comprising the virtual machine.

string
virtual_machine_power_state
Optional

The virtual machine power state.
Supported Filters : 'Equals'. This property can be used for sorting.

  • POWERED_OFF: The machine is powered off.
  • POWERED_ON: The machine is powered on.
  • SUSPENDED: The machine is suspended.
Possible values are : POWERED_OFF, POWERED_ON, SUSPENDED,
string
vm_moid
Optional

The moid of managed machine.
Supported Filters: 'Equals'.

Property Of