Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPRemoteUser
  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::SNMPRemoteUser`` class Structure that defines a user at particular remote SNMPv3 entity needed when using informs. auth_key and priv_key contained localized keys as defined in tools.ietf.org/html/rfc3826#section-1.2.

## Instance Attribute Summary (collapse)

- - (String) auth_key

  SNMP authorization key.

- - (Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto) authentication

  SNMP authorization protocol.

- - (String) engineid

  SNMP v3 engine id.

- - (String) priv_key

  SNMP privacy key.

- - (Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto) privacy

  SNMP privacy protocol.

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

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

  Constructs a new instance.

## Constructor Details

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

    805
    806
    807
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 805

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

    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 770

    class SNMPRemoteUser < 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_remote_user',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'auth_key' => VAPI::Bindings::StringType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'priv_key' => VAPI::Bindings::StringType.instance,
                        'engineid' => VAPI::Bindings::StringType.instance,
                    },
                    SNMPRemoteUser,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :sec_level,
                      :authentication,
                      :auth_key,
                      :privacy,
                      :priv_key,
                      :engineid

        # 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::SNMPAuthProto`) authentication

SNMP authorization protocol

Returns:

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

    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 770

    class SNMPRemoteUser < 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_remote_user',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'auth_key' => VAPI::Bindings::StringType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'priv_key' => VAPI::Bindings::StringType.instance,
                        'engineid' => VAPI::Bindings::StringType.instance,
                    },
                    SNMPRemoteUser,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :sec_level,
                      :authentication,
                      :auth_key,
                      :privacy,
                      :priv_key,
                      :engineid

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

SNMP v3 engine id

Returns:

- (`String`)

    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 770

    class SNMPRemoteUser < 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_remote_user',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'auth_key' => VAPI::Bindings::StringType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'priv_key' => VAPI::Bindings::StringType.instance,
                        'engineid' => VAPI::Bindings::StringType.instance,
                    },
                    SNMPRemoteUser,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :sec_level,
                      :authentication,
                      :auth_key,
                      :privacy,
                      :priv_key,
                      :engineid

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

    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 770

    class SNMPRemoteUser < 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_remote_user',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'auth_key' => VAPI::Bindings::StringType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'priv_key' => VAPI::Bindings::StringType.instance,
                        'engineid' => VAPI::Bindings::StringType.instance,
                    },
                    SNMPRemoteUser,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :sec_level,
                      :authentication,
                      :auth_key,
                      :privacy,
                      :priv_key,
                      :engineid

        # 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::SNMPPrivProto`) privacy

SNMP privacy protocol

Returns:

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

    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 770

    class SNMPRemoteUser < 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_remote_user',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'auth_key' => VAPI::Bindings::StringType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'priv_key' => VAPI::Bindings::StringType.instance,
                        'engineid' => VAPI::Bindings::StringType.instance,
                    },
                    SNMPRemoteUser,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :sec_level,
                      :authentication,
                      :auth_key,
                      :privacy,
                      :priv_key,
                      :engineid

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

    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 770

    class SNMPRemoteUser < 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_remote_user',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'auth_key' => VAPI::Bindings::StringType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'priv_key' => VAPI::Bindings::StringType.instance,
                        'engineid' => VAPI::Bindings::StringType.instance,
                    },
                    SNMPRemoteUser,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :sec_level,
                      :authentication,
                      :auth_key,
                      :privacy,
                      :priv_key,
                      :engineid

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

    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 770

    class SNMPRemoteUser < 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_remote_user',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'sec_level' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPSecLevel'),
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'auth_key' => VAPI::Bindings::StringType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'priv_key' => VAPI::Bindings::StringType.instance,
                        'engineid' => VAPI::Bindings::StringType.instance,
                    },
                    SNMPRemoteUser,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :sec_level,
                      :authentication,
                      :auth_key,
                      :privacy,
                      :priv_key,
                      :engineid

        # 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

    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 776

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