com.vmware.nsx.node.users

Interface SshKeys

All Superinterfaces:

com.vmware.vapi.bindings.Service, SshKeysTypes

All Known Implementing Classes:

SshKeysStub

public interface SshKeys
extends com.vmware.vapi.bindings.Service, SshKeysTypes

Field Summary

Fields inherited from interface com.vmware.nsx.node.users.SshKeysTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	addsshkey(java.lang.String userid, SshKeyProperties sshKeyProperties) Add SSH public key to authorized_keys file for node user
void	addsshkey(java.lang.String userid, SshKeyProperties sshKeyProperties, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Add SSH public key to authorized_keys file for node user
void	addsshkey(java.lang.String userid, SshKeyProperties sshKeyProperties, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add SSH public key to authorized_keys file for node user
void	addsshkey(java.lang.String userid, SshKeyProperties sshKeyProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add SSH public key to authorized_keys file for node user
SshKeyPropertiesListResult	list(java.lang.String userid) Returns a list of all SSH keys from authorized_keys file for node user
void	list(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<SshKeyPropertiesListResult> asyncCallback) Returns a list of all SSH keys from authorized_keys file for node user
void	list(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<SshKeyPropertiesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns a list of all SSH keys from authorized_keys file for node user
SshKeyPropertiesListResult	list(java.lang.String userid, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns a list of all SSH keys from authorized_keys file for node user
void	removesshkey(java.lang.String userid, SshKeyBaseProperties sshKeyBaseProperties) Remove SSH public key from authorized_keys file for node user
void	removesshkey(java.lang.String userid, SshKeyBaseProperties sshKeyBaseProperties, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Remove SSH public key from authorized_keys file for node user
void	removesshkey(java.lang.String userid, SshKeyBaseProperties sshKeyBaseProperties, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Remove SSH public key from authorized_keys file for node user
void	removesshkey(java.lang.String userid, SshKeyBaseProperties sshKeyBaseProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Remove SSH public key from authorized_keys file for node user

Method Detail

addsshkey

void addsshkey(java.lang.String userid,
               SshKeyProperties sshKeyProperties)

Add SSH public key to authorized_keys file for node user

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

userid - User id of the user (required)

sshKeyProperties - (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

addsshkey

void addsshkey(java.lang.String userid,
               SshKeyProperties sshKeyProperties,
               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Add SSH public key to authorized_keys file for node user

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

userid - User id of the user (required)

sshKeyProperties - (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

addsshkey

void addsshkey(java.lang.String userid,
               SshKeyProperties sshKeyProperties,
               com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Add SSH public key to authorized_keys file for node user

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

userid - User id of the user (required)

sshKeyProperties - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

addsshkey

void addsshkey(java.lang.String userid,
               SshKeyProperties sshKeyProperties,
               com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Add SSH public key to authorized_keys file for node user

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

userid - User id of the user (required)

sshKeyProperties - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

SshKeyPropertiesListResult list(java.lang.String userid)

Returns a list of all SSH keys from authorized_keys file for node user

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

userid - User id of the user (required)

Returns:

com.vmware.nsx.model.SshKeyPropertiesListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

SshKeyPropertiesListResult list(java.lang.String userid,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns a list of all SSH keys from authorized_keys file for node user

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

userid - User id of the user (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.SshKeyPropertiesListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(java.lang.String userid,
          com.vmware.vapi.bindings.client.AsyncCallback<SshKeyPropertiesListResult> asyncCallback)

Returns a list of all SSH keys from authorized_keys file for node user

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.SshKeyPropertiesListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

userid - User id of the user (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(java.lang.String userid,
          com.vmware.vapi.bindings.client.AsyncCallback<SshKeyPropertiesListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns a list of all SSH keys from authorized_keys file for node user

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.SshKeyPropertiesListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

userid - User id of the user (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

removesshkey

void removesshkey(java.lang.String userid,
                  SshKeyBaseProperties sshKeyBaseProperties)

Remove SSH public key from authorized_keys file for node user

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

userid - User id of the user (required)

sshKeyBaseProperties - (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

removesshkey

void removesshkey(java.lang.String userid,
                  SshKeyBaseProperties sshKeyBaseProperties,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Remove SSH public key from authorized_keys file for node user

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

userid - User id of the user (required)

sshKeyBaseProperties - (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

removesshkey

void removesshkey(java.lang.String userid,
                  SshKeyBaseProperties sshKeyBaseProperties,
                  com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Remove SSH public key from authorized_keys file for node user

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

userid - User id of the user (required)

sshKeyBaseProperties - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

removesshkey

void removesshkey(java.lang.String userid,
                  SshKeyBaseProperties sshKeyBaseProperties,
                  com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Remove SSH public key from authorized_keys file for node user

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

userid - User id of the user (required)

sshKeyBaseProperties - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.