Class List Method List File List

# Class: Com::Vmware::Appliance::Access::Ssh

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

## Overview

``Com::Vmware::Appliance::Access::Ssh`` class provides methods Get/Set enabled state of SSH-based controlled CLI.

## Instance Method Summary (collapse)

- - (Boolean) get

  Get enabled state of the SSH-based controlled CLI.

- - (Ssh) initialize(config) constructor

  Constructs a new instance.

- - (Void) set(enabled)

  Set enabled state of the SSH-based controlled CLI.

## Constructor Details

### - (`Ssh`) initialize(config)

Constructs a new instance.

Parameters:

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

  A hash with the api provider details.

    323
    324
    325
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 323

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

## Instance Method Details

### - (`Boolean`) get

Get enabled state of the SSH-based controlled CLI.

Returns:

- (`Boolean`) —

  SSH-based controlled CLI is enabled.

Raises:

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

  Generic error

    348
    349
    350
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 348

    def get()
        invoke_with_info(@@get_info)
    end

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

Set enabled state of the SSH-based controlled CLI.

Parameters:

- enabled (`Boolean`) —

  SSH-based controlled CLI is enabled.

Returns:

- (`Void`)

Raises:

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

  Generic error

    335
    336
    337
    338
    339
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 335

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