Class List Method List File List

# Class: Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPUser

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

## Overview

``Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPUser`` class Structure that defines information associated with an SNMP user. authKey and privKey are localized keys defined in tools.ietf.org/html/rfc3826#section-1.2.

## Instance Attribute Summary (collapse)

- - (String) auth_key

  SNMP authorization key.

- - (String) priv_key

  SNMP privacy key.

- - (Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel) sec_level

  SNMP security level.

- - (String) username

  SNMP Username.

## 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)

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

  Constructs a new instance.

## Constructor Details

### - (`SNMPUser`) 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)

    646
    647
    648
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 646

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

## Instance Attribute Details

### - (`String`) auth_key

SNMP authorization key

Returns:

- (`String`)

    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 617

    class SNMPUser < 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.techpreview.monitoring.snmp.SNMP_user',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                        'auth_key' => VAPI::Bindings::StringType.instance,
                        'priv_key' => VAPI::Bindings::StringType.instance,
                    },
                    SNMPUser,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :sec_level,
                      :auth_key,
                      :priv_key

        # 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

### - (`String`) priv_key

SNMP privacy key

Returns:

- (`String`)

    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 617

    class SNMPUser < 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.techpreview.monitoring.snmp.SNMP_user',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                        'auth_key' => VAPI::Bindings::StringType.instance,
                        'priv_key' => VAPI::Bindings::StringType.instance,
                    },
                    SNMPUser,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :sec_level,
                      :auth_key,
                      :priv_key

        # 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

### - (`Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel`) sec_level

SNMP security level

Returns:

- (`Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel`)

    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 617

    class SNMPUser < 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.techpreview.monitoring.snmp.SNMP_user',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                        'auth_key' => VAPI::Bindings::StringType.instance,
                        'priv_key' => VAPI::Bindings::StringType.instance,
                    },
                    SNMPUser,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :sec_level,
                      :auth_key,
                      :priv_key

        # 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

### - (`String`) username

SNMP Username

Returns:

- (`String`)

    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 617

    class SNMPUser < 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.techpreview.monitoring.snmp.SNMP_user',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                        'auth_key' => VAPI::Bindings::StringType.instance,
                        'priv_key' => VAPI::Bindings::StringType.instance,
                    },
                    SNMPUser,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :sec_level,
                      :auth_key,
                      :priv_key

        # 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

    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 623

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.techpreview.monitoring.snmp.SNMP_user',
            {
                'username' => VAPI::Bindings::StringType.instance,
                'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                'auth_key' => VAPI::Bindings::StringType.instance,
                'priv_key' => VAPI::Bindings::StringType.instance,
            },
            SNMPUser,
            false,
            nil)
    end