class OvirtSDK4::StorageDomainsService

Constants

ADD
LIST

Public Instance Methods

add(storage_domain, opts = {}) click to toggle source

Adds a new storage domain.

Creation of a new <<types/storage_domain,StorageDomain>> requires the `name`, `type`, `host` and `storage` attributes. Identify the `host` attribute with the `id` or `name` attributes. In oVirt 3.6 and later you can enable the wipe after delete option by default on the storage domain. To configure this, specify `wipe_after_delete` in the POST request. This option can be edited after the domain is created, but doing so will not change the wipe after delete property of disks that already exist.

To add a new storage domain with specified `name`, `type`, `storage.type`, `storage.address` and `storage.path` and by using a host with an id `123`, send a request as follows:

source

POST /ovirt-engine/api/storageDomains


With a request body as follows:

source,xml

<storage_domain>

<name>mydata</name>
<type>data</type>
<storage>
  <type>nfs</type>
  <address>mynfs.example.com</address>
  <path>/exports/mydata</path>
</storage>
<host>
  <name>myhost</name>
</host>

</storage_domain>


To create a new NFS ISO storage domain send a request like this:

source,xml

<storage_domain>

<name>myisos</name>
<type>iso</type>
<storage>
  <type>nfs</type>
  <address>mynfs.example.com</address>
  <path>/export/myisos</path>
</storage>
<host>
  <name>myhost</name>
</host>

</storage_domain>


To create a new iSCSI storage domain send a request like this:

source,xml

<storage_domain>

<name>myiscsi</name>
<type>data</type>
<storage>
  <type>iscsi</type>
  <logical_units>
    <logical_unit id="3600144f09dbd050000004eedbd340001"/>
    <logical_unit id="3600144f09dbd050000004eedbd340002"/>
  </logical_units>
</storage>
<host>
  <name>myhost</name>
</host>

</storage_domain>


@param storage_domain [StorageDomain] The `storage_domain` to add.

@param opts [Hash] Additional options.

@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 23068
def add(storage_domain, opts = {})
  internal_add(storage_domain, StorageDomain, ADD, opts)
end
block_domain(opts = {}) click to toggle source

Import an existing block storage domain to the system using the targets already connected to the host.

@param opts [Hash] Additional options.

@option opts [StorageDomain] :storage_domain

@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 23088
def block_domain(opts = {})
  internal_action(:blockdomain, :storage_domain, opts)
end
by_path(opts = {}) click to toggle source

Add a new storage domain to the system using the storage on the given host and path.

@param opts [Hash] Additional options.

@option opts [StorageDomain] :storage_domain

@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 23108
def by_path(opts = {})
  internal_action(:bypath, :storage_domain, opts)
end
direct_lun(opts = {}) click to toggle source

Add a new storage domain to the system using a direct lun.

@param opts [Hash] Additional options.

@option opts [StorageDomain] :storage_domain

@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 23128
def direct_lun(opts = {})
  internal_action(:directlun, :storage_domain, opts)
end
gluster_or_postfs(opts = {}) click to toggle source

Add a new storage domain to the system using the gluster or posixfs storage.

@param opts [Hash] Additional options.

@option opts [StorageDomain] :storage_domain

@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 23148
def gluster_or_postfs(opts = {})
  internal_action(:glusterorpostfs, :storage_domain, opts)
end
list(opts = {}) click to toggle source

Returns the list of storage domains of the system.

The order of the returned list of storage domains is guaranteed only if the `sortby` clause is included in the `search` parameter.

@param opts [Hash] Additional options.

@option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into

account. The default value is `true`, which means that case is taken into account. If you want to search
ignoring case set it to `false`.

@option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.

@option opts [Integer] :max Sets the maximum number of storage domains to return. If not specified all the storage domains are returned.

@option opts [String] :search A query string used to restrict the returned storage domains.

@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 [Array<StorageDomain>]

# File lib/ovirtsdk4/services.rb, line 23190
def list(opts = {})
  internal_get(LIST, opts)
end
local(opts = {}) click to toggle source

Add a new storage domain to the system using the storage on the localhost at the given path.

@param opts [Hash] Additional options.

@option opts [StorageDomain] :storage_domain

@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 23210
def local(opts = {})
  internal_action(:local, :storage_domain, 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 23232
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return storage_domain_service(path)
  end
  return storage_domain_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end
storage_domain_service(id) click to toggle source

Locates the `storage_domain` service.

@param id [String] The identifier of the `storage_domain`.

@return [StorageDomainService] A reference to the `storage_domain` service.

# File lib/ovirtsdk4/services.rb, line 23221
def storage_domain_service(id)
  StorageDomainService.new(self, id)
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 23248
def to_s
  "#<#{StorageDomainsService}:#{absolute_path}>"
end