class OvirtSDK4::OpenstackNetworkProviderService

Constants

GET
REMOVE
UPDATE

Public Instance Methods

certificates_service() click to toggle source

A service to view certificates for this external provider.

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

# File lib/ovirtsdk4/services.rb, line 15063
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.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [OpenStackNetworkProvider]

# File lib/ovirtsdk4/services.rb, line 14926
def get(opts = {})
  internal_get(GET, opts)
end
import_certificates(opts = {}) click to toggle source

Executes the `import_certificates` method.

@param opts [Hash] Additional options.

@option opts [Array<Certificate>] :certificates

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 14946
def import_certificates(opts = {})
  internal_action(:importcertificates, nil, opts)
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 15072
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. @option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 14978
def remove(opts = {})
  internal_remove(REMOVE, opts)
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 15083
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

In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.

source

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity


@param opts [Hash] Additional options.

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

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 15004
def test_connectivity(opts = {})
  internal_action(:testconnectivity, nil, opts)
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 15107
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.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [OpenStackNetworkProvider]

# File lib/ovirtsdk4/services.rb, line 15054
def update(provider, opts = {})
  internal_update(provider, OpenStackNetworkProvider, UPDATE, opts)
end