Class: IntersightClient::VnicIscsiBootPolicy

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

Overview

Configuration parameters to enable a server to boot its operating system from an iSCSI target machine located remotely over a network.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

  if attributes.key?(:'initiator_ip_source')
    self.initiator_ip_source = attributes[:'initiator_ip_source']
  else
    self.initiator_ip_source = 'DHCP'
  end

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

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

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

  if attributes.key?(:'target_source_type')
    self.target_source_type = attributes[:'target_source_type']
  else
    self.target_source_type = 'Static'
  end

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

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

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

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

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

Instance Attribute Details

#auto_targetvendor_name ⇒ Object

Auto target interface that is represented via the Initiator name or the DHCP vendor ID. The vendor ID can be up to 32 alphanumeric characters.



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

def auto_targetvendor_name
  @auto_targetvendor_name
end

#chap ⇒ Object

Returns the value of attribute chap.



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

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

def class_id
  @class_id
end

#initiator_ip_pool ⇒ Object

Returns the value of attribute initiator_ip_pool.



43
44
45
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 43

def initiator_ip_pool
  @initiator_ip_pool
end

#initiator_ip_source ⇒ Object

Source Type of Initiator IP Address - Auto/Static/Pool. * DHCP - The IP address is assigned using DHCP, if available. * Static - Static IPv4 address is assigned to the iSCSI boot interface based on the information entered in this area. * Pool - An IPv4 address is assigned to the iSCSI boot interface from the management IP address pool.



31
32
33
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 31

def initiator_ip_source
  @initiator_ip_source
end

#initiator_static_ip_v4_address ⇒ Object

Static IP address provided for iSCSI Initiator.



34
35
36
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 34

def initiator_static_ip_v4_address
  @initiator_static_ip_v4_address
end

#initiator_static_ip_v4_config ⇒ Object

Returns the value of attribute initiator_static_ip_v4_config.



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

def initiator_static_ip_v4_config
  @initiator_static_ip_v4_config
end

#iscsi_adapter_policy ⇒ Object

Returns the value of attribute iscsi_adapter_policy.



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

def iscsi_adapter_policy
  @iscsi_adapter_policy
end

#mutual_chap ⇒ Object

Returns the value of attribute mutual_chap.



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

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

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



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

def organization
  @organization
end

#primary_target_policy ⇒ Object

Returns the value of attribute primary_target_policy.



49
50
51
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 49

def primary_target_policy
  @primary_target_policy
end

#secondary_target_policy ⇒ Object

Returns the value of attribute secondary_target_policy.



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

def secondary_target_policy
  @secondary_target_policy
end

#target_source_type ⇒ Object

Source Type of Targets - Auto/Static. * Static - Type indicates that static target interface is assigned to iSCSI boot. * Auto - Type indicates that the system selects the target interface automatically during iSCSI boot.



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

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



101
102
103
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 101

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)



96
97
98
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 96

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.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 76

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'auto_targetvendor_name' => :'AutoTargetvendorName',
    :'chap' => :'Chap',
    :'initiator_ip_source' => :'InitiatorIpSource',
    :'initiator_static_ip_v4_address' => :'InitiatorStaticIpV4Address',
    :'initiator_static_ip_v4_config' => :'InitiatorStaticIpV4Config',
    :'mutual_chap' => :'MutualChap',
    :'target_source_type' => :'TargetSourceType',
    :'initiator_ip_pool' => :'InitiatorIpPool',
    :'iscsi_adapter_policy' => :'IscsiAdapterPolicy',
    :'organization' => :'Organization',
    :'primary_target_policy' => :'PrimaryTargetPolicy',
    :'secondary_target_policy' => :'SecondaryTargetPolicy'
  }
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



354
355
356
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 354

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



135
136
137
138
139
140
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 135

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



143
144
145
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 143

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
130
131
132
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 126

def self.openapi_nullable
  Set.new([
    :'chap',
    :'initiator_static_ip_v4_config',
    :'mutual_chap',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 106

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'auto_targetvendor_name' => :'String',
    :'chap' => :'VnicIscsiAuthProfile',
    :'initiator_ip_source' => :'String',
    :'initiator_static_ip_v4_address' => :'String',
    :'initiator_static_ip_v4_config' => :'IppoolIpV4Config',
    :'mutual_chap' => :'VnicIscsiAuthProfile',
    :'target_source_type' => :'String',
    :'initiator_ip_pool' => :'IppoolPoolRelationship',
    :'iscsi_adapter_policy' => :'VnicIscsiAdapterPolicyRelationship',
    :'organization' => :'OrganizationOrganizationRelationship',
    :'primary_target_policy' => :'VnicIscsiStaticTargetPolicyRelationship',
    :'secondary_target_policy' => :'VnicIscsiStaticTargetPolicyRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 320

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      auto_targetvendor_name == o.auto_targetvendor_name &&
      chap == o.chap &&
      initiator_ip_source == o.initiator_ip_source &&
      initiator_static_ip_v4_address == o.initiator_static_ip_v4_address &&
      initiator_static_ip_v4_config == o.initiator_static_ip_v4_config &&
      mutual_chap == o.mutual_chap &&
      target_source_type == o.target_source_type &&
      initiator_ip_pool == o.initiator_ip_pool &&
      iscsi_adapter_policy == o.iscsi_adapter_policy &&
      organization == o.organization &&
      primary_target_policy == o.primary_target_policy &&
      secondary_target_policy == o.secondary_target_policy && 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



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
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 385

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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 456

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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 361

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


341
342
343
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 341

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



347
348
349
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 347

def hash
  [class_id, object_type, auto_targetvendor_name, chap, initiator_ip_source, initiator_static_ip_v4_address, initiator_static_ip_v4_config, mutual_chap, target_source_type, initiator_ip_pool, iscsi_adapter_policy, organization, primary_target_policy, secondary_target_policy].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



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

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(/^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$/)
  if !@initiator_static_ip_v4_address.nil? && @initiator_static_ip_v4_address !~ pattern
    invalid_properties.push("invalid value for \"initiator_static_ip_v4_address\", 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



432
433
434
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 432

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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 438

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



426
427
428
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 426

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/intersight_client/models/vnic_iscsi_boot_policy.rb', line 252

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["vnic.IscsiBootPolicy"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["vnic.IscsiBootPolicy"])
  return false unless object_type_validator.valid?(@object_type)
  initiator_ip_source_validator = EnumAttributeValidator.new('String', ["DHCP", "Static", "Pool"])
  return false unless initiator_ip_source_validator.valid?(@initiator_ip_source)
  return false if !@initiator_static_ip_v4_address.nil? && @initiator_static_ip_v4_address !~ Regexp.new(/^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$/)
  target_source_type_validator = EnumAttributeValidator.new('String', ["Static", "Auto"])
  return false unless target_source_type_validator.valid?(@target_source_type)
  true && super
end