Class: OvirtSDK4::OpenstackVolumeProvidersService

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

Adds a new volume provider.

For example:

POST /ovirt-engine/api/openstackvolumeproviders

With a request body like this:

<openstack_volume_provider>
  <name>mycinder</name>
  <url>https://mycinder.example.com:8776</url>
  <data_center>
    <name>mydc</name>
  </data_center>
  <requires_authentication>true</requires_authentication>
  <username>admin</username>
  <password>mypassword</password>
  <tenant_name>mytenant</tenant_name>
</openstack_volume_provider>

Parameters:

  • provider (OpenStackVolumeProvider) —

    The provider to add.

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



18570
18571
18572
 
# File 'lib/ovirtsdk4/services.rb', line 18570

def add(provider, opts = {})
  internal_add(provider, OpenStackVolumeProvider, ADD, opts)
end

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

Retrieves the list of volume providers.

The order of the returned list of volume providers 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 providers to return. If not specified all the providers are returned.

  • :search (String) —

    A query string used to restrict the returned volume providers.

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



18607
18608
18609
 
# File 'lib/ovirtsdk4/services.rb', line 18607

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

#provider_service(id) ⇒ OpenstackVolumeProviderService

Locates the provider service.

Parameters:

  • id (String) —

    The identifier of the provider.

Returns:



18618
18619
18620
 
# File 'lib/ovirtsdk4/services.rb', line 18618

def provider_service(id)
  OpenstackVolumeProviderService.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.



18629
18630
18631
18632
18633
18634
18635
18636
18637
18638
 
# File 'lib/ovirtsdk4/services.rb', line 18629

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