Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. VirtualMachine
Nutanix v0.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.VirtualMachine

Explore with Pulumi AI

nutanix logo
Nutanix v0.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

    Provides a Nutanix Virtual Machine resource to Create a virtual machine.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pierskarsenbarg/nutanix";
import * as nutanix from "@pulumi/nutanix";

const clusters = nutanix.getClusters({});
const vm1 = new nutanix.VirtualMachine("vm1", {
    clusterUuid: clusters.then(clusters => clusters.entities?.[0]?.metadata?.uuid),
    categories: [{
        name: "Environment",
        value: "Staging",
    }],
    numVcpusPerSocket: 1,
    numSockets: 1,
    memorySizeMib: 2048,
});

    import pulumi
import pulumi_nutanix as nutanix

clusters = nutanix.get_clusters()
vm1 = nutanix.VirtualMachine("vm1",
    cluster_uuid=clusters.entities[0].metadata["uuid"],
    categories=[{
        "name": "Environment",
        "value": "Staging",
    }],
    num_vcpus_per_socket=1,
    num_sockets=1,
    memory_size_mib=2048)

    package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		clusters, err := nutanix.GetClusters(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = nutanix.NewVirtualMachine(ctx, "vm1", &nutanix.VirtualMachineArgs{
			ClusterUuid: pulumi.String(clusters.Entities[0].Metadata.Uuid),
			Categories: nutanix.VirtualMachineCategoryArray{
				&nutanix.VirtualMachineCategoryArgs{
					Name:  pulumi.String("Environment"),
					Value: pulumi.String("Staging"),
				},
			},
			NumVcpusPerSocket: pulumi.Int(1),
			NumSockets:        pulumi.Int(1),
			MemorySizeMib:     pulumi.Int(2048),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = PiersKarsenbarg.Nutanix;
using Nutanix = Pulumi.Nutanix;

return await Deployment.RunAsync(() => 
{
    var clusters = Nutanix.GetClusters.Invoke();

    var vm1 = new Nutanix.VirtualMachine("vm1", new()
    {
        ClusterUuid = clusters.Apply(getClustersResult => getClustersResult.Entities[0]?.Metadata?.Uuid),
        Categories = new[]
        {
            new Nutanix.Inputs.VirtualMachineCategoryArgs
            {
                Name = "Environment",
                Value = "Staging",
            },
        },
        NumVcpusPerSocket = 1,
        NumSockets = 1,
        MemorySizeMib = 2048,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.VirtualMachine;
import com.pulumi.nutanix.VirtualMachineArgs;
import com.pulumi.nutanix.inputs.VirtualMachineCategoryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var clusters = NutanixFunctions.getClusters();

        var vm1 = new VirtualMachine("vm1", VirtualMachineArgs.builder()
            .clusterUuid(clusters.applyValue(getClustersResult -> getClustersResult.entities()[0].metadata().uuid()))
            .categories(VirtualMachineCategoryArgs.builder()
                .name("Environment")
                .value("Staging")
                .build())
            .numVcpusPerSocket(1)
            .numSockets(1)
            .memorySizeMib(2048)
            .build());

    }
}

    resources:
  vm1:
    type: nutanix:VirtualMachine
    properties:
      clusterUuid: ${clusters.entities[0].metadata.uuid}
      categories:
        - name: Environment
          value: Staging
      numVcpusPerSocket: 1
      numSockets: 1
      memorySizeMib: 2048
variables:
  clusters:
    fn::invoke:
      Function: nutanix:getClusters
      Arguments: {}

    With Storage Config

    import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pierskarsenbarg/nutanix";
import * as nutanix from "@pulumi/nutanix";

const clusters = nutanix.getClusters({});
const vm = new nutanix.VirtualMachine("vm", {
    clusterUuid: clusters.then(clusters => clusters.entities?.[0]?.metadata?.uuid),
    numVcpusPerSocket: 1,
    numSockets: 1,
    memorySizeMib: 186,
    diskLists: [{
        diskSizeBytes: 68157440,
        diskSizeMib: 65,
        storageConfig: {
            storageContainerReferences: [{
                kind: "storage_container",
                uuid: "2bbe67bc-fd14-4637-8de1-6379257f4219",
            }],
        },
    }],
});

    import pulumi
import pulumi_nutanix as nutanix

clusters = nutanix.get_clusters()
vm = nutanix.VirtualMachine("vm",
    cluster_uuid=clusters.entities[0].metadata["uuid"],
    num_vcpus_per_socket=1,
    num_sockets=1,
    memory_size_mib=186,
    disk_lists=[{
        "disk_size_bytes": 68157440,
        "disk_size_mib": 65,
        "storage_config": {
            "storage_container_references": [{
                "kind": "storage_container",
                "uuid": "2bbe67bc-fd14-4637-8de1-6379257f4219",
            }],
        },
    }])

    package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		clusters, err := nutanix.GetClusters(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = nutanix.NewVirtualMachine(ctx, "vm", &nutanix.VirtualMachineArgs{
			ClusterUuid:       pulumi.String(clusters.Entities[0].Metadata.Uuid),
			NumVcpusPerSocket: pulumi.Int(1),
			NumSockets:        pulumi.Int(1),
			MemorySizeMib:     pulumi.Int(186),
			DiskLists: nutanix.VirtualMachineDiskListArray{
				&nutanix.VirtualMachineDiskListArgs{
					DiskSizeBytes: pulumi.Int(68157440),
					DiskSizeMib:   pulumi.Int(65),
					StorageConfig: &nutanix.VirtualMachineDiskListStorageConfigArgs{
						StorageContainerReferences: nutanix.VirtualMachineDiskListStorageConfigStorageContainerReferenceArray{
							&nutanix.VirtualMachineDiskListStorageConfigStorageContainerReferenceArgs{
								Kind: pulumi.String("storage_container"),
								Uuid: pulumi.String("2bbe67bc-fd14-4637-8de1-6379257f4219"),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = PiersKarsenbarg.Nutanix;
using Nutanix = Pulumi.Nutanix;

return await Deployment.RunAsync(() => 
{
    var clusters = Nutanix.GetClusters.Invoke();

    var vm = new Nutanix.VirtualMachine("vm", new()
    {
        ClusterUuid = clusters.Apply(getClustersResult => getClustersResult.Entities[0]?.Metadata?.Uuid),
        NumVcpusPerSocket = 1,
        NumSockets = 1,
        MemorySizeMib = 186,
        DiskLists = new[]
        {
            new Nutanix.Inputs.VirtualMachineDiskListArgs
            {
                DiskSizeBytes = 68157440,
                DiskSizeMib = 65,
                StorageConfig = new Nutanix.Inputs.VirtualMachineDiskListStorageConfigArgs
                {
                    StorageContainerReferences = new[]
                    {
                        new Nutanix.Inputs.VirtualMachineDiskListStorageConfigStorageContainerReferenceArgs
                        {
                            Kind = "storage_container",
                            Uuid = "2bbe67bc-fd14-4637-8de1-6379257f4219",
                        },
                    },
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.VirtualMachine;
import com.pulumi.nutanix.VirtualMachineArgs;
import com.pulumi.nutanix.inputs.VirtualMachineDiskListArgs;
import com.pulumi.nutanix.inputs.VirtualMachineDiskListStorageConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var clusters = NutanixFunctions.getClusters();

        var vm = new VirtualMachine("vm", VirtualMachineArgs.builder()
            .clusterUuid(clusters.applyValue(getClustersResult -> getClustersResult.entities()[0].metadata().uuid()))
            .numVcpusPerSocket(1)
            .numSockets(1)
            .memorySizeMib(186)
            .diskLists(VirtualMachineDiskListArgs.builder()
                .diskSizeBytes(68157440)
                .diskSizeMib(65)
                .storageConfig(VirtualMachineDiskListStorageConfigArgs.builder()
                    .storageContainerReferences(VirtualMachineDiskListStorageConfigStorageContainerReferenceArgs.builder()
                        .kind("storage_container")
                        .uuid("2bbe67bc-fd14-4637-8de1-6379257f4219")
                        .build())
                    .build())
                .build())
            .build());

    }
}

    resources:
  vm:
    type: nutanix:VirtualMachine
    properties:
      clusterUuid: ${clusters.entities[0].metadata.uuid}
      numVcpusPerSocket: 1
      numSockets: 1
      memorySizeMib: 186
      diskLists:
        - diskSizeBytes: 6.815744e+07
          diskSizeMib: 65
          storageConfig:
            storageContainerReferences:
              - kind: storage_container
                uuid: 2bbe67bc-fd14-4637-8de1-6379257f4219
variables:
  clusters:
    fn::invoke:
      Function: nutanix:getClusters
      Arguments: {}

    Create VirtualMachine Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VirtualMachine(name: string, args: VirtualMachineArgs, opts?: CustomResourceOptions);
    @overload
def VirtualMachine(resource_name: str,
                   args: VirtualMachineArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def VirtualMachine(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cluster_uuid: Optional[str] = None,
                   hardware_clock_timezone: Optional[str] = None,
                   power_state_mechanism: Optional[str] = None,
                   boot_device_order_lists: Optional[Sequence[str]] = None,
                   boot_type: Optional[str] = None,
                   categories: Optional[Sequence[VirtualMachineCategoryArgs]] = None,
                   cloud_init_cdrom_uuid: Optional[str] = None,
                   boot_device_disk_address: Optional[Mapping[str, str]] = None,
                   description: Optional[str] = None,
                   disk_lists: Optional[Sequence[VirtualMachineDiskListArgs]] = None,
                   enable_cpu_passthrough: Optional[bool] = None,
                   enable_script_exec: Optional[bool] = None,
                   gpu_lists: Optional[Sequence[VirtualMachineGpuListArgs]] = None,
                   guest_customization_cloud_init_custom_key_values: Optional[Mapping[str, str]] = None,
                   is_vcpu_hard_pinned: Optional[bool] = None,
                   guest_customization_cloud_init_user_data: Optional[str] = None,
                   guest_customization_is_overridable: Optional[bool] = None,
                   guest_customization_sysprep: Optional[Mapping[str, str]] = None,
                   guest_customization_sysprep_custom_key_values: Optional[Mapping[str, str]] = None,
                   use_hot_add: Optional[bool] = None,
                   boot_device_mac_address: Optional[str] = None,
                   guest_customization_cloud_init_meta_data: Optional[str] = None,
                   machine_type: Optional[str] = None,
                   memory_size_mib: Optional[int] = None,
                   name: Optional[str] = None,
                   ngt_credentials: Optional[Mapping[str, str]] = None,
                   ngt_enabled_capability_lists: Optional[Sequence[str]] = None,
                   nic_lists: Optional[Sequence[VirtualMachineNicListArgs]] = None,
                   num_sockets: Optional[int] = None,
                   num_vcpus_per_socket: Optional[int] = None,
                   num_vnuma_nodes: Optional[int] = None,
                   nutanix_guest_tools: Optional[Mapping[str, str]] = None,
                   owner_reference: Optional[Mapping[str, str]] = None,
                   parent_reference: Optional[Mapping[str, str]] = None,
                   availability_zone_reference: Optional[Mapping[str, str]] = None,
                   project_reference: Optional[Mapping[str, str]] = None,
                   serial_port_lists: Optional[Sequence[VirtualMachineSerialPortListArgs]] = None,
                   should_fail_on_script_failure: Optional[bool] = None,
                   guest_os_id: Optional[str] = None,
                   vga_console_enabled: Optional[bool] = None)
    func NewVirtualMachine(ctx *Context, name string, args VirtualMachineArgs, opts ...ResourceOption) (*VirtualMachine, error)
    public VirtualMachine(string name, VirtualMachineArgs args, CustomResourceOptions? opts = null)
    public VirtualMachine(String name, VirtualMachineArgs args)
public VirtualMachine(String name, VirtualMachineArgs args, CustomResourceOptions options)

    type: nutanix:VirtualMachine
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VirtualMachineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VirtualMachineArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VirtualMachineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualMachineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualMachineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var virtualMachineResource = new Nutanix.VirtualMachine("virtualMachineResource", new()
{
    ClusterUuid = "string",
    HardwareClockTimezone = "string",
    PowerStateMechanism = "string",
    BootDeviceOrderLists = new[]
    {
        "string",
    },
    BootType = "string",
    Categories = new[]
    {
        new Nutanix.Inputs.VirtualMachineCategoryArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    CloudInitCdromUuid = "string",
    BootDeviceDiskAddress = 
    {
        { "string", "string" },
    },
    Description = "string",
    DiskLists = new[]
    {
        new Nutanix.Inputs.VirtualMachineDiskListArgs
        {
            DataSourceReference = 
            {
                { "string", "string" },
            },
            DeviceProperties = new Nutanix.Inputs.VirtualMachineDiskListDevicePropertiesArgs
            {
                DeviceType = "string",
                DiskAddress = 
                {
                    { "string", "string" },
                },
            },
            DiskSizeBytes = 0,
            DiskSizeMib = 0,
            StorageConfig = new Nutanix.Inputs.VirtualMachineDiskListStorageConfigArgs
            {
                FlashMode = "string",
                StorageContainerReferences = new[]
                {
                    new Nutanix.Inputs.VirtualMachineDiskListStorageConfigStorageContainerReferenceArgs
                    {
                        Kind = "string",
                        Name = "string",
                        Url = "string",
                        Uuid = "string",
                    },
                },
            },
            Uuid = "string",
            VolumeGroupReference = 
            {
                { "string", "string" },
            },
        },
    },
    EnableCpuPassthrough = false,
    EnableScriptExec = false,
    GpuLists = new[]
    {
        new Nutanix.Inputs.VirtualMachineGpuListArgs
        {
            DeviceId = 0,
            Fraction = 0,
            FrameBufferSizeMib = 0,
            GuestDriverVersion = "string",
            Mode = "string",
            Name = "string",
            NumVirtualDisplayHeads = 0,
            PciAddress = "string",
            Uuid = "string",
            Vendor = "string",
        },
    },
    GuestCustomizationCloudInitCustomKeyValues = 
    {
        { "string", "string" },
    },
    IsVcpuHardPinned = false,
    GuestCustomizationCloudInitUserData = "string",
    GuestCustomizationIsOverridable = false,
    GuestCustomizationSysprep = 
    {
        { "string", "string" },
    },
    GuestCustomizationSysprepCustomKeyValues = 
    {
        { "string", "string" },
    },
    UseHotAdd = false,
    BootDeviceMacAddress = "string",
    GuestCustomizationCloudInitMetaData = "string",
    MachineType = "string",
    MemorySizeMib = 0,
    Name = "string",
    NgtCredentials = 
    {
        { "string", "string" },
    },
    NgtEnabledCapabilityLists = new[]
    {
        "string",
    },
    NicLists = new[]
    {
        new Nutanix.Inputs.VirtualMachineNicListArgs
        {
            IpEndpointLists = new[]
            {
                new Nutanix.Inputs.VirtualMachineNicListIpEndpointListArgs
                {
                    Ip = "string",
                    Type = "string",
                },
            },
            IsConnected = "string",
            MacAddress = "string",
            Model = "string",
            NetworkFunctionChainReference = 
            {
                { "string", "string" },
            },
            NetworkFunctionNicType = "string",
            NicType = "string",
            NumQueues = 0,
            SubnetName = "string",
            SubnetUuid = "string",
            Uuid = "string",
        },
    },
    NumSockets = 0,
    NumVcpusPerSocket = 0,
    NumVnumaNodes = 0,
    NutanixGuestTools = 
    {
        { "string", "string" },
    },
    OwnerReference = 
    {
        { "string", "string" },
    },
    ParentReference = 
    {
        { "string", "string" },
    },
    AvailabilityZoneReference = 
    {
        { "string", "string" },
    },
    ProjectReference = 
    {
        { "string", "string" },
    },
    SerialPortLists = new[]
    {
        new Nutanix.Inputs.VirtualMachineSerialPortListArgs
        {
            Index = 0,
            IsConnected = false,
        },
    },
    ShouldFailOnScriptFailure = false,
    GuestOsId = "string",
    VgaConsoleEnabled = false,
});

    example, err := nutanix.NewVirtualMachine(ctx, "virtualMachineResource", &nutanix.VirtualMachineArgs{
	ClusterUuid:           pulumi.String("string"),
	HardwareClockTimezone: pulumi.String("string"),
	PowerStateMechanism:   pulumi.String("string"),
	BootDeviceOrderLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	BootType: pulumi.String("string"),
	Categories: nutanix.VirtualMachineCategoryArray{
		&nutanix.VirtualMachineCategoryArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	CloudInitCdromUuid: pulumi.String("string"),
	BootDeviceDiskAddress: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DiskLists: nutanix.VirtualMachineDiskListArray{
		&nutanix.VirtualMachineDiskListArgs{
			DataSourceReference: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			DeviceProperties: &nutanix.VirtualMachineDiskListDevicePropertiesArgs{
				DeviceType: pulumi.String("string"),
				DiskAddress: pulumi.StringMap{
					"string": pulumi.String("string"),
				},
			},
			DiskSizeBytes: pulumi.Int(0),
			DiskSizeMib:   pulumi.Int(0),
			StorageConfig: &nutanix.VirtualMachineDiskListStorageConfigArgs{
				FlashMode: pulumi.String("string"),
				StorageContainerReferences: nutanix.VirtualMachineDiskListStorageConfigStorageContainerReferenceArray{
					&nutanix.VirtualMachineDiskListStorageConfigStorageContainerReferenceArgs{
						Kind: pulumi.String("string"),
						Name: pulumi.String("string"),
						Url:  pulumi.String("string"),
						Uuid: pulumi.String("string"),
					},
				},
			},
			Uuid: pulumi.String("string"),
			VolumeGroupReference: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
	EnableCpuPassthrough: pulumi.Bool(false),
	EnableScriptExec:     pulumi.Bool(false),
	GpuLists: nutanix.VirtualMachineGpuListArray{
		&nutanix.VirtualMachineGpuListArgs{
			DeviceId:               pulumi.Int(0),
			Fraction:               pulumi.Int(0),
			FrameBufferSizeMib:     pulumi.Int(0),
			GuestDriverVersion:     pulumi.String("string"),
			Mode:                   pulumi.String("string"),
			Name:                   pulumi.String("string"),
			NumVirtualDisplayHeads: pulumi.Int(0),
			PciAddress:             pulumi.String("string"),
			Uuid:                   pulumi.String("string"),
			Vendor:                 pulumi.String("string"),
		},
	},
	GuestCustomizationCloudInitCustomKeyValues: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsVcpuHardPinned:                    pulumi.Bool(false),
	GuestCustomizationCloudInitUserData: pulumi.String("string"),
	GuestCustomizationIsOverridable:     pulumi.Bool(false),
	GuestCustomizationSysprep: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	GuestCustomizationSysprepCustomKeyValues: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UseHotAdd:                           pulumi.Bool(false),
	BootDeviceMacAddress:                pulumi.String("string"),
	GuestCustomizationCloudInitMetaData: pulumi.String("string"),
	MachineType:                         pulumi.String("string"),
	MemorySizeMib:                       pulumi.Int(0),
	Name:                                pulumi.String("string"),
	NgtCredentials: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NgtEnabledCapabilityLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	NicLists: nutanix.VirtualMachineNicListArray{
		&nutanix.VirtualMachineNicListArgs{
			IpEndpointLists: nutanix.VirtualMachineNicListIpEndpointListArray{
				&nutanix.VirtualMachineNicListIpEndpointListArgs{
					Ip:   pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
			IsConnected: pulumi.String("string"),
			MacAddress:  pulumi.String("string"),
			Model:       pulumi.String("string"),
			NetworkFunctionChainReference: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			NetworkFunctionNicType: pulumi.String("string"),
			NicType:                pulumi.String("string"),
			NumQueues:              pulumi.Int(0),
			SubnetName:             pulumi.String("string"),
			SubnetUuid:             pulumi.String("string"),
			Uuid:                   pulumi.String("string"),
		},
	},
	NumSockets:        pulumi.Int(0),
	NumVcpusPerSocket: pulumi.Int(0),
	NumVnumaNodes:     pulumi.Int(0),
	NutanixGuestTools: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	OwnerReference: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ParentReference: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AvailabilityZoneReference: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ProjectReference: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SerialPortLists: nutanix.VirtualMachineSerialPortListArray{
		&nutanix.VirtualMachineSerialPortListArgs{
			Index:       pulumi.Int(0),
			IsConnected: pulumi.Bool(false),
		},
	},
	ShouldFailOnScriptFailure: pulumi.Bool(false),
	GuestOsId:                 pulumi.String("string"),
	VgaConsoleEnabled:         pulumi.Bool(false),
})

    var virtualMachineResource = new VirtualMachine("virtualMachineResource", VirtualMachineArgs.builder()
    .clusterUuid("string")
    .hardwareClockTimezone("string")
    .powerStateMechanism("string")
    .bootDeviceOrderLists("string")
    .bootType("string")
    .categories(VirtualMachineCategoryArgs.builder()
        .name("string")
        .value("string")
        .build())
    .cloudInitCdromUuid("string")
    .bootDeviceDiskAddress(Map.of("string", "string"))
    .description("string")
    .diskLists(VirtualMachineDiskListArgs.builder()
        .dataSourceReference(Map.of("string", "string"))
        .deviceProperties(VirtualMachineDiskListDevicePropertiesArgs.builder()
            .deviceType("string")
            .diskAddress(Map.of("string", "string"))
            .build())
        .diskSizeBytes(0)
        .diskSizeMib(0)
        .storageConfig(VirtualMachineDiskListStorageConfigArgs.builder()
            .flashMode("string")
            .storageContainerReferences(VirtualMachineDiskListStorageConfigStorageContainerReferenceArgs.builder()
                .kind("string")
                .name("string")
                .url("string")
                .uuid("string")
                .build())
            .build())
        .uuid("string")
        .volumeGroupReference(Map.of("string", "string"))
        .build())
    .enableCpuPassthrough(false)
    .enableScriptExec(false)
    .gpuLists(VirtualMachineGpuListArgs.builder()
        .deviceId(0)
        .fraction(0)
        .frameBufferSizeMib(0)
        .guestDriverVersion("string")
        .mode("string")
        .name("string")
        .numVirtualDisplayHeads(0)
        .pciAddress("string")
        .uuid("string")
        .vendor("string")
        .build())
    .guestCustomizationCloudInitCustomKeyValues(Map.of("string", "string"))
    .isVcpuHardPinned(false)
    .guestCustomizationCloudInitUserData("string")
    .guestCustomizationIsOverridable(false)
    .guestCustomizationSysprep(Map.of("string", "string"))
    .guestCustomizationSysprepCustomKeyValues(Map.of("string", "string"))
    .useHotAdd(false)
    .bootDeviceMacAddress("string")
    .guestCustomizationCloudInitMetaData("string")
    .machineType("string")
    .memorySizeMib(0)
    .name("string")
    .ngtCredentials(Map.of("string", "string"))
    .ngtEnabledCapabilityLists("string")
    .nicLists(VirtualMachineNicListArgs.builder()
        .ipEndpointLists(VirtualMachineNicListIpEndpointListArgs.builder()
            .ip("string")
            .type("string")
            .build())
        .isConnected("string")
        .macAddress("string")
        .model("string")
        .networkFunctionChainReference(Map.of("string", "string"))
        .networkFunctionNicType("string")
        .nicType("string")
        .numQueues(0)
        .subnetName("string")
        .subnetUuid("string")
        .uuid("string")
        .build())
    .numSockets(0)
    .numVcpusPerSocket(0)
    .numVnumaNodes(0)
    .nutanixGuestTools(Map.of("string", "string"))
    .ownerReference(Map.of("string", "string"))
    .parentReference(Map.of("string", "string"))
    .availabilityZoneReference(Map.of("string", "string"))
    .projectReference(Map.of("string", "string"))
    .serialPortLists(VirtualMachineSerialPortListArgs.builder()
        .index(0)
        .isConnected(false)
        .build())
    .shouldFailOnScriptFailure(false)
    .guestOsId("string")
    .vgaConsoleEnabled(false)
    .build());

    virtual_machine_resource = nutanix.VirtualMachine("virtualMachineResource",
    cluster_uuid="string",
    hardware_clock_timezone="string",
    power_state_mechanism="string",
    boot_device_order_lists=["string"],
    boot_type="string",
    categories=[nutanix.VirtualMachineCategoryArgs(
        name="string",
        value="string",
    )],
    cloud_init_cdrom_uuid="string",
    boot_device_disk_address={
        "string": "string",
    },
    description="string",
    disk_lists=[nutanix.VirtualMachineDiskListArgs(
        data_source_reference={
            "string": "string",
        },
        device_properties=nutanix.VirtualMachineDiskListDevicePropertiesArgs(
            device_type="string",
            disk_address={
                "string": "string",
            },
        ),
        disk_size_bytes=0,
        disk_size_mib=0,
        storage_config=nutanix.VirtualMachineDiskListStorageConfigArgs(
            flash_mode="string",
            storage_container_references=[nutanix.VirtualMachineDiskListStorageConfigStorageContainerReferenceArgs(
                kind="string",
                name="string",
                url="string",
                uuid="string",
            )],
        ),
        uuid="string",
        volume_group_reference={
            "string": "string",
        },
    )],
    enable_cpu_passthrough=False,
    enable_script_exec=False,
    gpu_lists=[nutanix.VirtualMachineGpuListArgs(
        device_id=0,
        fraction=0,
        frame_buffer_size_mib=0,
        guest_driver_version="string",
        mode="string",
        name="string",
        num_virtual_display_heads=0,
        pci_address="string",
        uuid="string",
        vendor="string",
    )],
    guest_customization_cloud_init_custom_key_values={
        "string": "string",
    },
    is_vcpu_hard_pinned=False,
    guest_customization_cloud_init_user_data="string",
    guest_customization_is_overridable=False,
    guest_customization_sysprep={
        "string": "string",
    },
    guest_customization_sysprep_custom_key_values={
        "string": "string",
    },
    use_hot_add=False,
    boot_device_mac_address="string",
    guest_customization_cloud_init_meta_data="string",
    machine_type="string",
    memory_size_mib=0,
    name="string",
    ngt_credentials={
        "string": "string",
    },
    ngt_enabled_capability_lists=["string"],
    nic_lists=[nutanix.VirtualMachineNicListArgs(
        ip_endpoint_lists=[nutanix.VirtualMachineNicListIpEndpointListArgs(
            ip="string",
            type="string",
        )],
        is_connected="string",
        mac_address="string",
        model="string",
        network_function_chain_reference={
            "string": "string",
        },
        network_function_nic_type="string",
        nic_type="string",
        num_queues=0,
        subnet_name="string",
        subnet_uuid="string",
        uuid="string",
    )],
    num_sockets=0,
    num_vcpus_per_socket=0,
    num_vnuma_nodes=0,
    nutanix_guest_tools={
        "string": "string",
    },
    owner_reference={
        "string": "string",
    },
    parent_reference={
        "string": "string",
    },
    availability_zone_reference={
        "string": "string",
    },
    project_reference={
        "string": "string",
    },
    serial_port_lists=[nutanix.VirtualMachineSerialPortListArgs(
        index=0,
        is_connected=False,
    )],
    should_fail_on_script_failure=False,
    guest_os_id="string",
    vga_console_enabled=False)

    const virtualMachineResource = new nutanix.VirtualMachine("virtualMachineResource", {
    clusterUuid: "string",
    hardwareClockTimezone: "string",
    powerStateMechanism: "string",
    bootDeviceOrderLists: ["string"],
    bootType: "string",
    categories: [{
        name: "string",
        value: "string",
    }],
    cloudInitCdromUuid: "string",
    bootDeviceDiskAddress: {
        string: "string",
    },
    description: "string",
    diskLists: [{
        dataSourceReference: {
            string: "string",
        },
        deviceProperties: {
            deviceType: "string",
            diskAddress: {
                string: "string",
            },
        },
        diskSizeBytes: 0,
        diskSizeMib: 0,
        storageConfig: {
            flashMode: "string",
            storageContainerReferences: [{
                kind: "string",
                name: "string",
                url: "string",
                uuid: "string",
            }],
        },
        uuid: "string",
        volumeGroupReference: {
            string: "string",
        },
    }],
    enableCpuPassthrough: false,
    enableScriptExec: false,
    gpuLists: [{
        deviceId: 0,
        fraction: 0,
        frameBufferSizeMib: 0,
        guestDriverVersion: "string",
        mode: "string",
        name: "string",
        numVirtualDisplayHeads: 0,
        pciAddress: "string",
        uuid: "string",
        vendor: "string",
    }],
    guestCustomizationCloudInitCustomKeyValues: {
        string: "string",
    },
    isVcpuHardPinned: false,
    guestCustomizationCloudInitUserData: "string",
    guestCustomizationIsOverridable: false,
    guestCustomizationSysprep: {
        string: "string",
    },
    guestCustomizationSysprepCustomKeyValues: {
        string: "string",
    },
    useHotAdd: false,
    bootDeviceMacAddress: "string",
    guestCustomizationCloudInitMetaData: "string",
    machineType: "string",
    memorySizeMib: 0,
    name: "string",
    ngtCredentials: {
        string: "string",
    },
    ngtEnabledCapabilityLists: ["string"],
    nicLists: [{
        ipEndpointLists: [{
            ip: "string",
            type: "string",
        }],
        isConnected: "string",
        macAddress: "string",
        model: "string",
        networkFunctionChainReference: {
            string: "string",
        },
        networkFunctionNicType: "string",
        nicType: "string",
        numQueues: 0,
        subnetName: "string",
        subnetUuid: "string",
        uuid: "string",
    }],
    numSockets: 0,
    numVcpusPerSocket: 0,
    numVnumaNodes: 0,
    nutanixGuestTools: {
        string: "string",
    },
    ownerReference: {
        string: "string",
    },
    parentReference: {
        string: "string",
    },
    availabilityZoneReference: {
        string: "string",
    },
    projectReference: {
        string: "string",
    },
    serialPortLists: [{
        index: 0,
        isConnected: false,
    }],
    shouldFailOnScriptFailure: false,
    guestOsId: "string",
    vgaConsoleEnabled: false,
});

    type: nutanix:VirtualMachine
properties:
    availabilityZoneReference:
        string: string
    bootDeviceDiskAddress:
        string: string
    bootDeviceMacAddress: string
    bootDeviceOrderLists:
        - string
    bootType: string
    categories:
        - name: string
          value: string
    cloudInitCdromUuid: string
    clusterUuid: string
    description: string
    diskLists:
        - dataSourceReference:
            string: string
          deviceProperties:
            deviceType: string
            diskAddress:
                string: string
          diskSizeBytes: 0
          diskSizeMib: 0
          storageConfig:
            flashMode: string
            storageContainerReferences:
                - kind: string
                  name: string
                  url: string
                  uuid: string
          uuid: string
          volumeGroupReference:
            string: string
    enableCpuPassthrough: false
    enableScriptExec: false
    gpuLists:
        - deviceId: 0
          fraction: 0
          frameBufferSizeMib: 0
          guestDriverVersion: string
          mode: string
          name: string
          numVirtualDisplayHeads: 0
          pciAddress: string
          uuid: string
          vendor: string
    guestCustomizationCloudInitCustomKeyValues:
        string: string
    guestCustomizationCloudInitMetaData: string
    guestCustomizationCloudInitUserData: string
    guestCustomizationIsOverridable: false
    guestCustomizationSysprep:
        string: string
    guestCustomizationSysprepCustomKeyValues:
        string: string
    guestOsId: string
    hardwareClockTimezone: string
    isVcpuHardPinned: false
    machineType: string
    memorySizeMib: 0
    name: string
    ngtCredentials:
        string: string
    ngtEnabledCapabilityLists:
        - string
    nicLists:
        - ipEndpointLists:
            - ip: string
              type: string
          isConnected: string
          macAddress: string
          model: string
          networkFunctionChainReference:
            string: string
          networkFunctionNicType: string
          nicType: string
          numQueues: 0
          subnetName: string
          subnetUuid: string
          uuid: string
    numSockets: 0
    numVcpusPerSocket: 0
    numVnumaNodes: 0
    nutanixGuestTools:
        string: string
    ownerReference:
        string: string
    parentReference:
        string: string
    powerStateMechanism: string
    projectReference:
        string: string
    serialPortLists:
        - index: 0
          isConnected: false
    shouldFailOnScriptFailure: false
    useHotAdd: false
    vgaConsoleEnabled: false

    VirtualMachine Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The VirtualMachine resource accepts the following input properties:

    ClusterUuid string
    • (Required) The UUID of the cluster.
    AvailabilityZoneReference Dictionary<string, string>
    • (Optional) The reference to a availability_zone.
    BootDeviceDiskAddress Dictionary<string, string>
    • (Optional) Address of disk to boot from.
    BootDeviceMacAddress string
    • (Optional) MAC address of nic to boot from.
    BootDeviceOrderLists List<string>
    • (Optional) 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
    • (Optional) 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.Inputs.VirtualMachineCategory>
    • (Optional) Categories for the vm.
    CloudInitCdromUuid string
    Description string
    • (Optional) A description for vm.
    DiskLists List<PiersKarsenbarg.Nutanix.Inputs.VirtualMachineDiskList>
    Disks attached to the VM.
    EnableCpuPassthrough bool
    • (Optional) Add true to enable CPU passthrough.
    EnableScriptExec bool
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    GpuLists List<PiersKarsenbarg.Nutanix.Inputs.VirtualMachineGpuList>
    • (Optional) GPUs attached to the VM.
    GuestCustomizationCloudInitCustomKeyValues Dictionary<string, string>
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    GuestCustomizationSysprep Dictionary<string, string>
    • (Optional) 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, string>
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    GuestOsId string
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    HardwareClockTimezone string
    • (Optional) VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).
    IsVcpuHardPinned bool
    • (Optional) Add true to enable CPU pinning.
    MachineType string
    • Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.
    MemorySizeMib int
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    Name string
    • (Required) The name for the vm.
    NgtCredentials Dictionary<string, string>
    • (Ooptional) Credentials to login server.
    NgtEnabledCapabilityLists List<string>
    Application names that are enabled.
    NicLists List<PiersKarsenbarg.Nutanix.Inputs.VirtualMachineNicList>
    • (Optional) Spec NICs attached to the VM.
    NumSockets int
    • (Optional) Number of vCPU sockets.
    NumVcpusPerSocket int
    • (Optional) Number of vCPUs per socket.
    NumVnumaNodes int
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    NutanixGuestTools Dictionary<string, string>
    • (Optional) Information regarding Nutanix Guest Tools.
    OwnerReference Dictionary<string, string>
    • (Optional) The reference to a user.
    ParentReference Dictionary<string, string>
    • (Optional) Reference to an entity that the VM cloned from.
    PowerStateMechanism string
    • (Optional) 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>
    • (Optional) The reference to a project.
    SerialPortLists List<PiersKarsenbarg.Nutanix.Inputs.VirtualMachineSerialPortList>
    • (Optional) Serial Ports configured on the VM.
    ShouldFailOnScriptFailure bool
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    UseHotAdd bool
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    VgaConsoleEnabled bool
    • (Optional) Indicates whether VGA console should be enabled or not.
    ClusterUuid string
    • (Required) The UUID of the cluster.
    AvailabilityZoneReference map[string]string
    • (Optional) The reference to a availability_zone.
    BootDeviceDiskAddress map[string]string
    • (Optional) Address of disk to boot from.
    BootDeviceMacAddress string
    • (Optional) MAC address of nic to boot from.
    BootDeviceOrderLists []string
    • (Optional) 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
    • (Optional) 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 []VirtualMachineCategoryArgs
    • (Optional) Categories for the vm.
    CloudInitCdromUuid string
    Description string
    • (Optional) A description for vm.
    DiskLists []VirtualMachineDiskListArgs
    Disks attached to the VM.
    EnableCpuPassthrough bool
    • (Optional) Add true to enable CPU passthrough.
    EnableScriptExec bool
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    GpuLists []VirtualMachineGpuListArgs
    • (Optional) GPUs attached to the VM.
    GuestCustomizationCloudInitCustomKeyValues map[string]string
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    GuestCustomizationSysprep map[string]string
    • (Optional) 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]string
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    GuestOsId string
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    HardwareClockTimezone string
    • (Optional) VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).
    IsVcpuHardPinned bool
    • (Optional) Add true to enable CPU pinning.
    MachineType string
    • Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.
    MemorySizeMib int
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    Name string
    • (Required) The name for the vm.
    NgtCredentials map[string]string
    • (Ooptional) Credentials to login server.
    NgtEnabledCapabilityLists []string
    Application names that are enabled.
    NicLists []VirtualMachineNicListArgs
    • (Optional) Spec NICs attached to the VM.
    NumSockets int
    • (Optional) Number of vCPU sockets.
    NumVcpusPerSocket int
    • (Optional) Number of vCPUs per socket.
    NumVnumaNodes int
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    NutanixGuestTools map[string]string
    • (Optional) Information regarding Nutanix Guest Tools.
    OwnerReference map[string]string
    • (Optional) The reference to a user.
    ParentReference map[string]string
    • (Optional) Reference to an entity that the VM cloned from.
    PowerStateMechanism string
    • (Optional) 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
    • (Optional) The reference to a project.
    SerialPortLists []VirtualMachineSerialPortListArgs
    • (Optional) Serial Ports configured on the VM.
    ShouldFailOnScriptFailure bool
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    UseHotAdd bool
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    VgaConsoleEnabled bool
    • (Optional) Indicates whether VGA console should be enabled or not.
    clusterUuid String
    • (Required) The UUID of the cluster.
    availabilityZoneReference Map<String,String>
    • (Optional) The reference to a availability_zone.
    bootDeviceDiskAddress Map<String,String>
    • (Optional) Address of disk to boot from.
    bootDeviceMacAddress String
    • (Optional) MAC address of nic to boot from.
    bootDeviceOrderLists List<String>
    • (Optional) 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
    • (Optional) 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<VirtualMachineCategory>
    • (Optional) Categories for the vm.
    cloudInitCdromUuid String
    description String
    • (Optional) A description for vm.
    diskLists List<VirtualMachineDiskList>
    Disks attached to the VM.
    enableCpuPassthrough Boolean
    • (Optional) Add true to enable CPU passthrough.
    enableScriptExec Boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    gpuLists List<VirtualMachineGpuList>
    • (Optional) GPUs attached to the VM.
    guestCustomizationCloudInitCustomKeyValues Map<String,String>
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    guestCustomizationSysprep Map<String,String>
    • (Optional) 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,String>
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    guestOsId String
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    hardwareClockTimezone String
    • (Optional) VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).
    isVcpuHardPinned Boolean
    • (Optional) Add true to enable CPU pinning.
    machineType String
    • Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.
    memorySizeMib Integer
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    name String
    • (Required) The name for the vm.
    ngtCredentials Map<String,String>
    • (Ooptional) Credentials to login server.
    ngtEnabledCapabilityLists List<String>
    Application names that are enabled.
    nicLists List<VirtualMachineNicList>
    • (Optional) Spec NICs attached to the VM.
    numSockets Integer
    • (Optional) Number of vCPU sockets.
    numVcpusPerSocket Integer
    • (Optional) Number of vCPUs per socket.
    numVnumaNodes Integer
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    nutanixGuestTools Map<String,String>
    • (Optional) Information regarding Nutanix Guest Tools.
    ownerReference Map<String,String>
    • (Optional) The reference to a user.
    parentReference Map<String,String>
    • (Optional) Reference to an entity that the VM cloned from.
    powerStateMechanism String
    • (Optional) 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>
    • (Optional) The reference to a project.
    serialPortLists List<VirtualMachineSerialPortList>
    • (Optional) Serial Ports configured on the VM.
    shouldFailOnScriptFailure Boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    useHotAdd Boolean
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    vgaConsoleEnabled Boolean
    • (Optional) Indicates whether VGA console should be enabled or not.
    clusterUuid string
    • (Required) The UUID of the cluster.
    availabilityZoneReference {[key: string]: string}
    • (Optional) The reference to a availability_zone.
    bootDeviceDiskAddress {[key: string]: string}
    • (Optional) Address of disk to boot from.
    bootDeviceMacAddress string
    • (Optional) MAC address of nic to boot from.
    bootDeviceOrderLists string[]
    • (Optional) 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
    • (Optional) 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 VirtualMachineCategory[]
    • (Optional) Categories for the vm.
    cloudInitCdromUuid string
    description string
    • (Optional) A description for vm.
    diskLists VirtualMachineDiskList[]
    Disks attached to the VM.
    enableCpuPassthrough boolean
    • (Optional) Add true to enable CPU passthrough.
    enableScriptExec boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    gpuLists VirtualMachineGpuList[]
    • (Optional) GPUs attached to the VM.
    guestCustomizationCloudInitCustomKeyValues {[key: string]: string}
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    guestCustomizationSysprep {[key: string]: string}
    • (Optional) 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]: string}
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    guestOsId string
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    hardwareClockTimezone string
    • (Optional) VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).
    isVcpuHardPinned boolean
    • (Optional) Add true to enable CPU pinning.
    machineType string
    • Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.
    memorySizeMib number
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    name string
    • (Required) The name for the vm.
    ngtCredentials {[key: string]: string}
    • (Ooptional) Credentials to login server.
    ngtEnabledCapabilityLists string[]
    Application names that are enabled.
    nicLists VirtualMachineNicList[]
    • (Optional) Spec NICs attached to the VM.
    numSockets number
    • (Optional) Number of vCPU sockets.
    numVcpusPerSocket number
    • (Optional) Number of vCPUs per socket.
    numVnumaNodes number
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    nutanixGuestTools {[key: string]: string}
    • (Optional) Information regarding Nutanix Guest Tools.
    ownerReference {[key: string]: string}
    • (Optional) The reference to a user.
    parentReference {[key: string]: string}
    • (Optional) Reference to an entity that the VM cloned from.
    powerStateMechanism string
    • (Optional) 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}
    • (Optional) The reference to a project.
    serialPortLists VirtualMachineSerialPortList[]
    • (Optional) Serial Ports configured on the VM.
    shouldFailOnScriptFailure boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    useHotAdd boolean
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    vgaConsoleEnabled boolean
    • (Optional) Indicates whether VGA console should be enabled or not.
    cluster_uuid str
    • (Required) The UUID of the cluster.
    availability_zone_reference Mapping[str, str]
    • (Optional) The reference to a availability_zone.
    boot_device_disk_address Mapping[str, str]
    • (Optional) Address of disk to boot from.
    boot_device_mac_address str
    • (Optional) MAC address of nic to boot from.
    boot_device_order_lists Sequence[str]
    • (Optional) 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
    • (Optional) 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[VirtualMachineCategoryArgs]
    • (Optional) Categories for the vm.
    cloud_init_cdrom_uuid str
    description str
    • (Optional) A description for vm.
    disk_lists Sequence[VirtualMachineDiskListArgs]
    Disks attached to the VM.
    enable_cpu_passthrough bool
    • (Optional) Add true to enable CPU passthrough.
    enable_script_exec bool
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    gpu_lists Sequence[VirtualMachineGpuListArgs]
    • (Optional) GPUs attached to the VM.
    guest_customization_cloud_init_custom_key_values Mapping[str, str]
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    guest_customization_sysprep Mapping[str, str]
    • (Optional) 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, str]
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    guest_os_id str
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    hardware_clock_timezone str
    • (Optional) VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).
    is_vcpu_hard_pinned bool
    • (Optional) Add true to enable CPU pinning.
    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
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    name str
    • (Required) The name for the vm.
    ngt_credentials Mapping[str, str]
    • (Ooptional) Credentials to login server.
    ngt_enabled_capability_lists Sequence[str]
    Application names that are enabled.
    nic_lists Sequence[VirtualMachineNicListArgs]
    • (Optional) Spec NICs attached to the VM.
    num_sockets int
    • (Optional) Number of vCPU sockets.
    num_vcpus_per_socket int
    • (Optional) Number of vCPUs per socket.
    num_vnuma_nodes int
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    nutanix_guest_tools Mapping[str, str]
    • (Optional) Information regarding Nutanix Guest Tools.
    owner_reference Mapping[str, str]
    • (Optional) The reference to a user.
    parent_reference Mapping[str, str]
    • (Optional) Reference to an entity that the VM cloned from.
    power_state_mechanism str
    • (Optional) 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]
    • (Optional) The reference to a project.
    serial_port_lists Sequence[VirtualMachineSerialPortListArgs]
    • (Optional) Serial Ports configured on the VM.
    should_fail_on_script_failure bool
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    use_hot_add bool
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    vga_console_enabled bool
    • (Optional) Indicates whether VGA console should be enabled or not.
    clusterUuid String
    • (Required) The UUID of the cluster.
    availabilityZoneReference Map<String>
    • (Optional) The reference to a availability_zone.
    bootDeviceDiskAddress Map<String>
    • (Optional) Address of disk to boot from.
    bootDeviceMacAddress String
    • (Optional) MAC address of nic to boot from.
    bootDeviceOrderLists List<String>
    • (Optional) 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
    • (Optional) 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>
    • (Optional) Categories for the vm.
    cloudInitCdromUuid String
    description String
    • (Optional) A description for vm.
    diskLists List<Property Map>
    Disks attached to the VM.
    enableCpuPassthrough Boolean
    • (Optional) Add true to enable CPU passthrough.
    enableScriptExec Boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    gpuLists List<Property Map>
    • (Optional) GPUs attached to the VM.
    guestCustomizationCloudInitCustomKeyValues Map<String>
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    guestCustomizationSysprep Map<String>
    • (Optional) 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>
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    guestOsId String
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    hardwareClockTimezone String
    • (Optional) VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles).
    isVcpuHardPinned Boolean
    • (Optional) Add true to enable CPU pinning.
    machineType String
    • Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.
    memorySizeMib Number
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    name String
    • (Required) The name for the vm.
    ngtCredentials Map<String>
    • (Ooptional) Credentials to login server.
    ngtEnabledCapabilityLists List<String>
    Application names that are enabled.
    nicLists List<Property Map>
    • (Optional) Spec NICs attached to the VM.
    numSockets Number
    • (Optional) Number of vCPU sockets.
    numVcpusPerSocket Number
    • (Optional) Number of vCPUs per socket.
    numVnumaNodes Number
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    nutanixGuestTools Map<String>
    • (Optional) Information regarding Nutanix Guest Tools.
    ownerReference Map<String>
    • (Optional) The reference to a user.
    parentReference Map<String>
    • (Optional) Reference to an entity that the VM cloned from.
    powerStateMechanism String
    • (Optional) 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>
    • (Optional) The reference to a project.
    serialPortLists List<Property Map>
    • (Optional) Serial Ports configured on the VM.
    shouldFailOnScriptFailure Boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    useHotAdd Boolean
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    vgaConsoleEnabled Boolean
    • (Optional) Indicates whether VGA console should be enabled or not.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VirtualMachine resource produces the following output properties:

    ApiVersion string
    The version of the API.
    ClusterName string
    • The name of the cluster.
    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.
    Metadata Dictionary<string, string>
    • The vm kind metadata.
    NicListStatuses List<PiersKarsenbarg.Nutanix.Outputs.VirtualMachineNicListStatus>
    • Status NICs attached to the VM.
    PowerState string
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    State string
    • The state of the vm.
    ApiVersion string
    The version of the API.
    ClusterName string
    • The name of the cluster.
    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.
    Metadata map[string]string
    • The vm kind metadata.
    NicListStatuses []VirtualMachineNicListStatus
    • Status NICs attached to the VM.
    PowerState string
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    State string
    • The state of the vm.
    apiVersion String
    The version of the API.
    clusterName String
    • The name of the cluster.
    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.
    metadata Map<String,String>
    • The vm kind metadata.
    nicListStatuses List<VirtualMachineNicListStatus>
    • Status NICs attached to the VM.
    powerState String
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    state String
    • The state of the vm.
    apiVersion string
    The version of the API.
    clusterName string
    • The name of the cluster.
    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.
    metadata {[key: string]: string}
    • The vm kind metadata.
    nicListStatuses VirtualMachineNicListStatus[]
    • Status NICs attached to the VM.
    powerState string
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    state string
    • The state of the vm.
    api_version str
    The version of the API.
    cluster_name str
    • The name of the cluster.
    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.
    metadata Mapping[str, str]
    • The vm kind metadata.
    nic_list_statuses Sequence[VirtualMachineNicListStatus]
    • Status NICs attached to the VM.
    power_state str
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    state str
    • The state of the vm.
    apiVersion String
    The version of the API.
    clusterName String
    • The name of the cluster.
    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.
    metadata Map<String>
    • The vm kind metadata.
    nicListStatuses List<Property Map>
    • Status NICs attached to the VM.
    powerState String
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    state String
    • The state of the vm.

    Look up Existing VirtualMachine Resource

    Get an existing VirtualMachine resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VirtualMachineState, opts?: CustomResourceOptions): VirtualMachine
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_version: Optional[str] = None,
        availability_zone_reference: Optional[Mapping[str, str]] = None,
        boot_device_disk_address: Optional[Mapping[str, str]] = None,
        boot_device_mac_address: Optional[str] = None,
        boot_device_order_lists: Optional[Sequence[str]] = None,
        boot_type: Optional[str] = None,
        categories: Optional[Sequence[VirtualMachineCategoryArgs]] = None,
        cloud_init_cdrom_uuid: Optional[str] = None,
        cluster_name: Optional[str] = None,
        cluster_uuid: Optional[str] = None,
        description: Optional[str] = None,
        disk_lists: Optional[Sequence[VirtualMachineDiskListArgs]] = None,
        enable_cpu_passthrough: Optional[bool] = None,
        enable_script_exec: Optional[bool] = None,
        gpu_lists: Optional[Sequence[VirtualMachineGpuListArgs]] = None,
        guest_customization_cloud_init_custom_key_values: Optional[Mapping[str, str]] = None,
        guest_customization_cloud_init_meta_data: Optional[str] = None,
        guest_customization_cloud_init_user_data: Optional[str] = None,
        guest_customization_is_overridable: Optional[bool] = None,
        guest_customization_sysprep: Optional[Mapping[str, str]] = None,
        guest_customization_sysprep_custom_key_values: Optional[Mapping[str, str]] = None,
        guest_os_id: Optional[str] = None,
        hardware_clock_timezone: Optional[str] = None,
        host_reference: Optional[Mapping[str, str]] = None,
        hypervisor_type: Optional[str] = None,
        is_vcpu_hard_pinned: Optional[bool] = None,
        machine_type: Optional[str] = None,
        memory_size_mib: Optional[int] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        ngt_credentials: Optional[Mapping[str, str]] = None,
        ngt_enabled_capability_lists: Optional[Sequence[str]] = None,
        nic_list_statuses: Optional[Sequence[VirtualMachineNicListStatusArgs]] = None,
        nic_lists: Optional[Sequence[VirtualMachineNicListArgs]] = None,
        num_sockets: Optional[int] = None,
        num_vcpus_per_socket: Optional[int] = None,
        num_vnuma_nodes: Optional[int] = None,
        nutanix_guest_tools: Optional[Mapping[str, str]] = None,
        owner_reference: Optional[Mapping[str, str]] = None,
        parent_reference: Optional[Mapping[str, str]] = None,
        power_state: Optional[str] = None,
        power_state_mechanism: Optional[str] = None,
        project_reference: Optional[Mapping[str, str]] = None,
        serial_port_lists: Optional[Sequence[VirtualMachineSerialPortListArgs]] = None,
        should_fail_on_script_failure: Optional[bool] = None,
        state: Optional[str] = None,
        use_hot_add: Optional[bool] = None,
        vga_console_enabled: Optional[bool] = None) -> VirtualMachine
    func GetVirtualMachine(ctx *Context, name string, id IDInput, state *VirtualMachineState, opts ...ResourceOption) (*VirtualMachine, error)
    public static VirtualMachine Get(string name, Input<string> id, VirtualMachineState? state, CustomResourceOptions? opts = null)
    public static VirtualMachine get(String name, Output<String> id, VirtualMachineState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiVersion string
    The version of the API.
    AvailabilityZoneReference Dictionary<string, string>
    • (Optional) The reference to a availability_zone.
    BootDeviceDiskAddress Dictionary<string, string>
    • (Optional) Address of disk to boot from.
    BootDeviceMacAddress string
    • (Optional) MAC address of nic to boot from.
    BootDeviceOrderLists List<string>
    • (Optional) 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
    • (Optional) 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.Inputs.VirtualMachineCategory>
    • (Optional) Categories for the vm.
    CloudInitCdromUuid string
    ClusterName string
    • The name of the cluster.
    ClusterUuid string
    • (Required) The UUID of the cluster.
    Description string
    • (Optional) A description for vm.
    DiskLists List<PiersKarsenbarg.Nutanix.Inputs.VirtualMachineDiskList>
    Disks attached to the VM.
    EnableCpuPassthrough bool
    • (Optional) Add true to enable CPU passthrough.
    EnableScriptExec bool
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    GpuLists List<PiersKarsenbarg.Nutanix.Inputs.VirtualMachineGpuList>
    • (Optional) GPUs attached to the VM.
    GuestCustomizationCloudInitCustomKeyValues Dictionary<string, string>
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    GuestCustomizationSysprep Dictionary<string, string>
    • (Optional) 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, string>
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    GuestOsId string
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    HardwareClockTimezone string
    • (Optional) 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.
    IsVcpuHardPinned bool
    • (Optional) Add true to enable CPU pinning.
    MachineType string
    • Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.
    MemorySizeMib int
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    Metadata Dictionary<string, string>
    • The vm kind metadata.
    Name string
    • (Required) The name for the vm.
    NgtCredentials Dictionary<string, string>
    • (Ooptional) Credentials to login server.
    NgtEnabledCapabilityLists List<string>
    Application names that are enabled.
    NicListStatuses List<PiersKarsenbarg.Nutanix.Inputs.VirtualMachineNicListStatus>
    • Status NICs attached to the VM.
    NicLists List<PiersKarsenbarg.Nutanix.Inputs.VirtualMachineNicList>
    • (Optional) Spec NICs attached to the VM.
    NumSockets int
    • (Optional) Number of vCPU sockets.
    NumVcpusPerSocket int
    • (Optional) Number of vCPUs per socket.
    NumVnumaNodes int
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    NutanixGuestTools Dictionary<string, string>
    • (Optional) Information regarding Nutanix Guest Tools.
    OwnerReference Dictionary<string, string>
    • (Optional) The reference to a user.
    ParentReference Dictionary<string, string>
    • (Optional) Reference to an entity that the VM cloned from.
    PowerState string
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    PowerStateMechanism string
    • (Optional) 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>
    • (Optional) The reference to a project.
    SerialPortLists List<PiersKarsenbarg.Nutanix.Inputs.VirtualMachineSerialPortList>
    • (Optional) Serial Ports configured on the VM.
    ShouldFailOnScriptFailure bool
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    State string
    • The state of the vm.
    UseHotAdd bool
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    VgaConsoleEnabled bool
    • (Optional) Indicates whether VGA console should be enabled or not.
    ApiVersion string
    The version of the API.
    AvailabilityZoneReference map[string]string
    • (Optional) The reference to a availability_zone.
    BootDeviceDiskAddress map[string]string
    • (Optional) Address of disk to boot from.
    BootDeviceMacAddress string
    • (Optional) MAC address of nic to boot from.
    BootDeviceOrderLists []string
    • (Optional) 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
    • (Optional) 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 []VirtualMachineCategoryArgs
    • (Optional) Categories for the vm.
    CloudInitCdromUuid string
    ClusterName string
    • The name of the cluster.
    ClusterUuid string
    • (Required) The UUID of the cluster.
    Description string
    • (Optional) A description for vm.
    DiskLists []VirtualMachineDiskListArgs
    Disks attached to the VM.
    EnableCpuPassthrough bool
    • (Optional) Add true to enable CPU passthrough.
    EnableScriptExec bool
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    GpuLists []VirtualMachineGpuListArgs
    • (Optional) GPUs attached to the VM.
    GuestCustomizationCloudInitCustomKeyValues map[string]string
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    GuestCustomizationSysprep map[string]string
    • (Optional) 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]string
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    GuestOsId string
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    HardwareClockTimezone string
    • (Optional) 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.
    IsVcpuHardPinned bool
    • (Optional) Add true to enable CPU pinning.
    MachineType string
    • Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.
    MemorySizeMib int
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    Metadata map[string]string
    • The vm kind metadata.
    Name string
    • (Required) The name for the vm.
    NgtCredentials map[string]string
    • (Ooptional) Credentials to login server.
    NgtEnabledCapabilityLists []string
    Application names that are enabled.
    NicListStatuses []VirtualMachineNicListStatusArgs
    • Status NICs attached to the VM.
    NicLists []VirtualMachineNicListArgs
    • (Optional) Spec NICs attached to the VM.
    NumSockets int
    • (Optional) Number of vCPU sockets.
    NumVcpusPerSocket int
    • (Optional) Number of vCPUs per socket.
    NumVnumaNodes int
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    NutanixGuestTools map[string]string
    • (Optional) Information regarding Nutanix Guest Tools.
    OwnerReference map[string]string
    • (Optional) The reference to a user.
    ParentReference map[string]string
    • (Optional) Reference to an entity that the VM cloned from.
    PowerState string
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    PowerStateMechanism string
    • (Optional) 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
    • (Optional) The reference to a project.
    SerialPortLists []VirtualMachineSerialPortListArgs
    • (Optional) Serial Ports configured on the VM.
    ShouldFailOnScriptFailure bool
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    State string
    • The state of the vm.
    UseHotAdd bool
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    VgaConsoleEnabled bool
    • (Optional) Indicates whether VGA console should be enabled or not.
    apiVersion String
    The version of the API.
    availabilityZoneReference Map<String,String>
    • (Optional) The reference to a availability_zone.
    bootDeviceDiskAddress Map<String,String>
    • (Optional) Address of disk to boot from.
    bootDeviceMacAddress String
    • (Optional) MAC address of nic to boot from.
    bootDeviceOrderLists List<String>
    • (Optional) 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
    • (Optional) 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<VirtualMachineCategory>
    • (Optional) Categories for the vm.
    cloudInitCdromUuid String
    clusterName String
    • The name of the cluster.
    clusterUuid String
    • (Required) The UUID of the cluster.
    description String
    • (Optional) A description for vm.
    diskLists List<VirtualMachineDiskList>
    Disks attached to the VM.
    enableCpuPassthrough Boolean
    • (Optional) Add true to enable CPU passthrough.
    enableScriptExec Boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    gpuLists List<VirtualMachineGpuList>
    • (Optional) GPUs attached to the VM.
    guestCustomizationCloudInitCustomKeyValues Map<String,String>
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    guestCustomizationSysprep Map<String,String>
    • (Optional) 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,String>
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    guestOsId String
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    hardwareClockTimezone String
    • (Optional) 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.
    isVcpuHardPinned Boolean
    • (Optional) Add true to enable CPU pinning.
    machineType String
    • Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.
    memorySizeMib Integer
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    metadata Map<String,String>
    • The vm kind metadata.
    name String
    • (Required) The name for the vm.
    ngtCredentials Map<String,String>
    • (Ooptional) Credentials to login server.
    ngtEnabledCapabilityLists List<String>
    Application names that are enabled.
    nicListStatuses List<VirtualMachineNicListStatus>
    • Status NICs attached to the VM.
    nicLists List<VirtualMachineNicList>
    • (Optional) Spec NICs attached to the VM.
    numSockets Integer
    • (Optional) Number of vCPU sockets.
    numVcpusPerSocket Integer
    • (Optional) Number of vCPUs per socket.
    numVnumaNodes Integer
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    nutanixGuestTools Map<String,String>
    • (Optional) Information regarding Nutanix Guest Tools.
    ownerReference Map<String,String>
    • (Optional) The reference to a user.
    parentReference Map<String,String>
    • (Optional) Reference to an entity that the VM cloned from.
    powerState String
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    powerStateMechanism String
    • (Optional) 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>
    • (Optional) The reference to a project.
    serialPortLists List<VirtualMachineSerialPortList>
    • (Optional) Serial Ports configured on the VM.
    shouldFailOnScriptFailure Boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    state String
    • The state of the vm.
    useHotAdd Boolean
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    vgaConsoleEnabled Boolean
    • (Optional) Indicates whether VGA console should be enabled or not.
    apiVersion string
    The version of the API.
    availabilityZoneReference {[key: string]: string}
    • (Optional) The reference to a availability_zone.
    bootDeviceDiskAddress {[key: string]: string}
    • (Optional) Address of disk to boot from.
    bootDeviceMacAddress string
    • (Optional) MAC address of nic to boot from.
    bootDeviceOrderLists string[]
    • (Optional) 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
    • (Optional) 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 VirtualMachineCategory[]
    • (Optional) Categories for the vm.
    cloudInitCdromUuid string
    clusterName string
    • The name of the cluster.
    clusterUuid string
    • (Required) The UUID of the cluster.
    description string
    • (Optional) A description for vm.
    diskLists VirtualMachineDiskList[]
    Disks attached to the VM.
    enableCpuPassthrough boolean
    • (Optional) Add true to enable CPU passthrough.
    enableScriptExec boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    gpuLists VirtualMachineGpuList[]
    • (Optional) GPUs attached to the VM.
    guestCustomizationCloudInitCustomKeyValues {[key: string]: string}
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    guestCustomizationSysprep {[key: string]: string}
    • (Optional) 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]: string}
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    guestOsId string
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    hardwareClockTimezone string
    • (Optional) 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.
    isVcpuHardPinned boolean
    • (Optional) Add true to enable CPU pinning.
    machineType string
    • Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.
    memorySizeMib number
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    metadata {[key: string]: string}
    • The vm kind metadata.
    name string
    • (Required) The name for the vm.
    ngtCredentials {[key: string]: string}
    • (Ooptional) Credentials to login server.
    ngtEnabledCapabilityLists string[]
    Application names that are enabled.
    nicListStatuses VirtualMachineNicListStatus[]
    • Status NICs attached to the VM.
    nicLists VirtualMachineNicList[]
    • (Optional) Spec NICs attached to the VM.
    numSockets number
    • (Optional) Number of vCPU sockets.
    numVcpusPerSocket number
    • (Optional) Number of vCPUs per socket.
    numVnumaNodes number
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    nutanixGuestTools {[key: string]: string}
    • (Optional) Information regarding Nutanix Guest Tools.
    ownerReference {[key: string]: string}
    • (Optional) The reference to a user.
    parentReference {[key: string]: string}
    • (Optional) Reference to an entity that the VM cloned from.
    powerState string
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    powerStateMechanism string
    • (Optional) 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}
    • (Optional) The reference to a project.
    serialPortLists VirtualMachineSerialPortList[]
    • (Optional) Serial Ports configured on the VM.
    shouldFailOnScriptFailure boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    state string
    • The state of the vm.
    useHotAdd boolean
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    vgaConsoleEnabled boolean
    • (Optional) Indicates whether VGA console should be enabled or not.
    api_version str
    The version of the API.
    availability_zone_reference Mapping[str, str]
    • (Optional) The reference to a availability_zone.
    boot_device_disk_address Mapping[str, str]
    • (Optional) Address of disk to boot from.
    boot_device_mac_address str
    • (Optional) MAC address of nic to boot from.
    boot_device_order_lists Sequence[str]
    • (Optional) 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
    • (Optional) 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[VirtualMachineCategoryArgs]
    • (Optional) Categories for the vm.
    cloud_init_cdrom_uuid str
    cluster_name str
    • The name of the cluster.
    cluster_uuid str
    • (Required) The UUID of the cluster.
    description str
    • (Optional) A description for vm.
    disk_lists Sequence[VirtualMachineDiskListArgs]
    Disks attached to the VM.
    enable_cpu_passthrough bool
    • (Optional) Add true to enable CPU passthrough.
    enable_script_exec bool
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    gpu_lists Sequence[VirtualMachineGpuListArgs]
    • (Optional) GPUs attached to the VM.
    guest_customization_cloud_init_custom_key_values Mapping[str, str]
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    guest_customization_sysprep Mapping[str, str]
    • (Optional) 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, str]
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    guest_os_id str
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    hardware_clock_timezone str
    • (Optional) 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.
    is_vcpu_hard_pinned bool
    • (Optional) Add true to enable CPU pinning.
    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
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    metadata Mapping[str, str]
    • The vm kind metadata.
    name str
    • (Required) The name for the vm.
    ngt_credentials Mapping[str, str]
    • (Ooptional) Credentials to login server.
    ngt_enabled_capability_lists Sequence[str]
    Application names that are enabled.
    nic_list_statuses Sequence[VirtualMachineNicListStatusArgs]
    • Status NICs attached to the VM.
    nic_lists Sequence[VirtualMachineNicListArgs]
    • (Optional) Spec NICs attached to the VM.
    num_sockets int
    • (Optional) Number of vCPU sockets.
    num_vcpus_per_socket int
    • (Optional) Number of vCPUs per socket.
    num_vnuma_nodes int
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    nutanix_guest_tools Mapping[str, str]
    • (Optional) Information regarding Nutanix Guest Tools.
    owner_reference Mapping[str, str]
    • (Optional) The reference to a user.
    parent_reference Mapping[str, str]
    • (Optional) Reference to an entity that the VM cloned from.
    power_state str
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    power_state_mechanism str
    • (Optional) 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]
    • (Optional) The reference to a project.
    serial_port_lists Sequence[VirtualMachineSerialPortListArgs]
    • (Optional) Serial Ports configured on the VM.
    should_fail_on_script_failure bool
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    state str
    • The state of the vm.
    use_hot_add bool
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    vga_console_enabled bool
    • (Optional) Indicates whether VGA console should be enabled or not.
    apiVersion String
    The version of the API.
    availabilityZoneReference Map<String>
    • (Optional) The reference to a availability_zone.
    bootDeviceDiskAddress Map<String>
    • (Optional) Address of disk to boot from.
    bootDeviceMacAddress String
    • (Optional) MAC address of nic to boot from.
    bootDeviceOrderLists List<String>
    • (Optional) 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
    • (Optional) 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>
    • (Optional) Categories for the vm.
    cloudInitCdromUuid String
    clusterName String
    • The name of the cluster.
    clusterUuid String
    • (Required) The UUID of the cluster.
    description String
    • (Optional) A description for vm.
    diskLists List<Property Map>
    Disks attached to the VM.
    enableCpuPassthrough Boolean
    • (Optional) Add true to enable CPU passthrough.
    enableScriptExec Boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to execute set script before ngt shutdown/reboot.
    gpuLists List<Property Map>
    • (Optional) GPUs attached to the VM.
    guestCustomizationCloudInitCustomKeyValues Map<String>
    • (Optional) 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
    • (Optional) 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
    • (Optional) Flag to allow override of customization by deployer.
    guestCustomizationSysprep Map<String>
    • (Optional) 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>
    • (Optional) Generic key value pair used for custom attributes in sysprep.
    guestOsId String
    • (Optional) Guest OS Identifier. For ESX, refer to VMware documentation link for the list of guest OS identifiers.
    hardwareClockTimezone String
    • (Optional) 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.
    isVcpuHardPinned Boolean
    • (Optional) Add true to enable CPU pinning.
    machineType String
    • Machine type for the VM. Machine type Q35 is required for secure boot and does not support IDE disks.
    memorySizeMib Number
    • (Optional) Memory size in MiB. On updating memory to powered ON VMs should only be done in 1GB increments.
    metadata Map<String>
    • The vm kind metadata.
    name String
    • (Required) The name for the vm.
    ngtCredentials Map<String>
    • (Ooptional) Credentials to login server.
    ngtEnabledCapabilityLists List<String>
    Application names that are enabled.
    nicListStatuses List<Property Map>
    • Status NICs attached to the VM.
    nicLists List<Property Map>
    • (Optional) Spec NICs attached to the VM.
    numSockets Number
    • (Optional) Number of vCPU sockets.
    numVcpusPerSocket Number
    • (Optional) Number of vCPUs per socket.
    numVnumaNodes Number
    • (Optional) Number of vNUMA nodes. 0 means vNUMA is disabled.
    nutanixGuestTools Map<String>
    • (Optional) Information regarding Nutanix Guest Tools.
    ownerReference Map<String>
    • (Optional) The reference to a user.
    parentReference Map<String>
    • (Optional) Reference to an entity that the VM cloned from.
    powerState String
    • (Optional) The current or desired power state of the VM. (Options : ON , OFF)
    powerStateMechanism String
    • (Optional) 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>
    • (Optional) The reference to a project.
    serialPortLists List<Property Map>
    • (Optional) Serial Ports configured on the VM.
    shouldFailOnScriptFailure Boolean
    • (Optional) Extra configs related to power state transition. Indicates whether to abort ngt shutdown/reboot if script fails.
    state String
    • The state of the vm.
    useHotAdd Boolean
    • (Optional) Use Hot Add when modifying VM resources. Passing value false will result in VM reboots. Default value is true.
    vgaConsoleEnabled Boolean
    • (Optional) Indicates whether VGA console should be enabled or not.

    Supporting Types

    VirtualMachineCategory, VirtualMachineCategoryArgs

    Name string
    • (Required) The name for the vm.
    Value string
    • value of the key.
    Name string
    • (Required) The name for the vm.
    Value string
    • value of the key.
    name String
    • (Required) The name for the vm.
    value String
    • value of the key.
    name string
    • (Required) The name for the vm.
    value string
    • value of the key.
    name str
    • (Required) The name for the vm.
    value str
    • value of the key.
    name String
    • (Required) The name for the vm.
    value String
    • value of the key.

    VirtualMachineDiskList, VirtualMachineDiskListArgs

    DataSourceReference Dictionary<string, string>

    Reference to a data source.

    The disk_size (the disk size_mib and the disk_size_bytes attributes) is only honored by creating an empty disk. When you are creating from an image, the size is ignored and the disk becomes the size of the image from which it was cloned. In VM creation, you can't set either disk size_mib or disk_size_bytes when you set data_source_reference but, you can update the disk_size after creation (second apply).

    DeviceProperties PiersKarsenbarg.Nutanix.Inputs.VirtualMachineDiskListDeviceProperties
    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.
    StorageConfig PiersKarsenbarg.Nutanix.Inputs.VirtualMachineDiskListStorageConfig
    Uuid string
    • (Optional) The device ID which is used to uniquely identify this particular disk.
    VolumeGroupReference Dictionary<string, string>
    DataSourceReference map[string]string

    Reference to a data source.

    The disk_size (the disk size_mib and the disk_size_bytes attributes) is only honored by creating an empty disk. When you are creating from an image, the size is ignored and the disk becomes the size of the image from which it was cloned. In VM creation, you can't set either disk size_mib or disk_size_bytes when you set data_source_reference but, you can update the disk_size after creation (second apply).

    DeviceProperties VirtualMachineDiskListDeviceProperties
    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.
    StorageConfig VirtualMachineDiskListStorageConfig
    Uuid string
    • (Optional) The device ID which is used to uniquely identify this particular disk.
    VolumeGroupReference map[string]string
    dataSourceReference Map<String,String>

    Reference to a data source.

    The disk_size (the disk size_mib and the disk_size_bytes attributes) is only honored by creating an empty disk. When you are creating from an image, the size is ignored and the disk becomes the size of the image from which it was cloned. In VM creation, you can't set either disk size_mib or disk_size_bytes when you set data_source_reference but, you can update the disk_size after creation (second apply).

    deviceProperties VirtualMachineDiskListDeviceProperties
    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.
    storageConfig VirtualMachineDiskListStorageConfig
    uuid String
    • (Optional) The device ID which is used to uniquely identify this particular disk.
    volumeGroupReference Map<String,String>
    dataSourceReference {[key: string]: string}

    Reference to a data source.

    The disk_size (the disk size_mib and the disk_size_bytes attributes) is only honored by creating an empty disk. When you are creating from an image, the size is ignored and the disk becomes the size of the image from which it was cloned. In VM creation, you can't set either disk size_mib or disk_size_bytes when you set data_source_reference but, you can update the disk_size after creation (second apply).

    deviceProperties VirtualMachineDiskListDeviceProperties
    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.
    storageConfig VirtualMachineDiskListStorageConfig
    uuid string
    • (Optional) The device ID which is used to uniquely identify this particular disk.
    volumeGroupReference {[key: string]: string}
    data_source_reference Mapping[str, str]

    Reference to a data source.

    The disk_size (the disk size_mib and the disk_size_bytes attributes) is only honored by creating an empty disk. When you are creating from an image, the size is ignored and the disk becomes the size of the image from which it was cloned. In VM creation, you can't set either disk size_mib or disk_size_bytes when you set data_source_reference but, you can update the disk_size after creation (second apply).

    device_properties VirtualMachineDiskListDeviceProperties
    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_config VirtualMachineDiskListStorageConfig
    uuid str
    • (Optional) The device ID which is used to uniquely identify this particular disk.
    volume_group_reference Mapping[str, str]
    dataSourceReference Map<String>

    Reference to a data source.

    The disk_size (the disk size_mib and the disk_size_bytes attributes) is only honored by creating an empty disk. When you are creating from an image, the size is ignored and the disk becomes the size of the image from which it was cloned. In VM creation, you can't set either disk size_mib or disk_size_bytes when you set data_source_reference but, you can update the disk_size after creation (second apply).

    deviceProperties 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.
    storageConfig Property Map
    uuid String
    • (Optional) The device ID which is used to uniquely identify this particular disk.
    volumeGroupReference Map<String>

    VirtualMachineDiskListDeviceProperties, VirtualMachineDiskListDevicePropertiesArgs

    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.

    VirtualMachineDiskListStorageConfig, VirtualMachineDiskListStorageConfigArgs

    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.VirtualMachineDiskListStorageConfigStorageContainerReference>
    • Reference to a kind. Either one of (kind, uuid) or url needs to be specified. Requires Prism Central / AOS 5.17+.
    • 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 []VirtualMachineDiskListStorageConfigStorageContainerReference
    • Reference to a kind. Either one of (kind, uuid) or url needs to be specified. Requires Prism Central / AOS 5.17+.
    • 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<VirtualMachineDiskListStorageConfigStorageContainerReference>
    • Reference to a kind. Either one of (kind, uuid) or url needs to be specified. Requires Prism Central / AOS 5.17+.
    • 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 VirtualMachineDiskListStorageConfigStorageContainerReference[]
    • Reference to a kind. Either one of (kind, uuid) or url needs to be specified. Requires Prism Central / AOS 5.17+.
    • 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[VirtualMachineDiskListStorageConfigStorageContainerReference]
    • Reference to a kind. Either one of (kind, uuid) or url needs to be specified. Requires Prism Central / AOS 5.17+.
    • 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. Requires Prism Central / AOS 5.17+.
    • 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

    VirtualMachineDiskListStorageConfigStorageContainerReference, VirtualMachineDiskListStorageConfigStorageContainerReferenceArgs

    Kind string
    • The kind name (Default value: project)(Required).
    Name string
    • (Required) The name for the vm.
    Url string
    Uuid string
    • the UUID(Required).
    Kind string
    • The kind name (Default value: project)(Required).
    Name string
    • (Required) The name for the vm.
    Url string
    Uuid string
    • the UUID(Required).
    kind String
    • The kind name (Default value: project)(Required).
    name String
    • (Required) The name for the vm.
    url String
    uuid String
    • the UUID(Required).
    kind string
    • The kind name (Default value: project)(Required).
    name string
    • (Required) The name for the vm.
    url string
    uuid string
    • the UUID(Required).
    kind str
    • The kind name (Default value: project)(Required).
    name str
    • (Required) The name for the vm.
    url str
    uuid str
    • the UUID(Required).
    kind String
    • The kind name (Default value: project)(Required).
    name String
    • (Required) The name for the vm.
    url String
    uuid String
    • the UUID(Required).

    VirtualMachineGpuList, VirtualMachineGpuListArgs

    DeviceId int
    • (Computed) The device ID of the GPU.
    Fraction int
    Fraction of the physical GPU assigned.
    FrameBufferSizeMib int
    • (ReadOnly) GPU frame buffer size in MiB.
    GuestDriverVersion string
    • (ReadOnly) Last determined guest driver version.
    Mode string
    • (Optional) The mode of this GPU.
    Name string
    • (ReadOnly) Name of the GPU resource.
    NumVirtualDisplayHeads int
    • (ReadOnly) Number of supported virtual display heads.
    PciAddress string
    GPU {segment:bus:device:function} (sbdf) address if assigned.
    Uuid string
    • (ReadOnly) UUID of the GPU.
    Vendor string
    • (Optional) The vendor of the GPU.
    DeviceId int
    • (Computed) The device ID of the GPU.
    Fraction int
    Fraction of the physical GPU assigned.
    FrameBufferSizeMib int
    • (ReadOnly) GPU frame buffer size in MiB.
    GuestDriverVersion string
    • (ReadOnly) Last determined guest driver version.
    Mode string
    • (Optional) The mode of this GPU.
    Name string
    • (ReadOnly) Name of the GPU resource.
    NumVirtualDisplayHeads int
    • (ReadOnly) Number of supported virtual display heads.
    PciAddress string
    GPU {segment:bus:device:function} (sbdf) address if assigned.
    Uuid string
    • (ReadOnly) UUID of the GPU.
    Vendor string
    • (Optional) The vendor of the GPU.
    deviceId Integer
    • (Computed) The device ID of the GPU.
    fraction Integer
    Fraction of the physical GPU assigned.
    frameBufferSizeMib Integer
    • (ReadOnly) GPU frame buffer size in MiB.
    guestDriverVersion String
    • (ReadOnly) Last determined guest driver version.
    mode String
    • (Optional) The mode of this GPU.
    name String
    • (ReadOnly) Name of the GPU resource.
    numVirtualDisplayHeads Integer
    • (ReadOnly) Number of supported virtual display heads.
    pciAddress String
    GPU {segment:bus:device:function} (sbdf) address if assigned.
    uuid String
    • (ReadOnly) UUID of the GPU.
    vendor String
    • (Optional) The vendor of the GPU.
    deviceId number
    • (Computed) The device ID of the GPU.
    fraction number
    Fraction of the physical GPU assigned.
    frameBufferSizeMib number
    • (ReadOnly) GPU frame buffer size in MiB.
    guestDriverVersion string
    • (ReadOnly) Last determined guest driver version.
    mode string
    • (Optional) The mode of this GPU.
    name string
    • (ReadOnly) Name of the GPU resource.
    numVirtualDisplayHeads number
    • (ReadOnly) Number of supported virtual display heads.
    pciAddress string
    GPU {segment:bus:device:function} (sbdf) address if assigned.
    uuid string
    • (ReadOnly) UUID of the GPU.
    vendor string
    • (Optional) The vendor 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
    • (ReadOnly) GPU frame buffer size in MiB.
    guest_driver_version str
    • (ReadOnly) Last determined guest driver version.
    mode str
    • (Optional) The mode of this GPU.
    name str
    • (ReadOnly) Name of the GPU resource.
    num_virtual_display_heads int
    • (ReadOnly) Number of supported virtual display heads.
    pci_address str
    GPU {segment:bus:device:function} (sbdf) address if assigned.
    uuid str
    • (ReadOnly) UUID of the GPU.
    vendor str
    • (Optional) The vendor of the GPU.
    deviceId Number
    • (Computed) The device ID of the GPU.
    fraction Number
    Fraction of the physical GPU assigned.
    frameBufferSizeMib Number
    • (ReadOnly) GPU frame buffer size in MiB.
    guestDriverVersion String
    • (ReadOnly) Last determined guest driver version.
    mode String
    • (Optional) The mode of this GPU.
    name String
    • (ReadOnly) Name of the GPU resource.
    numVirtualDisplayHeads Number
    • (ReadOnly) Number of supported virtual display heads.
    pciAddress String
    GPU {segment:bus:device:function} (sbdf) address if assigned.
    uuid String
    • (ReadOnly) UUID of the GPU.
    vendor String
    • (Optional) The vendor of the GPU.

    VirtualMachineNicList, VirtualMachineNicListArgs

    IpEndpointLists List<PiersKarsenbarg.Nutanix.Inputs.VirtualMachineNicListIpEndpointList>
    • 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 NIC's UUID, which is used to uniquely identify this particular NIC. This UUID may be used to refer to the NIC outside the context of the particular VM it is attached to.
    IpEndpointLists []VirtualMachineNicListIpEndpointList
    • 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 NIC's UUID, which is used to uniquely identify this particular NIC. This UUID may be used to refer to the NIC outside the context of the particular VM it is attached to.
    ipEndpointLists List<VirtualMachineNicListIpEndpointList>
    • 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 NIC's UUID, which is used to uniquely identify this particular NIC. This UUID may be used to refer to the NIC outside the context of the particular VM it is attached to.
    ipEndpointLists VirtualMachineNicListIpEndpointList[]
    • 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 NIC's UUID, which is used to uniquely identify this particular NIC. This UUID may be used to refer to the NIC outside the context of the particular VM it is attached to.
    ip_endpoint_lists Sequence[VirtualMachineNicListIpEndpointList]
    • 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 NIC's UUID, which is used to uniquely identify this particular NIC. This UUID may be used to refer to the NIC outside the context of the particular VM it is attached to.
    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 NIC's UUID, which is used to uniquely identify this particular NIC. This UUID may be used to refer to the NIC outside the context of the particular VM it is attached to.

    VirtualMachineNicListIpEndpointList, VirtualMachineNicListIpEndpointListArgs

    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)

    VirtualMachineNicListStatus, VirtualMachineNicListStatusArgs

    FloatingIp string
    • The Floating IP associated with the vnic. (Only in nic_list_status)
    IpEndpointLists List<PiersKarsenbarg.Nutanix.Inputs.VirtualMachineNicListStatusIpEndpointList>
    • 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(Required).
    FloatingIp string
    • The Floating IP associated with the vnic. (Only in nic_list_status)
    IpEndpointLists []VirtualMachineNicListStatusIpEndpointList
    • 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(Required).
    floatingIp String
    • The Floating IP associated with the vnic. (Only in nic_list_status)
    ipEndpointLists List<VirtualMachineNicListStatusIpEndpointList>
    • 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(Required).
    floatingIp string
    • The Floating IP associated with the vnic. (Only in nic_list_status)
    ipEndpointLists VirtualMachineNicListStatusIpEndpointList[]
    • 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(Required).
    floating_ip str
    • The Floating IP associated with the vnic. (Only in nic_list_status)
    ip_endpoint_lists Sequence[VirtualMachineNicListStatusIpEndpointList]
    • 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(Required).
    floatingIp String
    • The Floating IP associated with the vnic. (Only in nic_list_status)
    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(Required).

    VirtualMachineNicListStatusIpEndpointList, VirtualMachineNicListStatusIpEndpointListArgs

    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)

    VirtualMachineSerialPortList, VirtualMachineSerialPortListArgs

    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).

    Import

    Nutanix Virtual machines can be imported using the UUID eg,

    `

    $ pulumi import nutanix:index/virtualMachine:VirtualMachine vm01 0F75E6A7-55FB-44D9-A50D-14AD72E2CF7C

    `

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix