Class: OvirtSDK4::DataCenterNetworksService

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

Create a new network in a data center.

Post a request like in the example below to create a new network in a data center with an ID of 123.

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

Use the following example in its body:

<network>
  <name>mynetwork</name>
</network>

Parameters:

  • network (Network)

    The network object to be created in the data center.

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


6683
6684
6685
# File 'lib/ovirtsdk4/services.rb', line 6683

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

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

Lists networks in the data center.

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


6717
6718
6719
# File 'lib/ovirtsdk4/services.rb', line 6717

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

#network_service(id) ⇒ DataCenterNetworkService

Access the data center network service that manages the data center network specified by an ID.

Parameters:

  • id (String)

    The identifier of the network.

Returns:


6728
6729
6730
# File 'lib/ovirtsdk4/services.rb', line 6728

def network_service(id)
  DataCenterNetworkService.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.


6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
# File 'lib/ovirtsdk4/services.rb', line 6739

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