com.vmware.appliance

Interface LocalAccounts

All Superinterfaces:

LocalAccountsTypes, Service

All Known Implementing Classes:

LocalAccountsStub

public interface LocalAccounts
extends Service, LocalAccountsTypes

The LocalAccounts interface provides methods to manage local user account. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.LocalAccountsTypes

LocalAccountsTypes.Config, LocalAccountsTypes.Info, LocalAccountsTypes.UpdateConfig

Field Summary

Fields inherited from interface com.vmware.appliance.LocalAccountsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String username, LocalAccountsTypes.Config config) Create a new local user account.
void	create(java.lang.String username, LocalAccountsTypes.Config config, AsyncCallback<java.lang.Void> asyncCallback) Create a new local user account.
void	create(java.lang.String username, LocalAccountsTypes.Config config, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Create a new local user account.
void	create(java.lang.String username, LocalAccountsTypes.Config config, InvocationConfig invocationConfig) Create a new local user account.
void	delete(java.lang.String username) Delete a local user account.
void	delete(java.lang.String username, AsyncCallback<java.lang.Void> asyncCallback) Delete a local user account.
void	delete(java.lang.String username, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Delete a local user account.
void	delete(java.lang.String username, InvocationConfig invocationConfig) Delete a local user account.
LocalAccountsTypes.Info	get(java.lang.String username) Get the local user account information.
void	get(java.lang.String username, AsyncCallback<LocalAccountsTypes.Info> asyncCallback) Get the local user account information.
void	get(java.lang.String username, AsyncCallback<LocalAccountsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get the local user account information.
LocalAccountsTypes.Info	get(java.lang.String username, InvocationConfig invocationConfig) Get the local user account information.
java.util.List<java.lang.String>	list() Get a list of the local user accounts.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Get a list of the local user accounts.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Get a list of the local user accounts.
java.util.List<java.lang.String>	list(InvocationConfig invocationConfig) Get a list of the local user accounts.
void	set(java.lang.String username, LocalAccountsTypes.Config config) Set local user account properties.
void	set(java.lang.String username, LocalAccountsTypes.Config config, AsyncCallback<java.lang.Void> asyncCallback) Set local user account properties.
void	set(java.lang.String username, LocalAccountsTypes.Config config, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set local user account properties.
void	set(java.lang.String username, LocalAccountsTypes.Config config, InvocationConfig invocationConfig) Set local user account properties.
void	update(java.lang.String username, LocalAccountsTypes.UpdateConfig config) Update selected fields in local user account properties.
void	update(java.lang.String username, LocalAccountsTypes.UpdateConfig config, AsyncCallback<java.lang.Void> asyncCallback) Update selected fields in local user account properties.
void	update(java.lang.String username, LocalAccountsTypes.UpdateConfig config, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Update selected fields in local user account properties.
void	update(java.lang.String username, LocalAccountsTypes.UpdateConfig config, InvocationConfig invocationConfig) Update selected fields in local user account properties.

Method Detail

get

LocalAccountsTypes.Info get(java.lang.String username)

Get the local user account information. This method was added in vSphere API 6.7.

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

Parameters:

username - User login name

Returns:

Local user account information

Throws:

NotFound - If the account is not found

Error - Generic error

get

LocalAccountsTypes.Info get(java.lang.String username,
                            InvocationConfig invocationConfig)

Get the local user account information. This method was added in vSphere API 6.7.

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:

username - User login name

invocationConfig - Configuration for the method invocation.

Returns:

Local user account information

Throws:

NotFound - If the account is not found

Error - Generic error

get

void get(java.lang.String username,
         AsyncCallback<LocalAccountsTypes.Info> asyncCallback)

Get the local user account information. This method was added in vSphere API 6.7.

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

Invocation Result:
Local user account information

Operation Errors:
NotFound - If the account is not found
Error - Generic error

Parameters:

username - User login name

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

get

void get(java.lang.String username,
         AsyncCallback<LocalAccountsTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Get the local user account information. This method was added in vSphere API 6.7.

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:
Local user account information

Operation Errors:
NotFound - If the account is not found
Error - Generic error

Parameters:

username - User login name

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<java.lang.String> list()

Get a list of the local user accounts. This method was added in vSphere API 6.7.

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

Returns:

List of identifiers The return value will contain identifiers for the resource type: com.vmware.appliance.local_accounts.

Throws:

Error - Generic error

list

java.util.List<java.lang.String> list(InvocationConfig invocationConfig)

Get a list of the local user accounts. This method was added in vSphere API 6.7.

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:

invocationConfig - Configuration for the method invocation.

Returns:

List of identifiers The return value will contain identifiers for the resource type: com.vmware.appliance.local_accounts.

Throws:

Error - Generic error

list

void list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Get a list of the local user accounts. This method was added in vSphere API 6.7.

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

Invocation Result:
List of identifiers The return value will contain identifiers for the resource type: com.vmware.appliance.local_accounts.

Operation Errors:
Error - Generic error

Parameters:

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

list

void list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
          InvocationConfig invocationConfig)

Get a list of the local user accounts. This method was added in vSphere API 6.7.

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:
List of identifiers The return value will contain identifiers for the resource type: com.vmware.appliance.local_accounts.

Operation Errors:
Error - Generic error

Parameters:

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

invocationConfig - Configuration for the method invocation.

create

void create(java.lang.String username,
            LocalAccountsTypes.Config config)

Create a new local user account. This method was added in vSphere API 6.7.

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

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

Throws:

AlreadyExists - If an account already exists

InvalidArgument - If a username is invalid (username is validated against [a-zA-Z0-9][a-zA-Z0-9\-\.@]*[a-zA-Z0-9] pattern)

Error - Generic error

create

void create(java.lang.String username,
            LocalAccountsTypes.Config config,
            InvocationConfig invocationConfig)

Create a new local user account. This method was added in vSphere API 6.7.

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:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - If an account already exists

InvalidArgument - If a username is invalid (username is validated against [a-zA-Z0-9][a-zA-Z0-9\-\.@]*[a-zA-Z0-9] pattern)

Error - Generic error

create

void create(java.lang.String username,
            LocalAccountsTypes.Config config,
            AsyncCallback<java.lang.Void> asyncCallback)

Create a new local user account. This method was added in vSphere API 6.7.

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

Operation Errors:
AlreadyExists - If an account already exists
InvalidArgument - If a username is invalid (username is validated against [a-zA-Z0-9][a-zA-Z0-9\-\.@]*[a-zA-Z0-9] pattern)
Error - Generic error

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

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

create

void create(java.lang.String username,
            LocalAccountsTypes.Config config,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Create a new local user account. This method was added in vSphere API 6.7.

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:
AlreadyExists - If an account already exists
InvalidArgument - If a username is invalid (username is validated against [a-zA-Z0-9][a-zA-Z0-9\-\.@]*[a-zA-Z0-9] pattern)
Error - Generic error

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

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

invocationConfig - Configuration for the method invocation.

set

void set(java.lang.String username,
         LocalAccountsTypes.Config config)

Set local user account properties. This method was added in vSphere API 6.7.

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

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

Throws:

NotFound - If the account is not found

Error - Generic error

set

void set(java.lang.String username,
         LocalAccountsTypes.Config config,
         InvocationConfig invocationConfig)

Set local user account properties. This method was added in vSphere API 6.7.

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:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - If the account is not found

Error - Generic error

set

void set(java.lang.String username,
         LocalAccountsTypes.Config config,
         AsyncCallback<java.lang.Void> asyncCallback)

Set local user account properties. This method was added in vSphere API 6.7.

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

Operation Errors:
NotFound - If the account is not found
Error - Generic error

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

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

set

void set(java.lang.String username,
         LocalAccountsTypes.Config config,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Set local user account properties. This method was added in vSphere API 6.7.

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:
NotFound - If the account is not found
Error - Generic error

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String username,
            LocalAccountsTypes.UpdateConfig config)

Update selected fields in local user account properties. This method was added in vSphere API 6.7.

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

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

Throws:

NotFound - If the account is not found

Error - Generic error

update

void update(java.lang.String username,
            LocalAccountsTypes.UpdateConfig config,
            InvocationConfig invocationConfig)

Update selected fields in local user account properties. This method was added in vSphere API 6.7.

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:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - If the account is not found

Error - Generic error

update

void update(java.lang.String username,
            LocalAccountsTypes.UpdateConfig config,
            AsyncCallback<java.lang.Void> asyncCallback)

Update selected fields in local user account properties. This method was added in vSphere API 6.7.

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

Operation Errors:
NotFound - If the account is not found
Error - Generic error

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

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

update

void update(java.lang.String username,
            LocalAccountsTypes.UpdateConfig config,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Update selected fields in local user account properties. This method was added in vSphere API 6.7.

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:
NotFound - If the account is not found
Error - Generic error

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

config - User configuration

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String username)

Delete a local user account. This method was added in vSphere API 6.7.

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

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

Throws:

NotFound - If the account is not found

Error - Generic error

delete

void delete(java.lang.String username,
            InvocationConfig invocationConfig)

Delete a local user account. This method was added in vSphere API 6.7.

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:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - If the account is not found

Error - Generic error

delete

void delete(java.lang.String username,
            AsyncCallback<java.lang.Void> asyncCallback)

Delete a local user account. This method was added in vSphere API 6.7.

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

Operation Errors:
NotFound - If the account is not found
Error - Generic error

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

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

delete

void delete(java.lang.String username,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Delete a local user account. This method was added in vSphere API 6.7.

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:
NotFound - If the account is not found
Error - Generic error

Parameters:

username - User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

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

invocationConfig - Configuration for the method invocation.