Class: OvirtSDK4::AffinityGroupVmLabelsService

Inherits:
Service
  • Object
show all
Defined in:
lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary collapse

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#add(label, opts = {}) ⇒ AffinityLabel

Adds a virtual machine label to the affinity group.

For example, to add the label 789 to the affinity group 456 of cluster 123, send a request like this:

POST /ovirt-engine/api/clusters/123/affinitygroups/456/vmlabels

With the following body:

<affinity_label id="789"/>

Parameters:

  • label (AffinityLabel)

    The AffinityLabel object to add to the affinity group.

  • opts (Hash) (defaults to: {})

    Additional options.

Options Hash (opts):

  • :headers (Hash) — default: {}

    Additional HTTP headers.

  • :query (Hash) — default: {}

    Additional URL query parameters.

  • :timeout (Integer) — default: 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.

  • :wait (Boolean) — default: true

    If true wait for the response.

Returns:


1470
1471
1472
# File 'lib/ovirtsdk4/services.rb', line 1470

def add(label, opts = {})
  internal_add(label, AffinityLabel, ADD, opts)
end

#label_service(id) ⇒ AffinityGroupVmLabelService

Access the service that manages the virtual machine label assignment to this affinity group.

Parameters:

  • id (String)

    The identifier of the label.

Returns:


1516
1517
1518
# File 'lib/ovirtsdk4/services.rb', line 1516

def label_service(id)
  AffinityGroupVmLabelService.new(self, id)
end

#list(opts = {}) ⇒ Array<AffinityLabel>

List all virtual machine labels assigned to this affinity group.

The order of the returned labels isn’t guaranteed.

Parameters:

  • opts (Hash) (defaults to: {})

    Additional options.

Options Hash (opts):

  • :follow (String)

    Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.

  • :max (Integer)

    Sets the maximum number of virtual machine labels to return. If not specified, all the labels are returned.

  • :headers (Hash) — default: {}

    Additional HTTP headers.

  • :query (Hash) — default: {}

    Additional URL query parameters.

  • :timeout (Integer) — default: 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.

  • :wait (Boolean) — default: true

    If true wait for the response.

Returns:


1505
1506
1507
# File 'lib/ovirtsdk4/services.rb', line 1505

def list(opts = {})
  internal_get(LIST, opts)
end

#service(path) ⇒ Service

Locates the service corresponding to the given path.

Parameters:

  • path (String)

    The path of the service.

Returns:

  • (Service)

    A reference to the service.


1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'lib/ovirtsdk4/services.rb', line 1527

def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return label_service(path)
  end
  return label_service(path[0..(index - 1)]).service(path[(index + 1)..-1])
end