Class: OvirtSDK4::NetworkLabelsService

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 = {}) ⇒ NetworkLabel

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:

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

With a request body like this:

<network_label id="mylabel"/>

Parameters:

  • label (NetworkLabel)

    The label to add.

  • 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:


16246
16247
16248
# File 'lib/ovirtsdk4/services.rb', line 16246

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

#label_service(id) ⇒ NetworkLabelService

Locates the label service.

Parameters:

  • id (String)

    The identifier of the label.

Returns:


16291
16292
16293
# File 'lib/ovirtsdk4/services.rb', line 16291

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

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

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

The order of the returned list of 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 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:


16280
16281
16282
# File 'lib/ovirtsdk4/services.rb', line 16280

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.


16302
16303
16304
16305
16306
16307
16308
16309
16310
16311
# File 'lib/ovirtsdk4/services.rb', line 16302

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