Class: IntersightClient::SnmpUser

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/snmp_user.rb

Overview

Complex type for a User based security model, for communication between an agent and manager. Applicable only for SNMPv3.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SnmpUser

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/intersight_client/models/snmp_user.rb', line 134

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::SnmpUser` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'snmp.User'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'snmp.User'
  end

  if attributes.key?(:'auth_password')
    self.auth_password = attributes[:'auth_password']
  end

  if attributes.key?(:'auth_type')
    self.auth_type = attributes[:'auth_type']
  else
    self.auth_type = 'NA'
  end

  if attributes.key?(:'is_auth_password_set')
    self.is_auth_password_set = attributes[:'is_auth_password_set']
  else
    self.is_auth_password_set = false
  end

  if attributes.key?(:'is_privacy_password_set')
    self.is_privacy_password_set = attributes[:'is_privacy_password_set']
  else
    self.is_privacy_password_set = false
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'privacy_password')
    self.privacy_password = attributes[:'privacy_password']
  end

  if attributes.key?(:'privacy_type')
    self.privacy_type = attributes[:'privacy_type']
  else
    self.privacy_type = 'NA'
  end

  if attributes.key?(:'security_level')
    self.security_level = attributes[:'security_level']
  else
    self.security_level = 'AuthPriv'
  end
end

Instance Attribute Details

#auth_password ⇒ Object

Authorization password for the user.



26
27
28
 
# File 'lib/intersight_client/models/snmp_user.rb', line 26

def auth_password
  @auth_password
end

#auth_type ⇒ Object

Authorization protocol for authenticating the user. * NA - Authentication protocol is not applicable. * MD5 - MD5 protocol is used to authenticate SNMP user. * SHA - SHA protocol is used to authenticate SNMP user. * SHA-224 - SHA-224 protocol is used to authenticate SNMP user. * SHA-256 - SHA-256 protocol is used to authenticate SNMP user. * SHA-384 - SHA-384 protocol is used to authenticate SNMP user. * SHA-512 - SHA-512 protocol is used to authenticate SNMP user.



29
30
31
 
# File 'lib/intersight_client/models/snmp_user.rb', line 29

def auth_type
  @auth_type
end

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/snmp_user.rb', line 20

def class_id
  @class_id
end

#is_auth_password_set ⇒ Object

Indicates whether the value of the ‘authPassword’ property has been set.



32
33
34
 
# File 'lib/intersight_client/models/snmp_user.rb', line 32

def is_auth_password_set
  @is_auth_password_set
end

#is_privacy_password_set ⇒ Object

Indicates whether the value of the ‘privacyPassword’ property has been set.



35
36
37
 
# File 'lib/intersight_client/models/snmp_user.rb', line 35

def is_privacy_password_set
  @is_privacy_password_set
end

#name ⇒ Object

SNMP username. Must have a minimum of 1 and and a maximum of 31 characters.



38
39
40
 
# File 'lib/intersight_client/models/snmp_user.rb', line 38

def name
  @name
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/snmp_user.rb', line 23

def object_type
  @object_type
end

#privacy_password ⇒ Object

Privacy password for the user.



41
42
43
 
# File 'lib/intersight_client/models/snmp_user.rb', line 41

def privacy_password
  @privacy_password
end

#privacy_type ⇒ Object

Privacy protocol for the user. * NA - Privacy protocol is not applicable. * DES - DES privacy protocol is used for SNMP user. * AES - AES privacy protocol is used for SNMP user.



44
45
46
 
# File 'lib/intersight_client/models/snmp_user.rb', line 44

def privacy_type
  @privacy_type
end

#security_level ⇒ Object

Security mechanism used for communication between agent and manager. * AuthPriv - The user requires both an authorization password and a privacy password. * NoAuthNoPriv - The user does not require an authorization or privacy password. * AuthNoPriv - The user requires an authorization password but not a privacy password.



47
48
49
 
# File 'lib/intersight_client/models/snmp_user.rb', line 47

def security_level
  @security_level
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



93
94
95
 
# File 'lib/intersight_client/models/snmp_user.rb', line 93

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



88
89
90
 
# File 'lib/intersight_client/models/snmp_user.rb', line 88

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/intersight_client/models/snmp_user.rb', line 72

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'auth_password' => :'AuthPassword',
    :'auth_type' => :'AuthType',
    :'is_auth_password_set' => :'IsAuthPasswordSet',
    :'is_privacy_password_set' => :'IsPrivacyPasswordSet',
    :'name' => :'Name',
    :'privacy_password' => :'PrivacyPassword',
    :'privacy_type' => :'PrivacyType',
    :'security_level' => :'SecurityLevel'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



344
345
346
 
# File 'lib/intersight_client/models/snmp_user.rb', line 344

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



120
121
122
123
124
125
 
# File 'lib/intersight_client/models/snmp_user.rb', line 120

def self.openapi_all_of
  [
  :'MoBaseComplexType',
  :'SnmpUserAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



128
129
130
 
# File 'lib/intersight_client/models/snmp_user.rb', line 128

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
 
# File 'lib/intersight_client/models/snmp_user.rb', line 114

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/intersight_client/models/snmp_user.rb', line 98

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'auth_password' => :'String',
    :'auth_type' => :'String',
    :'is_auth_password_set' => :'Boolean',
    :'is_privacy_password_set' => :'Boolean',
    :'name' => :'String',
    :'privacy_password' => :'String',
    :'privacy_type' => :'String',
    :'security_level' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/intersight_client/models/snmp_user.rb', line 314

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      auth_password == o.auth_password &&
      auth_type == o.auth_type &&
      is_auth_password_set == o.is_auth_password_set &&
      is_privacy_password_set == o.is_privacy_password_set &&
      name == o.name &&
      privacy_password == o.privacy_password &&
      privacy_type == o.privacy_type &&
      security_level == o.security_level && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/intersight_client/models/snmp_user.rb', line 375

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/intersight_client/models/snmp_user.rb', line 446

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/intersight_client/models/snmp_user.rb', line 351

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  SnmpUser.openapi_types.each_pair do |key, type|
    if attributes[SnmpUser.attribute_map[key]].nil? && SnmpUser.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[SnmpUser.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[SnmpUser.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[SnmpUser.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[SnmpUser.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


331
332
333
 
# File 'lib/intersight_client/models/snmp_user.rb', line 331

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



337
338
339
 
# File 'lib/intersight_client/models/snmp_user.rb', line 337

def hash
  [class_id, object_type, auth_password, auth_type, is_auth_password_set, is_privacy_password_set, name, privacy_password, privacy_type, security_level].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/intersight_client/models/snmp_user.rb', line 207

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

  if @object_type.nil?
    invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
  end

  if !@name.nil? && @name.to_s.length > 31
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 31.')
  end

  if !@name.nil? && @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



422
423
424
 
# File 'lib/intersight_client/models/snmp_user.rb', line 422

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/intersight_client/models/snmp_user.rb', line 428

def to_hash
  hash = super
  SnmpUser.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = SnmpUser.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



416
417
418
 
# File 'lib/intersight_client/models/snmp_user.rb', line 416

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/intersight_client/models/snmp_user.rb', line 230

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["snmp.User"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["snmp.User"])
  return false unless object_type_validator.valid?(@object_type)
  auth_type_validator = EnumAttributeValidator.new('String', ["NA", "MD5", "SHA", "SHA-224", "SHA-256", "SHA-384", "SHA-512"])
  return false unless auth_type_validator.valid?(@auth_type)
  return false if !@name.nil? && @name.to_s.length > 31
  return false if !@name.nil? && @name.to_s.length < 1
  privacy_type_validator = EnumAttributeValidator.new('String', ["NA", "DES", "AES"])
  return false unless privacy_type_validator.valid?(@privacy_type)
  security_level_validator = EnumAttributeValidator.new('String', ["AuthPriv", "NoAuthNoPriv", "AuthNoPriv"])
  return false unless security_level_validator.valid?(@security_level)
  true && super
end