class OvirtSDK4::OpenstackVolumeProvidersService

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 17865
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

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

Adds a new volume provider.

For example:

source

POST /ovirt-engine/api/openstackvolumeproviders


With a request body like this:

source,xml

<openstack_volume_provider>

<name>mycinder</name>
<url>https://mycinder.example.com:8776</url>
<data_center>
  <name>mydc</name>
</data_center>
<requires_authentication>true</requires_authentication>
<username>admin</username>
<password>mypassword</password>
<tenant_name>mytenant</tenant_name>

</openstack_volume_provider>


@param provider [OpenStackVolumeProvider] The `provider` to add.

@param opts [Hash] Additional options.

@return [OpenStackVolumeProvider]

# File lib/ovirtsdk4/services.rb, line 17903
def add(provider, opts = {})
  if provider.is_a?(Hash)
    provider = OvirtSDK4::OpenStackVolumeProvider.new(provider)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    OpenStackVolumeProviderWriter.write_one(provider, 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 OpenStackVolumeProviderReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
list(opts = {}) click to toggle source

Retrieves the list of volume providers.

@param opts [Hash] Additional options.

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

@return [Array<OpenStackVolumeProvider>]

# File lib/ovirtsdk4/services.rb, line 17939
def list(opts = {})
  query = {}
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = 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 OpenStackVolumeProviderReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
provider_service(id) click to toggle source

Locates the `provider` service.

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

@return [OpenstackVolumeProviderService] A reference to the `provider` service.

# File lib/ovirtsdk4/services.rb, line 17968
def provider_service(id)
  OpenstackVolumeProviderService.new(@connection, "#{@path}/#{id}")
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 17979
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return provider_service(path)
  end
  return provider_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

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