Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Appliance::Techpreview::Localaccounts::User
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb

## Overview

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

## Defined Under Namespace

Classes: NewUserConfig, UserAccountStatus, UserConfig, UserConfigGet, UserPasswordStatus, UserRole

## Instance Method Summary (collapse)

- - (Void) add(config)

  Create a new local user account.

- - (Void) delete(username)

  Delete a local user account.

- - (Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserConfigGet) get(username)

  Get the local user account information.

- - (User) initialize(config) constructor

  Constructs a new instance.

- - (Array<Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserConfigGet>) list

  List of local accounts.

- - (Void) set(config)

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

## Constructor Details

### - (`User`) initialize(config)

Constructs a new instance.

Parameters:

- config (`VAPI::Bindings::StubConfig`) —

  A hash with the api provider details.

    103
    104
    105
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 103

    def initialize(config)
        super(config, @@service_info)
    end

## Instance Method Details

### - (`Void`) add(config)

Create a new local user account.

Parameters:

- config (`Com::Vmware::Appliance::Techpreview::Localaccounts::User::NewUserConfig`) —

  User configuration.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    129
    130
    131
    132
    133
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 129

    def add(config)
        invoke_with_info(@@add_info, {
            'config' => config,
        })
    end

### - (`Void`) delete(username)

Delete a local user account.

Parameters:

- username (`String`) —

  User login name.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    115
    116
    117
    118
    119
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 115

    def delete(username)
        invoke_with_info(@@delete_info, {
            'username' => username,
        })
    end

### - (`Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserConfigGet`) get(username)

Get the local user account information.

Parameters:

- username (`String`) —

  User login name.

Returns:

- (`Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserConfigGet`) —

  local user account information

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    169
    170
    171
    172
    173
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 169

    def get(username)
        invoke_with_info(@@get_info, {
            'username' => username,
        })
    end

### - (`Array<Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserConfigGet>`) list

List of local accounts

Returns:

- (`Array<Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserConfigGet>`) —

  User configuration.

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    156
    157
    158
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 156

    def list()
        invoke_with_info(@@list_info)
    end

### - (`Void`) set(config)

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

Parameters:

- config (`Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserConfig`) —

  User configuration.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    143
    144
    145
    146
    147
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 143

    def set(config)
        invoke_with_info(@@set_info, {
            'config' => config,
        })
    end