Class: IntersightClient::SnmpPolicy

Inherits:
PolicyAbstractPolicy show all
Defined in:
lib/intersight_client/models/snmp_policy.rb

Overview

Policy to configure SNMP settings on endpoint.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from PolicyAbstractPolicy

#description, #name

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SnmpPolicy

Initializes the object



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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 164

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::SnmpPolicy` 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.Policy'
  end

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

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

  if attributes.key?(:'community_access')
    self.community_access = attributes[:'community_access']
  else
    self.community_access = 'Disabled'
  end

  if attributes.key?(:'enabled')
    self.enabled = attributes[:'enabled']
  else
    self.enabled = true
  end

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

  if attributes.key?(:'snmp_port')
    self.snmp_port = attributes[:'snmp_port']
  else
    self.snmp_port = 161
  end

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

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

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

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

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

  if attributes.key?(:'v2_enabled')
    self.v2_enabled = attributes[:'v2_enabled']
  else
    self.v2_enabled = true
  end

  if attributes.key?(:'v3_enabled')
    self.v3_enabled = attributes[:'v3_enabled']
  else
    self.v3_enabled = true
  end

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

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

Instance Attribute Details

#access_community_string ⇒ Object

The default SNMPv1, SNMPv2c community name or SNMPv3 username to include on any trap messages sent to the SNMP host. The name can be 18 characters long.



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

def access_community_string
  @access_community_string
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_policy.rb', line 20

def class_id
  @class_id
end

#community_access ⇒ Object

Controls access to the information in the inventory tables. Applicable only for SNMPv1 and SNMPv2c users. * Disabled - Blocks access to the information in the inventory tables. * Limited - Partial access to read the information in the inventory tables. * Full - Full access to read the information in the inventory tables.



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

def community_access
  @community_access
end

#enabled ⇒ Object

State of the SNMP Policy on the endpoint. If enabled, the endpoint sends SNMP traps to the designated host.



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

def enabled
  @enabled
end

#engine_id ⇒ Object

User-defined unique identification of the static engine.



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

def engine_id
  @engine_id
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_policy.rb', line 23

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



59
60
61
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 59

def organization
  @organization
end

#profiles ⇒ Object

An array of relationships to policyAbstractConfigProfile resources.



62
63
64
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 62

def profiles
  @profiles
end

#snmp_port ⇒ Object

Port on which Cisco IMC SNMP agent runs. Enter a value between 1-65535. Reserved ports not allowed (22, 23, 80, 123, 389, 443, 623, 636, 2068, 3268, 3269).



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

def snmp_port
  @snmp_port
end

#snmp_traps ⇒ Object

Returns the value of attribute snmp_traps.



40
41
42
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 40

def snmp_traps
  @snmp_traps
end

#snmp_users ⇒ Object

Returns the value of attribute snmp_users.



42
43
44
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 42

def snmp_users
  @snmp_users
end

#sys_contact ⇒ Object

Contact person responsible for the SNMP implementation. Enter a string up to 64 characters, such as an email address or a name and telephone number.



45
46
47
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 45

def sys_contact
  @sys_contact
end

#sys_location ⇒ Object

Location of host on which the SNMP agent (server) runs.



48
49
50
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 48

def sys_location
  @sys_location
end

#trap_community ⇒ Object

SNMP community group used for sending SNMP trap to other devices. Valid only for SNMPv2c users.



51
52
53
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 51

def trap_community
  @trap_community
end

#v2_enabled ⇒ Object

State of the SNMP v2c on the endpoint. If enabled, the endpoint sends SNMP v2c properties to the designated host.



54
55
56
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 54

def v2_enabled
  @v2_enabled
end

#v3_enabled ⇒ Object

State of the SNMP v3 on the endpoint. If enabled, the endpoint sends SNMP v3 properties to the designated host.



57
58
59
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 57

def v3_enabled
  @v3_enabled
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)



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

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)



109
110
111
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 109

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.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 87

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'access_community_string' => :'AccessCommunityString',
    :'community_access' => :'CommunityAccess',
    :'enabled' => :'Enabled',
    :'engine_id' => :'EngineId',
    :'snmp_port' => :'SnmpPort',
    :'snmp_traps' => :'SnmpTraps',
    :'snmp_users' => :'SnmpUsers',
    :'sys_contact' => :'SysContact',
    :'sys_location' => :'SysLocation',
    :'trap_community' => :'TrapCommunity',
    :'v2_enabled' => :'V2Enabled',
    :'v3_enabled' => :'V3Enabled',
    :'organization' => :'Organization',
    :'profiles' => :'Profiles'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



502
503
504
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 502

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



150
151
152
153
154
155
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 150

def self.openapi_all_of
  [
  :'PolicyAbstractPolicy',
  :'SnmpPolicyAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



158
159
160
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 158

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



141
142
143
144
145
146
147
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 141

def self.openapi_nullable
  Set.new([
    :'snmp_traps',
    :'snmp_users',
    :'profiles'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 119

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'access_community_string' => :'String',
    :'community_access' => :'String',
    :'enabled' => :'Boolean',
    :'engine_id' => :'String',
    :'snmp_port' => :'Integer',
    :'snmp_traps' => :'Array<SnmpTrap>',
    :'snmp_users' => :'Array<SnmpUser>',
    :'sys_contact' => :'String',
    :'sys_location' => :'String',
    :'trap_community' => :'String',
    :'v2_enabled' => :'Boolean',
    :'v3_enabled' => :'Boolean',
    :'organization' => :'OrganizationOrganizationRelationship',
    :'profiles' => :'Array<PolicyAbstractConfigProfileRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 466

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      access_community_string == o.access_community_string &&
      community_access == o.community_access &&
      enabled == o.enabled &&
      engine_id == o.engine_id &&
      snmp_port == o.snmp_port &&
      snmp_traps == o.snmp_traps &&
      snmp_users == o.snmp_users &&
      sys_contact == o.sys_contact &&
      sys_location == o.sys_location &&
      trap_community == o.trap_community &&
      v2_enabled == o.v2_enabled &&
      v3_enabled == o.v3_enabled &&
      organization == o.organization &&
      profiles == o.profiles && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 533

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



604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 604

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



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 509

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  SnmpPolicy.openapi_types.each_pair do |key, type|
    if attributes[SnmpPolicy.attribute_map[key]].nil? && SnmpPolicy.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[SnmpPolicy.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[SnmpPolicy.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[SnmpPolicy.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[SnmpPolicy.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


489
490
491
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 489

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



495
496
497
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 495

def hash
  [class_id, object_type, access_community_string, community_access, enabled, engine_id, snmp_port, snmp_traps, snmp_users, sys_contact, sys_location, trap_community, v2_enabled, v3_enabled, organization, profiles].hash
end

#list_invalid_properties ⇒ Object

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 267

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 !@access_community_string.nil? && @access_community_string.to_s.length > 18
    invalid_properties.push('invalid value for "access_community_string", the character length must be smaller than or equal to 18.')
  end

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

  pattern = Regexp.new(/^[^#!&]*$/)
  if !@engine_id.nil? && @engine_id !~ pattern
    invalid_properties.push("invalid value for \"engine_id\", must conform to the pattern #{pattern}.")
  end

  if !@snmp_port.nil? && @snmp_port > 65535
    invalid_properties.push('invalid value for "snmp_port", must be smaller than or equal to 65535.')
  end

  if !@snmp_port.nil? && @snmp_port < 1
    invalid_properties.push('invalid value for "snmp_port", must be greater than or equal to 1.')
  end

  if !@snmp_traps.nil? && @snmp_traps.length > 15
    invalid_properties.push('invalid value for "snmp_traps", number of items must be less than or equal to 15.')
  end

  if !@snmp_users.nil? && @snmp_users.length > 15
    invalid_properties.push('invalid value for "snmp_users", number of items must be less than or equal to 15.')
  end

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



580
581
582
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 580

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 586

def to_hash
  hash = super
  SnmpPolicy.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = SnmpPolicy.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



574
575
576
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 574

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/intersight_client/models/snmp_policy.rb', line 323

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["snmp.Policy"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["snmp.Policy"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@access_community_string.nil? && @access_community_string.to_s.length > 18
  community_access_validator = EnumAttributeValidator.new('String', ["Disabled", "Limited", "Full"])
  return false unless community_access_validator.valid?(@community_access)
  return false if !@engine_id.nil? && @engine_id.to_s.length > 27
  return false if !@engine_id.nil? && @engine_id !~ Regexp.new(/^[^#!&]*$/)
  return false if !@snmp_port.nil? && @snmp_port > 65535
  return false if !@snmp_port.nil? && @snmp_port < 1
  return false if !@snmp_traps.nil? && @snmp_traps.length > 15
  return false if !@snmp_users.nil? && @snmp_users.length > 15
  return false if !@sys_contact.nil? && @sys_contact.to_s.length > 64
  return false if !@sys_location.nil? && @sys_location.to_s.length > 64
  return false if !@trap_community.nil? && @trap_community.to_s.length > 18
  true && super
end