VMware vSphere Automation SDK Perl The VMware vSphere Automation SDK for Perl supports the client-side vSphere Automation API for access to vSphere services and capabilities

- Main Page
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Files Functions
Classes | List of all members
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:
click to view
# Number of lines of code in add: 10
sub add {
my ($self, %args) = @_;
my $config = $args {config};
$self->validate_args (method_name => 'add',
method_args => \%args);
return $self->invoke (method_name => 'add',
method_args => \%args);
}

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:
click to view
# Number of lines of code in delete: 10
sub delete {
my ($self, %args) = @_;
my $username = $args {username};
$self->validate_args (method_name => 'delete',
method_args => \%args);
return $self->invoke (method_name => 'delete',
method_args => \%args);
}

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:
click to view
# Number of lines of code in get: 10
sub get {
my ($self, %args) = @_;
my $username = $args {username};
$self->validate_args (method_name => 'get',
method_args => \%args);
return $self->invoke (method_name => 'get',
method_args => \%args);
}

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:
click to view
# Number of lines of code in list: 4
sub list {
my ($self, %args) = @_;
return $self->invoke(method_name => 'list', method_args => {});
}

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:
click to view
# Number of lines of code in new: 11
sub new {
my ($class, %args) = @_;
$class = ref($class) || $class;
my $stub_config = $args {stub_config};
my $api_provider = $args {api_provider};
my $self = $class->SUPER::new('stub_config' => $stub_config,
'api_provider' => $api_provider);
bless $self, $class;
return $self;
}

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:
click to view
# Number of lines of code in set: 10
sub set {
my ($self, %args) = @_;
my $config = $args {config};
$self->validate_args (method_name => 'set',
method_args => \%args);
return $self->invoke (method_name => 'set',
method_args => \%args);
}

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

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