Class: IntersightClient::TamSecurityAdvisory

Inherits:
TamBaseAdvisory show all
Defined in:
lib/intersight_client/models/tam_security_advisory.rb

Overview

Intersight representation of a Cisco PSIRT (tools.cisco.com/security/center/publicationListing.x) advisory definition. It includes the description of the security advisory and a corresponding reference to the published advisory. It also includes the Intersight data sources needed to evaluate the applicability of this advisory for relevant Intersight managed objects. A PSIRT definition is evaluated against all managed object referenced using the included data sources. Only Cisco TAC and Intersight devops engineers have the ability to create PSIRT definitions in Intersight.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from TamBaseAdvisory

#description, #name, #severity, #state

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 = {}) ⇒ TamSecurityAdvisory

Initializes the object



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/tam_security_advisory.rb', line 168

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = 'interim'
  end

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

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

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

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

Instance Attribute Details

#actions ⇒ Object

Returns the value of attribute actions.



25
26
27
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 25

def actions
  @actions
end

#advisory_id ⇒ Object

Cisco generated identifier for the published security advisory.



28
29
30
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 28

def advisory_id
  @advisory_id
end

#api_data_sources ⇒ Object

Returns the value of attribute api_data_sources.



30
31
32
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 30

def api_data_sources
  @api_data_sources
end

#base_score ⇒ Object

CVSS version 3 base score for the security Advisory.



33
34
35
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 33

def base_score
  @base_score
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/tam_security_advisory.rb', line 20

def class_id
  @class_id
end

#cve_ids ⇒ Object

Returns the value of attribute cve_ids.



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

def cve_ids
  @cve_ids
end

#date_published ⇒ Object

Date when the security advisory was first published by Cisco.



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

def date_published
  @date_published
end

#date_updated ⇒ Object

Date when the security advisory was last updated by Cisco.



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

def date_updated
  @date_updated
end

#environmental_score ⇒ Object

CVSS version 3 environmental score for the security Advisory.



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

def environmental_score
  @environmental_score
end

#external_url ⇒ Object

A link to an external URL describing security Advisory in more details.



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

def external_url
  @external_url
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/tam_security_advisory.rb', line 23

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



64
65
66
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 64

def organization
  @organization
end

#recommendation ⇒ Object

Recommended action to resolve the security advisory.



50
51
52
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 50

def recommendation
  @recommendation
end

#status ⇒ Object

Cisco assigned status of the published advisory based on whether the investigation is complete or on-going. * interim - The Cisco investigation for the advisory is ongoing. Cisco will issue revisions to the advisory when additional information, including fixed software release data, becomes available. * final - Cisco has completed its evaluation of the vulnerability described in the advisory. There will be no further updates unless there is a material change in the nature of the vulnerability.



53
54
55
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 53

def status
  @status
end

#temporal_score ⇒ Object

CVSS version 3 temporal score for the security Advisory.



56
57
58
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 56

def temporal_score
  @temporal_score
end

#version ⇒ Object

Cisco assigned advisory version after latest revision.



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

def version
  @version
end

#workaround ⇒ Object

Workarounds available for the advisory.



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

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



117
118
119
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 117

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)



112
113
114
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 112

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'actions' => :'Actions',
    :'advisory_id' => :'AdvisoryId',
    :'api_data_sources' => :'ApiDataSources',
    :'base_score' => :'BaseScore',
    :'cve_ids' => :'CveIds',
    :'date_published' => :'DatePublished',
    :'date_updated' => :'DateUpdated',
    :'environmental_score' => :'EnvironmentalScore',
    :'external_url' => :'ExternalUrl',
    :'recommendation' => :'Recommendation',
    :'status' => :'Status',
    :'temporal_score' => :'TemporalScore',
    :'version' => :'Version',
    :'workaround' => :'Workaround',
    :'organization' => :'Organization'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



452
453
454
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 452

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



154
155
156
157
158
159
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 154

def self.openapi_all_of
  [
  :'TamBaseAdvisory',
  :'TamSecurityAdvisoryAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



162
163
164
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 162

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



145
146
147
148
149
150
151
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 145

def self.openapi_nullable
  Set.new([
    :'actions',
    :'api_data_sources',
    :'cve_ids',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 122

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'actions' => :'Array<TamAction>',
    :'advisory_id' => :'String',
    :'api_data_sources' => :'Array<TamApiDataSource>',
    :'base_score' => :'Float',
    :'cve_ids' => :'Array<String>',
    :'date_published' => :'Time',
    :'date_updated' => :'Time',
    :'environmental_score' => :'Float',
    :'external_url' => :'String',
    :'recommendation' => :'String',
    :'status' => :'String',
    :'temporal_score' => :'Float',
    :'version' => :'String',
    :'workaround' => :'String',
    :'organization' => :'OrganizationOrganizationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 415

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      actions == o.actions &&
      advisory_id == o.advisory_id &&
      api_data_sources == o.api_data_sources &&
      base_score == o.base_score &&
      cve_ids == o.cve_ids &&
      date_published == o.date_published &&
      date_updated == o.date_updated &&
      environmental_score == o.environmental_score &&
      external_url == o.external_url &&
      recommendation == o.recommendation &&
      status == o.status &&
      temporal_score == o.temporal_score &&
      version == o.version &&
      workaround == o.workaround &&
      organization == o.organization && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 483

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



554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 554

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



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 459

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

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


439
440
441
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 439

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



445
446
447
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 445

def hash
  [class_id, object_type, actions, advisory_id, api_data_sources, base_score, cve_ids, date_published, date_updated, environmental_score, external_url, recommendation, status, temporal_score, version, workaround, organization].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
 
# File 'lib/intersight_client/models/tam_security_advisory.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 !@base_score.nil? && @base_score > 10.0
    invalid_properties.push('invalid value for "base_score", must be smaller than or equal to 10.0.')
  end

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

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

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

  pattern = Regexp.new(/^$|^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[\w\-\._~:\/?#\[\]@!\$&'\(\)\*\+,;=.]+$/)
  if !@external_url.nil? && @external_url !~ pattern
    invalid_properties.push("invalid value for \"external_url\", must conform to the pattern #{pattern}.")
  end

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



530
531
532
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 530

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 536

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



524
525
526
 
# File 'lib/intersight_client/models/tam_security_advisory.rb', line 524

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["tam.SecurityAdvisory"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["tam.SecurityAdvisory"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@base_score.nil? && @base_score > 10.0
  return false if !@base_score.nil? && @base_score < 0.0
  return false if !@environmental_score.nil? && @environmental_score > 10.0
  return false if !@environmental_score.nil? && @environmental_score < 0.0
  return false if !@external_url.nil? && @external_url !~ Regexp.new(/^$|^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[\w\-\._~:\/?#\[\]@!\$&'\(\)\*\+,;=.]+$/)
  status_validator = EnumAttributeValidator.new('String', ["interim", "final"])
  return false unless status_validator.valid?(@status)
  return false if !@temporal_score.nil? && @temporal_score > 10.0
  return false if !@temporal_score.nil? && @temporal_score < 0.0
  true && super
end