class OvirtSDK4::AttachedStorageDomainService

Constants

ACTIVATE
DEACTIVATE
GET
REMOVE

Public Instance Methods

activate(opts = {}) click to toggle source

This operation activates an attached storage domain. Once the storage domain is activated it is ready for use with the data center.

source

POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate


The activate action does not take any action specific parameters, so the request body should contain an empty `action`:

source,xml

<action/>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the activation should be performed asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 3781
def activate(opts = {})
  internal_action(:activate, nil, ACTIVATE, opts)
end
deactivate(opts = {}) click to toggle source

This operation deactivates an attached storage domain. Once the storage domain is deactivated it will not be used with the data center. For example, to deactivate storage domain `456`, send the following request:

source

POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate


With a request body like this:

source,xml

<action/>


If the `force` parameter is `true` then the operation will succeed, even if the OVF update which takes place before the deactivation of the storage domain failed. If the `force` parameter is `false` and the OVF update failed, the deactivation of the storage domain will also fail.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the deactivation should be performed asynchronously.

@option opts [Boolean] :force Indicates if the operation should succeed and the storage domain should be moved to a deactivated state, even if

the OVF update for the storage domain failed.
For example, to deactivate storage domain `456` using force flag, send the following request:

[source]
----
POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate
----

With a request body like this:

[source,xml]
----
<action>
  <force>true</force>
<action>
----

This parameter is optional, and the default value is `false`.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 3846
def deactivate(opts = {})
  internal_action(:deactivate, nil, DEACTIVATE, opts)
end
disks_service() click to toggle source

Locates the `disks` service.

@return [AttachedStorageDomainDisksService] A reference to `disks` service.

# File lib/ovirtsdk4/services.rb, line 3909
def disks_service
  @disks_service ||= AttachedStorageDomainDisksService.new(self, 'disks')
end
get(opts = {}) click to toggle source

Returns the representation of the object managed by this service.

@param opts [Hash] Additional options.

@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part

of the current request. See <<documents/003_common_concepts/follow, here>> for details.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [StorageDomain]

# File lib/ovirtsdk4/services.rb, line 3875
def get(opts = {})
  internal_get(GET, opts)
end
remove(opts = {}) click to toggle source

Deletes the object managed by this service.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove should be performed asynchronously. @option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 3900
def remove(opts = {})
  internal_remove(REMOVE, opts)
end
service(path) click to toggle source

Locates the service corresponding to the given path.

@param path [String] The path of the service.

@return [Service] A reference to the service.

# File lib/ovirtsdk4/services.rb, line 3920
def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'disks'
    return disks_service
  end
  if path.start_with?('disks/')
    return disks_service.service(path[6..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end