class OvirtSDK4::NetworkLabelsService

Constants

ADD
LIST

Public Instance Methods

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

Attaches label to logical network.

You can attach labels to a logical network to automate the association of that logical network with physical host network interfaces to which the same label has been attached.

For example, to attach the label `mylabel` to a logical network having id `123` send a request like this:

source

POST /ovirt-engine/api/networks/123/networklabels


With a request body like this:

source,xml

<network_label id=“mylabel”/>


@param label [NetworkLabel] The `label` to add.

@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 [NetworkLabel]

# File lib/ovirtsdk4/services.rb, line 16516
def add(label, opts = {})
  internal_add(label, NetworkLabel, ADD, opts)
end
label_service(id) click to toggle source

Locates the `label` service.

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

@return [NetworkLabelService] A reference to the `label` service.

# File lib/ovirtsdk4/services.rb, line 16561
def label_service(id)
  NetworkLabelService.new(self, id)
end
list(opts = {}) click to toggle source

Returns the list of labels attached to the network or host NIC.

The order of the returned list of labels isn't guaranteed.

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

@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 [Array<NetworkLabel>]

# File lib/ovirtsdk4/services.rb, line 16550
def list(opts = {})
  internal_get(LIST, opts)
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 16572
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