class OvirtSDK4::GlusterVolumeService
Constants
- GET
- REMOVE
Public Instance Methods
Get the gluster volume details.
For example, to get details of a gluster volume with identifier `123` in cluster `456`, send a request like this:
- source
GET /ovirt-engine/api/clusters/456/glustervolumes/123
This GET request will return the following output:
- source,xml
<gluster_volume id=“123”>
<name>data</name> <link href="/ovirt-engine/api/clusters/456/glustervolumes/123/glusterbricks" rel="glusterbricks"/> <disperse_count>0</disperse_count> <options> <option> <name>storage.owner-gid</name> <value>36</value> </option> <option> <name>performance.io-cache</name> <value>off</value> </option> <option> <name>cluster.data-self-heal-algorithm</name> <value>full</value> </option> </options> <redundancy_count>0</redundancy_count> <replica_count>3</replica_count> <status>up</status> <stripe_count>0</stripe_count> <transport_types> <transport_type>tcp</transport_type> </transport_types> <volume_type>replicate</volume_type> </gluster_volume>
@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 [GlusterVolume]
# File lib/ovirtsdk4/services.rb, line 31407 def get(opts = {}) internal_get(GET, opts) end
Get gluster volume profile statistics.
For example, to get profile statistics for a gluster volume with identifier `123` in cluster `456`, send a request like this:
- source
POST /ovirt-engine/api/clusters/456/glustervolumes/123/getprofilestatistics
@param opts [Hash] Additional options.
@option opts [GlusterVolumeProfileDetails] :details Gluster volume profiling information returned from the action.
@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.
# File lib/ovirtsdk4/services.rb, line 31435 def get_profile_statistics(opts = {}) internal_action(:getprofilestatistics, :details, opts) end
Reference to a service managing gluster bricks.
@return [GlusterBricksService] A reference to `gluster_bricks` service.
# File lib/ovirtsdk4/services.rb, line 31767 def gluster_bricks_service @gluster_bricks_service ||= GlusterBricksService.new(self, 'glusterbricks') end
Rebalance the gluster volume.
Rebalancing a gluster volume helps to distribute the data evenly across all the bricks. After expanding or shrinking a gluster volume (without migrating data), we need to rebalance the data among the bricks. In a non-replicated volume, all bricks should be online to perform the rebalance operation. In a replicated volume, at least one of the bricks in the replica should be online.
For example, to rebalance a gluster volume with identifier `123` in cluster `456`, send a request like this:
- source
POST /ovirt-engine/api/clusters/456/glustervolumes/123/rebalance
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the rebalance should be performed asynchronously.
@option opts [Boolean] :fix_layout If set to true, rebalance will only fix the layout so that new data added to the volume is distributed
across all the hosts. But it will not migrate/rebalance the existing data. Default is `false`.
@option opts [Boolean] :force Indicates if the rebalance should be force started. The rebalance command can be executed with the force
option even when the older clients are connected to the cluster. However, this could lead to a data loss situation. Default is `false`.
@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.
# File lib/ovirtsdk4/services.rb, line 31474 def rebalance(opts = {}) internal_action(:rebalance, nil, opts) end
Removes the gluster volume.
For example, to remove a volume with identifier `123` in cluster `456`, send a request like this:
- source
DELETE /ovirt-engine/api/clusters/456/glustervolumes/123
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the remove should be performed asynchronously. @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.
# File lib/ovirtsdk4/services.rb, line 31506 def remove(opts = {}) internal_remove(REMOVE, opts) end
Resets all the options set in the gluster volume.
For example, to reset all options in a gluster volume with identifier `123` in cluster `456`, send a request like this:
- source
POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetalloptions
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the reset should be performed asynchronously.
@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.
# File lib/ovirtsdk4/services.rb, line 31534 def reset_all_options(opts = {}) internal_action(:resetalloptions, nil, opts) end
Resets a particular option in the gluster volume.
For example, to reset a particular option `option1` in a gluster volume with identifier `123` in cluster `456`, send a request like this:
- source
POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetoption
With the following request body:
- source,xml
<action>
<option name="option1"/>
</action>
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the reset should be performed asynchronously.
@option opts [Boolean] :force
@option opts [Option] :option Option to reset.
@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.
# File lib/ovirtsdk4/services.rb, line 31575 def reset_option(opts = {}) internal_action(:resetoption, nil, opts) end
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 31787 def service(path) if path.nil? || path == '' return self end if path == 'glusterbricks' return gluster_bricks_service end if path.start_with?('glusterbricks/') return gluster_bricks_service.service(path[14..-1]) end if path == 'statistics' return statistics_service end if path.start_with?('statistics/') return statistics_service.service(path[11..-1]) end raise Error.new("The path \"#{path}\" doesn't correspond to any service") end
Sets a particular option in the gluster volume.
For example, to set `option1` with value `value1` in a gluster volume with identifier `123` in cluster `456`, send a request like this:
- source
POST /ovirt-engine/api/clusters/456/glustervolumes/123/setoption
With the following request body:
- source,xml
<action>
<option name="option1" value="value1"/>
</action>
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the action should be performed asynchronously.
@option opts [Option] :option Option to set.
@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.
# File lib/ovirtsdk4/services.rb, line 31614 def set_option(opts = {}) internal_action(:setoption, nil, opts) end
Starts the gluster volume.
A Gluster Volume should be started to read/write data. For example, to start a gluster volume with identifier `123` in cluster `456`, send a request like this:
- source
POST /ovirt-engine/api/clusters/456/glustervolumes/123/start
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the action should be performed asynchronously.
@option opts [Boolean] :force Indicates if the volume should be force started. If a gluster volume is started already but few/all bricks
are down then force start can be used to bring all the bricks up. Default is `false`.
@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.
# File lib/ovirtsdk4/services.rb, line 31645 def start(opts = {}) internal_action(:start, nil, opts) end
Start profiling the gluster volume.
For example, to start profiling a gluster volume with identifier `123` in cluster `456`, send a request like this:
- source
POST /ovirt-engine/api/clusters/456/glustervolumes/123/startprofile
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the action should be performed asynchronously.
@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.
# File lib/ovirtsdk4/services.rb, line 31672 def start_profile(opts = {}) internal_action(:startprofile, nil, opts) end
Locates the `statistics` service.
@return [StatisticsService] A reference to `statistics` service.
# File lib/ovirtsdk4/services.rb, line 31776 def statistics_service @statistics_service ||= StatisticsService.new(self, 'statistics') end
Stops the gluster volume.
Stopping a volume will make its data inaccessible.
For example, to stop a gluster volume with identifier `123` in cluster `456`, send a request like this:
- source
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stop
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the action should be performed asynchronously.
@option opts [Boolean] :force
@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.
# File lib/ovirtsdk4/services.rb, line 31703 def stop(opts = {}) internal_action(:stop, nil, opts) end
Stop profiling the gluster volume.
For example, to stop profiling a gluster volume with identifier `123` in cluster `456`, send a request like this:
- source
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stopprofile
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the action should be performed asynchronously.
@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.
# File lib/ovirtsdk4/services.rb, line 31730 def stop_profile(opts = {}) internal_action(:stopprofile, nil, opts) end
Stop rebalancing the gluster volume.
For example, to stop rebalancing a gluster volume with identifier `123` in cluster `456`, send a request like this:
- source
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stoprebalance
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the action should be performed asynchronously.
@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.
# File lib/ovirtsdk4/services.rb, line 31758 def stop_rebalance(opts = {}) internal_action(:stoprebalance, nil, opts) end
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 31811 def to_s "#<#{GlusterVolumeService}:#{absolute_path}>" end