Class: VSphereAutomation::Appliance::ApplianceTechpreviewMonitoringSnmpSNMPConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplianceTechpreviewMonitoringSnmpSNMPConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 91

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'authentication')
    self.authentication = attributes[:'authentication']
  end

  if attributes.has_key?(:'communities')
    if (value = attributes[:'communities']).is_a?(Array)
      self.communities = value
    end
  end

  if attributes.has_key?(:'engineid')
    self.engineid = attributes[:'engineid']
  end

  if attributes.has_key?(:'loglevel')
    self.loglevel = attributes[:'loglevel']
  end

  if attributes.has_key?(:'notraps')
    if (value = attributes[:'notraps']).is_a?(Array)
      self.notraps = value
    end
  end

  if attributes.has_key?(:'port')
    self.port = attributes[:'port']
  end

  if attributes.has_key?(:'privacy')
    self.privacy = attributes[:'privacy']
  end

  if attributes.has_key?(:'remoteusers')
    if (value = attributes[:'remoteusers']).is_a?(Array)
      self.remoteusers = value
    end
  end

  if attributes.has_key?(:'syscontact')
    self.syscontact = attributes[:'syscontact']
  end

  if attributes.has_key?(:'syslocation')
    self.syslocation = attributes[:'syslocation']
  end

  if attributes.has_key?(:'targets')
    if (value = attributes[:'targets']).is_a?(Array)
      self.targets = value
    end
  end

  if attributes.has_key?(:'users')
    if (value = attributes[:'users']).is_a?(Array)
      self.users = value
    end
  end

  if attributes.has_key?(:'v3targets')
    if (value = attributes[:'v3targets']).is_a?(Array)
      self.v3targets = value
    end
  end
end

Instance Attribute Details

#authentication ⇒ Object

Returns the value of attribute authentication.



14
15
16
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 14

def authentication
  @authentication
end

#communities ⇒ Object

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



17
18
19
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 17

def communities
  @communities
end

#engineid ⇒ Object

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



20
21
22
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 20

def engineid
  @engineid
end

#loglevel ⇒ Object

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



23
24
25
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 23

def loglevel
  @loglevel
end

#notraps ⇒ Object

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



26
27
28
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 26

def notraps
  @notraps
end

#port ⇒ Object

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



29
30
31
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 29

def port
  @port
end

#privacy ⇒ Object

Returns the value of attribute privacy.



31
32
33
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 31

def privacy
  @privacy
end

#remoteusers ⇒ Object

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.



34
35
36
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 34

def remoteusers
  @remoteusers
end

#syscontact ⇒ Object

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



37
38
39
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 37

def syscontact
  @syscontact
end

#syslocation ⇒ Object

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



40
41
42
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 40

def syslocation
  @syslocation
end

#targets ⇒ Object

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



43
44
45
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 43

def targets
  @targets
end

#users ⇒ Object

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.



46
47
48
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 46

def users
  @users
end

#v3targets ⇒ Object

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



49
50
51
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 49

def v3targets
  @v3targets
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 52

def self.attribute_map
  {
    :'authentication' => :'authentication',
    :'communities' => :'communities',
    :'engineid' => :'engineid',
    :'loglevel' => :'loglevel',
    :'notraps' => :'notraps',
    :'port' => :'port',
    :'privacy' => :'privacy',
    :'remoteusers' => :'remoteusers',
    :'syscontact' => :'syscontact',
    :'syslocation' => :'syslocation',
    :'targets' => :'targets',
    :'users' => :'users',
    :'v3targets' => :'v3targets'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 71

def self.openapi_types
  {
    :'authentication' => :'ApplianceTechpreviewMonitoringSnmpSNMPAuthProto',
    :'communities' => :'Array<String>',
    :'engineid' => :'String',
    :'loglevel' => :'String',
    :'notraps' => :'Array<String>',
    :'port' => :'Integer',
    :'privacy' => :'ApplianceTechpreviewMonitoringSnmpSNMPPrivProto',
    :'remoteusers' => :'Array<String>',
    :'syscontact' => :'String',
    :'syslocation' => :'String',
    :'targets' => :'Array<String>',
    :'users' => :'Array<String>',
    :'v3targets' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authentication == o.authentication &&
      communities == o.communities &&
      engineid == o.engineid &&
      loglevel == o.loglevel &&
      notraps == o.notraps &&
      port == o.port &&
      privacy == o.privacy &&
      remoteusers == o.remoteusers &&
      syscontact == o.syscontact &&
      syslocation == o.syslocation &&
      targets == o.targets &&
      users == o.users &&
      v3targets == o.v3targets
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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 296

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN, :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
    temp_model = VSphereAutomation::Appliance.const_get(type).new
    temp_model.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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 362

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 275

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


262
263
264
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



268
269
270
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 268

def hash
  [authentication, communities, engineid, loglevel, notraps, port, privacy, remoteusers, syscontact, syslocation, targets, users, v3targets].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



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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 164

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

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

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

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

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

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

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

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

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

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

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

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

  if @v3targets.nil?
    invalid_properties.push('invalid value for "v3targets", v3targets cannot be nil.')
  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



342
343
344
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 342

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



348
349
350
351
352
353
354
355
356
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 348

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



336
337
338
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 336

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/vsphere-automation-appliance/models/appliance_techpreview_monitoring_snmp_snmp_config.rb', line 223

def valid?
  return false if @authentication.nil?
  return false if @communities.nil?
  return false if @engineid.nil?
  return false if @loglevel.nil?
  return false if @notraps.nil?
  return false if @port.nil?
  return false if @privacy.nil?
  return false if @remoteusers.nil?
  return false if @syscontact.nil?
  return false if @syslocation.nil?
  return false if @targets.nil?
  return false if @users.nil?
  return false if @v3targets.nil?
  true
end