Class: IntersightClient::StorageStoragePolicy

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

Overview

The storage policy models the reusable storage related configuration that can be applied on many servers. This policy allows creation of RAID groups using existing disk group policies and virtual drives on the drive groups. The user has options to move all unused disks to JBOD or Unconfigured good state. The encryption of drives can be enabled through this policy using remote keys from a KMIP server.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 135

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

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

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

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

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

  if attributes.key?(:'unused_disks_state')
    self.unused_disks_state = attributes[:'unused_disks_state']
  else
    self.unused_disks_state = 'NoChange'
  end

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

  if attributes.key?(:'drive_group')
    if (value = attributes[:'drive_group']).is_a?(Array)
      self.drive_group = value
    end
  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

#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/storage_storage_policy.rb', line 20

def class_id
  @class_id
end

#drive_group ⇒ Object

An array of relationships to storageDriveGroup resources.



39
40
41
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 39

def drive_group
  @drive_group
end

#global_hot_spares ⇒ Object

A collection of disks that is to be used as hot spares, globally, for all the RAID groups. Allowed value is a number range separated by a comma or a hyphen.



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

def global_hot_spares
  @global_hot_spares
end

#m2_virtual_drive ⇒ Object

Returns the value of attribute m2_virtual_drive.



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

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

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



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

def organization
  @organization
end

#profiles ⇒ Object

An array of relationships to policyAbstractConfigProfile resources.



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

def profiles
  @profiles
end

#raid0_drive ⇒ Object

Returns the value of attribute raid0_drive.



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

def raid0_drive
  @raid0_drive
end

#unused_disks_state ⇒ Object

State to which disks, not used in this policy, are to be moved. NoChange will not change the drive state. * NoChange - Drive state will not be modified by Storage Policy. * UnconfiguredGood - Unconfigured good state -ready to be added in a RAID group. * Jbod - JBOD state where the disks start showing up to Host OS.



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

def unused_disks_state
  @unused_disks_state
end

#use_jbod_for_vd_creation ⇒ Object

Disks in JBOD State are used to create virtual drives.



36
37
38
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 36

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



90
91
92
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 90

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)



85
86
87
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 85

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.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 69

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'global_hot_spares' => :'GlobalHotSpares',
    :'m2_virtual_drive' => :'M2VirtualDrive',
    :'raid0_drive' => :'Raid0Drive',
    :'unused_disks_state' => :'UnusedDisksState',
    :'use_jbod_for_vd_creation' => :'UseJbodForVdCreation',
    :'drive_group' => :'DriveGroup',
    :'organization' => :'Organization',
    :'profiles' => :'Profiles'
  }
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



310
311
312
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 310

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



129
130
131
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 129

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
115
116
117
118
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 111

def self.openapi_nullable
  Set.new([
    :'m2_virtual_drive',
    :'raid0_drive',
    :'drive_group',
    :'profiles'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 95

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'global_hot_spares' => :'String',
    :'m2_virtual_drive' => :'StorageM2VirtualDriveConfig',
    :'raid0_drive' => :'StorageR0Drive',
    :'unused_disks_state' => :'String',
    :'use_jbod_for_vd_creation' => :'Boolean',
    :'drive_group' => :'Array<StorageDriveGroupRelationship>',
    :'organization' => :'OrganizationOrganizationRelationship',
    :'profiles' => :'Array<PolicyAbstractConfigProfileRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 280

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      global_hot_spares == o.global_hot_spares &&
      m2_virtual_drive == o.m2_virtual_drive &&
      raid0_drive == o.raid0_drive &&
      unused_disks_state == o.unused_disks_state &&
      use_jbod_for_vd_creation == o.use_jbod_for_vd_creation &&
      drive_group == o.drive_group &&
      organization == o.organization &&
      profiles == o.profiles && 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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 341

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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 412

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 317

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


297
298
299
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 303

def hash
  [class_id, object_type, global_hot_spares, m2_virtual_drive, raid0_drive, unused_disks_state, use_jbod_for_vd_creation, drive_group, organization, profiles].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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 204

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

  pattern = Regexp.new(/^$|^((\d+\-\d+)|(\d+))(,((\d+\-\d+)|(\d+)))*$/)
  if !@global_hot_spares.nil? && @global_hot_spares !~ pattern
    invalid_properties.push("invalid value for \"global_hot_spares\", must conform to the pattern #{pattern}.")
  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



388
389
390
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 388

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



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 394

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



382
383
384
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 382

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



224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/intersight_client/models/storage_storage_policy.rb', line 224

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["storage.StoragePolicy"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["storage.StoragePolicy"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@global_hot_spares.nil? && @global_hot_spares !~ Regexp.new(/^$|^((\d+\-\d+)|(\d+))(,((\d+\-\d+)|(\d+)))*$/)
  unused_disks_state_validator = EnumAttributeValidator.new('String', ["NoChange", "UnconfiguredGood", "Jbod"])
  return false unless unused_disks_state_validator.valid?(@unused_disks_state)
  true && super
end