class OvirtSDK4::OpenstackNetworkProviderService

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 16728
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

certificates_service() click to toggle source

Locates the `certificates` service.

@return [ExternalProviderCertificatesService] A reference to `certificates` service.

# File lib/ovirtsdk4/services.rb, line 16914
def certificates_service
  ExternalProviderCertificatesService.new(@connection, "#{@path}/certificates")
end
get(opts = {}) click to toggle source

Returns the representation of the object managed by this service.

For example, to get the OpenStack network provider with identifier `1234`, send a request like this:

source

GET /ovirt-engine/api/openstacknetworkproviders/1234


@param opts [Hash] Additional options.

@return [OpenStackNetworkProvider]

# File lib/ovirtsdk4/services.rb, line 16747
def get(opts = {})
  query = {}
  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 OpenStackNetworkProviderReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
import_certificates(opts = {}) click to toggle source

Executes the `import_certificates` method.

@param opts [Hash] Additional options.

@option opts [Array<Certificate>] :certificates

# File lib/ovirtsdk4/services.rb, line 16771
def import_certificates(opts = {})
  action = Action.new(opts)
  writer = XmlWriter.new(nil, true)
  ActionWriter.write_one(action, writer)
  body = writer.string
  writer.close
  request = HttpRequest.new(
    method: :POST,
    url: "#{@path}/importcertificates",
    body: body
  )
  response = @connection.send(request)
  case response.code
  when 200
    action = check_action(response)
  else
    check_action(response)
  end
end
networks_service() click to toggle source

Reference to OpenStack networks service.

@return [OpenstackNetworksService] A reference to `networks` service.

# File lib/ovirtsdk4/services.rb, line 16923
def networks_service
  OpenstackNetworksService.new(@connection, "#{@path}/networks")
end
remove(opts = {}) click to toggle source

Removes the provider.

For example, to remove the OpenStack network provider with identifier `1234`, send a request like this:

source

DELETE /ovirt-engine/api/openstacknetworkproviders/1234


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove should be performed asynchronously.

# File lib/ovirtsdk4/services.rb, line 16804
def remove(opts = {})
  query = {}
  value = opts[:async]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['async'] = value
  end
  request = HttpRequest.new(method: :DELETE, url: @path, query: query)
  response = @connection.send(request)
  unless response.code == 200
    check_fault(response)
  end
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 16934
def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'certificates'
    return certificates_service
  end
  if path.start_with?('certificates/')
    return certificates_service.service(path[13..-1])
  end
  if path == 'networks'
    return networks_service
  end
  if path.start_with?('networks/')
    return networks_service.service(path[9..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end
test_connectivity(opts = {}) click to toggle source

Executes the `test_connectivity` method.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the test should be performed asynchronously.

# File lib/ovirtsdk4/services.rb, line 16825
def test_connectivity(opts = {})
  action = Action.new(opts)
  writer = XmlWriter.new(nil, true)
  ActionWriter.write_one(action, writer)
  body = writer.string
  writer.close
  request = HttpRequest.new(
    method: :POST,
    url: "#{@path}/testconnectivity",
    body: body
  )
  response = @connection.send(request)
  case response.code
  when 200
    action = check_action(response)
  else
    check_action(response)
  end
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 16958
def to_s
  "#<#{OpenstackNetworkProviderService}:#{@path}>"
end
update(provider, opts = {}) click to toggle source

Updates the provider.

For example, to update `provider_name`, `requires_authentication`, `url`, `tenant_name` and `type` properties, for the OpenStack network provider with identifier `1234`, send a request like this:

source

PUT /ovirt-engine/api/openstacknetworkproviders/1234


With a request body like this:

source,xml

<openstack_network_provider>

<name>ovn-network-provider</name>
<requires_authentication>false</requires_authentication>
<url>http://some_server_url.domain.com:9696</url>
<tenant_name>oVirt</tenant_name>
<type>external</type>

</openstack_network_provider>


@param provider [OpenStackNetworkProvider] The provider to update. @param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the update should be performed asynchronously.

@return [OpenStackNetworkProvider]

# File lib/ovirtsdk4/services.rb, line 16876
def update(provider, opts = {})
  if provider.is_a?(Hash)
    provider = OvirtSDK4::OpenStackNetworkProvider.new(provider)
  end
  query = {}
  value = opts[:async]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['async'] = value
  end
  request = HttpRequest.new(method: :PUT, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    OpenStackNetworkProviderWriter.write_one(provider, writer)
    request.body = writer.string
  ensure
    writer.close
  end
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return OpenStackNetworkProviderReader.read_one(reader)
    ensure
      reader.close
    end
    return result
  else
    check_fault(response)
  end
end