class OvirtSDK4::StorageServerConnectionService

Constants

GET
REMOVE
UPDATE
UPDATE_GLUSTERFS
UPDATE_ISCSI
UPDATE_LOCAL
UPDATE_NFS
UPDATE_VFS

Public Instance Methods

get(opts = {}) click to toggle source

Returns the representation of the object managed by this service.

@param opts [Hash] Additional options.

@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part

of the current request. See <<documents/003_common_concepts/follow, here>> for details.

@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 [StorageConnection]

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

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.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove should be performed asynchronously. @option opts [String] :host 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:

[source]
----
DELETE /ovirt-engine/api/storageconnections/123?host=456
----

@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 24831
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 24945
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 = {}) click to toggle source

Updates the storage connection.

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

source,xml

PUT /ovirt-engine/api/storageconnections/123


With a request body like this:

source,xml

<storage_connection>

<address>mynewnfs.example.com</address>

</storage_connection>


To change the connection of an iSCSI storage server, send a request like this:

source,xml

PUT /ovirt-engine/api/storageconnections/123


With a request body like this:

source,xml

<storage_connection>

<port>3260</port>
<target>iqn.2017-01.com.myhost:444</target>

</storage_connection>


@param connection [StorageConnection] The `connection` to update. @param opts [Hash] Additional options.

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

@option opts [Boolean] :force 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`.

@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 [StorageConnection]

# File lib/ovirtsdk4/services.rb, line 24899
def update(connection, opts = {})
  internal_update(connection, StorageConnection, UPDATE, opts)
end
update_glusterfs(connection, opts = {}) click to toggle source

Update the specified Glusterfs storage connection in the system.

@param connection [StorageConnection] The `connection` to update. @param opts [Hash] Additional options.

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

@option opts [Boolean] :force 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`.

@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 [StorageConnection]

# File lib/ovirtsdk4/services.rb, line 24687
def update_glusterfs(connection, opts = {})
  internal_update(connection, StorageConnection, UPDATE_GLUSTERFS, opts)
end
update_iscsi(connection, opts = {}) click to toggle source

Update the specified iSCSI storage connection in the system.

@param connection [StorageConnection] The `connection` to update. @param opts [Hash] Additional options.

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

@option opts [Boolean] :force 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`.

@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 [StorageConnection]

# File lib/ovirtsdk4/services.rb, line 24722
def update_iscsi(connection, opts = {})
  internal_update(connection, StorageConnection, UPDATE_ISCSI, opts)
end
update_local(connection, opts = {}) click to toggle source

Update the specified local storage connection in the system.

@param connection [StorageConnection] The `connection` to update. @param opts [Hash] Additional options.

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

@option opts [Boolean] :force 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`.

@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 [StorageConnection]

# File lib/ovirtsdk4/services.rb, line 24757
def update_local(connection, opts = {})
  internal_update(connection, StorageConnection, UPDATE_LOCAL, opts)
end
update_nfs(connection, opts = {}) click to toggle source

Update the specified NFS storage connection in the system.

@param connection [StorageConnection] The `connection` to update. @param opts [Hash] Additional options.

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

@option opts [Boolean] :force 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`.

@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 [StorageConnection]

# File lib/ovirtsdk4/services.rb, line 24792
def update_nfs(connection, opts = {})
  internal_update(connection, StorageConnection, UPDATE_NFS, opts)
end
update_vfs(connection, opts = {}) click to toggle source

Update the specified VFS storage connection in the system.

@param connection [StorageConnection] The `connection` to update. @param opts [Hash] Additional options.

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

@option opts [Boolean] :force 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`.

@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 [StorageConnection]

# File lib/ovirtsdk4/services.rb, line 24934
def update_vfs(connection, opts = {})
  internal_update(connection, StorageConnection, UPDATE_VFS, opts)
end