Class List Method List File List

# Class: Com::Vmware::Appliance::Access::Shell

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Appliance::Access::Shell
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb

## Overview

``Com::Vmware::Appliance::Access::Shell`` class provides methods Get/Set enabled state of BASH.

## Defined Under Namespace

Classes: ShellConfig

## Instance Method Summary (collapse)

- - (Com::Vmware::Appliance::Access::Shell::ShellConfig) get

  Get enabled state of BASH, that is, access to BASH from within the controlled CLI.

- - (Shell) initialize(config) constructor

  Constructs a new instance.

- - (Void) set(config)

  Set enabled state of BASH, that is, access to BASH from within the controlled CLI.

## Constructor Details

### - (`Shell`) initialize(config)

Constructs a new instance.

Parameters:

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

  A hash with the api provider details.

    210
    211
    212
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 210

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

## Instance Method Details

### - (`Com::Vmware::Appliance::Access::Shell::ShellConfig`) get

Get enabled state of BASH, that is, access to BASH from within the controlled CLI.

Returns:

- (`Com::Vmware::Appliance::Access::Shell::ShellConfig`) —

  Current shell configuration.

Raises:

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

  Generic error

    235
    236
    237
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 235

    def get()
        invoke_with_info(@@get_info)
    end

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

Set enabled state of BASH, that is, access to BASH from within the controlled CLI.

Parameters:

- config (`Com::Vmware::Appliance::Access::Shell::ShellConfig`) —

  Shell configuration

Returns:

- (`Void`)

Raises:

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

  Generic error

    222
    223
    224
    225
    226
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 222

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