VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::appliance::LocalAccounts Interface Reference

The LocalAccounts interface provides methods to manage local user account. More...

Inherited by vmware::appliance::LocalAccountsStub.

List of all members.

Public Member Functions

vmware.appliance.LocalAccountsTypes.Info Get (string username)
 Get the local user account information.
vmware.appliance.LocalAccountsTypes.Info Get (string username, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Get the local user account information.
global::System.Threading.Tasks.Task
< vmware.appliance.LocalAccountsTypes.Info
GetAsync (string username)
 Get the local user account information.
global::System.Threading.Tasks.Task
< vmware.appliance.LocalAccountsTypes.Info
GetAsync (string username, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Get the local user account information.
global::System.Collections.Generic.List
< string > 
List ()
 Get a list of the local user accounts.
global::System.Collections.Generic.List
< string > 
List (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Get a list of the local user accounts.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< string > > 
ListAsync ()
 Get a list of the local user accounts.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< string > > 
ListAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Get a list of the local user accounts.
void Create (string username, vmware.appliance.LocalAccountsTypes.Config config)
 Create a new local user account.
void Create (string username, vmware.appliance.LocalAccountsTypes.Config config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Create a new local user account.
global::System.Threading.Tasks.Task CreateAsync (string username, vmware.appliance.LocalAccountsTypes.Config config)
 Create a new local user account.
global::System.Threading.Tasks.Task CreateAsync (string username, vmware.appliance.LocalAccountsTypes.Config config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Create a new local user account.
void Set (string username, vmware.appliance.LocalAccountsTypes.Config config)
 Set local user account properties.
void Set (string username, vmware.appliance.LocalAccountsTypes.Config config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Set local user account properties.
global::System.Threading.Tasks.Task SetAsync (string username, vmware.appliance.LocalAccountsTypes.Config config)
 Set local user account properties.
global::System.Threading.Tasks.Task SetAsync (string username, vmware.appliance.LocalAccountsTypes.Config config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Set local user account properties.
void Update (string username, vmware.appliance.LocalAccountsTypes.UpdateConfig config)
 Update selected fields in local user account properties.
void Update (string username, vmware.appliance.LocalAccountsTypes.UpdateConfig config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Update selected fields in local user account properties.
global::System.Threading.Tasks.Task UpdateAsync (string username, vmware.appliance.LocalAccountsTypes.UpdateConfig config)
 Update selected fields in local user account properties.
global::System.Threading.Tasks.Task UpdateAsync (string username, vmware.appliance.LocalAccountsTypes.UpdateConfig config, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Update selected fields in local user account properties.
void Delete (string username)
 Delete a local user account.
void Delete (string username, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Delete a local user account.
global::System.Threading.Tasks.Task DeleteAsync (string username)
 Delete a local user account.
global::System.Threading.Tasks.Task DeleteAsync (string username, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Delete a local user account.

Detailed Description

The LocalAccounts interface provides methods to manage local user account.

This interface was added in vSphere API 6.7.


Member Function Documentation

void vmware::appliance::LocalAccounts::Create ( string  username,
vmware.appliance.LocalAccountsTypes.Config  config 
)

Create a new local user account.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsIf an account already exists
vmware.vapi.std.errors.InvalidArgumentIf a username is invalid (username is validated against [a-zA-Z0-9][a-zA-Z0-9\-\.@]*[a-zA-Z0-9] pattern)
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration

Implemented in vmware::appliance::LocalAccountsStub.

void vmware::appliance::LocalAccounts::Create ( string  username,
vmware.appliance.LocalAccountsTypes.Config  config,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Create a new local user account.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsIf an account already exists
vmware.vapi.std.errors.InvalidArgumentIf a username is invalid (username is validated against [a-zA-Z0-9][a-zA-Z0-9\-\.@]*[a-zA-Z0-9] pattern)
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task vmware::appliance::LocalAccounts::CreateAsync ( string  username,
vmware.appliance.LocalAccountsTypes.Config  config 
)

Create a new local user account.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsIf an account already exists
vmware.vapi.std.errors.InvalidArgumentIf a username is invalid (username is validated against [a-zA-Z0-9][a-zA-Z0-9\-\.@]*[a-zA-Z0-9] pattern)
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task vmware::appliance::LocalAccounts::CreateAsync ( string  username,
vmware.appliance.LocalAccountsTypes.Config  config,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Create a new local user account.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsIf an account already exists
vmware.vapi.std.errors.InvalidArgumentIf a username is invalid (username is validated against [a-zA-Z0-9][a-zA-Z0-9\-\.@]*[a-zA-Z0-9] pattern)
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::LocalAccountsStub.

void vmware::appliance::LocalAccounts::Delete ( string  username)

Delete a local user account.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .

Implemented in vmware::appliance::LocalAccountsStub.

void vmware::appliance::LocalAccounts::Delete ( string  username,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Delete a local user account.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task vmware::appliance::LocalAccounts::DeleteAsync ( string  username)

Delete a local user account.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task vmware::appliance::LocalAccounts::DeleteAsync ( string  username,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Delete a local user account.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::LocalAccountsStub.

vmware.appliance.LocalAccountsTypes.Info vmware::appliance::LocalAccounts::Get ( string  username,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Get the local user account information.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Local user account information

Implemented in vmware::appliance::LocalAccountsStub.

vmware.appliance.LocalAccountsTypes.Info vmware::appliance::LocalAccounts::Get ( string  username)

Get the local user account information.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name
Returns:
Local user account information

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task<vmware.appliance.LocalAccountsTypes.Info> vmware::appliance::LocalAccounts::GetAsync ( string  username,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Get the local user account information.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Local user account information

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task<vmware.appliance.LocalAccountsTypes.Info> vmware::appliance::LocalAccounts::GetAsync ( string  username)

Get the local user account information.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name
Returns:
Local user account information

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Collections.Generic.List<string> vmware::appliance::LocalAccounts::List ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Get a list of the local user accounts.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
Returns:
List of identifiers The result will contain identifiers for the resource type: com.vmware.appliance.local_accounts .

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Collections.Generic.List<string> vmware::appliance::LocalAccounts::List ( )

Get a list of the local user accounts.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
Returns:
List of identifiers The result will contain identifiers for the resource type: com.vmware.appliance.local_accounts .

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<string> > vmware::appliance::LocalAccounts::ListAsync ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Get a list of the local user accounts.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
Returns:
List of identifiers The result will contain identifiers for the resource type: com.vmware.appliance.local_accounts .

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<string> > vmware::appliance::LocalAccounts::ListAsync ( )

Get a list of the local user accounts.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.ErrorGeneric error
Returns:
List of identifiers The result will contain identifiers for the resource type: com.vmware.appliance.local_accounts .

Implemented in vmware::appliance::LocalAccountsStub.

void vmware::appliance::LocalAccounts::Set ( string  username,
vmware.appliance.LocalAccountsTypes.Config  config 
)

Set local user account properties.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration

Implemented in vmware::appliance::LocalAccountsStub.

void vmware::appliance::LocalAccounts::Set ( string  username,
vmware.appliance.LocalAccountsTypes.Config  config,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Set local user account properties.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task vmware::appliance::LocalAccounts::SetAsync ( string  username,
vmware.appliance.LocalAccountsTypes.Config  config,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Set local user account properties.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task vmware::appliance::LocalAccounts::SetAsync ( string  username,
vmware.appliance.LocalAccountsTypes.Config  config 
)

Set local user account properties.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration

Implemented in vmware::appliance::LocalAccountsStub.

void vmware::appliance::LocalAccounts::Update ( string  username,
vmware.appliance.LocalAccountsTypes.UpdateConfig  config 
)

Update selected fields in local user account properties.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration

Implemented in vmware::appliance::LocalAccountsStub.

void vmware::appliance::LocalAccounts::Update ( string  username,
vmware.appliance.LocalAccountsTypes.UpdateConfig  config,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Update selected fields in local user account properties.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task vmware::appliance::LocalAccounts::UpdateAsync ( string  username,
vmware.appliance.LocalAccountsTypes.UpdateConfig  config,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Update selected fields in local user account properties.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::appliance::LocalAccountsStub.

global::System.Threading.Tasks.Task vmware::appliance::LocalAccounts::UpdateAsync ( string  username,
vmware.appliance.LocalAccountsTypes.UpdateConfig  config 
)

Update selected fields in local user account properties.

This method was added in vSphere API 6.7.

Exceptions:
vmware.vapi.std.errors.NotFoundIf the account is not found
vmware.vapi.std.errors.ErrorGeneric error
Parameters:
usernameUser login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts .
configUser configuration

Implemented in vmware::appliance::LocalAccountsStub.


The documentation for this interface was generated from the following file: