class OvirtSDK4::AffinityGroupService
Constants
- GET
- REMOVE
- UPDATE
Public Instance Methods
Retrieve the affinity group details.
- source,xml
<affinity_group id=“00000000-0000-0000-0000-000000000000”>
<name>AF_GROUP_001</name> <cluster id="00000000-0000-0000-0000-000000000000"/> <positive>true</positive> <enforcing>true</enforcing>
</affinity_group>
@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 [AffinityGroup]
# File lib/ovirtsdk4/services.rb, line 797 def get(opts = {}) internal_get(GET, opts) end
Remove the affinity group.
- source
DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the removal 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 827 def remove(opts = {}) internal_remove(REMOVE, 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 878 def service(path) if path.nil? || path == '' return self end if path == 'vms' return vms_service end if path.start_with?('vms/') return vms_service.service(path[4..-1]) end raise Error.new("The path \"#{path}\" doesn't correspond to any service") end
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 896 def to_s "#<#{AffinityGroupService}:#{@path}>" end
Update the affinity group.
@param group [AffinityGroup] The affinity group. @param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the update 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.
@return [AffinityGroup]
# File lib/ovirtsdk4/services.rb, line 856 def update(group, opts = {}) internal_update(group, AffinityGroup, UPDATE, opts) end
Returns a reference to the service that manages the list of all virtual machines attached to this affinity group.
@return [AffinityGroupVmsService] A reference to `vms` service.
# File lib/ovirtsdk4/services.rb, line 867 def vms_service AffinityGroupVmsService.new(@connection, "#{@path}/vms") end