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 [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part
of the current request. See <<documents/003_common_concepts/follow, here>> for details.
@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 930 def get(opts = {}) internal_get(GET, opts) end
Returns a reference to the service that manages the list of all host labels attached to this affinity group.
@return [AffinityGroupHostLabelsService] A reference to `host_labels` service.
# File lib/ovirtsdk4/services.rb, line 1000 def host_labels_service @host_labels_service ||= AffinityGroupHostLabelsService.new(self, 'hostlabels') end
Returns a reference to the service that manages the list of all hosts attached to this affinity group.
@return [AffinityGroupHostsService] A reference to `hosts` service.
# File lib/ovirtsdk4/services.rb, line 1011 def hosts_service @hosts_service ||= AffinityGroupHostsService.new(self, 'hosts') 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 960 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 1044 def service(path) if path.nil? || path == '' return self end if path == 'hostlabels' return host_labels_service end if path.start_with?('hostlabels/') return host_labels_service.service(path[11..-1]) end if path == 'hosts' return hosts_service end if path.start_with?('hosts/') return hosts_service.service(path[6..-1]) end if path == 'vmlabels' return vm_labels_service end if path.start_with?('vmlabels/') return vm_labels_service.service(path[9..-1]) 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
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 989 def update(group, opts = {}) internal_update(group, AffinityGroup, UPDATE, opts) end
Returns a reference to the service that manages the list of all virtual machine labels attached to this affinity group.
@return [AffinityGroupVmLabelsService] A reference to `vm_labels` service.
# File lib/ovirtsdk4/services.rb, line 1022 def vm_labels_service @vm_labels_service ||= AffinityGroupVmLabelsService.new(self, 'vmlabels') 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 1033 def vms_service @vms_service ||= AffinityGroupVmsService.new(self, 'vms') end