Class: OvirtSDK4::ClusterNetworksService

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(network, opts = {}) ⇒ Network

Assigns the network to a cluster.

Post a request like in the example below to assign the network to a cluster:

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

Use the following example in its body:

<network id="123" />

Parameters:

  • network (Network)

    The network object to be assigned to the cluster.

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


5767
5768
5769
# File 'lib/ovirtsdk4/services.rb', line 5767

def add(network, opts = {})
  internal_add(network, Network, ADD, opts)
end

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

Lists the networks that are assigned to the cluster.

The order of the returned clusters 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 networks to return. If not specified, all the networks 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:


5801
5802
5803
# File 'lib/ovirtsdk4/services.rb', line 5801

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

#network_service(id) ⇒ ClusterNetworkService

Access the cluster network service that manages the cluster network specified by an ID.

Parameters:

  • id (String)

    The identifier of the network.

Returns:


5812
5813
5814
# File 'lib/ovirtsdk4/services.rb', line 5812

def network_service(id)
  ClusterNetworkService.new(self, id)
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.


5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
# File 'lib/ovirtsdk4/services.rb', line 5823

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