class OvirtSDK4::StorageServerConnectionExtensionsService

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

Public Instance Methods

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

Creates a new storage server connection extension for the given host.

The extension lets the user define credentials for an iSCSI target for a specific host. For example to use `myuser` and `mypassword` as the credentials when connecting to the iSCSI target from host `123` send a request like this:

source

POST /ovirt-engine/api/hosts/123/storageconnectionextensions


With a request body like this:

source,xml

<storage_connection_extension>

<target>iqn.2016-01.com.example:mytarget</target>
<username>myuser</username>
<password>mypassword</password>

</storage_connection_extension>


@param extension [StorageConnectionExtension] The `extension` to add.

@param opts [Hash] Additional options.

@return [StorageConnectionExtension]

# File lib/ovirtsdk4/services.rb, line 24516
def add(extension, opts = {})
  if extension.is_a?(Hash)
    extension = OvirtSDK4::StorageConnectionExtension.new(extension)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    StorageConnectionExtensionWriter.write_one(extension, 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 StorageConnectionExtensionReader.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 [Integer] :max Sets the maximum number of extensions to return. If not specified all the extensions are returned.

@return [Array<StorageConnectionExtension>]

# File lib/ovirtsdk4/services.rb, line 24552
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 StorageConnectionExtensionReader.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 24592
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return storage_connection_extension_service(path)
  end
  return storage_connection_extension_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end
storage_connection_extension_service(id) click to toggle source

Locates the `storage_connection_extension` service.

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

@return [StorageServerConnectionExtensionService] A reference to the `storage_connection_extension` service.

# File lib/ovirtsdk4/services.rb, line 24581
def storage_connection_extension_service(id)
  StorageServerConnectionExtensionService.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 24608
def to_s
  "#<#{StorageServerConnectionExtensionsService}:#{@path}>"
end