Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Appliance::Access::Shell::ShellConfig
  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::ShellConfig`` class Structure that defines shell configuration.

## Instance Attribute Summary (collapse)

- - (Boolean) enabled

  Enabled can be set to true or false.

- - (Fixnum) timeout

  The timeout (in seconds) specifies how long you enable the Shell access.

## Class Method Summary (collapse)

- + (VAPI::Bindings::StructType) binding_type

  Holds (gets or creates) the binding type metadata for this structure type.

## Instance Method Summary (collapse)

- - (ShellConfig) initialize(ruby_values = nil, struct_value = nil) constructor

  Constructs a new instance.

## Constructor Details

### - (`ShellConfig`) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

- ruby_values (`Hash`) (defaults to: `nil`) —

  a map of initial property values (optional)

- struct_value (`VAPI::Data::StructValue`) (defaults to: `nil`) —

  a raw StructValue from the wire (optional)

    273
    274
    275
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 273

    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end

## Instance Attribute Details

### - (`Boolean`) enabled

Enabled can be set to true or false

Returns:

- (`Boolean`)

    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 248

    class ShellConfig < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.appliance.access.shell.shell_config',
                    {
                        'enabled' => VAPI::Bindings::BooleanType.instance,
                        'timeout' => VAPI::Bindings::IntegerType.instance,
                    },
                    ShellConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :enabled,
                      :timeout

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`Fixnum`) timeout

The timeout (in seconds) specifies how long you enable the Shell access. The maximum timeout is 86400 seconds(1 day).

Returns:

- (`Fixnum`)

    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 248

    class ShellConfig < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.appliance.access.shell.shell_config',
                    {
                        'enabled' => VAPI::Bindings::BooleanType.instance,
                        'timeout' => VAPI::Bindings::IntegerType.instance,
                    },
                    ShellConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :enabled,
                      :timeout

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

## Class Method Details

### + (`VAPI::Bindings::StructType`) binding_type

Holds (gets or creates) the binding type metadata for this structure type.

Returns:

- (`VAPI::Bindings::StructType`) —

  the binding type

    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/access.rb', line 254

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.access.shell.shell_config',
            {
                'enabled' => VAPI::Bindings::BooleanType.instance,
                'timeout' => VAPI::Bindings::IntegerType.instance,
            },
            ShellConfig,
            false,
            nil)
    end