class OvirtSDK4::GlusterVolumesService

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

Public Instance Methods

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

Creates a new gluster volume.

The volume is created based on properties of the `volume` parameter. The properties `name`, `volume_type` and `bricks` are required.

For example, to add a volume with name `myvolume` to the cluster `123`, send the following request:

source

POST /ovirt-engine/api/clusters/123/glustervolumes


With the following request body:

source,xml

<gluster_volume>

<name>myvolume</name>
<volume_type>replicate</volume_type>
<replica_count>3</replica_count>
<bricks>
  <brick>
    <server_id>server1</server_id>
    <brick_dir>/exp1</brick_dir>
  </brick>
  <brick>
    <server_id>server2</server_id>
    <brick_dir>/exp1</brick_dir>
  </brick>
  <brick>
    <server_id>server3</server_id>
    <brick_dir>/exp1</brick_dir>
  </brick>
<bricks>

</gluster_volume>


@param volume [GlusterVolume] The gluster volume definition from which to create the volume is passed as input and the newly created

volume is returned.

@param opts [Hash] Additional options.

@return [GlusterVolume]

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

Lists all gluster volumes in the cluster.

For example, to list all Gluster Volumes in cluster `456`, send a request like this:

source

GET /ovirt-engine/api/clusters/456/glustervolumes


@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 [Integer] :max Sets the maximum number of volumes to return. If not specified all the volumes are returned.

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

@return [Array<GlusterVolume>]

# File lib/ovirtsdk4/services.rb, line 10546
def list(opts = {})
  query = {}
  value = opts[:case_sensitive]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['case_sensitive'] = 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 GlusterVolumeReader.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 10595
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return volume_service(path)
  end
  return volume_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 10611
def to_s
  "#<#{GlusterVolumesService}:#{@path}>"
end
volume_service(id) click to toggle source

Reference to a service managing gluster volume.

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

@return [GlusterVolumeService] A reference to the `volume` service.

# File lib/ovirtsdk4/services.rb, line 10584
def volume_service(id)
  GlusterVolumeService.new(@connection, "#{@path}/#{id}")
end