Class List Method List File List

# Class: Com::Vmware::Appliance::Access::Consolecli

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

## Overview

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

## Instance Method Summary (collapse)

- - (Boolean) get

  Get enabled state of the console-based controlled CLI (TTY1).

- - (Consolecli) initialize(config) constructor

  Constructs a new instance.

- - (Void) set(enabled)

  Set enabled state of the console-based controlled CLI (TTY1).

## Constructor Details

### - (`Consolecli`) initialize(config)

Constructs a new instance.

Parameters:

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

  A hash with the api provider details.

    62
    63
    64
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 62

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

## Instance Method Details

### - (`Boolean`) get

Get enabled state of the console-based controlled CLI (TTY1).

Returns:

- (`Boolean`) —

  Console-based controlled CLI is enabled.

Raises:

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

  Generic error

    87
    88
    89
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 87

    def get()
        invoke_with_info(@@get_info)
    end

### - (`Void`) set(enabled)

Set enabled state of the console-based controlled CLI (TTY1).

Parameters:

- enabled (`Boolean`) —

  Console-based controlled CLI is enabled.

Returns:

- (`Void`)

Raises:

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

  Generic error

    74
    75
    76
    77
    78
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 74

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