Class: IntersightClient::ComputeIpAddress

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/compute_ip_address.rb

Overview

Complex type representing an IP address in UCSM.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ComputeIpAddress

Initializes the object



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

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

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

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

  if attributes.key?(:'category')
    self.category = attributes[:'category']
  else
    self.category = 'Equipment'
  end

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

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

  if attributes.key?(:'http_port')
    self.http_port = attributes[:'http_port']
  else
    self.http_port = 80
  end

  if attributes.key?(:'https_port')
    self.https_port = attributes[:'https_port']
  else
    self.https_port = 443
  end

  if attributes.key?(:'kvm_port')
    self.kvm_port = attributes[:'kvm_port']
  else
    self.kvm_port = 2068
  end

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

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = 'Outband'
  end

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

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

Instance Attribute Details

#address ⇒ Object

IP Address to be used for KVM.



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

def address
  @address
end

#category ⇒ Object

Category of the Kvm IP Address. * ‘Equipment` - Ip Address assigned to an equipment. * `ServiceProfile` - Ip Address assigned to a Service Profile.



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

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

def class_id
  @class_id
end

#default_gateway ⇒ Object

Default gateway property of KVM IP Address.



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

def default_gateway
  @default_gateway
end

#dn ⇒ Object

The distinguished name for this managed object.



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

def dn
  @dn
end

#http_port ⇒ Object

HTTP port of an IP Address.



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

def http_port
  @http_port
end

#https_port ⇒ Object

Secured HTTP port of an IP Address.



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

def https_port
  @https_port
end

#kvm_port ⇒ Object

Port number on which the KVM is running and used for connecting to KVM console.



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

def kvm_port
  @kvm_port
end

#kvm_vlan ⇒ Object

VLAN Identifier of Inband IP Address.



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

def kvm_vlan
  @kvm_vlan
end

#name ⇒ Object

Name to identify the KVM IP Address. * ‘Outband` - The user assigned Out of band IP Address. * `Inband` - The user assigned Inband IP Address.



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

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

def object_type
  @object_type
end

#subnet ⇒ Object

Subnet detail of a KVM IP Address.



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

def subnet
  @subnet
end

#type ⇒ Object

Type of the KVM IP Address. * ‘MgmtInterface` - Ip Address of a Management Interface. * `VnicIpV4StaticAddr` - Static Ipv4 Address of a Virtual Network Interface. * `VnicIpV4PooledAddr` - Ipv4 Address of a Virtual Network Interface from an address pool. * `VnicIpV4MgmtPooledAddr` - Ipv4 Address of a Virtual Network Interface from a Managed address pool. * `VnicIpV6StaticAddr` - Static Ipv6 Address of a Virtual Network Interface. * `VnicIpV6MgmtPooledAddr` - Ipv6 Address of a Virtual Network Interface from a Managed address pool. * `VnicIpV4ProfDerivedAddr` - Server Profile derived Ipv4 Address of a Virtual Network Interface. * `MgmtIpV6ProfDerivedAddr` - Server Profile derived Ipv6 Address used for accessing server management services.



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

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



105
106
107
 
# File 'lib/intersight_client/models/compute_ip_address.rb', line 105

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)



100
101
102
 
# File 'lib/intersight_client/models/compute_ip_address.rb', line 100

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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'address' => :'Address',
    :'category' => :'Category',
    :'default_gateway' => :'DefaultGateway',
    :'dn' => :'Dn',
    :'http_port' => :'HttpPort',
    :'https_port' => :'HttpsPort',
    :'kvm_port' => :'KvmPort',
    :'kvm_vlan' => :'KvmVlan',
    :'name' => :'Name',
    :'subnet' => :'Subnet',
    :'type' => :'Type'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



352
353
354
 
# File 'lib/intersight_client/models/compute_ip_address.rb', line 352

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/compute_ip_address.rb', line 135

def self.openapi_all_of
  [
  :'ComputeIpAddressAllOf',
  :'MoBaseComplexType'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



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

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'address' => :'String',
    :'category' => :'String',
    :'default_gateway' => :'String',
    :'dn' => :'String',
    :'http_port' => :'Integer',
    :'https_port' => :'Integer',
    :'kvm_port' => :'Integer',
    :'kvm_vlan' => :'Integer',
    :'name' => :'String',
    :'subnet' => :'String',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      address == o.address &&
      category == o.category &&
      default_gateway == o.default_gateway &&
      dn == o.dn &&
      http_port == o.http_port &&
      https_port == o.https_port &&
      kvm_port == o.kvm_port &&
      kvm_vlan == o.kvm_vlan &&
      name == o.name &&
      subnet == o.subnet &&
      type == o.type && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/intersight_client/models/compute_ip_address.rb', line 383

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



454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/intersight_client/models/compute_ip_address.rb', line 454

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



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

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

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


339
340
341
 
# File 'lib/intersight_client/models/compute_ip_address.rb', line 339

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



345
346
347
 
# File 'lib/intersight_client/models/compute_ip_address.rb', line 345

def hash
  [class_id, object_type, address, category, default_gateway, dn, http_port, https_port, kvm_port, kvm_vlan, name, subnet, type].hash
end

#list_invalid_properties ⇒ Object

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



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

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)



430
431
432
 
# File 'lib/intersight_client/models/compute_ip_address.rb', line 430

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/intersight_client/models/compute_ip_address.rb', line 436

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



424
425
426
 
# File 'lib/intersight_client/models/compute_ip_address.rb', line 424

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["compute.IpAddress"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["compute.IpAddress"])
  return false unless object_type_validator.valid?(@object_type)
  category_validator = EnumAttributeValidator.new('String', ["Equipment", "ServiceProfile"])
  return false unless category_validator.valid?(@category)
  name_validator = EnumAttributeValidator.new('String', ["Outband", "Inband"])
  return false unless name_validator.valid?(@name)
  type_validator = EnumAttributeValidator.new('String', ["MgmtInterface", "VnicIpV4StaticAddr", "VnicIpV4PooledAddr", "VnicIpV4MgmtPooledAddr", "VnicIpV6StaticAddr", "VnicIpV6MgmtPooledAddr", "VnicIpV4ProfDerivedAddr", "MgmtIpV6ProfDerivedAddr"])
  return false unless type_validator.valid?(@type)
  true && super
end