Class: OvirtSDK4::StorageServerConnectionService

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

#get(opts = {}) ⇒ StorageConnection

Returns the representation of the object managed by this service.

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.

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



23143
23144
23145
 
# File 'lib/ovirtsdk4/services.rb', line 23143

def get(opts = {})
  internal_get(GET, opts)
end

#remove(opts = {}) ⇒ Object

Removes a storage connection.

A storage connection can only be deleted if neither storage domain nor LUN disks reference it. The host name or id is optional; providing it disconnects (unmounts) the connection from that host.

Parameters:

  • opts (Hash) (defaults to: {}) —

    Additional options.

Options Hash (opts):

  • :async (Boolean) —

    Indicates if the remove should be performed asynchronously.

  • :host (String) —

    The name or identifier of the host from which the connection would be unmounted (disconnected). If not provided, no host will be disconnected.

    For example, to use the host with identifier 456 to delete the storage connection with identifier 123 send a request like this:

    DELETE /ovirt-engine/api/storageconnections/123?host=456
  • :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.



23287
23288
23289
 
# File 'lib/ovirtsdk4/services.rb', line 23287

def remove(opts = {})
  internal_remove(REMOVE, opts)
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.

Raises:



23387
23388
23389
23390
23391
23392
 
# File 'lib/ovirtsdk4/services.rb', line 23387

def service(path)
  if path.nil? || path == ''
    return self
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end

#update(connection, opts = {}) ⇒ StorageConnection

Updates the storage connection.

For example, to change the address of the storage server send a request like this:

PUT /ovirt-engine/api/storageconnections/123

With a request body like this:

<storage_connection>
  <address>mynewnfs.example.com</address>
  <host>
    <name>myhost</name>
  </host>
</storage_connection>

Parameters:

  • connection (StorageConnection) —

    The connection to update.

  • opts (Hash) (defaults to: {}) —

    Additional options.

Options Hash (opts):

  • :async (Boolean) —

    Indicates if the update should be performed asynchronously.

  • :force (Boolean) —

    Indicates if the operation should succeed regardless to the relevant storage domain’s status (i.e. updating is also applicable when storage domain’s status is not maintenance).

    This parameter is optional, and the default value is false.

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



23341
23342
23343
 
# File 'lib/ovirtsdk4/services.rb', line 23341

def update(connection, opts = {})
  internal_update(connection, StorageConnection, UPDATE, opts)
end

#update_iscsi(connection, opts = {}) ⇒ StorageConnection

Update the specified iSCSI storage connection in the system.

Parameters:

  • connection (StorageConnection) —

    The connection to update.

  • opts (Hash) (defaults to: {}) —

    Additional options.

Options Hash (opts):

  • :async (Boolean) —

    Indicates if the update should be performed asynchronously.

  • :force (Boolean) —

    Indicates if the operation should succeed regardless to the relevant storage domain’s status (i.e. updating is also applicable when storage domain’s status is not maintenance).

    This parameter is optional, and the default value is false.

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



23178
23179
23180
 
# File 'lib/ovirtsdk4/services.rb', line 23178

def update_iscsi(connection, opts = {})
  internal_update(connection, StorageConnection, UPDATE_ISCSI, opts)
end

#update_local(connection, opts = {}) ⇒ StorageConnection

Update the specified local storage connection in the system.

Parameters:

  • connection (StorageConnection) —

    The connection to update.

  • opts (Hash) (defaults to: {}) —

    Additional options.

Options Hash (opts):

  • :async (Boolean) —

    Indicates if the update should be performed asynchronously.

  • :force (Boolean) —

    Indicates if the operation should succeed regardless to the relevant storage domain’s status (i.e. updating is also applicable when storage domain’s status is not maintenance).

    This parameter is optional, and the default value is false.

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



23213
23214
23215
 
# File 'lib/ovirtsdk4/services.rb', line 23213

def update_local(connection, opts = {})
  internal_update(connection, StorageConnection, UPDATE_LOCAL, opts)
end

#update_nfs(connection, opts = {}) ⇒ StorageConnection

Update the specified nfs storage connection in the system.

Parameters:

  • connection (StorageConnection) —

    The connection to update.

  • opts (Hash) (defaults to: {}) —

    Additional options.

Options Hash (opts):

  • :async (Boolean) —

    Indicates if the update should be performed asynchronously.

  • :force (Boolean) —

    Indicates if the operation should succeed regardless to the relevant storage domain’s status (i.e. updating is also applicable when storage domain’s status is not maintenance).

    This parameter is optional, and the default value is false.

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



23248
23249
23250
 
# File 'lib/ovirtsdk4/services.rb', line 23248

def update_nfs(connection, opts = {})
  internal_update(connection, StorageConnection, UPDATE_NFS, opts)
end

#update_vfs(connection, opts = {}) ⇒ StorageConnection

Update the specified vfs storage connection in the system.

Parameters:

  • connection (StorageConnection) —

    The connection to update.

  • opts (Hash) (defaults to: {}) —

    Additional options.

Options Hash (opts):

  • :async (Boolean) —

    Indicates if the update should be performed asynchronously.

  • :force (Boolean) —

    Indicates if the operation should succeed regardless to the relevant storage domain’s status (i.e. updating is also applicable when storage domain’s status is not maintenance).

    This parameter is optional, and the default value is false.

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



23376
23377
23378
 
# File 'lib/ovirtsdk4/services.rb', line 23376

def update_vfs(connection, opts = {})
  internal_update(connection, StorageConnection, UPDATE_VFS, opts)
end