class OvirtSDK4::NetworksService

Public Class Methods

new(connection, path) click to toggle source

Creates a new implementation of the service.

@param connection [Connection] The connection to be used by this service.

@param path [String] The relative path of this service, for example `vms/123/disks`.

@api private

# File lib/ovirtsdk4/services.rb, line 15865
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

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

Creates a new logical network, or associates an existing network with a data center.

Creation of a new network requires the `name` and `data_center` elements.

For example, to create a network named `mynetwork` for data center `123` send a request like this:

source

POST /ovirt-engine/api/networks


With a request body like this:

source,xml

<network>

<name>mynetwork</name>
<data_center id="123"/>

</network>


To associate the existing network `456` with the data center `123` send a request like this:

source

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


With a request body like this:

source,xml

<network>

<name>ovirtmgmt</name>

</network>


@param network [Network] The `network` to add.

@param opts [Hash] Additional options.

@return [Network]

# File lib/ovirtsdk4/services.rb, line 15915
def add(network, opts = {})
  if network.is_a?(Hash)
    network = OvirtSDK4::Network.new(network)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    NetworkWriter.write_one(network, writer)
    request.body = writer.string
  ensure
    writer.close
  end
  response = @connection.send(request)
  case response.code
  when 200, 201, 202
    begin
      reader = XmlReader.new(response.body)
      return NetworkReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
list(opts = {}) click to toggle source

List logical networks.

For example:

source

GET /ovirt-engine/api/networks


Will respond:

source,xml

<networks>

<network href="/ovirt-engine/api/networks/123" id="123">
  <name>ovirtmgmt</name>
  <description>Default Management Network</description>
  <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/>
  <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/>
  <mtu>0</mtu>
  <stp>false</stp>
  <usages>
    <usage>vm</usage>
  </usages>
  <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
</network>
...

</networks>


@param opts [Hash] Additional options.

@option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into

account. The default value is `true`, which means that case is taken into account. If you want to search
ignoring case set it to `false`.

@option opts [Integer] :max Sets the maximum number of networks to return. If not specified all the networks are returned.

@option opts [String] :search A query string used to restrict the returned networks.

@return [Array<Network>]

# File lib/ovirtsdk4/services.rb, line 15986
def list(opts = {})
  query = {}
  value = opts[:case_sensitive]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['case_sensitive'] = value
  end
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = value
  end
  value = opts[:search]
  unless value.nil?
    query['search'] = value
  end
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return NetworkReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
network_service(id) click to toggle source

Reference to the service that manages a specific network.

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

@return [NetworkService] A reference to the `network` service.

# File lib/ovirtsdk4/services.rb, line 16024
def network_service(id)
  NetworkService.new(@connection, "#{@path}/#{id}")
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 16035
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
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 16051
def to_s
  "#<#{NetworksService}:#{@path}>"
end