Class: OvirtSDK4::DiskService

Inherits:

MeasurableService

Object
Service
MeasurableService
OvirtSDK4::DiskService

show all

Defined in:: lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary collapse

#convert(opts = {}) ⇒ Object

Converts disk format and/or preallocation mode.
#copy(opts = {}) ⇒ Object

This operation copies a disk to the specified storage domain.
#disk_snapshots_service ⇒ DiskSnapshotsService

Reference to the service that manages the DiskSnapshots.
#export(opts = {}) ⇒ Object

Exports a disk to an export storage domain.
#get(opts = {}) ⇒ Disk

Retrieves the description of the disk.
#move(opts = {}) ⇒ Object

Moves a disk to another storage domain.
#permissions_service ⇒ AssignedPermissionsService

Reference to the service that manages the permissions assigned to the disk.
#reduce(opts = {}) ⇒ Object

Reduces the size of the disk image.
#refresh_lun(opts = {}) ⇒ Object

Refreshes a direct LUN disk with up-to-date information from the storage.
#remove(opts = {}) ⇒ Object

Removes a disk.
#service(path) ⇒ Service

Locates the service corresponding to the given path.
#sparsify(opts = {}) ⇒ Object

Sparsify the disk.
#statistics_service ⇒ StatisticsService

Locates the statistics service.
#update(disk, opts = {}) ⇒ Disk

Updates the parameters of the specified disk.

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#convert(opts = {}) ⇒ `Object`

Converts disk format and/or preallocation mode.

For example, to convert the disk format from preallocated-cow to a sparse-raw image, send a request like the following:

POST /ovirt-engine/api/disks/123/convert

With the following request body:

 <action>
   <disk>
     <sparse>true</sparse>
     <format>raw</format>
   </disk>
 </action>

Note: In order to sparsify a disk, two conversions might be needed if the disk is on a Block Storage Domain. For example: If a disk is RAW, converting it to QCOW will result in a larger disk. In order to reduce the size, it is possible to convert the disk again to QCOW and keep the same allocation policy.

Parameters:

opts (Hash) (defaults to: {}) —

Additional options.

Options Hash (opts):

:disk (Disk) —

The description of the disk.
:follow (String) —

Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
:headers (Hash) — default: {} —

Additional HTTP headers.
:query (Hash) — default: {} —

Additional URL query parameters.
:timeout (Integer) — default: nil —

The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.
:wait (Boolean) — default: true —

If true wait for the response.



37181
37182
37183

# File 'lib/ovirtsdk4/services.rb', line 37181

def convert(opts = {})
  internal_action(:convert, nil, CONVERT, opts)
end

#copy(opts = {}) ⇒ `Object`

This operation copies a disk to the specified storage domain.

For example, a disk can be copied using the following request:

POST /ovirt-engine/api/disks/123/copy

With a request body like this:

<action>
  <storage_domain id="456"/>
  <disk>
    <name>mydisk</name>
  </disk>
</action>

If the disk profile or the quota currently used by the disk are not defined for the new storage domain, they can be explicitly specified. If they are not specified, the first available disk profile and the default quota are used.

For example, to specify disk profile 987 and quota 753, send a request body like this:

<action>
  <storage_domain id="456"/>
  <disk_profile id="987"/>
  <quota id="753"/>
</action>

Parameters:

opts (Hash) (defaults to: {}) —

Additional options.

Options Hash (opts):

:async (Boolean) —

Indicates if the copy should be performed asynchronously.
:disk (Disk)
:disk_profile (DiskProfile) —

Disk profile for the disk in the new storage domain.

Disk profiles are defined for storage domains, so the old disk profile will not exist in the new storage domain. If this parameter is not used, the first disk profile from the new storage domain to which the user has permissions will be assigned to the disk.
:filter (Boolean) —

Indicates if the results should be filtered according to the permissions of the user.
:quota (Quota) —

Quota for the disk in the new storage domain.

This optional parameter can be used to specify new quota for the disk, because the current quota may not be defined for the new storage domain. If this parameter is not used and the old quota is not defined for the new storage domain, the default (unlimited) quota will be assigned to the disk.
:storage_domain (StorageDomain) —
The storage domain where the new disk is created. This can be specified using the id or name attributes. For example, to copy a disk to the storage domain called mydata, send a request like this:
```
POST /ovirt-engine/api/storagedomains/123/disks/789
```
With a request body like this:
```
<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
</action>
```
:headers (Hash) — default: {} —

Additional HTTP headers.
:query (Hash) — default: {} —

Additional URL query parameters.
:timeout (Integer) — default: nil —

The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.
:wait (Boolean) — default: true —

If true wait for the response.



37281
37282
37283

# File 'lib/ovirtsdk4/services.rb', line 37281

def copy(opts = {})
  internal_action(:copy, nil, COPY, opts)
end

#disk_snapshots_service ⇒ `DiskSnapshotsService`

Reference to the service that manages the DiskSnapshots.

For example, to list all disk snapshots under the disks resource '123':

GET /ovirt-engine/api/disks/123/disksnapshots

For example, to retrieve a specific disk snapshot '789' under the disk resource '123':

GET /ovirt-engine/api/disks/123/disksnapshots/789

Returns:

(DiskSnapshotsService) —

A reference to disk_snapshots service.



37649
37650
37651

# File 'lib/ovirtsdk4/services.rb', line 37649

def disk_snapshots_service
  @disk_snapshots_service ||= DiskSnapshotsService.new(self, 'disksnapshots')
end

#export(opts = {}) ⇒ `Object`

Exports a disk to an export storage domain.

Parameters:

opts (Hash) (defaults to: {}) —

Additional options.

Options Hash (opts):

:async (Boolean) —

Indicates if the export should be performed asynchronously.
:filter (Boolean) —

Indicates if the results should be filtered according to the permissions of the user.
:storage_domain (StorageDomain) —

The export storage domain where the disk will be exported to.
:headers (Hash) — default: {} —

Additional HTTP headers.
:query (Hash) — default: {} —

Additional URL query parameters.
:timeout (Integer) — default: nil —

The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.
:wait (Boolean) — default: true —

If true wait for the response.



37313
37314
37315

# File 'lib/ovirtsdk4/services.rb', line 37313

def export(opts = {})
  internal_action(:export, nil, EXPORT, opts)
end

#get(opts = {}) ⇒ `Disk`

Retrieves the description of the disk.

Parameters:

opts (Hash) (defaults to: {}) —

Additional options.

Options Hash (opts):

:all_content (Boolean) —
Indicates if all of the attributes of the disk should be included in the response.

By default the following disk attributes are excluded:
- vms
For example, to retrieve the complete representation of disk '123':
```
GET /ovirt-engine/api/disks/123?all_content=true
```
:follow (String) —

Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
:headers (Hash) — default: {} —

Additional HTTP headers.
:query (Hash) — default: {} —

Additional URL query parameters.
:timeout (Integer) — default: nil —

The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.
:wait (Boolean) — default: true —

If true wait for the response.

Returns:

(Disk)



37355
37356
37357

# File 'lib/ovirtsdk4/services.rb', line 37355

def get(opts = {})
  internal_get(GET, opts)
end

#move(opts = {}) ⇒ `Object`

Moves a disk to another storage domain.

For example, to move the disk with identifier 123 to a storage domain with identifier 456 send the following request:

POST /ovirt-engine/api/disks/123/move

With the following request body:

<action>
  <storage_domain id="456"/>
</action>

If the disk profile or the quota used currently by the disk aren’t defined for the new storage domain, then they can be explicitly specified. If they aren’t then the first available disk profile and the default quota are used.

For example, to explicitly use disk profile 987 and quota 753 send a request body like this:

<action>
  <storage_domain id="456"/>
  <disk_profile id="987"/>
  <quota id="753"/>
</action>

Parameters:

opts (Hash) (defaults to: {}) —

Additional options.

Options Hash (opts):

:async (Boolean) —

Indicates if the move should be performed asynchronously.
:disk_profile (DiskProfile) —

Disk profile for the disk in the new storage domain.

Disk profiles are defined for storage domains, so the old disk profile will not exist in the new storage domain. If this parameter is not used, the first disk profile from the new storage domain to which the user has permissions will be assigned to the disk.
:filter (Boolean) —

Indicates if the results should be filtered according to the permissions of the user.
:quota (Quota) —

Quota for the disk in the new storage domain.

This optional parameter can be used to specify new quota for the disk, because the current quota may not be defined for the new storage domain. If this parameter is not used and the old quota is not defined for the new storage domain, the default (unlimited) quota will be assigned to the disk.
:storage_domain (StorageDomain) —

The storage domain where the disk will be moved to.
:headers (Hash) — default: {} —

Additional HTTP headers.
:query (Hash) — default: {} —

Additional URL query parameters.
:timeout (Integer) — default: nil —

The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.
:wait (Boolean) — default: true —

If true wait for the response.



37438
37439
37440

# File 'lib/ovirtsdk4/services.rb', line 37438

def move(opts = {})
  internal_action(:move, nil, MOVE, opts)
end

#permissions_service ⇒ `AssignedPermissionsService`

Reference to the service that manages the permissions assigned to the disk.

Returns:

(AssignedPermissionsService) —

A reference to permissions service.



37658
37659
37660

# File 'lib/ovirtsdk4/services.rb', line 37658

def permissions_service
  @permissions_service ||= AssignedPermissionsService.new(self, 'permissions')
end

#reduce(opts = {}) ⇒ `Object`

Reduces the size of the disk image.

Invokes reduce on the logical volume (i.e. this is only applicable for block storage domains). This is applicable for floating disks and disks attached to non-running virtual machines. There is no need to specify the size as the optimal size is calculated automatically.

Parameters:

opts (Hash) (defaults to: {}) —

Additional options.

Options Hash (opts):

:async (Boolean) —

Indicates if the remove should be performed asynchronously.
:headers (Hash) — default: {} —

Additional HTTP headers.
:query (Hash) — default: {} —

Additional URL query parameters.
:timeout (Integer) — default: nil —

The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.
:wait (Boolean) — default: true —

If true wait for the response.



37468
37469
37470

# File 'lib/ovirtsdk4/services.rb', line 37468

def reduce(opts = {})
  internal_action(:reduce, nil, REDUCE, opts)
end

#refresh_lun(opts = {}) ⇒ `Object`

Refreshes a direct LUN disk with up-to-date information from the storage.

Refreshing a direct LUN disk is useful when:

The LUN was added using the API without the host parameter, and therefore does not contain any information from the storage (see DisksService::add).
New information about the LUN is available on the storage and you want to update the LUN with it.

To refresh direct LUN disk 123 using host 456, send the following request:

POST /ovirt-engine/api/disks/123/refreshlun

With the following request body:

<action>
  <host id='456'/>
</action>

Parameters:

opts (Hash) (defaults to: {}) —

Additional options.

Options Hash (opts):

:host (Host) —

The host that will be used to refresh the direct LUN disk.
:headers (Hash) — default: {} —

Additional HTTP headers.
:query (Hash) — default: {} —

Additional URL query parameters.
:timeout (Integer) — default: nil —

The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.
:wait (Boolean) — default: true —

If true wait for the response.



37516
37517
37518

# File 'lib/ovirtsdk4/services.rb', line 37516

def refresh_lun(opts = {})
  internal_action(:refreshlun, nil, REFRESH_LUN, opts)
end

#remove(opts = {}) ⇒ `Object`

Removes a disk.

Parameters:

opts (Hash) (defaults to: {}) —

Additional options.

Options Hash (opts):

:async (Boolean) —

Indicates if the remove should be performed asynchronously.
:headers (Hash) — default: {} —

Additional HTTP headers.
:query (Hash) — default: {} —

Additional URL query parameters.
:timeout (Integer) — default: nil —

The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.
:wait (Boolean) — default: true —

If true wait for the response.



37541
37542
37543

# File 'lib/ovirtsdk4/services.rb', line 37541

def remove(opts = {})
  internal_remove(REMOVE, opts)
end

#service(path) ⇒ `Service`

Locates the service corresponding to the given path.

Parameters:

path (String) —

The path of the service.

Returns:

(Service) —

A reference to the service.

Raises:

(Error)

# File 'lib/ovirtsdk4/services.rb', line 37678

def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'disksnapshots'
    return disk_snapshots_service
  end
  if path.start_with?('disksnapshots/')
    return disk_snapshots_service.service(path[14..-1])
  end
  if path == 'permissions'
    return permissions_service
  end
  if path.start_with?('permissions/')
    return permissions_service.service(path[12..-1])
  end
  if path == 'statistics'
    return statistics_service
  end
  if path.start_with?('statistics/')
    return statistics_service.service(path[11..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end

#sparsify(opts = {}) ⇒ `Object`

Sparsify the disk.

Sparsification frees space in the disk image that is not used by its filesystem. As a result, the image will occupy less space on the storage.

Currently sparsification works only on disks without snapshots. Disks having derived disks are also not allowed.

Parameters:

opts (Hash) (defaults to: {}) —

Additional options.

Options Hash (opts):

:headers (Hash) — default: {} —

Additional HTTP headers.
:query (Hash) — default: {} —

Additional URL query parameters.
:timeout (Integer) — default: nil —

The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.
:wait (Boolean) — default: true —

If true wait for the response.



37570
37571
37572

# File 'lib/ovirtsdk4/services.rb', line 37570

def sparsify(opts = {})
  internal_action(:sparsify, nil, SPARSIFY, opts)
end

#statistics_service ⇒ `StatisticsService`

Locates the statistics service.

Returns:

(StatisticsService) —

A reference to statistics service.



37667
37668
37669

# File 'lib/ovirtsdk4/services.rb', line 37667

def statistics_service
  @statistics_service ||= StatisticsService.new(self, 'statistics')
end

#update(disk, opts = {}) ⇒ `Disk`

Updates the parameters of the specified disk.

This operation allows updating the following floating disk properties:

For Image disks: provisioned_size, alias, description, wipe_after_delete, shareable, backup and disk_profile.
For LUN disks: alias, description and shareable.
Cinder integration has been replaced by Managed Block Storage.
For Managed Block disks: provisioned_size, alias and description.
For VM attached disks, the qcow_version can also be updated.

For example, a disk’s update can be done by using the following request:

PUT /ovirt-engine/api/disks/123

With a request body like this:

<disk>
  <qcow_version>qcow2_v3</qcow_version>
  <alias>new-alias</alias>
  <description>new-desc</description>
</disk>

Since the backend operation is asynchronous, the disk element that is returned to the user might not be synced with the changed properties.

Parameters:

disk (Disk) —

The update to apply to the disk.
opts (Hash) (defaults to: {}) —

Additional options.

Options Hash (opts):

:headers (Hash) — default: {} —

Additional HTTP headers.
:query (Hash) — default: {} —

Additional URL query parameters.
:timeout (Integer) — default: nil —

The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.
:wait (Boolean) — default: true —

If true wait for the response.

Returns:

(Disk)



37629
37630
37631

# File 'lib/ovirtsdk4/services.rb', line 37629

def update(disk, opts = {})
  internal_update(disk, Disk, UPDATE, opts)
end

Class: OvirtSDK4::DiskService

Instance Method Summary collapse

Methods inherited from Service

Instance Method Details

#convert(opts = {}) ⇒ Object

#copy(opts = {}) ⇒ Object

#disk_snapshots_service ⇒ DiskSnapshotsService

#export(opts = {}) ⇒ Object

#get(opts = {}) ⇒ Disk

#move(opts = {}) ⇒ Object

#permissions_service ⇒ AssignedPermissionsService

#reduce(opts = {}) ⇒ Object

#refresh_lun(opts = {}) ⇒ Object

#remove(opts = {}) ⇒ Object

#service(path) ⇒ Service

#sparsify(opts = {}) ⇒ Object

#statistics_service ⇒ StatisticsService

#update(disk, opts = {}) ⇒ Disk

#convert(opts = {}) ⇒ `Object`

#copy(opts = {}) ⇒ `Object`

#disk_snapshots_service ⇒ `DiskSnapshotsService`

#export(opts = {}) ⇒ `Object`

#get(opts = {}) ⇒ `Disk`

#move(opts = {}) ⇒ `Object`

#permissions_service ⇒ `AssignedPermissionsService`

#reduce(opts = {}) ⇒ `Object`

#refresh_lun(opts = {}) ⇒ `Object`

#remove(opts = {}) ⇒ `Object`

#service(path) ⇒ `Service`

#sparsify(opts = {}) ⇒ `Object`

#statistics_service ⇒ `StatisticsService`

#update(disk, opts = {}) ⇒ `Disk`