1. Packages
  2. Vcd Provider
  3. API Docs
  4. VmInternalDisk
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.VmInternalDisk

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Create VmInternalDisk Resource

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

    Constructor syntax

    new VmInternalDisk(name: string, args: VmInternalDiskArgs, opts?: CustomResourceOptions);
    @overload
    def VmInternalDisk(resource_name: str,
                       args: VmInternalDiskInitArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def VmInternalDisk(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       bus_number: Optional[float] = None,
                       bus_type: Optional[str] = None,
                       size_in_mb: Optional[float] = None,
                       unit_number: Optional[float] = None,
                       vapp_name: Optional[str] = None,
                       vm_name: Optional[str] = None,
                       allow_vm_reboot: Optional[bool] = None,
                       iops: Optional[float] = None,
                       org: Optional[str] = None,
                       storage_profile: Optional[str] = None,
                       vdc: Optional[str] = None,
                       vm_internal_disk_id: Optional[str] = None)
    func NewVmInternalDisk(ctx *Context, name string, args VmInternalDiskArgs, opts ...ResourceOption) (*VmInternalDisk, error)
    public VmInternalDisk(string name, VmInternalDiskArgs args, CustomResourceOptions? opts = null)
    public VmInternalDisk(String name, VmInternalDiskArgs args)
    public VmInternalDisk(String name, VmInternalDiskArgs args, CustomResourceOptions options)
    
    type: vcd:VmInternalDisk
    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 VmInternalDiskArgs
    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 VmInternalDiskInitArgs
    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 VmInternalDiskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VmInternalDiskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VmInternalDiskArgs
    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 vmInternalDiskResource = new Vcd.VmInternalDisk("vmInternalDiskResource", new()
    {
        BusNumber = 0,
        BusType = "string",
        SizeInMb = 0,
        UnitNumber = 0,
        VappName = "string",
        VmName = "string",
        AllowVmReboot = false,
        Iops = 0,
        Org = "string",
        StorageProfile = "string",
        Vdc = "string",
        VmInternalDiskId = "string",
    });
    
    example, err := vcd.NewVmInternalDisk(ctx, "vmInternalDiskResource", &vcd.VmInternalDiskArgs{
    	BusNumber:        pulumi.Float64(0),
    	BusType:          pulumi.String("string"),
    	SizeInMb:         pulumi.Float64(0),
    	UnitNumber:       pulumi.Float64(0),
    	VappName:         pulumi.String("string"),
    	VmName:           pulumi.String("string"),
    	AllowVmReboot:    pulumi.Bool(false),
    	Iops:             pulumi.Float64(0),
    	Org:              pulumi.String("string"),
    	StorageProfile:   pulumi.String("string"),
    	Vdc:              pulumi.String("string"),
    	VmInternalDiskId: pulumi.String("string"),
    })
    
    var vmInternalDiskResource = new VmInternalDisk("vmInternalDiskResource", VmInternalDiskArgs.builder()
        .busNumber(0)
        .busType("string")
        .sizeInMb(0)
        .unitNumber(0)
        .vappName("string")
        .vmName("string")
        .allowVmReboot(false)
        .iops(0)
        .org("string")
        .storageProfile("string")
        .vdc("string")
        .vmInternalDiskId("string")
        .build());
    
    vm_internal_disk_resource = vcd.VmInternalDisk("vmInternalDiskResource",
        bus_number=0,
        bus_type="string",
        size_in_mb=0,
        unit_number=0,
        vapp_name="string",
        vm_name="string",
        allow_vm_reboot=False,
        iops=0,
        org="string",
        storage_profile="string",
        vdc="string",
        vm_internal_disk_id="string")
    
    const vmInternalDiskResource = new vcd.VmInternalDisk("vmInternalDiskResource", {
        busNumber: 0,
        busType: "string",
        sizeInMb: 0,
        unitNumber: 0,
        vappName: "string",
        vmName: "string",
        allowVmReboot: false,
        iops: 0,
        org: "string",
        storageProfile: "string",
        vdc: "string",
        vmInternalDiskId: "string",
    });
    
    type: vcd:VmInternalDisk
    properties:
        allowVmReboot: false
        busNumber: 0
        busType: string
        iops: 0
        org: string
        sizeInMb: 0
        storageProfile: string
        unitNumber: 0
        vappName: string
        vdc: string
        vmInternalDiskId: string
        vmName: string
    

    VmInternalDisk Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VmInternalDisk resource accepts the following input properties:

    BusNumber double
    The number of the SCSI or IDE controller itself.
    BusType string
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    SizeInMb double
    The size of the disk in MB.
    UnitNumber double
    The device number on the SCSI or IDE controller of the disk.
    VappName string
    The vAPP this VM internal disk belongs to.
    VmName string
    VM in vAPP in which internal disk is created.
    AllowVmReboot bool
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    Iops double
    Specifies the IOPS for the disk. Default is 0.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    StorageProfile string
    Storage profile which overrides the VM default one.
    Vdc string
    The name of VDC to use, optional if defined at provider level
    VmInternalDiskId string
    BusNumber float64
    The number of the SCSI or IDE controller itself.
    BusType string
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    SizeInMb float64
    The size of the disk in MB.
    UnitNumber float64
    The device number on the SCSI or IDE controller of the disk.
    VappName string
    The vAPP this VM internal disk belongs to.
    VmName string
    VM in vAPP in which internal disk is created.
    AllowVmReboot bool
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    Iops float64
    Specifies the IOPS for the disk. Default is 0.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    StorageProfile string
    Storage profile which overrides the VM default one.
    Vdc string
    The name of VDC to use, optional if defined at provider level
    VmInternalDiskId string
    busNumber Double
    The number of the SCSI or IDE controller itself.
    busType String
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    sizeInMb Double
    The size of the disk in MB.
    unitNumber Double
    The device number on the SCSI or IDE controller of the disk.
    vappName String
    The vAPP this VM internal disk belongs to.
    vmName String
    VM in vAPP in which internal disk is created.
    allowVmReboot Boolean
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    iops Double
    Specifies the IOPS for the disk. Default is 0.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    storageProfile String
    Storage profile which overrides the VM default one.
    vdc String
    The name of VDC to use, optional if defined at provider level
    vmInternalDiskId String
    busNumber number
    The number of the SCSI or IDE controller itself.
    busType string
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    sizeInMb number
    The size of the disk in MB.
    unitNumber number
    The device number on the SCSI or IDE controller of the disk.
    vappName string
    The vAPP this VM internal disk belongs to.
    vmName string
    VM in vAPP in which internal disk is created.
    allowVmReboot boolean
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    iops number
    Specifies the IOPS for the disk. Default is 0.
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    storageProfile string
    Storage profile which overrides the VM default one.
    vdc string
    The name of VDC to use, optional if defined at provider level
    vmInternalDiskId string
    bus_number float
    The number of the SCSI or IDE controller itself.
    bus_type str
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    size_in_mb float
    The size of the disk in MB.
    unit_number float
    The device number on the SCSI or IDE controller of the disk.
    vapp_name str
    The vAPP this VM internal disk belongs to.
    vm_name str
    VM in vAPP in which internal disk is created.
    allow_vm_reboot bool
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    iops float
    Specifies the IOPS for the disk. Default is 0.
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    storage_profile str
    Storage profile which overrides the VM default one.
    vdc str
    The name of VDC to use, optional if defined at provider level
    vm_internal_disk_id str
    busNumber Number
    The number of the SCSI or IDE controller itself.
    busType String
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    sizeInMb Number
    The size of the disk in MB.
    unitNumber Number
    The device number on the SCSI or IDE controller of the disk.
    vappName String
    The vAPP this VM internal disk belongs to.
    vmName String
    VM in vAPP in which internal disk is created.
    allowVmReboot Boolean
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    iops Number
    Specifies the IOPS for the disk. Default is 0.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    storageProfile String
    Storage profile which overrides the VM default one.
    vdc String
    The name of VDC to use, optional if defined at provider level
    vmInternalDiskId String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ThinProvisioned bool
    Specifies whether the disk storage is pre-allocated or allocated on demand.
    Id string
    The provider-assigned unique ID for this managed resource.
    ThinProvisioned bool
    Specifies whether the disk storage is pre-allocated or allocated on demand.
    id String
    The provider-assigned unique ID for this managed resource.
    thinProvisioned Boolean
    Specifies whether the disk storage is pre-allocated or allocated on demand.
    id string
    The provider-assigned unique ID for this managed resource.
    thinProvisioned boolean
    Specifies whether the disk storage is pre-allocated or allocated on demand.
    id str
    The provider-assigned unique ID for this managed resource.
    thin_provisioned bool
    Specifies whether the disk storage is pre-allocated or allocated on demand.
    id String
    The provider-assigned unique ID for this managed resource.
    thinProvisioned Boolean
    Specifies whether the disk storage is pre-allocated or allocated on demand.

    Look up Existing VmInternalDisk Resource

    Get an existing VmInternalDisk 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?: VmInternalDiskState, opts?: CustomResourceOptions): VmInternalDisk
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_vm_reboot: Optional[bool] = None,
            bus_number: Optional[float] = None,
            bus_type: Optional[str] = None,
            iops: Optional[float] = None,
            org: Optional[str] = None,
            size_in_mb: Optional[float] = None,
            storage_profile: Optional[str] = None,
            thin_provisioned: Optional[bool] = None,
            unit_number: Optional[float] = None,
            vapp_name: Optional[str] = None,
            vdc: Optional[str] = None,
            vm_internal_disk_id: Optional[str] = None,
            vm_name: Optional[str] = None) -> VmInternalDisk
    func GetVmInternalDisk(ctx *Context, name string, id IDInput, state *VmInternalDiskState, opts ...ResourceOption) (*VmInternalDisk, error)
    public static VmInternalDisk Get(string name, Input<string> id, VmInternalDiskState? state, CustomResourceOptions? opts = null)
    public static VmInternalDisk get(String name, Output<String> id, VmInternalDiskState state, CustomResourceOptions options)
    resources:  _:    type: vcd:VmInternalDisk    get:      id: ${id}
    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:
    AllowVmReboot bool
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    BusNumber double
    The number of the SCSI or IDE controller itself.
    BusType string
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    Iops double
    Specifies the IOPS for the disk. Default is 0.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    SizeInMb double
    The size of the disk in MB.
    StorageProfile string
    Storage profile which overrides the VM default one.
    ThinProvisioned bool
    Specifies whether the disk storage is pre-allocated or allocated on demand.
    UnitNumber double
    The device number on the SCSI or IDE controller of the disk.
    VappName string
    The vAPP this VM internal disk belongs to.
    Vdc string
    The name of VDC to use, optional if defined at provider level
    VmInternalDiskId string
    VmName string
    VM in vAPP in which internal disk is created.
    AllowVmReboot bool
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    BusNumber float64
    The number of the SCSI or IDE controller itself.
    BusType string
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    Iops float64
    Specifies the IOPS for the disk. Default is 0.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    SizeInMb float64
    The size of the disk in MB.
    StorageProfile string
    Storage profile which overrides the VM default one.
    ThinProvisioned bool
    Specifies whether the disk storage is pre-allocated or allocated on demand.
    UnitNumber float64
    The device number on the SCSI or IDE controller of the disk.
    VappName string
    The vAPP this VM internal disk belongs to.
    Vdc string
    The name of VDC to use, optional if defined at provider level
    VmInternalDiskId string
    VmName string
    VM in vAPP in which internal disk is created.
    allowVmReboot Boolean
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    busNumber Double
    The number of the SCSI or IDE controller itself.
    busType String
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    iops Double
    Specifies the IOPS for the disk. Default is 0.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    sizeInMb Double
    The size of the disk in MB.
    storageProfile String
    Storage profile which overrides the VM default one.
    thinProvisioned Boolean
    Specifies whether the disk storage is pre-allocated or allocated on demand.
    unitNumber Double
    The device number on the SCSI or IDE controller of the disk.
    vappName String
    The vAPP this VM internal disk belongs to.
    vdc String
    The name of VDC to use, optional if defined at provider level
    vmInternalDiskId String
    vmName String
    VM in vAPP in which internal disk is created.
    allowVmReboot boolean
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    busNumber number
    The number of the SCSI or IDE controller itself.
    busType string
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    iops number
    Specifies the IOPS for the disk. Default is 0.
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    sizeInMb number
    The size of the disk in MB.
    storageProfile string
    Storage profile which overrides the VM default one.
    thinProvisioned boolean
    Specifies whether the disk storage is pre-allocated or allocated on demand.
    unitNumber number
    The device number on the SCSI or IDE controller of the disk.
    vappName string
    The vAPP this VM internal disk belongs to.
    vdc string
    The name of VDC to use, optional if defined at provider level
    vmInternalDiskId string
    vmName string
    VM in vAPP in which internal disk is created.
    allow_vm_reboot bool
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    bus_number float
    The number of the SCSI or IDE controller itself.
    bus_type str
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    iops float
    Specifies the IOPS for the disk. Default is 0.
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    size_in_mb float
    The size of the disk in MB.
    storage_profile str
    Storage profile which overrides the VM default one.
    thin_provisioned bool
    Specifies whether the disk storage is pre-allocated or allocated on demand.
    unit_number float
    The device number on the SCSI or IDE controller of the disk.
    vapp_name str
    The vAPP this VM internal disk belongs to.
    vdc str
    The name of VDC to use, optional if defined at provider level
    vm_internal_disk_id str
    vm_name str
    VM in vAPP in which internal disk is created.
    allowVmReboot Boolean
    Powers off VM when changing any attribute of an IDE disk or unit/bus number of other disk types, after the change is complete VM is powered back on. Without this setting enabled, such changes on a powered-on VM would fail. Defaults to false.
    busNumber Number
    The number of the SCSI or IDE controller itself.
    busType String
    The type of disk controller. Possible values: ide, parallel( LSI Logic Parallel SCSI), sas(LSI Logic SAS (SCSI)), paravirtual(Paravirtual (SCSI)), sata, nvme. Note nvme requires v3.4.0+ and VCD 10.2.1+
    iops Number
    Specifies the IOPS for the disk. Default is 0.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    sizeInMb Number
    The size of the disk in MB.
    storageProfile String
    Storage profile which overrides the VM default one.
    thinProvisioned Boolean
    Specifies whether the disk storage is pre-allocated or allocated on demand.
    unitNumber Number
    The device number on the SCSI or IDE controller of the disk.
    vappName String
    The vAPP this VM internal disk belongs to.
    vdc String
    The name of VDC to use, optional if defined at provider level
    vmInternalDiskId String
    vmName String
    VM in vAPP in which internal disk is created.

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware