Com::Vmware::Appliance::Techpreview::Localaccounts::User Class Reference

Inheritance diagram for Com::Vmware::Appliance::Techpreview::Localaccounts::User:

Classes
class	NewUserConfig
class	UserAccountStatus
class	UserConfig
class	UserConfigGet
class	UserPasswordStatus
class	UserRole

Avaliable Methods
public method	add ()
public method	get ()
public method	delete ()
public method	new ()
public method	list ()
public method	set ()

Detailed Description

Com::Vmware::Appliance::Techpreview::Localaccounts::User interface provides methods* Perform operations on local user account.

Member Function Documentation

public method Com::Vmware::Appliance::Techpreview::Localaccounts::User::add

(

)

Create a new local user account.

Parameters

config

[REQUIRED] User configuration. . The value must be Com::Vmware::Appliance::Techpreview::Localaccounts::User::NewUserConfig.

Exceptions

Com::Vmware::Vapi::Std::Errors::Error

Generic error

Code:

public method Com::Vmware::Appliance::Techpreview::Localaccounts::User::delete

(

)

Delete a local user account.

Parameters

username

[REQUIRED] User login name. . The value must be String.

Exceptions

Com::Vmware::Vapi::Std::Errors::Error

Generic error

Code:

public method Com::Vmware::Appliance::Techpreview::Localaccounts::User::get

(

)

Get the local user account information.

Parameters

username

[REQUIRED] User login name. . The value must be String.

Return values

local

user account information The return type will be Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserConfigGet

Exceptions

Com::Vmware::Vapi::Std::Errors::Error

Generic error

Code:

public method Com::Vmware::Appliance::Techpreview::Localaccounts::User::list

(

)

List of local accounts

Return values

User	configuration. The return type will be Array of Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserConfigGet

Exceptions

Com::Vmware::Vapi::Std::Errors::Error

Generic error

Code:

public method Com::Vmware::Appliance::Techpreview::Localaccounts::User::new

(

)

Constructor to initialize the object

Parameters

api_provider	- protocol connection to use with stubs created by this factory
StubConfig	- Stub's additional configuration

Return values

Blessed

object

Code:

public method Com::Vmware::Appliance::Techpreview::Localaccounts::User::set

(

)

Update local user account properties role, full name, enabled status and password

Parameters

config

[REQUIRED] User configuration. . The value must be Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserConfig.

Exceptions

Com::Vmware::Vapi::Std::Errors::Error

Generic error

Code:

---

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

• Com/Vmware/Appliance/Techpreview/Localaccounts/User.pm