Package org.ovirt.engine.sdk4.services
Interface StorageDomainService
-
- All Superinterfaces:
Service
- All Known Implementing Classes:
StorageDomainServiceImpl
public interface StorageDomainService extends Service
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
StorageDomainService.GetRequest
Retrieves the description of the storage domain.static interface
StorageDomainService.GetResponse
Retrieves the description of the storage domain.static interface
StorageDomainService.IsAttachedRequest
Used for querying if the storage domain is already attached to a data center using the is_attached boolean field, which is part of the storage server.static interface
StorageDomainService.IsAttachedResponse
Used for querying if the storage domain is already attached to a data center using the is_attached boolean field, which is part of the storage server.static interface
StorageDomainService.ReduceLunsRequest
This operation reduces logical units from the storage domain.static interface
StorageDomainService.ReduceLunsResponse
This operation reduces logical units from the storage domain.static interface
StorageDomainService.RefreshLunsRequest
This operation refreshes the LUN size.static interface
StorageDomainService.RefreshLunsResponse
This operation refreshes the LUN size.static interface
StorageDomainService.RemoveRequest
Removes the storage domain.static interface
StorageDomainService.RemoveResponse
Removes the storage domain.static interface
StorageDomainService.UpdateOvfStoreRequest
This operation forces the update of the `OVF_STORE` of this storage domain.static interface
StorageDomainService.UpdateOvfStoreResponse
This operation forces the update of the `OVF_STORE` of this storage domain.static interface
StorageDomainService.UpdateRequest
Updates a storage domain.static interface
StorageDomainService.UpdateResponse
Updates a storage domain.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AssignedDiskProfilesService
diskProfilesService()
DiskSnapshotsService
diskSnapshotsService()
StorageDomainDisksService
disksService()
Reference to the service that manages the disks available in the storage domain.FilesService
filesService()
Returns a reference to the service that manages the files available in the storage domain.StorageDomainService.GetRequest
get()
Retrieves the description of the storage domain.ImagesService
imagesService()
StorageDomainService.IsAttachedRequest
isAttached()
Used for querying if the storage domain is already attached to a data center using the is_attached boolean field, which is part of the storage server.AssignedPermissionsService
permissionsService()
StorageDomainService.ReduceLunsRequest
reduceLuns()
This operation reduces logical units from the storage domain.StorageDomainService.RefreshLunsRequest
refreshLuns()
This operation refreshes the LUN size.StorageDomainService.RemoveRequest
remove()
Removes the storage domain.Service
service(String path)
Service locator method, returns individual service on which the URI is dispatched.StorageDomainServerConnectionsService
storageConnectionsService()
Returns a reference to the service that manages the storage connections.StorageDomainTemplatesService
templatesService()
StorageDomainService.UpdateRequest
update()
Updates a storage domain.StorageDomainService.UpdateOvfStoreRequest
updateOvfStore()
This operation forces the update of the `OVF_STORE` of this storage domain.StorageDomainVmsService
vmsService()
-
-
-
Method Detail
-
get
StorageDomainService.GetRequest get()
Retrieves the description of the storage domain.
-
isAttached
StorageDomainService.IsAttachedRequest isAttached()
Used for querying if the storage domain is already attached to a data center using the is_attached boolean field, which is part of the storage server. IMPORTANT: Executing this API will cause the host to disconnect from the storage domain.
-
reduceLuns
StorageDomainService.ReduceLunsRequest reduceLuns()
This operation reduces logical units from the storage domain. In order to do so the data stored on the provided logical units will be moved to other logical units of the storage domain and only then they will be reduced from the storage domain. For example, in order to reduce two logical units from a storage domain send a request like this: [source] ---- POST /ovirt-engine/api/storageDomains/123/reduceluns ---- With a request body like this: [source,xml] ----of iSCSI or FCP).
-
refreshLuns
StorageDomainService.RefreshLunsRequest refreshLuns()
This operation refreshes the LUN size. After increasing the size of the underlying LUN on the storage server, the user can refresh the LUN size. This action forces a rescan of the provided LUNs and updates the database with the new size, if required. For example, in order to refresh the size of two LUNs send a request like this: [source] ---- POST /ovirt-engine/api/storageDomains/262b056b-aede-40f1-9666-b883eff59d40/refreshluns ---- With a request body like this: [source,xml] ----
-
remove
StorageDomainService.RemoveRequest remove()
Removes the storage domain. Without any special parameters, the storage domain is detached from the system and removed from the database. The storage domain can then be imported to the same or to a different setup, with all the data on it. If the storage is not accessible the operation will fail. If the `destroy` parameter is `true` then the operation will always succeed, even if the storage is not accessible, the failure is just ignored and the storage domain is removed from the database anyway. If the `format` parameter is `true` then the actual storage is formatted, and the metadata is removed from the LUN or directory, so it can no longer be imported to the same or to a different setup.
-
update
StorageDomainService.UpdateRequest update()
Updates a storage domain. Not all of the <>'s attributes are updatable after creation. Those that can be updated are: `name`, `description`, `comment`, `warning_low_space_indicator`, `critical_space_action_blocker` and `wipe_after_delete.` (Note that changing the `wipe_after_delete` attribute will not change the wipe after delete property of disks that already exist). To update the `name` and `wipe_after_delete` attributes of a storage domain with an identifier `123`, send a request as follows: [source] ---- PUT /ovirt-engine/api/storageDomains/123 ---- With a request body as follows: [source,xml] ---- data2 true
-
updateOvfStore
StorageDomainService.UpdateOvfStoreRequest updateOvfStore()
This operation forces the update of the `OVF_STORE` of this storage domain. The `OVF_STORE` is a disk image that contains the metadata of virtual machines and disks that reside in the storage domain. This metadata is used in case the domain is imported or exported to or from a different data center or a different installation. By default the `OVF_STORE` is updated periodically (set by default to 60 minutes) but users might want to force an update after an important change, or when the they believe the `OVF_STORE` is corrupt. When initiated by the user, `OVF_STORE` update will be performed whether an update is needed or not.
-
diskProfilesService
AssignedDiskProfilesService diskProfilesService()
-
diskSnapshotsService
DiskSnapshotsService diskSnapshotsService()
-
disksService
StorageDomainDisksService disksService()
Reference to the service that manages the disks available in the storage domain.
-
filesService
FilesService filesService()
Returns a reference to the service that manages the files available in the storage domain.
-
imagesService
ImagesService imagesService()
-
permissionsService
AssignedPermissionsService permissionsService()
-
storageConnectionsService
StorageDomainServerConnectionsService storageConnectionsService()
Returns a reference to the service that manages the storage connections.
-
templatesService
StorageDomainTemplatesService templatesService()
-
vmsService
StorageDomainVmsService vmsService()
-
-