org.jclouds.cloudstack.features
Interface SSHKeyPairApi

public interface SSHKeyPairApi

Provides synchronous access to CloudStack SSHKeyPair features.

See Also:

Method Summary

SshKeyPair	createSSHKeyPair(String name) Creates a SshKeyPair with specified name.
void	deleteSSHKeyPair(String name) Deletes the SSHKeyPairApi with given name.
SshKeyPair	getSSHKeyPair(String name) Retrieves the SSHKeyPairApi with given name.
Set<SshKeyPair>	listSSHKeyPairs(ListSSHKeyPairsOptions... options) Returns a list of SshKeyPairs registered by current user.
SshKeyPair	registerSSHKeyPair(String name, String publicKey) Registers a SshKeyPair with the given name and public kay material.

Method Detail

listSSHKeyPairs

@Named(value="listSSHKeyPairs")
Set<SshKeyPair> listSSHKeyPairs(ListSSHKeyPairsOptions... options)

Returns a list of SshKeyPairs registered by current user.

Parameters:

options - if present, how to constrain the list

Returns:

Set of SshKeyPairs matching the current constrains or empty set if no SshKeyPairs found.

registerSSHKeyPair

@Named(value="registerSSHKeyPair")
SshKeyPair registerSSHKeyPair(String name,
                                    String publicKey)

Registers a SshKeyPair with the given name and public kay material.

Parameters:

name - of the keypair

publicKey - Public key material of the keypair

Returns:

Created SshKeyPair.

createSSHKeyPair

@Named(value="createSSHKeyPair")
SshKeyPair createSSHKeyPair(String name)

Creates a SshKeyPair with specified name.

Parameters:

name - of the SshKeyPair.

Returns:

Created SshKeyPair.

getSSHKeyPair

@Named(value="listSSHKeyPairs")
SshKeyPair getSSHKeyPair(String name)

Retrieves the SSHKeyPairApi with given name.

Parameters:

name - name of the key pair

Returns:

SSH Key pair or null if not found.

deleteSSHKeyPair

@Named(value="deleteSSHKeyPair")
void deleteSSHKeyPair(String name)

Deletes the SSHKeyPairApi with given name.

Parameters:

name - name of the key pair