class OvirtSDK4::StorageDomainsService

Public Class Methods

new(connection, path) click to toggle source

Creates a new implementation of the service.

@param connection [Connection] The connection to be used by this service.

@param path [String] The relative path of this service, for example `vms/123/disks`.

@api private

# File lib/ovirtsdk4/services.rb, line 23947
def initialize(connection, path)
  @connection = connection
  @path = path
end

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.

@return [StorageDomain]

# File lib/ovirtsdk4/services.rb, line 24031
def add(storage_domain, opts = {})
  if storage_domain.is_a?(Hash)
    storage_domain = OvirtSDK4::StorageDomain.new(storage_domain)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    StorageDomainWriter.write_one(storage_domain, writer)
    request.body = writer.string
  ensure
    writer.close
  end
  response = @connection.send(request)
  case response.code
  when 200, 201, 202
    begin
      reader = XmlReader.new(response.body)
      return StorageDomainReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
list(opts = {}) click to toggle source

Returns the representation of the object managed by this service.

@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.

@return [Array<StorageDomain>]

# File lib/ovirtsdk4/services.rb, line 24075
def list(opts = {})
  query = {}
  value = opts[:case_sensitive]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['case_sensitive'] = value
  end
  value = opts[:filter]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['filter'] = value
  end
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = value
  end
  value = opts[:search]
  unless value.nil?
    query['search'] = value
  end
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return StorageDomainReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
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 24129
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 24118
def storage_domain_service(id)
  StorageDomainService.new(@connection, "#{@path}/#{id}")
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

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