Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPConfig
  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::SNMPConfig`` class Structure that defines the SNMP configuration, provided as input to set(), and never the result of get(). See SNMPConfigReadOnly. This structure is used to configure SNMP v1, v2c, and v3.

## Instance Attribute Summary (collapse)

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

  Set the default authentication protocol.

- - (Array<String>) communities

  Set up to ten communities, each of no more than 64 characters long.

- - (String) engineid

  Set SNMPv3 engine ID.

- - (String) loglevel

  System Agent syslog logging level: debug|info|warning|error.

- - (Array<String>) notraps

  Comma-separated list of trap OIDs (object identifiers) for traps not to be sent by the agent.

- - (Fixnum) port

  Set up a UDP port which the SNMP agent uses to listen on for polling requests.

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

  Set the default privacy protocol.

- - (Array<String>) remoteusers

  Set up to five inform user IDs.

- - (String) syscontact

  System contact string as presented in sysContact.0.

- - (String) syslocation

  System location string as presented in sysLocation.0.

- - (Array<String>) targets

  Set up to three targets to which to send SNMPv1 traps.

- - (Array<String>) users

  Set up to five local users.

- - (Array<String>) v3targets

  Set up to three SNMPv3 notification targets.

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

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

  Constructs a new instance.

## Constructor Details

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

    598
    599
    600
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 598

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

## Instance Attribute Details

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

Set the default authentication protocol. Values can be none, MD5, or SHA1.

Returns:

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

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

        # 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

### - (`Array<String>`) communities

Set up to ten communities, each of no more than 64 characters long. The format is: community1. This setting overwrites any previous settings.

Returns:

- (`Array<String>`)

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

        # 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

Set SNMPv3 engine ID. The engine ID must contain 5 to 32 hexadecimal characters. “0x” and colon (:) are removed from the ID.

Returns:

- (`String`)

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

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

System Agent syslog logging level: debug|info|warning|error.

Returns:

- (`String`)

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

        # 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

### - (`Array<String>`) notraps

Comma-separated list of trap OIDs (object identifiers) for traps not to be sent by the agent. Use ‘reset’ to clear the setting.

Returns:

- (`Array<String>`)

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

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

Set up a UDP port which the SNMP agent uses to listen on for polling requests. The default UDP port is 161.

Returns:

- (`Fixnum`)

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

        # 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

Set the default privacy protocol. Values: none or AES128.

Returns:

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

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

        # 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

### - (`Array<String>`) remoteusers

Set up to five inform user IDs. The format is: user/auth-proto/-|auth-hash/priv-proto/-|priv-hash/engine-id. Here, user must be maximum 32 characters long; auth-proto is none, MD5 or SHA1; priv-proto is none or AES; ’-’ indicates no hash; engine-id is a hexadecimal string ‘0x0-9a-f’ and must be up to 32 characters long.

Returns:

- (`Array<String>`)

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

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

System contact string as presented in sysContact.0. Up to 255 characters long.

Returns:

- (`String`)

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

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

System location string as presented in sysLocation.0. Up to 255 characters long.

Returns:

- (`String`)

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

        # 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

### - (`Array<String>`) targets

Set up to three targets to which to send SNMPv1 traps. The format is: ip-or-hostname[\@port]/community. The default port is UDP 162. This setting overwrites any previous settings.

Returns:

- (`Array<String>`)

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

        # 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

### - (`Array<String>`) users

Set up to five local users. The format is: user/-|auth-hash/-|priv-hash/model. Here user is maximum 32 characters long; ’-’ indicates no hash; model is one of none, auth or priv.

Returns:

- (`Array<String>`)

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

        # 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

### - (`Array<String>`) v3targets

Set up to three SNMPv3 notification targets. Format is: ip-or-hostname[\@port]/remote-user/security-level/trap|inform.

Returns:

- (`Array<String>`)

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 551

    class SNMPConfig < 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_config',
                    {
                        'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                        'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'engineid' => VAPI::Bindings::StringType.instance,
                        'loglevel' => VAPI::Bindings::StringType.instance,
                        'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                        'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'syscontact' => VAPI::Bindings::StringType.instance,
                        'syslocation' => VAPI::Bindings::StringType.instance,
                        'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    SNMPConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication,
                      :communities,
                      :engineid,
                      :loglevel,
                      :notraps,
                      :port,
                      :privacy,
                      :remoteusers,
                      :syscontact,
                      :syslocation,
                      :targets,
                      :users,
                      :v3targets

        # 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

    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 557

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.techpreview.monitoring.snmp.SNMP_config',
            {
                'authentication' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPAuthProto'),
                'communities' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                'engineid' => VAPI::Bindings::StringType.instance,
                'loglevel' => VAPI::Bindings::StringType.instance,
                'notraps' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                'port' => VAPI::Bindings::IntegerType.instance,
                'privacy' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPPrivProto'),
                'remoteusers' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                'syscontact' => VAPI::Bindings::StringType.instance,
                'syslocation' => VAPI::Bindings::StringType.instance,
                'targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                'users' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                'v3targets' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
            },
            SNMPConfig,
            false,
            nil)
    end