Class: IntersightClient::ApplianceDeviceClaim

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/appliance_device_claim.rb

Overview

DeviceClaim managed object represents a user initiated claim request for claiming an endpoint device. There can be many DeviceClaim managed object for a given endpoint device when users claim and unclaim devices repeatedly. Claiming an endpoint device is a multi-step operation. The Intersight Appliance starts a workflow with multiple tasks to process the device claim request. The status of the device claim operation can be obtained from the claim workflow.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/intersight_client/models/appliance_device_claim.rb', line 157

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

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

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

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

  if attributes.key?(:'is_password_set')
    self.is_password_set = attributes[:'is_password_set']
  else
    self.is_password_set = false
  end

  if attributes.key?(:'is_renew')
    self.is_renew = attributes[:'is_renew']
  else
    self.is_renew = false
  end

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

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

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

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

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = 'started'
  end

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



58
59
60
 
# File 'lib/intersight_client/models/appliance_device_claim.rb', line 58

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

def class_id
  @class_id
end

#device_id ⇒ Object

Device identifier of the endpoint device.



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

def device_id
  @device_id
end

#hostname ⇒ Object

Hostname or IP address of the endpoint device the user wants to claim.



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

def hostname
  @hostname
end

#is_password_set ⇒ Object

Indicates whether the value of the ‘password’ property has been set.



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

def is_password_set
  @is_password_set
end

#is_renew ⇒ Object

Tracks if this device is to be claimed or certificate renewal.



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

def is_renew
  @is_renew
end

#message ⇒ Object

Message set by the device claim process.



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

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

def object_type
  @object_type
end

#password ⇒ Object

Password to be used to login to the endpoint device.



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

def password
  @password
end

#platform_type ⇒ Object

Platform type of the endpoint device. * “ - The device reported an empty or unrecognized platform type. * APIC - An Application Policy Infrastructure Controller cluster. * DCNM - A Data Center Network Manager instance. Data Center Network Manager (DCNM) is the network management platform for all NX-OS-enabled deployments, spanning new fabric architectures, IP Fabric for Media, and storage networking deployments for the Cisco Nexus-powered data center. * UCSFI - A UCS Fabric Interconnect in HA or standalone mode, which is being managed by UCS Manager (UCSM). * UCSFIISM - A UCS Fabric Interconnect in HA or standalone mode, managed directly by Intersight. * IMC - A standalone UCS Server Integrated Management Controller. * IMCM4 - A standalone UCS M4 Server. * IMCM5 - A standalone UCS M5 server. * IMCRack - A standalone UCS M6 and above server. * UCSIOM - An UCS Chassis IO module. * HX - A HyperFlex storage controller. * HyperFlexAP - A HyperFlex Application Platform. * IWE - An Intersight Workload Engine. * UCSD - A UCS Director virtual appliance. Cisco UCS Director automates, orchestrates, and manages Cisco and third-party hardware. * IntersightAppliance - A Cisco Intersight Connected Virtual Appliance. * IntersightAssist - A Cisco Intersight Assist. * PureStorageFlashArray - A Pure Storage FlashArray device. * UCSC890 - A standalone Cisco UCSC890 server. * NetAppOntap - A NetApp ONTAP storage system. * NetAppActiveIqUnifiedManager - A NetApp Active IQ Unified Manager. * EmcScaleIo - An EMC ScaleIO storage system. * EmcVmax - An EMC VMAX storage system. * EmcVplex - An EMC VPLEX storage system. * EmcXtremIo - An EMC XtremIO storage system. * VmwareVcenter - A VMware vCenter device that manages Virtual Machines. * MicrosoftHyperV - A Microsoft Hyper-V system that manages Virtual Machines. * AppDynamics - An AppDynamics controller that monitors applications. * Dynatrace - A software-intelligence monitoring platform that simplifies enterprise cloud complexity and accelerates digital transformation. * NewRelic - A software-intelligence monitoring platform that simplifies enterprise cloud complexity and accelerates digital transformation. * ServiceNow - A cloud-based workflow automation platform that enables enterprise organizations to improve operational efficiencies by streamlining and automating routine work tasks. * ReadHatOpenStack - An OpenStack target manages Virtual Machines, Physical Machines, Datacenters and Virtual Datacenters using different OpenStack services as administrative endpoints. * CloudFoundry - An open source cloud platform on which developers can build, deploy, run and scale applications. * MicrosoftAzureApplicationInsights - A feature of Azure Monitor, is an extensible Application Performance Management service for developers and DevOps professionals to monitor their live applications. * OpenStack - An OpenStack target manages Virtual Machines, Physical Machines, Datacenters and Virtual Datacenters using different OpenStack services as administrative endpoints. * MicrosoftSqlServer - A Microsoft SQL database server. * Kubernetes - A Kubernetes cluster that runs containerized applications. * AmazonWebService - A Amazon web service target that discovers and monitors different services like EC2. It discovers entities like VMs, Volumes, regions etc. and monitors attributes like Mem, CPU, cost. * AmazonWebServiceBilling - A Amazon web service billing target to retrieve billing information stored in S3 bucket. * MicrosoftAzureServicePrincipal - A Microsoft Azure Service Principal target that discovers all the associated Azure subscriptions. * MicrosoftAzureEnterpriseAgreement - A Microsoft Azure Enterprise Agreement target that discovers cost, billing and RIs. * DellCompellent - A Dell Compellent storage system. * HPE3Par - A HPE 3PAR storage system. * RedHatEnterpriseVirtualization - A Red Hat Enterprise Virtualization Hypervisor system that manages Virtual Machines. * NutanixAcropolis - A Nutanix Acropolis system that combines servers and storage into a distributed infrastructure platform. * HPEOneView - A HPE Oneview management system that manages compute, storage, and networking. * ServiceEngine - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications. * HitachiVirtualStoragePlatform - A Hitachi Virtual Storage Platform also referred to as Hitachi VSP. It includes various storage systems designed for data centers. * IMCBlade - An Intersight managed UCS Blade Server. * TerraformCloud - A Terraform Cloud account. * TerraformAgent - A Terraform Cloud Agent that Intersight will deploy in datacenter. The agent will execute Terraform plan for Terraform Cloud workspace configured to use the agent. * CustomTarget - An external endpoint added as Target that can be accessed through its HTTP API interface in Intersight Orchestrator automation workflow.Standard HTTP authentication scheme supported: Basic. * AnsibleEndpoint - An external endpoint added as Target that can be accessed through Ansible in Intersight Cloud Orchestrator automation workflow. * HTTPEndpoint - An external endpoint added as Target that can be accessed through its HTTP API interface in Intersight Orchestrator automation workflow.Standard HTTP authentication scheme supported: Basic, Bearer Token. * SSHEndpoint - An external endpoint added as Target that can be accessed through SSH in Intersight Cloud Orchestrator automation workflow. * CiscoCatalyst - A Cisco Catalyst networking switch device.



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

def platform_type
  @platform_type
end

#request_id ⇒ Object

User defined claim request identifier set by the UI. The RequestId field is not a mandatory. The Intersight Appliance will assign a unique value automatically if the field is not set.



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

def request_id
  @request_id
end

#reservation ⇒ Object

Returns the value of attribute reservation.



60
61
62
 
# File 'lib/intersight_client/models/appliance_device_claim.rb', line 60

def reservation
  @reservation
end

#security_token ⇒ Object

Device security token of the endpoint device.



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

def security_token
  @security_token
end

#status ⇒ Object

Status of the device claim process. * started - Device claim operation has started. * failed - Device claim operation has failed. * completed - Device claim operation has completed.



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

def status
  @status
end

#username ⇒ Object

Username to log in to the endpoint device.



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

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)



111
112
113
 
# File 'lib/intersight_client/models/appliance_device_claim.rb', line 111

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)



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

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.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/intersight_client/models/appliance_device_claim.rb', line 85

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'device_id' => :'DeviceId',
    :'hostname' => :'Hostname',
    :'is_password_set' => :'IsPasswordSet',
    :'is_renew' => :'IsRenew',
    :'message' => :'Message',
    :'password' => :'Password',
    :'platform_type' => :'PlatformType',
    :'request_id' => :'RequestId',
    :'security_token' => :'SecurityToken',
    :'status' => :'Status',
    :'username' => :'Username',
    :'account' => :'Account',
    :'reservation' => :'Reservation'
  }
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/appliance_device_claim.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)



143
144
145
146
147
148
 
# File 'lib/intersight_client/models/appliance_device_claim.rb', line 143

def self.openapi_all_of
  [
  :'ApplianceDeviceClaimAllOf',
  :'MoBaseMo'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



151
152
153
 
# File 'lib/intersight_client/models/appliance_device_claim.rb', line 151

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



137
138
139
140
 
# File 'lib/intersight_client/models/appliance_device_claim.rb', line 137

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

.openapi_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/intersight_client/models/appliance_device_claim.rb', line 116

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'device_id' => :'String',
    :'hostname' => :'String',
    :'is_password_set' => :'Boolean',
    :'is_renew' => :'Boolean',
    :'message' => :'String',
    :'password' => :'String',
    :'platform_type' => :'String',
    :'request_id' => :'String',
    :'security_token' => :'String',
    :'status' => :'String',
    :'username' => :'String',
    :'account' => :'IamAccountRelationship',
    :'reservation' => :'ResourceReservationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/intersight_client/models/appliance_device_claim.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 &&
      device_id == o.device_id &&
      hostname == o.hostname &&
      is_password_set == o.is_password_set &&
      is_renew == o.is_renew &&
      message == o.message &&
      password == o.password &&
      platform_type == o.platform_type &&
      request_id == o.request_id &&
      security_token == o.security_token &&
      status == o.status &&
      username == o.username &&
       == o. &&
      reservation == o.reservation && 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/appliance_device_claim.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/appliance_device_claim.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/appliance_device_claim.rb', line 361

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

def hash
  [class_id, object_type, device_id, hostname, is_password_set, is_renew, message, password, platform_type, request_id, security_token, status, username, , reservation].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



248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/intersight_client/models/appliance_device_claim.rb', line 248

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



432
433
434
 
# File 'lib/intersight_client/models/appliance_device_claim.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/appliance_device_claim.rb', line 438

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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/intersight_client/models/appliance_device_claim.rb', line 263

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["appliance.DeviceClaim"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["appliance.DeviceClaim"])
  return false unless object_type_validator.valid?(@object_type)
  platform_type_validator = EnumAttributeValidator.new('String', ["", "APIC", "DCNM", "UCSFI", "UCSFIISM", "IMC", "IMCM4", "IMCM5", "IMCRack", "UCSIOM", "HX", "HyperFlexAP", "IWE", "UCSD", "IntersightAppliance", "IntersightAssist", "PureStorageFlashArray", "UCSC890", "NetAppOntap", "NetAppActiveIqUnifiedManager", "EmcScaleIo", "EmcVmax", "EmcVplex", "EmcXtremIo", "VmwareVcenter", "MicrosoftHyperV", "AppDynamics", "Dynatrace", "NewRelic", "ServiceNow", "ReadHatOpenStack", "CloudFoundry", "MicrosoftAzureApplicationInsights", "OpenStack", "MicrosoftSqlServer", "Kubernetes", "AmazonWebService", "AmazonWebServiceBilling", "MicrosoftAzureServicePrincipal", "MicrosoftAzureEnterpriseAgreement", "DellCompellent", "HPE3Par", "RedHatEnterpriseVirtualization", "NutanixAcropolis", "HPEOneView", "ServiceEngine", "HitachiVirtualStoragePlatform", "IMCBlade", "TerraformCloud", "TerraformAgent", "CustomTarget", "AnsibleEndpoint", "HTTPEndpoint", "SSHEndpoint", "CiscoCatalyst"])
  return false unless platform_type_validator.valid?(@platform_type)
  status_validator = EnumAttributeValidator.new('String', ["started", "failed", "completed"])
  return false unless status_validator.valid?(@status)
  true && super
end