Class: Com::Vmware::Appliance::Techpreview::Monitoring::Snmp::SNMPHashConfig

Inherits:
VAPI::Bindings::VapiStruct
  • Object
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::SNMPHashConfig`` class Structure to provide up to two secrets to combine with the SNMPv3 engine ID and authentication or privacy protocol to form a localized hash. auth_hash is always required, priv_hash can be empty. By default arguments are paths on the local filesystem, raw_secret takes path to be the actual raw secret. First implementation was in ESXi: esxcli system snmp hash --help

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

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



951
952
953
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 951

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

Instance Attribute Details

- (String) auth_hash

Provide filename to secret for authentication hash, use in set --users (required secret)

Returns:

  • (String) 


924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 924

class SNMPHashConfig < 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_hash_config',
                {
                    'auth_hash' => VAPI::Bindings::StringType.instance,
                    'priv_hash' => VAPI::Bindings::StringType.instance,
                    'raw_secret' => VAPI::Bindings::BooleanType.instance,
                },
                SNMPHashConfig,
                false,
                nil)
        end
    end

    attr_accessor :auth_hash,
                  :priv_hash,
                  :raw_secret

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

Provide filename to secret for privacy hash, use in set --users (secret)

Returns:

  • (String) 


924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 924

class SNMPHashConfig < 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_hash_config',
                {
                    'auth_hash' => VAPI::Bindings::StringType.instance,
                    'priv_hash' => VAPI::Bindings::StringType.instance,
                    'raw_secret' => VAPI::Bindings::BooleanType.instance,
                },
                SNMPHashConfig,
                false,
                nil)
        end
    end

    attr_accessor :auth_hash,
                  :priv_hash,
                  :raw_secret

    # 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

- (Boolean) raw_secret

Make --auth_path and --priv_path flags read raw secret from command line instead of file.

Returns:

  • (Boolean) 


924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 924

class SNMPHashConfig < 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_hash_config',
                {
                    'auth_hash' => VAPI::Bindings::StringType.instance,
                    'priv_hash' => VAPI::Bindings::StringType.instance,
                    'raw_secret' => VAPI::Bindings::BooleanType.instance,
                },
                SNMPHashConfig,
                false,
                nil)
        end
    end

    attr_accessor :auth_hash,
                  :priv_hash,
                  :raw_secret

    # 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 



930
931
932
933
934
935
936
937
938
939
940
941
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/monitoring.rb', line 930

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.appliance.techpreview.monitoring.snmp.SNMP_hash_config',
        {
            'auth_hash' => VAPI::Bindings::StringType.instance,
            'priv_hash' => VAPI::Bindings::StringType.instance,
            'raw_secret' => VAPI::Bindings::BooleanType.instance,
        },
        SNMPHashConfig,
        false,
        nil)
end