class OvirtSDK4::SshPublicKeysService

Constants

ADD
LIST

Public Instance Methods

add(key, opts = {}) click to toggle source

Adds a new `key`.

@param key [SshPublicKey] The `key` to add.

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

# File lib/ovirtsdk4/services.rb, line 21638
def add(key, opts = {})
  internal_add(key, SshPublicKey, ADD, opts)
end
key_service(id) click to toggle source

Locates the `key` service.

@param id [String] The identifier of the `key`.

@return [SshPublicKeyService] A reference to the `key` service.

# File lib/ovirtsdk4/services.rb, line 21722
def key_service(id)
  SshPublicKeyService.new(self, id)
end
list(opts = {}) click to toggle source

Returns a list of SSH public keys of the user.

For example, to retrieve the list of SSH keys of user with identifier `123`, send a request like this:

source

GET /ovirt-engine/api/users/123/sshpublickeys


The result will be the following XML document:

source,xml

<ssh_public_keys>

<ssh_public_key href="/ovirt-engine/api/users/123/sshpublickeys/456" id="456">
  <content>ssh-rsa ...</content>
  <user href="/ovirt-engine/api/users/123" id="123"/>
</ssh_public_key>

</ssh_public_keys>


Or the following JSON object

source,json

{

"ssh_public_key": [
  {
    "content": "ssh-rsa ...",
    "user": {
      "href": "/ovirt-engine/api/users/123",
      "id": "123"
    },
    "href": "/ovirt-engine/api/users/123/sshpublickeys/456",
    "id": "456"
  }
]

}


The order of the returned list of keys is not guaranteed.

@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 [Integer] :max Sets the maximum number of keys to return. If not specified all the keys are returned.

@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 [Array<SshPublicKey>]

# File lib/ovirtsdk4/services.rb, line 21711
def list(opts = {})
  internal_get(LIST, 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 21733
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return key_service(path)
  end
  return key_service(path[0..(index - 1)]).service(path[(index + 1)..-1])
end