nutanix.getVirtualMachine

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

func LookupVirtualMachine(ctx *Context, args *LookupVirtualMachineArgs, opts ...InvokeOption) (*LookupVirtualMachineResult, error)
func LookupVirtualMachineOutput(ctx *Context, args *LookupVirtualMachineOutputArgs, opts ...InvokeOption) LookupVirtualMachineResultOutput

> Note: This function is named LookupVirtualMachine in the Go SDK.

VmId string

Represents virtual machine UUID

BootDeviceDiskAddress Dictionary<string, string>

• Address of disk to boot from.

BootDeviceMacAddress string

• MAC address of nic to boot from.

Categories List<PiersKarsenbarg.Nutanix.Inputs.GetVirtualMachineCategory>

• Categories for the vm.

VmId string

Represents virtual machine UUID

BootDeviceDiskAddress map[string]string

• Address of disk to boot from.

BootDeviceMacAddress string

• MAC address of nic to boot from.

Categories []GetVirtualMachineCategory

• Categories for the vm.

vmId String

Represents virtual machine UUID

bootDeviceDiskAddress Map<String,String>

• Address of disk to boot from.

bootDeviceMacAddress String

• MAC address of nic to boot from.

categories List<GetVirtualMachineCategory>

• Categories for the vm.

vmId string

Represents virtual machine UUID

bootDeviceDiskAddress {[key: string]: string}

• Address of disk to boot from.

bootDeviceMacAddress string

• MAC address of nic to boot from.

categories GetVirtualMachineCategory[]

• Categories for the vm.

vm_id str

Represents virtual machine UUID

boot_device_disk_address Mapping[str, str]

• Address of disk to boot from.

boot_device_mac_address str

• MAC address of nic to boot from.

categories Sequence[GetVirtualMachineCategory]

• Categories for the vm.

vmId String

Represents virtual machine UUID

bootDeviceDiskAddress Map<String>

• Address of disk to boot from.

bootDeviceMacAddress String

• MAC address of nic to boot from.

categories List<Property Map>

• Categories for the vm.

ApiVersion string

The version of the API.

AvailabilityZoneReference Dictionary<string, string>

• The reference to a availability_zone.

BootDeviceDiskAddress Dictionary<string, string>

• Address of disk to boot from.

BootDeviceMacAddress string

• MAC address of nic to boot from.

BootDeviceOrderLists List<string>

• Indicates the order of device types in which VM should try to boot from. If boot device order is not provided the system will decide appropriate boot device order.

BootType string

• Indicates whether the VM should use Secure boot, UEFI boot or Legacy boot.If UEFI or; Secure boot is enabled then other legacy boot options (like boot_device and; boot_device_order_list) are ignored. Secure boot depends on UEFI boot, i.e. enabling; Secure boot means that UEFI boot is also enabled. The possible value are: UEFI", "LEGACY", "SECURE_BOOT".

Categories List<PiersKarsenbarg.Nutanix.Outputs.GetVirtualMachineCategory>

• Categories for the vm.

ClusterName string

• The name of the reference to the cluster.

ClusterUuid string

Description string

• A description for vm.

DiskLists List<PiersKarsenbarg.Nutanix.Outputs.GetVirtualMachineDiskList>

Disks attached to the VM.

EnableCpuPassthrough bool

EnableScriptExec bool

• Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.

GpuLists List<PiersKarsenbarg.Nutanix.Outputs.GetVirtualMachineGpuList>

• GPUs attached to the VM.

GuestCustomizationCloudInitCustomKeyValues Dictionary<string, object>

• Generic key value pair used for custom attributes in cloud init.

GuestCustomizationCloudInitMetaData string

The contents of the meta_data configuration for cloud-init. This can be formatted as YAML or JSON. The value must be base64 encoded.

GuestCustomizationCloudInitUserData string

• The contents of the user_data configuration for cloud-init. This can be formatted as YAML, JSON, or could be a shell script. The value must be base64 encoded.

GuestCustomizationIsOverridable bool

• Flag to allow override of customization by deployer.

GuestCustomizationSysprep Dictionary<string, string>

• VM guests may be customized at boot time using one of several different methods. Currently, cloud-init w/ ConfigDriveV2 (for Linux VMs) and Sysprep (for Windows VMs) are supported. Only ONE OF sysprep or cloud_init should be provided. Note that guest customization can currently only be set during VM creation. Attempting to change it after creation will result in an error. Additional properties can be specified. For example - in the context of VM template creation if "override_script" is set to "True" then the deployer can upload their own custom script.

GuestCustomizationSysprepCustomKeyValues Dictionary<string, object>

• Generic key value pair used for custom attributes in sysprep.

GuestOsId string

• Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.

HardwareClockTimezone string

• VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).

HostReference Dictionary<string, string>

• Reference to a host.

HypervisorType string

• The hypervisor type for the hypervisor the VM is hosted on.

Id string

The provider-assigned unique ID for this managed resource.

IsVcpuHardPinned bool

MachineType string

• Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.

MemorySizeMib int

• Memory size in MiB.

MessageLists List<PiersKarsenbarg.Nutanix.Outputs.GetVirtualMachineMessageList>

Metadata Dictionary<string, string>

• The vm kind metadata.

Name string

• the name.

NgtCredentials Dictionary<string, object>

• Credentials to login server.

NgtEnabledCapabilityLists List<string>

Application names that are enabled.

NicLists List<PiersKarsenbarg.Nutanix.Outputs.GetVirtualMachineNicList>

• NICs attached to the VM.

NumSockets int

• Number of vCPU sockets.

NumVcpusPerSocket int

• Number of vCPUs per socket.

NumVnumaNodes int

• Number of vNUMA nodes. 0 means vNUMA is disabled.

NutanixGuestTools Dictionary<string, string>

• Information regarding Nutanix Guest Tools.

OwnerReference Dictionary<string, string>

• The reference to a user.

ParentReference Dictionary<string, string>

PowerState string

• The current or desired power state of the VM. (Options : ON , OFF)

PowerStateMechanism string

• Indicates the mechanism guiding the VM power state transition. Currently used for the transition to "OFF" state. Power state mechanism (ACPI/GUEST/HARD).

ProjectReference Dictionary<string, string>

• The reference to a project.

SerialPortLists List<PiersKarsenbarg.Nutanix.Outputs.GetVirtualMachineSerialPortList>

• (Optional) Serial Ports configured on the VM.

ShouldFailOnScriptFailure bool

• Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.

State string

• Nutanix Guest Tools is enabled or not.

VgaConsoleEnabled bool

• Indicates whether VGA console should be enabled or not.

VmId string

ApiVersion string

The version of the API.

AvailabilityZoneReference map[string]string

• The reference to a availability_zone.

BootDeviceDiskAddress map[string]string

• Address of disk to boot from.

BootDeviceMacAddress string

• MAC address of nic to boot from.

BootDeviceOrderLists []string

• Indicates the order of device types in which VM should try to boot from. If boot device order is not provided the system will decide appropriate boot device order.

BootType string

• Indicates whether the VM should use Secure boot, UEFI boot or Legacy boot.If UEFI or; Secure boot is enabled then other legacy boot options (like boot_device and; boot_device_order_list) are ignored. Secure boot depends on UEFI boot, i.e. enabling; Secure boot means that UEFI boot is also enabled. The possible value are: UEFI", "LEGACY", "SECURE_BOOT".

Categories []GetVirtualMachineCategory

• Categories for the vm.

ClusterName string

• The name of the reference to the cluster.

ClusterUuid string

Description string

• A description for vm.

DiskLists []GetVirtualMachineDiskList

Disks attached to the VM.

EnableCpuPassthrough bool

EnableScriptExec bool

• Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.

GpuLists []GetVirtualMachineGpuList

• GPUs attached to the VM.

GuestCustomizationCloudInitCustomKeyValues map[string]interface{}

• Generic key value pair used for custom attributes in cloud init.

GuestCustomizationCloudInitMetaData string

The contents of the meta_data configuration for cloud-init. This can be formatted as YAML or JSON. The value must be base64 encoded.

GuestCustomizationCloudInitUserData string

• The contents of the user_data configuration for cloud-init. This can be formatted as YAML, JSON, or could be a shell script. The value must be base64 encoded.

GuestCustomizationIsOverridable bool

• Flag to allow override of customization by deployer.

GuestCustomizationSysprep map[string]string

• VM guests may be customized at boot time using one of several different methods. Currently, cloud-init w/ ConfigDriveV2 (for Linux VMs) and Sysprep (for Windows VMs) are supported. Only ONE OF sysprep or cloud_init should be provided. Note that guest customization can currently only be set during VM creation. Attempting to change it after creation will result in an error. Additional properties can be specified. For example - in the context of VM template creation if "override_script" is set to "True" then the deployer can upload their own custom script.

GuestCustomizationSysprepCustomKeyValues map[string]interface{}

• Generic key value pair used for custom attributes in sysprep.

GuestOsId string

• Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.

HardwareClockTimezone string

• VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).

HostReference map[string]string

• Reference to a host.

HypervisorType string

• The hypervisor type for the hypervisor the VM is hosted on.

Id string

The provider-assigned unique ID for this managed resource.

IsVcpuHardPinned bool

MachineType string

• Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.

MemorySizeMib int

• Memory size in MiB.

MessageLists []GetVirtualMachineMessageList

Metadata map[string]string

• The vm kind metadata.

Name string

• the name.

NgtCredentials map[string]interface{}

• Credentials to login server.

NgtEnabledCapabilityLists []string

Application names that are enabled.

NicLists []GetVirtualMachineNicList

• NICs attached to the VM.

NumSockets int

• Number of vCPU sockets.

NumVcpusPerSocket int

• Number of vCPUs per socket.

NumVnumaNodes int

• Number of vNUMA nodes. 0 means vNUMA is disabled.

NutanixGuestTools map[string]string

• Information regarding Nutanix Guest Tools.

OwnerReference map[string]string

• The reference to a user.

ParentReference map[string]string

PowerState string

• The current or desired power state of the VM. (Options : ON , OFF)

PowerStateMechanism string

• Indicates the mechanism guiding the VM power state transition. Currently used for the transition to "OFF" state. Power state mechanism (ACPI/GUEST/HARD).

ProjectReference map[string]string

• The reference to a project.

SerialPortLists []GetVirtualMachineSerialPortList

• (Optional) Serial Ports configured on the VM.

ShouldFailOnScriptFailure bool

• Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.

State string

• Nutanix Guest Tools is enabled or not.

VgaConsoleEnabled bool

• Indicates whether VGA console should be enabled or not.

VmId string

apiVersion String

The version of the API.

availabilityZoneReference Map<String,String>

• The reference to a availability_zone.

bootDeviceDiskAddress Map<String,String>

• Address of disk to boot from.

bootDeviceMacAddress String

• MAC address of nic to boot from.

bootDeviceOrderLists List<String>

• Indicates the order of device types in which VM should try to boot from. If boot device order is not provided the system will decide appropriate boot device order.

bootType String

• Indicates whether the VM should use Secure boot, UEFI boot or Legacy boot.If UEFI or; Secure boot is enabled then other legacy boot options (like boot_device and; boot_device_order_list) are ignored. Secure boot depends on UEFI boot, i.e. enabling; Secure boot means that UEFI boot is also enabled. The possible value are: UEFI", "LEGACY", "SECURE_BOOT".

categories List<GetVirtualMachineCategory>

• Categories for the vm.

clusterName String

• The name of the reference to the cluster.

clusterUuid String

description String

• A description for vm.

diskLists List<GetVirtualMachineDiskList>

Disks attached to the VM.

enableCpuPassthrough Boolean

enableScriptExec Boolean

• Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.

gpuLists List<GetVirtualMachineGpuList>

• GPUs attached to the VM.

guestCustomizationCloudInitCustomKeyValues Map<String,Object>

• Generic key value pair used for custom attributes in cloud init.

guestCustomizationCloudInitMetaData String

The contents of the meta_data configuration for cloud-init. This can be formatted as YAML or JSON. The value must be base64 encoded.

guestCustomizationCloudInitUserData String

• The contents of the user_data configuration for cloud-init. This can be formatted as YAML, JSON, or could be a shell script. The value must be base64 encoded.

guestCustomizationIsOverridable Boolean

• Flag to allow override of customization by deployer.

guestCustomizationSysprep Map<String,String>

• VM guests may be customized at boot time using one of several different methods. Currently, cloud-init w/ ConfigDriveV2 (for Linux VMs) and Sysprep (for Windows VMs) are supported. Only ONE OF sysprep or cloud_init should be provided. Note that guest customization can currently only be set during VM creation. Attempting to change it after creation will result in an error. Additional properties can be specified. For example - in the context of VM template creation if "override_script" is set to "True" then the deployer can upload their own custom script.

guestCustomizationSysprepCustomKeyValues Map<String,Object>

• Generic key value pair used for custom attributes in sysprep.

guestOsId String

• Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.

hardwareClockTimezone String

• VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).

hostReference Map<String,String>

• Reference to a host.

hypervisorType String

• The hypervisor type for the hypervisor the VM is hosted on.

id String

The provider-assigned unique ID for this managed resource.

isVcpuHardPinned Boolean

machineType String

• Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.

memorySizeMib Integer

• Memory size in MiB.

messageLists List<GetVirtualMachineMessageList>

metadata Map<String,String>

• The vm kind metadata.

name String

• the name.

ngtCredentials Map<String,Object>

• Credentials to login server.

ngtEnabledCapabilityLists List<String>

Application names that are enabled.

nicLists List<GetVirtualMachineNicList>

• NICs attached to the VM.

numSockets Integer

• Number of vCPU sockets.

numVcpusPerSocket Integer

• Number of vCPUs per socket.

numVnumaNodes Integer

• Number of vNUMA nodes. 0 means vNUMA is disabled.

nutanixGuestTools Map<String,String>

• Information regarding Nutanix Guest Tools.

ownerReference Map<String,String>

• The reference to a user.

parentReference Map<String,String>

powerState String

• The current or desired power state of the VM. (Options : ON , OFF)

powerStateMechanism String

• Indicates the mechanism guiding the VM power state transition. Currently used for the transition to "OFF" state. Power state mechanism (ACPI/GUEST/HARD).

projectReference Map<String,String>

• The reference to a project.

serialPortLists List<GetVirtualMachineSerialPortList>

• (Optional) Serial Ports configured on the VM.

shouldFailOnScriptFailure Boolean

• Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.

state String

• Nutanix Guest Tools is enabled or not.

vgaConsoleEnabled Boolean

• Indicates whether VGA console should be enabled or not.

vmId String

apiVersion string

The version of the API.

availabilityZoneReference {[key: string]: string}

• The reference to a availability_zone.

bootDeviceDiskAddress {[key: string]: string}

• Address of disk to boot from.

bootDeviceMacAddress string

• MAC address of nic to boot from.

bootDeviceOrderLists string[]

• Indicates the order of device types in which VM should try to boot from. If boot device order is not provided the system will decide appropriate boot device order.

bootType string

• Indicates whether the VM should use Secure boot, UEFI boot or Legacy boot.If UEFI or; Secure boot is enabled then other legacy boot options (like boot_device and; boot_device_order_list) are ignored. Secure boot depends on UEFI boot, i.e. enabling; Secure boot means that UEFI boot is also enabled. The possible value are: UEFI", "LEGACY", "SECURE_BOOT".

categories GetVirtualMachineCategory[]

• Categories for the vm.

clusterName string

• The name of the reference to the cluster.

clusterUuid string

description string

• A description for vm.

diskLists GetVirtualMachineDiskList[]

Disks attached to the VM.

enableCpuPassthrough boolean

enableScriptExec boolean

• Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.

gpuLists GetVirtualMachineGpuList[]

• GPUs attached to the VM.

guestCustomizationCloudInitCustomKeyValues {[key: string]: any}

• Generic key value pair used for custom attributes in cloud init.

guestCustomizationCloudInitMetaData string

The contents of the meta_data configuration for cloud-init. This can be formatted as YAML or JSON. The value must be base64 encoded.

guestCustomizationCloudInitUserData string

• The contents of the user_data configuration for cloud-init. This can be formatted as YAML, JSON, or could be a shell script. The value must be base64 encoded.

guestCustomizationIsOverridable boolean

• Flag to allow override of customization by deployer.

guestCustomizationSysprep {[key: string]: string}

• VM guests may be customized at boot time using one of several different methods. Currently, cloud-init w/ ConfigDriveV2 (for Linux VMs) and Sysprep (for Windows VMs) are supported. Only ONE OF sysprep or cloud_init should be provided. Note that guest customization can currently only be set during VM creation. Attempting to change it after creation will result in an error. Additional properties can be specified. For example - in the context of VM template creation if "override_script" is set to "True" then the deployer can upload their own custom script.

guestCustomizationSysprepCustomKeyValues {[key: string]: any}

• Generic key value pair used for custom attributes in sysprep.

guestOsId string

• Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.

hardwareClockTimezone string

• VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).

hostReference {[key: string]: string}

• Reference to a host.

hypervisorType string

• The hypervisor type for the hypervisor the VM is hosted on.

id string

The provider-assigned unique ID for this managed resource.

isVcpuHardPinned boolean

machineType string

• Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.

memorySizeMib number

• Memory size in MiB.

messageLists GetVirtualMachineMessageList[]

metadata {[key: string]: string}

• The vm kind metadata.

name string

• the name.

ngtCredentials {[key: string]: any}

• Credentials to login server.

ngtEnabledCapabilityLists string[]

Application names that are enabled.

nicLists GetVirtualMachineNicList[]

• NICs attached to the VM.

numSockets number

• Number of vCPU sockets.

numVcpusPerSocket number

• Number of vCPUs per socket.

numVnumaNodes number

• Number of vNUMA nodes. 0 means vNUMA is disabled.

nutanixGuestTools {[key: string]: string}

• Information regarding Nutanix Guest Tools.

ownerReference {[key: string]: string}

• The reference to a user.

parentReference {[key: string]: string}

powerState string

• The current or desired power state of the VM. (Options : ON , OFF)

powerStateMechanism string

• Indicates the mechanism guiding the VM power state transition. Currently used for the transition to "OFF" state. Power state mechanism (ACPI/GUEST/HARD).

projectReference {[key: string]: string}

• The reference to a project.

serialPortLists GetVirtualMachineSerialPortList[]

• (Optional) Serial Ports configured on the VM.

shouldFailOnScriptFailure boolean

• Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.

state string

• Nutanix Guest Tools is enabled or not.

vgaConsoleEnabled boolean

• Indicates whether VGA console should be enabled or not.

vmId string

api_version str

The version of the API.

availability_zone_reference Mapping[str, str]

• The reference to a availability_zone.

boot_device_disk_address Mapping[str, str]

• Address of disk to boot from.

boot_device_mac_address str

• MAC address of nic to boot from.

boot_device_order_lists Sequence[str]

• Indicates the order of device types in which VM should try to boot from. If boot device order is not provided the system will decide appropriate boot device order.

boot_type str

• Indicates whether the VM should use Secure boot, UEFI boot or Legacy boot.If UEFI or; Secure boot is enabled then other legacy boot options (like boot_device and; boot_device_order_list) are ignored. Secure boot depends on UEFI boot, i.e. enabling; Secure boot means that UEFI boot is also enabled. The possible value are: UEFI", "LEGACY", "SECURE_BOOT".

categories Sequence[GetVirtualMachineCategory]

• Categories for the vm.

cluster_name str

• The name of the reference to the cluster.

cluster_uuid str

description str

• A description for vm.

disk_lists Sequence[GetVirtualMachineDiskList]

Disks attached to the VM.

enable_cpu_passthrough bool

enable_script_exec bool

• Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.

gpu_lists Sequence[GetVirtualMachineGpuList]

• GPUs attached to the VM.

guest_customization_cloud_init_custom_key_values Mapping[str, Any]

• Generic key value pair used for custom attributes in cloud init.

guest_customization_cloud_init_meta_data str

The contents of the meta_data configuration for cloud-init. This can be formatted as YAML or JSON. The value must be base64 encoded.

guest_customization_cloud_init_user_data str

• The contents of the user_data configuration for cloud-init. This can be formatted as YAML, JSON, or could be a shell script. The value must be base64 encoded.

guest_customization_is_overridable bool

• Flag to allow override of customization by deployer.

guest_customization_sysprep Mapping[str, str]

• VM guests may be customized at boot time using one of several different methods. Currently, cloud-init w/ ConfigDriveV2 (for Linux VMs) and Sysprep (for Windows VMs) are supported. Only ONE OF sysprep or cloud_init should be provided. Note that guest customization can currently only be set during VM creation. Attempting to change it after creation will result in an error. Additional properties can be specified. For example - in the context of VM template creation if "override_script" is set to "True" then the deployer can upload their own custom script.

guest_customization_sysprep_custom_key_values Mapping[str, Any]

• Generic key value pair used for custom attributes in sysprep.

guest_os_id str

• Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.

hardware_clock_timezone str

• VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).

host_reference Mapping[str, str]

• Reference to a host.

hypervisor_type str

• The hypervisor type for the hypervisor the VM is hosted on.

id str

The provider-assigned unique ID for this managed resource.

is_vcpu_hard_pinned bool

machine_type str

• Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.

memory_size_mib int

• Memory size in MiB.

message_lists Sequence[GetVirtualMachineMessageList]

metadata Mapping[str, str]

• The vm kind metadata.

name str

• the name.

ngt_credentials Mapping[str, Any]

• Credentials to login server.

ngt_enabled_capability_lists Sequence[str]

Application names that are enabled.

nic_lists Sequence[GetVirtualMachineNicList]

• NICs attached to the VM.

num_sockets int

• Number of vCPU sockets.

num_vcpus_per_socket int

• Number of vCPUs per socket.

num_vnuma_nodes int

• Number of vNUMA nodes. 0 means vNUMA is disabled.

nutanix_guest_tools Mapping[str, str]

• Information regarding Nutanix Guest Tools.

owner_reference Mapping[str, str]

• The reference to a user.

parent_reference Mapping[str, str]

power_state str

• The current or desired power state of the VM. (Options : ON , OFF)

power_state_mechanism str

• Indicates the mechanism guiding the VM power state transition. Currently used for the transition to "OFF" state. Power state mechanism (ACPI/GUEST/HARD).

project_reference Mapping[str, str]

• The reference to a project.

serial_port_lists Sequence[GetVirtualMachineSerialPortList]

• (Optional) Serial Ports configured on the VM.

should_fail_on_script_failure bool

• Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.

state str

• Nutanix Guest Tools is enabled or not.

vga_console_enabled bool

• Indicates whether VGA console should be enabled or not.

vm_id str

apiVersion String

The version of the API.

availabilityZoneReference Map<String>

• The reference to a availability_zone.

bootDeviceDiskAddress Map<String>

• Address of disk to boot from.

bootDeviceMacAddress String

• MAC address of nic to boot from.

bootDeviceOrderLists List<String>

• Indicates the order of device types in which VM should try to boot from. If boot device order is not provided the system will decide appropriate boot device order.

bootType String

• Indicates whether the VM should use Secure boot, UEFI boot or Legacy boot.If UEFI or; Secure boot is enabled then other legacy boot options (like boot_device and; boot_device_order_list) are ignored. Secure boot depends on UEFI boot, i.e. enabling; Secure boot means that UEFI boot is also enabled. The possible value are: UEFI", "LEGACY", "SECURE_BOOT".

categories List<Property Map>

• Categories for the vm.

clusterName String

• The name of the reference to the cluster.

clusterUuid String

description String

• A description for vm.

diskLists List<Property Map>

Disks attached to the VM.

enableCpuPassthrough Boolean

enableScriptExec Boolean

• Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.

gpuLists List<Property Map>

• GPUs attached to the VM.

guestCustomizationCloudInitCustomKeyValues Map<Any>

• Generic key value pair used for custom attributes in cloud init.

guestCustomizationCloudInitMetaData String

The contents of the meta_data configuration for cloud-init. This can be formatted as YAML or JSON. The value must be base64 encoded.

guestCustomizationCloudInitUserData String

• The contents of the user_data configuration for cloud-init. This can be formatted as YAML, JSON, or could be a shell script. The value must be base64 encoded.

guestCustomizationIsOverridable Boolean

• Flag to allow override of customization by deployer.

guestCustomizationSysprep Map<String>

• VM guests may be customized at boot time using one of several different methods. Currently, cloud-init w/ ConfigDriveV2 (for Linux VMs) and Sysprep (for Windows VMs) are supported. Only ONE OF sysprep or cloud_init should be provided. Note that guest customization can currently only be set during VM creation. Attempting to change it after creation will result in an error. Additional properties can be specified. For example - in the context of VM template creation if "override_script" is set to "True" then the deployer can upload their own custom script.

guestCustomizationSysprepCustomKeyValues Map<Any>

• Generic key value pair used for custom attributes in sysprep.

guestOsId String

• Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.

hardwareClockTimezone String

• VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).

hostReference Map<String>

• Reference to a host.

hypervisorType String

• The hypervisor type for the hypervisor the VM is hosted on.

id String

The provider-assigned unique ID for this managed resource.

isVcpuHardPinned Boolean

machineType String

• Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.

memorySizeMib Number

• Memory size in MiB.

messageLists List<Property Map>

metadata Map<String>

• The vm kind metadata.

name String

• the name.

ngtCredentials Map<Any>

• Credentials to login server.

ngtEnabledCapabilityLists List<String>

Application names that are enabled.

nicLists List<Property Map>

• NICs attached to the VM.

numSockets Number

• Number of vCPU sockets.

numVcpusPerSocket Number

• Number of vCPUs per socket.

numVnumaNodes Number

• Number of vNUMA nodes. 0 means vNUMA is disabled.

nutanixGuestTools Map<String>

• Information regarding Nutanix Guest Tools.

ownerReference Map<String>

• The reference to a user.

parentReference Map<String>

powerState String

• The current or desired power state of the VM. (Options : ON , OFF)

powerStateMechanism String

• Indicates the mechanism guiding the VM power state transition. Currently used for the transition to "OFF" state. Power state mechanism (ACPI/GUEST/HARD).

projectReference Map<String>

• The reference to a project.

serialPortLists List<Property Map>

• (Optional) Serial Ports configured on the VM.

shouldFailOnScriptFailure Boolean

• Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.

state String

• Nutanix Guest Tools is enabled or not.

vgaConsoleEnabled Boolean

• Indicates whether VGA console should be enabled or not.

vmId String

Name string

• the name.

Value string

• value of the key.

Name string

• the name.

Value string

• value of the key.

name String

• the name.

value String

• value of the key.

name string

• the name.

value string

• value of the key.

name str

• the name.

value str

• value of the key.

name String

• the name.

value String

• value of the key.

DataSourceReference Dictionary<string, string>

Reference to a data source.

DeviceProperties List<PiersKarsenbarg.Nutanix.Inputs.GetVirtualMachineDiskListDeviceProperty>

Properties to a device.

DiskSizeBytes int

Size of the disk in Bytes.

DiskSizeMib int

Size of the disk in MiB. Must match the size specified in 'disk_size_bytes' - rounded up to the nearest MiB - when that field is present.

StorageConfigs List<PiersKarsenbarg.Nutanix.Inputs.GetVirtualMachineDiskListStorageConfig>

Uuid string

• the UUID.

VolumeGroupReference Dictionary<string, string>

Reference to a volume group.

DataSourceReference map[string]string

Reference to a data source.

DeviceProperties []GetVirtualMachineDiskListDeviceProperty

Properties to a device.

DiskSizeBytes int

Size of the disk in Bytes.

DiskSizeMib int

Size of the disk in MiB. Must match the size specified in 'disk_size_bytes' - rounded up to the nearest MiB - when that field is present.

StorageConfigs []GetVirtualMachineDiskListStorageConfig

Uuid string

• the UUID.

VolumeGroupReference map[string]string

Reference to a volume group.

dataSourceReference Map<String,String>

Reference to a data source.

deviceProperties List<GetVirtualMachineDiskListDeviceProperty>

Properties to a device.

diskSizeBytes Integer

Size of the disk in Bytes.

diskSizeMib Integer

Size of the disk in MiB. Must match the size specified in 'disk_size_bytes' - rounded up to the nearest MiB - when that field is present.

storageConfigs List<GetVirtualMachineDiskListStorageConfig>

uuid String

• the UUID.

volumeGroupReference Map<String,String>

Reference to a volume group.

dataSourceReference {[key: string]: string}

Reference to a data source.

deviceProperties GetVirtualMachineDiskListDeviceProperty[]

Properties to a device.

diskSizeBytes number

Size of the disk in Bytes.

diskSizeMib number

Size of the disk in MiB. Must match the size specified in 'disk_size_bytes' - rounded up to the nearest MiB - when that field is present.

storageConfigs GetVirtualMachineDiskListStorageConfig[]

uuid string

• the UUID.

volumeGroupReference {[key: string]: string}

Reference to a volume group.

data_source_reference Mapping[str, str]

Reference to a data source.

device_properties Sequence[GetVirtualMachineDiskListDeviceProperty]

Properties to a device.

disk_size_bytes int

Size of the disk in Bytes.

disk_size_mib int

Size of the disk in MiB. Must match the size specified in 'disk_size_bytes' - rounded up to the nearest MiB - when that field is present.

storage_configs Sequence[GetVirtualMachineDiskListStorageConfig]

uuid str

• the UUID.

volume_group_reference Mapping[str, str]

Reference to a volume group.

dataSourceReference Map<String>

Reference to a data source.

deviceProperties List<Property Map>

Properties to a device.

diskSizeBytes Number

Size of the disk in Bytes.

diskSizeMib Number

Size of the disk in MiB. Must match the size specified in 'disk_size_bytes' - rounded up to the nearest MiB - when that field is present.

storageConfigs List<Property Map>

uuid String

• the UUID.

volumeGroupReference Map<String>

Reference to a volume group.

DeviceType string

• A Disk type (default: DISK).

DiskAddress Dictionary<string, string>

• Address of disk to boot from.

DeviceType string

• A Disk type (default: DISK).

DiskAddress map[string]string

• Address of disk to boot from.

deviceType String

• A Disk type (default: DISK).

diskAddress Map<String,String>

• Address of disk to boot from.

deviceType string

• A Disk type (default: DISK).

diskAddress {[key: string]: string}

• Address of disk to boot from.

device_type str

• A Disk type (default: DISK).

disk_address Mapping[str, str]

• Address of disk to boot from.

deviceType String

• A Disk type (default: DISK).

diskAddress Map<String>

• Address of disk to boot from.

FlashMode string

• State of the storage policy to pin virtual disks to the hot tier. When specified as a VM attribute, the storage policy applies to all virtual disks of the VM unless overridden by the same attribute specified for a virtual disk.

StorageContainerReferences List<PiersKarsenbarg.Nutanix.Inputs.GetVirtualMachineDiskListStorageConfigStorageContainerReference>

• Reference to a kind. Either one of (kind, uuid) or url needs to be specified.

• storage_container_reference.#.url: - GET query on the URL will provide information on the source.
• storage_container_reference.#.kind: - kind of the container reference
• storage_container_reference.#.name: - name of the container reference
• storage_container_reference.#.uuid: - uiid of the container reference

FlashMode string

• State of the storage policy to pin virtual disks to the hot tier. When specified as a VM attribute, the storage policy applies to all virtual disks of the VM unless overridden by the same attribute specified for a virtual disk.

StorageContainerReferences []GetVirtualMachineDiskListStorageConfigStorageContainerReference

• Reference to a kind. Either one of (kind, uuid) or url needs to be specified.

• storage_container_reference.#.url: - GET query on the URL will provide information on the source.
• storage_container_reference.#.kind: - kind of the container reference
• storage_container_reference.#.name: - name of the container reference
• storage_container_reference.#.uuid: - uiid of the container reference

flashMode String

• State of the storage policy to pin virtual disks to the hot tier. When specified as a VM attribute, the storage policy applies to all virtual disks of the VM unless overridden by the same attribute specified for a virtual disk.

storageContainerReferences List<GetVirtualMachineDiskListStorageConfigStorageContainerReference>

• Reference to a kind. Either one of (kind, uuid) or url needs to be specified.

• storage_container_reference.#.url: - GET query on the URL will provide information on the source.
• storage_container_reference.#.kind: - kind of the container reference
• storage_container_reference.#.name: - name of the container reference
• storage_container_reference.#.uuid: - uiid of the container reference

flashMode string

• State of the storage policy to pin virtual disks to the hot tier. When specified as a VM attribute, the storage policy applies to all virtual disks of the VM unless overridden by the same attribute specified for a virtual disk.

storageContainerReferences GetVirtualMachineDiskListStorageConfigStorageContainerReference[]

• Reference to a kind. Either one of (kind, uuid) or url needs to be specified.

• storage_container_reference.#.url: - GET query on the URL will provide information on the source.
• storage_container_reference.#.kind: - kind of the container reference
• storage_container_reference.#.name: - name of the container reference
• storage_container_reference.#.uuid: - uiid of the container reference

flash_mode str

• State of the storage policy to pin virtual disks to the hot tier. When specified as a VM attribute, the storage policy applies to all virtual disks of the VM unless overridden by the same attribute specified for a virtual disk.

storage_container_references Sequence[GetVirtualMachineDiskListStorageConfigStorageContainerReference]

• Reference to a kind. Either one of (kind, uuid) or url needs to be specified.

• storage_container_reference.#.url: - GET query on the URL will provide information on the source.
• storage_container_reference.#.kind: - kind of the container reference
• storage_container_reference.#.name: - name of the container reference
• storage_container_reference.#.uuid: - uiid of the container reference

flashMode String

• State of the storage policy to pin virtual disks to the hot tier. When specified as a VM attribute, the storage policy applies to all virtual disks of the VM unless overridden by the same attribute specified for a virtual disk.

storageContainerReferences List<Property Map>

• Reference to a kind. Either one of (kind, uuid) or url needs to be specified.

• storage_container_reference.#.url: - GET query on the URL will provide information on the source.
• storage_container_reference.#.kind: - kind of the container reference
• storage_container_reference.#.name: - name of the container reference
• storage_container_reference.#.uuid: - uiid of the container reference

Kind string

• The kind name (Default value: project).

Name string

• the name.

Url string

Uuid string

• the UUID.

Kind string

• The kind name (Default value: project).

Name string

• the name.

Url string

Uuid string

• the UUID.

kind String

• The kind name (Default value: project).

name String

• the name.

url String

uuid String

• the UUID.

kind string

• The kind name (Default value: project).

name string

• the name.

url string

uuid string

• the UUID.

kind str

• The kind name (Default value: project).

name str

• the name.

url str

uuid str

• the UUID.

kind String

• The kind name (Default value: project).

name String

• the name.

url String

uuid String

• the UUID.

DeviceId int

• (Computed) The device ID of the GPU.

Fraction int

Fraction of the physical GPU assigned.

FrameBufferSizeMib int

• GPU frame buffer size in MiB.

GuestDriverVersion string

• Last determined guest driver version.

Mode string

• The mode of this GPU.

Name string

• the name.

NumVirtualDisplayHeads int

• Number of supported virtual display heads.

PciAddress string

GPU {segment:bus:device:function} (sbdf) address if assigned.

Uuid string

• the UUID.

Vendor string

• The vendor of the GPU.

• UUID: - UUID of the GPU.

DeviceId int

• (Computed) The device ID of the GPU.

Fraction int

Fraction of the physical GPU assigned.

FrameBufferSizeMib int

• GPU frame buffer size in MiB.

GuestDriverVersion string

• Last determined guest driver version.

Mode string

• The mode of this GPU.

Name string

• the name.

NumVirtualDisplayHeads int

• Number of supported virtual display heads.

PciAddress string

GPU {segment:bus:device:function} (sbdf) address if assigned.

Uuid string

• the UUID.

Vendor string

• The vendor of the GPU.

• UUID: - UUID of the GPU.

deviceId Integer

• (Computed) The device ID of the GPU.

fraction Integer

Fraction of the physical GPU assigned.

frameBufferSizeMib Integer

• GPU frame buffer size in MiB.

guestDriverVersion String

• Last determined guest driver version.

mode String

• The mode of this GPU.

name String

• the name.

numVirtualDisplayHeads Integer

• Number of supported virtual display heads.

pciAddress String

GPU {segment:bus:device:function} (sbdf) address if assigned.

uuid String

• the UUID.

vendor String

• The vendor of the GPU.

• UUID: - UUID of the GPU.

deviceId number

• (Computed) The device ID of the GPU.

fraction number

Fraction of the physical GPU assigned.

frameBufferSizeMib number

• GPU frame buffer size in MiB.

guestDriverVersion string

• Last determined guest driver version.

mode string

• The mode of this GPU.

name string

• the name.

numVirtualDisplayHeads number

• Number of supported virtual display heads.

pciAddress string

GPU {segment:bus:device:function} (sbdf) address if assigned.

uuid string

• the UUID.

vendor string

• The vendor of the GPU.

• UUID: - UUID of the GPU.

device_id int

• (Computed) The device ID of the GPU.

fraction int

Fraction of the physical GPU assigned.

frame_buffer_size_mib int

• GPU frame buffer size in MiB.

guest_driver_version str

• Last determined guest driver version.

mode str

• The mode of this GPU.

name str

• the name.

num_virtual_display_heads int

• Number of supported virtual display heads.

pci_address str

GPU {segment:bus:device:function} (sbdf) address if assigned.

uuid str

• the UUID.

vendor str

• The vendor of the GPU.

• UUID: - UUID of the GPU.

deviceId Number

• (Computed) The device ID of the GPU.

fraction Number

Fraction of the physical GPU assigned.

frameBufferSizeMib Number

• GPU frame buffer size in MiB.

guestDriverVersion String

• Last determined guest driver version.

mode String

• The mode of this GPU.

name String

• the name.

numVirtualDisplayHeads Number

• Number of supported virtual display heads.

pciAddress String

GPU {segment:bus:device:function} (sbdf) address if assigned.

uuid String

• the UUID.

vendor String

• The vendor of the GPU.

• UUID: - UUID of the GPU.

Details Dictionary<string, object>

Message string

Reason string

Details map[string]interface{}

Message string

Reason string

details Map<String,Object>

message String

reason String

details {[key: string]: any}

message string

reason string

details Mapping[str, Any]

message str

reason str

details Map<Any>

message String

reason String

FloatingIp string

• The Floating IP associated with the vnic.

IpEndpointLists List<PiersKarsenbarg.Nutanix.Inputs.GetVirtualMachineNicListIpEndpointList>

• IP endpoints for the adapter. Currently, IPv4 addresses are supported.

IsConnected string

• Indicates whether the serial port connection is connected or not (true or false).

MacAddress string

• The MAC address for the adapter.

Model string

• The model of this NIC. (Options : VIRTIO , E1000).

NetworkFunctionChainReference Dictionary<string, string>

• The reference to a network_function_chain.

NetworkFunctionNicType string

• The type of this Network function NIC. Defaults to INGRESS. (Options : INGRESS , EGRESS , TAP).

NicType string

• The type of this NIC. Defaults to NORMAL_NIC. (Options : NORMAL_NIC , DIRECT_NIC , NETWORK_FUNCTION_NIC).

NumQueues int

• The number of tx/rx queue pairs for this NIC.

SubnetName string

• The name of the subnet reference to.

SubnetUuid string

• The reference to a subnet.

Uuid string

• the UUID.

FloatingIp string

• The Floating IP associated with the vnic.

IpEndpointLists []GetVirtualMachineNicListIpEndpointList

• IP endpoints for the adapter. Currently, IPv4 addresses are supported.

IsConnected string

• Indicates whether the serial port connection is connected or not (true or false).

MacAddress string

• The MAC address for the adapter.

Model string

• The model of this NIC. (Options : VIRTIO , E1000).

NetworkFunctionChainReference map[string]string

• The reference to a network_function_chain.

NetworkFunctionNicType string

• The type of this Network function NIC. Defaults to INGRESS. (Options : INGRESS , EGRESS , TAP).

NicType string

• The type of this NIC. Defaults to NORMAL_NIC. (Options : NORMAL_NIC , DIRECT_NIC , NETWORK_FUNCTION_NIC).

NumQueues int

• The number of tx/rx queue pairs for this NIC.

SubnetName string

• The name of the subnet reference to.

SubnetUuid string

• The reference to a subnet.

Uuid string

• the UUID.

floatingIp String

• The Floating IP associated with the vnic.

ipEndpointLists List<GetVirtualMachineNicListIpEndpointList>

• IP endpoints for the adapter. Currently, IPv4 addresses are supported.

isConnected String

• Indicates whether the serial port connection is connected or not (true or false).

macAddress String

• The MAC address for the adapter.

model String

• The model of this NIC. (Options : VIRTIO , E1000).

networkFunctionChainReference Map<String,String>

• The reference to a network_function_chain.

networkFunctionNicType String

• The type of this Network function NIC. Defaults to INGRESS. (Options : INGRESS , EGRESS , TAP).

nicType String

• The type of this NIC. Defaults to NORMAL_NIC. (Options : NORMAL_NIC , DIRECT_NIC , NETWORK_FUNCTION_NIC).

numQueues Integer

• The number of tx/rx queue pairs for this NIC.

subnetName String

• The name of the subnet reference to.

subnetUuid String

• The reference to a subnet.

uuid String

• the UUID.

floatingIp string

• The Floating IP associated with the vnic.

ipEndpointLists GetVirtualMachineNicListIpEndpointList[]

• IP endpoints for the adapter. Currently, IPv4 addresses are supported.

isConnected string

• Indicates whether the serial port connection is connected or not (true or false).

macAddress string

• The MAC address for the adapter.

model string

• The model of this NIC. (Options : VIRTIO , E1000).

networkFunctionChainReference {[key: string]: string}

• The reference to a network_function_chain.

networkFunctionNicType string

• The type of this Network function NIC. Defaults to INGRESS. (Options : INGRESS , EGRESS , TAP).

nicType string

• The type of this NIC. Defaults to NORMAL_NIC. (Options : NORMAL_NIC , DIRECT_NIC , NETWORK_FUNCTION_NIC).

numQueues number

• The number of tx/rx queue pairs for this NIC.

subnetName string

• The name of the subnet reference to.

subnetUuid string

• The reference to a subnet.

uuid string

• the UUID.

floating_ip str

• The Floating IP associated with the vnic.

ip_endpoint_lists Sequence[GetVirtualMachineNicListIpEndpointList]

• IP endpoints for the adapter. Currently, IPv4 addresses are supported.

is_connected str

• Indicates whether the serial port connection is connected or not (true or false).

mac_address str

• The MAC address for the adapter.

model str

• The model of this NIC. (Options : VIRTIO , E1000).

network_function_chain_reference Mapping[str, str]

• The reference to a network_function_chain.

network_function_nic_type str

• The type of this Network function NIC. Defaults to INGRESS. (Options : INGRESS , EGRESS , TAP).

nic_type str

• The type of this NIC. Defaults to NORMAL_NIC. (Options : NORMAL_NIC , DIRECT_NIC , NETWORK_FUNCTION_NIC).

num_queues int

• The number of tx/rx queue pairs for this NIC.

subnet_name str

• The name of the subnet reference to.

subnet_uuid str

• The reference to a subnet.

uuid str

• the UUID.

floatingIp String

• The Floating IP associated with the vnic.

ipEndpointLists List<Property Map>

• IP endpoints for the adapter. Currently, IPv4 addresses are supported.

isConnected String

• Indicates whether the serial port connection is connected or not (true or false).

macAddress String

• The MAC address for the adapter.

model String

• The model of this NIC. (Options : VIRTIO , E1000).

networkFunctionChainReference Map<String>

• The reference to a network_function_chain.

networkFunctionNicType String

• The type of this Network function NIC. Defaults to INGRESS. (Options : INGRESS , EGRESS , TAP).

nicType String

• The type of this NIC. Defaults to NORMAL_NIC. (Options : NORMAL_NIC , DIRECT_NIC , NETWORK_FUNCTION_NIC).

numQueues Number

• The number of tx/rx queue pairs for this NIC.

subnetName String

• The name of the subnet reference to.

subnetUuid String

• The reference to a subnet.

uuid String

• the UUID.

Ip string

• Address string.

Type string

• Address type. It can only be "ASSIGNED" in the spec. If no type is specified in the spec, the default type is set to "ASSIGNED". (Options : ASSIGNED , LEARNED)

Ip string

• Address string.

Type string

• Address type. It can only be "ASSIGNED" in the spec. If no type is specified in the spec, the default type is set to "ASSIGNED". (Options : ASSIGNED , LEARNED)

ip String

• Address string.

type String

• Address type. It can only be "ASSIGNED" in the spec. If no type is specified in the spec, the default type is set to "ASSIGNED". (Options : ASSIGNED , LEARNED)

ip string

• Address string.

type string

• Address type. It can only be "ASSIGNED" in the spec. If no type is specified in the spec, the default type is set to "ASSIGNED". (Options : ASSIGNED , LEARNED)

ip str

• Address string.

type str

• Address type. It can only be "ASSIGNED" in the spec. If no type is specified in the spec, the default type is set to "ASSIGNED". (Options : ASSIGNED , LEARNED)

ip String

• Address string.

type String

• Address type. It can only be "ASSIGNED" in the spec. If no type is specified in the spec, the default type is set to "ASSIGNED". (Options : ASSIGNED , LEARNED)

Index int

• Index of the serial port (int).

IsConnected bool

• Indicates whether the serial port connection is connected or not (true or false).

Index int

• Index of the serial port (int).

IsConnected bool

• Indicates whether the serial port connection is connected or not (true or false).

index Integer

• Index of the serial port (int).

isConnected Boolean

• Indicates whether the serial port connection is connected or not (true or false).

index number

• Index of the serial port (int).

isConnected boolean

• Indicates whether the serial port connection is connected or not (true or false).

index int

• Index of the serial port (int).

is_connected bool

• Indicates whether the serial port connection is connected or not (true or false).

index Number

• Index of the serial port (int).

isConnected Boolean

• Indicates whether the serial port connection is connected or not (true or false).