Class: IntersightClient::StorageHitachiHost

Inherits:
StorageBaseHost show all
Defined in:
lib/intersight_client/models/storage_hitachi_host.rb

Overview

A host group entity in Hitachi storage array. It is an abstraction used by Hitachi storage to organize the storage network addresses (Fibre Channel worldwide names or iSCSI qualified names) of client computers and to control communications between clients and volumes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from StorageBaseHost

#description, #initiators, #name, #os_type, #storage_utilization

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
229
230
231
232
233
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 152

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

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

  if attributes.key?(:'authentication_mode')
    self.authentication_mode = attributes[:'authentication_mode']
  else
    self.authentication_mode = 'N/A'
  end

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

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

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

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

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'FC'
  end

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

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

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

Instance Attribute Details

#array ⇒ Object

Returns the value of attribute array.



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

def array
  @array
end

#authentication_mode ⇒ Object

Authentication mode for the iSCSI target. * ‘N/A` - Authentication Mode is not available. * `CHAP` - CHAP-authentication mode. * `NONE` - Authentication mode is not set. * `BOTH` - Comply with Host Setting.



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

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

def class_id
  @class_id
end

#host_group_id ⇒ Object

ID of the host group.



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

def host_group_id
  @host_group_id
end

#host_group_number ⇒ Object

Host group number for this host.



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

def host_group_number
  @host_group_number
end

#host_mode_options ⇒ Object

Returns the value of attribute host_mode_options.



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

def host_mode_options
  @host_mode_options
end

#is_chap_mutual ⇒ Object

Mutual CHAP setting that is Enabled or Disabled.



37
38
39
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 37

def is_chap_mutual
  @is_chap_mutual
end

#iscsi_name ⇒ Object

IQN (iSCSI qualified name). Can be up to 255 characters long.



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

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

def object_type
  @object_type
end

#port_id ⇒ Object

Port ID of the host group.



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

def port_id
  @port_id
end

#port_lun_security ⇒ Object

LUN security setting for the port.



46
47
48
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 46

def port_lun_security
  @port_lun_security
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



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

def registered_device
  @registered_device
end

#type ⇒ Object

Host Group type, it can be FC or iSCSI. * ‘FC` - Port supports fibre channel protocol. * `iSCSI` - Port supports iSCSI protocol. * `FCoE` - Port supports fibre channel over ethernet protocol.



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

def type
  @type
end

#wwn ⇒ Object

World wide port name, 64 bit address represented in hexa decimal notation.



52
53
54
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 52

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



106
107
108
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 106

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)



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

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.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 81

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'authentication_mode' => :'AuthenticationMode',
    :'host_group_id' => :'HostGroupId',
    :'host_group_number' => :'HostGroupNumber',
    :'host_mode_options' => :'HostModeOptions',
    :'is_chap_mutual' => :'IsChapMutual',
    :'iscsi_name' => :'IscsiName',
    :'port_id' => :'PortId',
    :'port_lun_security' => :'PortLunSecurity',
    :'type' => :'Type',
    :'wwn' => :'Wwn',
    :'array' => :'Array',
    :'registered_device' => :'RegisteredDevice'
  }
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



342
343
344
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 342

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



138
139
140
141
142
143
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 138

def self.openapi_all_of
  [
  :'StorageBaseHost',
  :'StorageHitachiHostAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



146
147
148
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 146

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



131
132
133
134
135
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 131

def self.openapi_nullable
  Set.new([
    :'host_mode_options',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 111

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'authentication_mode' => :'String',
    :'host_group_id' => :'String',
    :'host_group_number' => :'Integer',
    :'host_mode_options' => :'Array<Integer>',
    :'is_chap_mutual' => :'Boolean',
    :'iscsi_name' => :'String',
    :'port_id' => :'String',
    :'port_lun_security' => :'Boolean',
    :'type' => :'String',
    :'wwn' => :'String',
    :'array' => :'StorageHitachiArrayRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 308

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      authentication_mode == o.authentication_mode &&
      host_group_id == o.host_group_id &&
      host_group_number == o.host_group_number &&
      host_mode_options == o.host_mode_options &&
      is_chap_mutual == o.is_chap_mutual &&
      iscsi_name == o.iscsi_name &&
      port_id == o.port_id &&
      port_lun_security == o.port_lun_security &&
      type == o.type &&
      wwn == o.wwn &&
      array == o.array &&
      registered_device == o.registered_device && 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



373
374
375
376
377
378
379
380
381
382
383
384
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
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 373

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



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 444

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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 349

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


329
330
331
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



335
336
337
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 335

def hash
  [class_id, object_type, authentication_mode, host_group_id, host_group_number, host_mode_options, is_chap_mutual, iscsi_name, port_id, port_lun_security, type, wwn, array, registered_device].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



237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 237

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

  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



420
421
422
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 420

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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 426

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



414
415
416
 
# File 'lib/intersight_client/models/storage_hitachi_host.rb', line 414

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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["storage.HitachiHost"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["storage.HitachiHost"])
  return false unless object_type_validator.valid?(@object_type)
  authentication_mode_validator = EnumAttributeValidator.new('String', ["N/A", "CHAP", "NONE", "BOTH"])
  return false unless authentication_mode_validator.valid?(@authentication_mode)
  type_validator = EnumAttributeValidator.new('String', ["FC", "iSCSI", "FCoE"])
  return false unless type_validator.valid?(@type)
  true && super
end