Class List Method List File List

# Class: Com::Vmware::Appliance::Techpreview::Shutdown

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

## Overview

``Com::Vmware::Appliance::Techpreview::Shutdown`` class provides methods Performs reboot/shutdow operations on appliance.

## Defined Under Namespace

Classes: ShutdownConfig, ShutdownGetConfig

## Instance Method Summary (collapse)

- - (Void) cancel

  Cancel pending shutdown action.

- - (Com::Vmware::Appliance::Techpreview::Shutdown::ShutdownGetConfig) get

  Get details about the pending shutdown action.

- - (Shutdown) initialize(config) constructor

  Constructs a new instance.

- - (Void) poweroff(config)

  Power off the appliance.

- - (Void) reboot(config)

  Reboot the appliance.

## Constructor Details

### - (`Shutdown`) initialize(config)

Constructs a new instance.

Parameters:

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

  A hash with the api provider details.

    726
    727
    728
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 726

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

## Instance Method Details

### - (`Void`) cancel

Cancel pending shutdown action.

Returns:

- (`Void`)

Raises:

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

  Generic error

    736
    737
    738
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 736

    def cancel()
        invoke_with_info(@@cancel_info)
    end

### - (`Com::Vmware::Appliance::Techpreview::Shutdown::ShutdownGetConfig`) get

Get details about the pending shutdown action.

Returns:

- (`Com::Vmware::Appliance::Techpreview::Shutdown::ShutdownGetConfig`) —

  Configuration of pending shutdown action.

Raises:

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

  Generic error

    775
    776
    777
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 775

    def get()
        invoke_with_info(@@get_info)
    end

### - (`Void`) poweroff(config)

Power off the appliance.

Parameters:

- config (`Com::Vmware::Appliance::Techpreview::Shutdown::ShutdownConfig`) —

  Configuration of poweroff action

Returns:

- (`Void`)

Raises:

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

  Generic error

    748
    749
    750
    751
    752
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 748

    def poweroff(config)
        invoke_with_info(@@poweroff_info, {
            'config' => config,
        })
    end

### - (`Void`) reboot(config)

Reboot the appliance.

Parameters:

- config (`Com::Vmware::Appliance::Techpreview::Shutdown::ShutdownConfig`) —

  Configuration of reboot action

Returns:

- (`Void`)

Raises:

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

  Generic error

    762
    763
    764
    765
    766
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 762

    def reboot(config)
        invoke_with_info(@@reboot_info, {
            'config' => config,
        })
    end