Class OlvmVirtualMachine

[JsonProperty(PropertyName = "autoPinningPolicy")]
[JsonConverter(typeof(StringEnumConverter))]
public OlvmVirtualMachine.AutoPinningPolicyEnum? AutoPinningPolicy { get; set; }

Property Value

Type	Description
OlvmVirtualMachine.AutoPinningPolicyEnum?	Specifies if and how the auto CPU and NUMA configuration is applied.

Bios

Declaration

[JsonProperty(PropertyName = "bios")]
public OlvmBios Bios { get; set; }

Property Value

Type	Description
OlvmBios

Comment

Declaration

[JsonProperty(PropertyName = "comment")]
public string Comment { get; set; }

Property Value

Type	Description
string	Free text containing comments about this object.

Console

Declaration

[JsonProperty(PropertyName = "console")]
public OlvmConsole Console { get; set; }

Property Value

Type	Description
OlvmConsole

Cpu

Declaration

[JsonProperty(PropertyName = "cpu")]
public OlvmCpu Cpu { get; set; }

Property Value

Type	Description
OlvmCpu

CpuPinningPolicy

Declaration

[JsonProperty(PropertyName = "cpuPinningPolicy")]
[JsonConverter(typeof(StringEnumConverter))]
public OlvmVirtualMachine.CpuPinningPolicyEnum? CpuPinningPolicy { get; set; }

Property Value

Type	Description
OlvmVirtualMachine.CpuPinningPolicyEnum?	Type representing the CPU and NUMA pinning policy.

CpuShares

Declaration

[JsonProperty(PropertyName = "cpuShares")]
public int? CpuShares { get; set; }

Property Value

Type	Description
int?	Number of CPU Shares

CustomCompatibilityVersion

Declaration

[JsonProperty(PropertyName = "customCompatibilityVersion")]
public OlvmVersion CustomCompatibilityVersion { get; set; }

Property Value

Type	Description
OlvmVersion

CustomCpuModel

Declaration

[JsonProperty(PropertyName = "customCpuModel")]
public string CustomCpuModel { get; set; }

Property Value

Type	Description
string	Custom CPU model

CustomEmulatedMachine

Declaration

[JsonProperty(PropertyName = "customEmulatedMachine")]
public string CustomEmulatedMachine { get; set; }

Property Value

Type	Description
string	Custom Emulated machine

CustomProperties

Declaration

[JsonProperty(PropertyName = "customProperties")]
public List<OlvmCustomProperty> CustomProperties { get; set; }

Property Value

Type	Description
List<OlvmCustomProperty>	Custom properties applied to the vNIC profile.

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	A human-readable description in plain text.

Display

Declaration

[JsonProperty(PropertyName = "display")]
public OlvmDisplay Display { get; set; }

Property Value

Type	Description
OlvmDisplay

Domain

Declaration

[JsonProperty(PropertyName = "domain")]
public OlvmDomain Domain { get; set; }

Property Value

Type	Description
OlvmDomain

Fqdn

Declaration

[JsonProperty(PropertyName = "fqdn")]
public string Fqdn { get; set; }

Property Value

Type	Description
string	Fully qualified domain name of the virtual machine.

GuestOperatingSystem

Declaration

[JsonProperty(PropertyName = "guestOperatingSystem")]
public OlvmGuestOperatingSystem GuestOperatingSystem { get; set; }

Property Value

Type	Description
OlvmGuestOperatingSystem

GuestTimeZone

Declaration

[JsonProperty(PropertyName = "guestTimeZone")]
public string GuestTimeZone { get; set; }

Property Value

Type	Description
string	What time zone is used by the virtual machine (as returned by guest agent).

HighAvailability

Declaration

[JsonProperty(PropertyName = "highAvailability")]
public OlvmHighAvailability HighAvailability { get; set; }

Property Value

Type	Description
OlvmHighAvailability

Initialization

Declaration

[JsonProperty(PropertyName = "initialization")]
public OlvmInitialization Initialization { get; set; }

Property Value

Type	Description
OlvmInitialization

IoThreads

Declaration

[JsonProperty(PropertyName = "ioThreads")]
public int? IoThreads { get; set; }

Property Value

Type	Description
int?	For performance tuning of IO threading.

IsContainIllegalImages

Declaration

[JsonProperty(PropertyName = "isContainIllegalImages")]
public bool? IsContainIllegalImages { get; set; }

Property Value

Type	Description
bool?	Indicates whether the virtual machine has snapshots with disks in ILLEGAL state.

IsDeleteProtected

Declaration

[JsonProperty(PropertyName = "isDeleteProtected")]
public bool? IsDeleteProtected { get; set; }

Property Value

Type	Description
bool?	If true, the virtual machine cannot be deleted.

IsMultiQueuesEnabled

Declaration

[JsonProperty(PropertyName = "isMultiQueuesEnabled")]
public bool? IsMultiQueuesEnabled { get; set; }

Property Value

Type	Description
bool?	If true, each virtual interface will get the optimal number of queues, depending on the available virtual Cpus.

IsNextRunConfigurationExists

Declaration

[JsonProperty(PropertyName = "isNextRunConfigurationExists")]
public bool? IsNextRunConfigurationExists { get; set; }

Property Value

Type	Description
bool?	Indicates if virtual machine configuration has been changed and requires restart of the virtual machine.

IsRunOnce

Declaration

[JsonProperty(PropertyName = "isRunOnce")]
public bool? IsRunOnce { get; set; }

Property Value

Type	Description
bool?	If true, the virtual machine has been started using the run once command, meaning it???s configuration might differ from the stored one for the purpose of this single run.

IsSoundcardEnabled

Declaration

[JsonProperty(PropertyName = "isSoundcardEnabled")]
public bool? IsSoundcardEnabled { get; set; }

Property Value

Type	Description
bool?	If true, the sound card is added to the virtual machine.

IsStartPaused

Declaration

[JsonProperty(PropertyName = "isStartPaused")]
public bool? IsStartPaused { get; set; }

Property Value

Type	Description
bool?	If true, the virtual machine will be initially in 'paused' state after start.

IsStateless

Declaration

[JsonProperty(PropertyName = "isStateless")]
public bool? IsStateless { get; set; }

Property Value

Type	Description
bool?	If true, the virtual machine is stateless - it???s state (disks) are rolled-back after shutdown.

IsTpmEnabled

Declaration

[JsonProperty(PropertyName = "isTpmEnabled")]
public bool? IsTpmEnabled { get; set; }

Property Value

Type	Description
bool?	If true, a TPM device is added to the virtual machine.

IsTunnelMigration

Declaration

[JsonProperty(PropertyName = "isTunnelMigration")]
public bool? IsTunnelMigration { get; set; }

Property Value

Type	Description
bool?	If true, the network data transfer will be encrypted during virtual machine live migration.

IsUseLatestTemplateVersion

Declaration

[JsonProperty(PropertyName = "isUseLatestTemplateVersion")]
public bool? IsUseLatestTemplateVersion { get; set; }

Property Value

Type	Description
bool?	If true, the virtual machine is reconfigured to the latest version of it???s template when it is started.

IsVirtioScsiEnabled

Declaration

[JsonProperty(PropertyName = "isVirtioScsiEnabled")]
public bool? IsVirtioScsiEnabled { get; set; }

Property Value

Type	Description
bool?	Indicates if Virtio SCSI Support is enabled.

IsVirtioScsiMultiQueuesEnabled

Declaration

[JsonProperty(PropertyName = "isVirtioScsiMultiQueuesEnabled")]
public bool? IsVirtioScsiMultiQueuesEnabled { get; set; }

Property Value

Type	Description
bool?	If true, the Virtio-SCSI devices will obtain a number of multiple queues depending on the available virtual Cpus and disks, or according to the specified virtioScsiMultiQueues

LargeIcon

Declaration

[JsonProperty(PropertyName = "largeIcon")]
public OlvmIcon LargeIcon { get; set; }

Property Value

Type	Description
OlvmIcon

MemoryInBytes

Declaration

[JsonProperty(PropertyName = "memoryInBytes")]
public long? MemoryInBytes { get; set; }

Property Value

Type	Description
long?	The virtual machine???s memory, in bytes.

MemoryPolicy

Declaration

[JsonProperty(PropertyName = "memoryPolicy")]
public OlvmMemoryPolicy MemoryPolicy { get; set; }

Property Value

Type	Description
OlvmMemoryPolicy

MigrationDowntimeInMs

Declaration

[JsonProperty(PropertyName = "migrationDowntimeInMs")]
public int? MigrationDowntimeInMs { get; set; }

Property Value

Type	Description
int?	Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

MigrationPolicy

Declaration

[JsonProperty(PropertyName = "migrationPolicy")]
public OlvmMigrationOptions MigrationPolicy { get; set; }

Property Value

Type	Description
OlvmMigrationOptions

NumaTuneMode

Declaration

[JsonProperty(PropertyName = "numaTuneMode")]
[JsonConverter(typeof(StringEnumConverter))]
public OlvmVirtualMachine.NumaTuneModeEnum? NumaTuneMode { get; set; }

Property Value

Type	Description
OlvmVirtualMachine.NumaTuneModeEnum?	How the NUMA topology is applied.

Origin

Declaration

[JsonProperty(PropertyName = "origin")]
public string Origin { get; set; }

Property Value

Type	Description
string	The origin of this virtual machine.

Os

Declaration

[JsonProperty(PropertyName = "os")]
public OlvmOperatingSystem Os { get; set; }

Property Value

Type	Description
OlvmOperatingSystem

PlacementPolicy

Declaration

[JsonProperty(PropertyName = "placementPolicy")]
public OlvmVmPlacementPolicy PlacementPolicy { get; set; }

Property Value

Type	Description
OlvmVmPlacementPolicy

SerialNumber

Declaration

[JsonProperty(PropertyName = "serialNumber")]
public OlvmSerialNumber SerialNumber { get; set; }

Property Value

Type	Description
OlvmSerialNumber

SmallIcon

Declaration

[JsonProperty(PropertyName = "smallIcon")]
public OlvmIcon SmallIcon { get; set; }

Property Value

Type	Description
OlvmIcon

Status

Declaration

[JsonProperty(PropertyName = "status")]
public OlvmVmStatus Status { get; set; }

Property Value

Type	Description
OlvmVmStatus

StatusDetail

Declaration

[JsonProperty(PropertyName = "statusDetail")]
public string StatusDetail { get; set; }

Property Value

Type	Description
string	Human readable detail of current status.

StopReason

Declaration

[JsonProperty(PropertyName = "stopReason")]
public string StopReason { get; set; }

Property Value

Type	Description
string	The reason the virtual machine was stopped.

StorageDomainLease

Declaration

[JsonProperty(PropertyName = "storageDomainLease")]
public OlvmStorageDomainProperties StorageDomainLease { get; set; }

Property Value

Type	Description
OlvmStorageDomainProperties

StorageErrorResumeBehavior

Declaration

[JsonProperty(PropertyName = "storageErrorResumeBehavior")]
[JsonConverter(typeof(StringEnumConverter))]
public OlvmVirtualMachine.StorageErrorResumeBehaviorEnum? StorageErrorResumeBehavior { get; set; }

Property Value

Type	Description
OlvmVirtualMachine.StorageErrorResumeBehaviorEnum?	Determines how the virtual machine will be resumed after storage error.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	Creation time.

TimeStart

Declaration

[JsonProperty(PropertyName = "timeStart")]
public DateTime? TimeStart { get; set; }

Property Value

Type	Description
DateTime?	The date in which the virtual machine was started.

TimeStop

Declaration

[JsonProperty(PropertyName = "timeStop")]
public DateTime? TimeStop { get; set; }

Property Value

Type	Description
DateTime?	The date in which the virtual machine was stopped.

Timezone

Declaration

[JsonProperty(PropertyName = "timezone")]
public string Timezone { get; set; }

Property Value

Type	Description
string	Name of time zone.

Type

Declaration

[JsonProperty(PropertyName = "type")]
public OlvmVmType Type { get; set; }

Property Value

Type	Description
OlvmVmType

Usb

Declaration

[JsonProperty(PropertyName = "usb")]
public OlvmUsb Usb { get; set; }

Property Value

Type	Description
OlvmUsb

VirtioScsiMultiQueues

Declaration

[JsonProperty(PropertyName = "virtioScsiMultiQueues")]
public int? VirtioScsiMultiQueues { get; set; }

Property Value

Type	Description
int?	Number of queues for a Virtio-SCSI contoller this field requires virtioScsiMultiQueuesEnabled to be true see virtioScsiMultiQueuesEnabled for more info

VirtualMachineName

Declaration

[JsonProperty(PropertyName = "virtualMachineName")]
public string VirtualMachineName { get; set; }

Property Value

Type	Description
string	Name of the property.