Class: IntersightClient::KvmSession

Inherits:
SessionAbstractSubSession show all
Defined in:
lib/intersight_client/models/kvm_session.rb

Overview

Virtual KVM Session that provides Single Sign-On access to the vKVM console of the server. The vKVM access can be direct or can be tunneled by specifying the tunnel to be used for the access.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from SessionAbstractSubSession

#session, #target, #target_name, #user

Attributes inherited from SessionAbstractSession

#client_ip_address, #end_time, #role, #status, #user_id_or_email

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

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



126
127
128
129
130
131
132
133
134
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
 
# File 'lib/intersight_client/models/kvm_session.rb', line 126

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

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

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

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

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

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

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

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

  if attributes.key?(:'tunnel')
    self.tunnel = attributes[:'tunnel']
  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/kvm_session.rb', line 20

def class_id
  @class_id
end

#device ⇒ Object

Returns the value of attribute device.



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

def device
  @device
end

#kvm_launch_url_path ⇒ Object

One time URL that is used to launch the KVM console.



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

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

def object_type
  @object_type
end

#one_time_password ⇒ Object

Temporary one-time password for vKVM access.



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

def one_time_password
  @one_time_password
end

#server ⇒ Object

Returns the value of attribute server.



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

def server
  @server
end

#sso_supported ⇒ Object

Indicates if vKVM SSO is supported on the server.



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

def sso_supported
  @sso_supported
end

#tunnel ⇒ Object

Returns the value of attribute tunnel.



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

def tunnel
  @tunnel
end

#username ⇒ Object

Username used for vKVM access.



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

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



86
87
88
 
# File 'lib/intersight_client/models/kvm_session.rb', line 86

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)



81
82
83
 
# File 'lib/intersight_client/models/kvm_session.rb', line 81

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.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/intersight_client/models/kvm_session.rb', line 66

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'kvm_launch_url_path' => :'KvmLaunchUrlPath',
    :'one_time_password' => :'OneTimePassword',
    :'sso_supported' => :'SsoSupported',
    :'username' => :'Username',
    :'device' => :'Device',
    :'server' => :'Server',
    :'tunnel' => :'Tunnel'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



261
262
263
 
# File 'lib/intersight_client/models/kvm_session.rb', line 261

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'KvmSessionAllOf',
  :'SessionAbstractSubSession'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



120
121
122
 
# File 'lib/intersight_client/models/kvm_session.rb', line 120

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/intersight_client/models/kvm_session.rb', line 91

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'kvm_launch_url_path' => :'String',
    :'one_time_password' => :'String',
    :'sso_supported' => :'Boolean',
    :'username' => :'String',
    :'device' => :'AssetDeviceRegistrationRelationship',
    :'server' => :'ComputePhysicalRelationship',
    :'tunnel' => :'KvmTunnelRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      kvm_launch_url_path == o.kvm_launch_url_path &&
      one_time_password == o.one_time_password &&
      sso_supported == o.sso_supported &&
      username == o.username &&
      device == o.device &&
      server == o.server &&
      tunnel == o.tunnel && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/intersight_client/models/kvm_session.rb', line 292

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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/intersight_client/models/kvm_session.rb', line 363

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/intersight_client/models/kvm_session.rb', line 268

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


248
249
250
 
# File 'lib/intersight_client/models/kvm_session.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



254
255
256
 
# File 'lib/intersight_client/models/kvm_session.rb', line 254

def hash
  [class_id, object_type, kvm_launch_url_path, one_time_password, sso_supported, username, device, server, tunnel].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



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/intersight_client/models/kvm_session.rb', line 185

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:

  • Returns the object in the form of hash



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

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/intersight_client/models/kvm_session.rb', line 345

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



333
334
335
 
# File 'lib/intersight_client/models/kvm_session.rb', line 333

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • true if the model is valid



200
201
202
203
204
205
206
207
208
 
# File 'lib/intersight_client/models/kvm_session.rb', line 200

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["kvm.Session"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["kvm.Session"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end