Class: Com::Vmware::Vcenter::Vm::Hardware::Disk

Inherits:
VAPI::Bindings::VapiService
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb

Overview

The ``Com::Vmware::Vcenter::Vm::Hardware::Disk`` class provides methods for configuring the virtual disks of a virtual machine. A virtual disk has a backing such as a VMDK file. The backing has an independent lifecycle from the virtual machine when it is detached from the virtual machine. The :func:`Com::Vmware::Vcenter::Vm::Hardware::Disk.create` method provides the ability to create a new virtual disk. When creating a virtual disk, a new VMDK file may be created or an existing VMDK file may used as a backing. Once a VMDK file is associated with a virtual machine, its lifecycle will be bound to the virtual machine. In other words, it will be deleted when the virtual machine is deleted. The :func:`Com::Vmware::Vcenter::Vm::Hardware::Disk.delete` method provides the ability to detach a VMDK file from the virtual machine. The :func:`Com::Vmware::Vcenter::Vm::Hardware::Disk.delete` method does not delete the VMDK file that backs the virtual disk. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

Defined Under Namespace

Classes: BackingInfo, BackingSpec, BackingType, CreateSpec, HostBusAdapterType, Info, Summary, UpdateSpec, VmdkCreateSpec

Constant Summary

RESOURCE_TYPE = 
'com.vmware.vcenter.vm.hardware.Disk'

Instance Method Summary (collapse)

Constructor Details

- (Disk) initialize(config)

Constructs a new instance.

Parameters:

  • config (VAPI::Bindings::StubConfig) —

    A hash with the api provider details. 



1716
1717
1718
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1716

def initialize(config)
    super(config, @@service_info)
end

Instance Method Details

- (String) create(vm, spec)

Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.

Parameters:

Returns:

  • (String) —

    Virtual disk identifier.

Raises:



1810
1811
1812
1813
1814
1815
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1810

def create(vm, spec)
    invoke_with_info(@@create_info, {
        'vm' => vm,
        'spec' => spec,
    })
end

- (Void) delete(vm, disk)

Removes a virtual disk from the virtual machine. This method does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

Parameters:

  • vm (String) —

    Virtual machine identifier.

  • disk (String) —

    Virtual disk identifier.

Returns:

  • (Void)

Raises:



1875
1876
1877
1878
1879
1880
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1875

def delete(vm, disk)
    invoke_with_info(@@delete_info, {
        'vm' => vm,
        'disk' => disk,
    })
end

- (Com::Vmware::Vcenter::Vm::Hardware::Disk::Info) get(vm, disk)

Returns information about a virtual disk.

Parameters:

  • vm (String) —

    Virtual machine identifier.

  • disk (String) —

    Virtual disk identifier.

Returns:

Raises:



1768
1769
1770
1771
1772
1773
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1768

def get(vm, disk)
    invoke_with_info(@@get_info, {
        'vm' => vm,
        'disk' => disk,
    })
end

- (Array<Com::Vmware::Vcenter::Vm::Hardware::Disk::Summary>) list(vm)

Returns commonly used information about the virtual disks belonging to the virtual machine.

Parameters:

  • vm (String) —

    Virtual machine identifier.

Returns:

Raises:



1741
1742
1743
1744
1745
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1741

def list(vm)
    invoke_with_info(@@list_info, {
        'vm' => vm,
    })
end

- (Void) update(vm, disk, spec)

Updates the configuration of a virtual disk. An update method can be used to detach the existing VMDK file and attach another VMDK file to the virtual machine.

Parameters:

Returns:

  • (Void)

Raises:



1843
1844
1845
1846
1847
1848
1849
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1843

def update(vm, disk, spec)
    invoke_with_info(@@update_info, {
        'vm' => vm,
        'disk' => disk,
        'spec' => spec,
    })
end