class OvirtSDK4::StorageDomainsService

Constants

ADD
ADD_BLOCK_DOMAIN
ADD_BY_PATH
ADD_DIRECT_LUN
ADD_GLUSTER_OR_POSTFS
ADD_LOCAL
LIST

Public Instance Methods

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

Adds a new storage domain.

Creation of a new xref:types-storage_domain requires the `name`, `type`, `host`, and `storage` attributes. Identify the `host` attribute with the `id` or `name` attributes. In {product-name} 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 using a host with an id `123`, send a request like this:

source

POST /ovirt-engine/api/storageDomains


With a request body like this:

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

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

@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 24436
def add_block_domain(storage_domain, opts = {})
  internal_add(storage_domain, StorageDomain, ADD_BLOCK_DOMAIN, opts)
end
add_by_path(storage_domain, opts = {}) click to toggle source

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

@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 24463
def add_by_path(storage_domain, opts = {})
  internal_add(storage_domain, StorageDomain, ADD_BY_PATH, opts)
end
add_direct_lun(storage_domain, opts = {}) click to toggle source

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

@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 24490
def add_direct_lun(storage_domain, opts = {})
  internal_add(storage_domain, StorageDomain, ADD_DIRECT_LUN, opts)
end
add_gluster_or_postfs(storage_domain, opts = {}) click to toggle source

Add a new storage domain to the system using Gluster or POSIX FS storage.

@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 24517
def add_gluster_or_postfs(storage_domain, opts = {})
  internal_add(storage_domain, StorageDomain, ADD_GLUSTER_OR_POSTFS, opts)
end
add_local(storage_domain, opts = {}) click to toggle source

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

@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 24590
def add_local(storage_domain, opts = {})
  internal_add(storage_domain, StorageDomain, ADD_LOCAL, opts)
end
list(opts = {}) click to toggle source

Returns the list of storage domains in 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 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 [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 [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 24563
def list(opts = {})
  internal_get(LIST, 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 24612
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 24601
def storage_domain_service(id)
  StorageDomainService.new(self, id)
end