Class: OCI::Ocvp::Models::Sddc

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ocvp/models/sddc.rb

Overview

An Oracle Cloud VMware Solution software-defined data center (SDDC) contains the resources required for a functional VMware environment. Instances in an SDDC (see EsxiHost) run in a virtual cloud network (VCN) and are preconfigured with VMware and storage. Use the vCenter utility to manage and deploy VMware virtual machines (VMs) in the SDDC.

The SDDC uses a single management subnet for provisioning the SDDC. It also uses a set of VLANs for various components of the VMware environment (vSphere, vMotion, vSAN, and so on). See the Core Services API for information about VCN subnets and VLANs.

Constant Summary collapse

HCX_MODE_ENUM = 
[
  HCX_MODE_DISABLED = 'DISABLED'.freeze,
  HCX_MODE_ADVANCED = 'ADVANCED'.freeze,
  HCX_MODE_ENTERPRISE = 'ENTERPRISE'.freeze,
  HCX_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Sddc

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/oci/ocvp/models/sddc.rb', line 353

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.vmware_software_version = attributes[:'vmwareSoftwareVersion'] if attributes[:'vmwareSoftwareVersion']

  raise 'You cannot provide both :vmwareSoftwareVersion and :vmware_software_version' if attributes.key?(:'vmwareSoftwareVersion') && attributes.key?(:'vmware_software_version')

  self.vmware_software_version = attributes[:'vmware_software_version'] if attributes[:'vmware_software_version']

  self.esxi_software_version = attributes[:'esxiSoftwareVersion'] if attributes[:'esxiSoftwareVersion']

  raise 'You cannot provide both :esxiSoftwareVersion and :esxi_software_version' if attributes.key?(:'esxiSoftwareVersion') && attributes.key?(:'esxi_software_version')

  self.esxi_software_version = attributes[:'esxi_software_version'] if attributes[:'esxi_software_version']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.clusters_count = attributes[:'clustersCount'] if attributes[:'clustersCount']

  raise 'You cannot provide both :clustersCount and :clusters_count' if attributes.key?(:'clustersCount') && attributes.key?(:'clusters_count')

  self.clusters_count = attributes[:'clusters_count'] if attributes[:'clusters_count']

  self.vcenter_fqdn = attributes[:'vcenterFqdn'] if attributes[:'vcenterFqdn']

  raise 'You cannot provide both :vcenterFqdn and :vcenter_fqdn' if attributes.key?(:'vcenterFqdn') && attributes.key?(:'vcenter_fqdn')

  self.vcenter_fqdn = attributes[:'vcenter_fqdn'] if attributes[:'vcenter_fqdn']

  self.nsx_manager_fqdn = attributes[:'nsxManagerFqdn'] if attributes[:'nsxManagerFqdn']

  raise 'You cannot provide both :nsxManagerFqdn and :nsx_manager_fqdn' if attributes.key?(:'nsxManagerFqdn') && attributes.key?(:'nsx_manager_fqdn')

  self.nsx_manager_fqdn = attributes[:'nsx_manager_fqdn'] if attributes[:'nsx_manager_fqdn']

  self.vcenter_private_ip_id = attributes[:'vcenterPrivateIpId'] if attributes[:'vcenterPrivateIpId']

  raise 'You cannot provide both :vcenterPrivateIpId and :vcenter_private_ip_id' if attributes.key?(:'vcenterPrivateIpId') && attributes.key?(:'vcenter_private_ip_id')

  self.vcenter_private_ip_id = attributes[:'vcenter_private_ip_id'] if attributes[:'vcenter_private_ip_id']

  self.nsx_manager_private_ip_id = attributes[:'nsxManagerPrivateIpId'] if attributes[:'nsxManagerPrivateIpId']

  raise 'You cannot provide both :nsxManagerPrivateIpId and :nsx_manager_private_ip_id' if attributes.key?(:'nsxManagerPrivateIpId') && attributes.key?(:'nsx_manager_private_ip_id')

  self.nsx_manager_private_ip_id = attributes[:'nsx_manager_private_ip_id'] if attributes[:'nsx_manager_private_ip_id']

  self.vcenter_username = attributes[:'vcenterUsername'] if attributes[:'vcenterUsername']

  raise 'You cannot provide both :vcenterUsername and :vcenter_username' if attributes.key?(:'vcenterUsername') && attributes.key?(:'vcenter_username')

  self.vcenter_username = attributes[:'vcenter_username'] if attributes[:'vcenter_username']

  self.nsx_manager_username = attributes[:'nsxManagerUsername'] if attributes[:'nsxManagerUsername']

  raise 'You cannot provide both :nsxManagerUsername and :nsx_manager_username' if attributes.key?(:'nsxManagerUsername') && attributes.key?(:'nsx_manager_username')

  self.nsx_manager_username = attributes[:'nsx_manager_username'] if attributes[:'nsx_manager_username']

  self.ssh_authorized_keys = attributes[:'sshAuthorizedKeys'] if attributes[:'sshAuthorizedKeys']

  raise 'You cannot provide both :sshAuthorizedKeys and :ssh_authorized_keys' if attributes.key?(:'sshAuthorizedKeys') && attributes.key?(:'ssh_authorized_keys')

  self.ssh_authorized_keys = attributes[:'ssh_authorized_keys'] if attributes[:'ssh_authorized_keys']

  self.nsx_edge_uplink_ip_id = attributes[:'nsxEdgeUplinkIpId'] if attributes[:'nsxEdgeUplinkIpId']

  raise 'You cannot provide both :nsxEdgeUplinkIpId and :nsx_edge_uplink_ip_id' if attributes.key?(:'nsxEdgeUplinkIpId') && attributes.key?(:'nsx_edge_uplink_ip_id')

  self.nsx_edge_uplink_ip_id = attributes[:'nsx_edge_uplink_ip_id'] if attributes[:'nsx_edge_uplink_ip_id']

  self.hcx_private_ip_id = attributes[:'hcxPrivateIpId'] if attributes[:'hcxPrivateIpId']

  raise 'You cannot provide both :hcxPrivateIpId and :hcx_private_ip_id' if attributes.key?(:'hcxPrivateIpId') && attributes.key?(:'hcx_private_ip_id')

  self.hcx_private_ip_id = attributes[:'hcx_private_ip_id'] if attributes[:'hcx_private_ip_id']

  self.hcx_fqdn = attributes[:'hcxFqdn'] if attributes[:'hcxFqdn']

  raise 'You cannot provide both :hcxFqdn and :hcx_fqdn' if attributes.key?(:'hcxFqdn') && attributes.key?(:'hcx_fqdn')

  self.hcx_fqdn = attributes[:'hcx_fqdn'] if attributes[:'hcx_fqdn']

  self.hcx_mode = attributes[:'hcxMode'] if attributes[:'hcxMode']

  raise 'You cannot provide both :hcxMode and :hcx_mode' if attributes.key?(:'hcxMode') && attributes.key?(:'hcx_mode')

  self.hcx_mode = attributes[:'hcx_mode'] if attributes[:'hcx_mode']

  self.initial_configuration = attributes[:'initialConfiguration'] if attributes[:'initialConfiguration']

  raise 'You cannot provide both :initialConfiguration and :initial_configuration' if attributes.key?(:'initialConfiguration') && attributes.key?(:'initial_configuration')

  self.initial_configuration = attributes[:'initial_configuration'] if attributes[:'initial_configuration']

  self.is_hcx_pending_downgrade = attributes[:'isHcxPendingDowngrade'] unless attributes[:'isHcxPendingDowngrade'].nil?
  self.is_hcx_pending_downgrade = false if is_hcx_pending_downgrade.nil? && !attributes.key?(:'isHcxPendingDowngrade') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isHcxPendingDowngrade and :is_hcx_pending_downgrade' if attributes.key?(:'isHcxPendingDowngrade') && attributes.key?(:'is_hcx_pending_downgrade')

  self.is_hcx_pending_downgrade = attributes[:'is_hcx_pending_downgrade'] unless attributes[:'is_hcx_pending_downgrade'].nil?
  self.is_hcx_pending_downgrade = false if is_hcx_pending_downgrade.nil? && !attributes.key?(:'isHcxPendingDowngrade') && !attributes.key?(:'is_hcx_pending_downgrade') # rubocop:disable Style/StringLiterals

  self.hcx_on_prem_licenses = attributes[:'hcxOnPremLicenses'] if attributes[:'hcxOnPremLicenses']

  raise 'You cannot provide both :hcxOnPremLicenses and :hcx_on_prem_licenses' if attributes.key?(:'hcxOnPremLicenses') && attributes.key?(:'hcx_on_prem_licenses')

  self.hcx_on_prem_licenses = attributes[:'hcx_on_prem_licenses'] if attributes[:'hcx_on_prem_licenses']

  self.time_hcx_billing_cycle_end = attributes[:'timeHcxBillingCycleEnd'] if attributes[:'timeHcxBillingCycleEnd']

  raise 'You cannot provide both :timeHcxBillingCycleEnd and :time_hcx_billing_cycle_end' if attributes.key?(:'timeHcxBillingCycleEnd') && attributes.key?(:'time_hcx_billing_cycle_end')

  self.time_hcx_billing_cycle_end = attributes[:'time_hcx_billing_cycle_end'] if attributes[:'time_hcx_billing_cycle_end']

  self.time_hcx_license_status_updated = attributes[:'timeHcxLicenseStatusUpdated'] if attributes[:'timeHcxLicenseStatusUpdated']

  raise 'You cannot provide both :timeHcxLicenseStatusUpdated and :time_hcx_license_status_updated' if attributes.key?(:'timeHcxLicenseStatusUpdated') && attributes.key?(:'time_hcx_license_status_updated')

  self.time_hcx_license_status_updated = attributes[:'time_hcx_license_status_updated'] if attributes[:'time_hcx_license_status_updated']

  self.is_single_host_sddc = attributes[:'isSingleHostSddc'] unless attributes[:'isSingleHostSddc'].nil?
  self.is_single_host_sddc = false if is_single_host_sddc.nil? && !attributes.key?(:'isSingleHostSddc') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isSingleHostSddc and :is_single_host_sddc' if attributes.key?(:'isSingleHostSddc') && attributes.key?(:'is_single_host_sddc')

  self.is_single_host_sddc = attributes[:'is_single_host_sddc'] unless attributes[:'is_single_host_sddc'].nil?
  self.is_single_host_sddc = false if is_single_host_sddc.nil? && !attributes.key?(:'isSingleHostSddc') && !attributes.key?(:'is_single_host_sddc') # rubocop:disable Style/StringLiterals

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']
end

Instance Attribute Details

#clusters_count ⇒ Integer

[Required] The number of Clusters in the SDDC.

Returns:

  • (Integer) 


95
96
97
 
# File 'lib/oci/ocvp/models/sddc.rb', line 95

def clusters_count
  @clusters_count
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the SDDC.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/ocvp/models/sddc.rb', line 91

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


245
246
247
 
# File 'lib/oci/ocvp/models/sddc.rb', line 245

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A descriptive name for the SDDC. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/ocvp/models/sddc.rb', line 48

def display_name
  @display_name
end

#esxi_software_version ⇒ String

In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see list_supported_vmware_software_versions).

This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this SDDC in the future with create_esxi_host unless a different version is configured on the Cluster or ESXi host level.

Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer version of bundled ESXi software supported by the Oracle Cloud VMware Solution, you should use update_sddc to update the SDDC's vmwareSoftwareVersion with that new version.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/ocvp/models/sddc.rb', line 85

def esxi_software_version
  @esxi_software_version
end

#freeform_tags ⇒ Hash<String, String>

[Required] Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


237
238
239
 
# File 'lib/oci/ocvp/models/sddc.rb', line 237

def freeform_tags
  @freeform_tags
end

#hcx_fqdn ⇒ String

The FQDN for HCX Manager.

Example: hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com

Returns:

  • (String) 


174
175
176
 
# File 'lib/oci/ocvp/models/sddc.rb', line 174

def hcx_fqdn
  @hcx_fqdn
end

#hcx_mode ⇒ String

[Required] HCX configuration of the SDDC.

Returns:

  • (String) 


179
180
181
 
# File 'lib/oci/ocvp/models/sddc.rb', line 179

def hcx_mode
  @hcx_mode
end

#hcx_on_prem_licenses ⇒ Array<OCI::Ocvp::Models::HcxLicenseSummary>

The activation licenses to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution.

Returns:



192
193
194
 
# File 'lib/oci/ocvp/models/sddc.rb', line 192

def hcx_on_prem_licenses
  @hcx_on_prem_licenses
end

#hcx_private_ip_id ⇒ String

The OCID of the PrivateIp object that is the virtual IP (VIP) for HCX Manager. For information about PrivateIp objects, see the Core Services API.

Returns:

  • (String) 


167
168
169
 
# File 'lib/oci/ocvp/models/sddc.rb', line 167

def hcx_private_ip_id
  @hcx_private_ip_id
end

#id ⇒ String

[Required] The OCID of the SDDC.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/ocvp/models/sddc.rb', line 41

def id
  @id
end

#initial_configuration ⇒ OCI::Ocvp::Models::InitialConfiguration

This attribute is required.

Returns:



183
184
185
 
# File 'lib/oci/ocvp/models/sddc.rb', line 183

def initial_configuration
  @initial_configuration
end

#is_hcx_pending_downgrade ⇒ BOOLEAN

Indicates whether SDDC is pending downgrade from HCX Enterprise to HCX Advanced.

Returns:

  • (BOOLEAN) 


187
188
189
 
# File 'lib/oci/ocvp/models/sddc.rb', line 187

def is_hcx_pending_downgrade
  @is_hcx_pending_downgrade
end

#is_single_host_sddc ⇒ BOOLEAN

Indicates whether this SDDC is designated for only single ESXi host.

Returns:

  • (BOOLEAN) 


211
212
213
 
# File 'lib/oci/ocvp/models/sddc.rb', line 211

def is_single_host_sddc
  @is_single_host_sddc
end

#lifecycle_state ⇒ String

The current state of the SDDC.

Returns:

  • (String) 


229
230
231
 
# File 'lib/oci/ocvp/models/sddc.rb', line 229

def lifecycle_state
  @lifecycle_state
end

#nsx_edge_uplink_ip_id ⇒ String

The OCID of the PrivateIp object that is the virtual IP (VIP) for the NSX Edge Uplink. Use this OCID as the route target for route table rules when setting up connectivity between the SDDC and other networks. For information about PrivateIp objects, see the Core Services API.

Returns:

  • (String) 


160
161
162
 
# File 'lib/oci/ocvp/models/sddc.rb', line 160

def nsx_edge_uplink_ip_id
  @nsx_edge_uplink_ip_id
end

#nsx_manager_fqdn ⇒ String

[Required] The FQDN for NSX Manager.

Example: nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/ocvp/models/sddc.rb', line 109

def nsx_manager_fqdn
  @nsx_manager_fqdn
end

#nsx_manager_private_ip_id ⇒ String

[Required] The OCID of the PrivateIp object that is the virtual IP (VIP) for NSX Manager. For information about PrivateIp objects, see the Core Services API.

Returns:

  • (String) 


123
124
125
 
# File 'lib/oci/ocvp/models/sddc.rb', line 123

def nsx_manager_private_ip_id
  @nsx_manager_private_ip_id
end

#nsx_manager_username ⇒ String

The SDDC includes an administrator username and initial password for NSX Manager. You can change this initial username to a different value in NSX Manager.

Returns:

  • (String) 


135
136
137
 
# File 'lib/oci/ocvp/models/sddc.rb', line 135

def nsx_manager_username
  @nsx_manager_username
end

#ssh_authorized_keys ⇒ String

[Required] One or more public SSH keys to be included in the ~/.ssh/authorized_keys file for the default user on each ESXi host. Use a newline character to separate multiple keys. The SSH keys must be in the format required for the authorized_keys file.

This attribute is not guaranteed to reflect the public SSH keys currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the public SSH keys that Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this SDDC in the future with create_esxi_host.

Therefore, if you upgrade the existing ESXi hosts in the SDDC to use different SSH keys, you should use update_sddc to update the SDDC's sshAuthorizedKeys with the new public keys.

Returns:

  • (String) 


152
153
154
 
# File 'lib/oci/ocvp/models/sddc.rb', line 152

def ssh_authorized_keys
  @ssh_authorized_keys
end

#time_created ⇒ DateTime

[Required] The date and time the SDDC was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


219
220
221
 
# File 'lib/oci/ocvp/models/sddc.rb', line 219

def time_created
  @time_created
end

#time_hcx_billing_cycle_end ⇒ DateTime

The date and time current HCX Enterprise billing cycle ends, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


199
200
201
 
# File 'lib/oci/ocvp/models/sddc.rb', line 199

def time_hcx_billing_cycle_end
  @time_hcx_billing_cycle_end
end

#time_hcx_license_status_updated ⇒ DateTime

The date and time the SDDC's HCX on-premise license status was updated, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


207
208
209
 
# File 'lib/oci/ocvp/models/sddc.rb', line 207

def time_hcx_license_status_updated
  @time_hcx_license_status_updated
end

#time_updated ⇒ DateTime

The date and time the SDDC was updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


225
226
227
 
# File 'lib/oci/ocvp/models/sddc.rb', line 225

def time_updated
  @time_updated
end

#vcenter_fqdn ⇒ String

[Required] The FQDN for vCenter.

Example: vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com

Returns:

  • (String) 


102
103
104
 
# File 'lib/oci/ocvp/models/sddc.rb', line 102

def vcenter_fqdn
  @vcenter_fqdn
end

#vcenter_private_ip_id ⇒ String

[Required] The OCID of the PrivateIp object that is the virtual IP (VIP) for vCenter. For information about PrivateIp objects, see the Core Services API.

Returns:

  • (String) 


116
117
118
 
# File 'lib/oci/ocvp/models/sddc.rb', line 116

def vcenter_private_ip_id
  @vcenter_private_ip_id
end

#vcenter_username ⇒ String

The SDDC includes an administrator username and password for vCenter. You can change this initial username to a different value in vCenter.

Returns:

  • (String) 


129
130
131
 
# File 'lib/oci/ocvp/models/sddc.rb', line 129

def vcenter_username
  @vcenter_username
end

#vmware_software_version ⇒ String

[Required] In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see list_supported_vmware_software_versions).

This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this SDDC in the future with create_esxi_host.

Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer version of bundled VMware software supported by the Oracle Cloud VMware Solution, you should use update_sddc to update the SDDC's vmwareSoftwareVersion with that new version.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/ocvp/models/sddc.rb', line 66

def vmware_software_version
  @vmware_software_version
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/oci/ocvp/models/sddc.rb', line 248

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'vmware_software_version': :'vmwareSoftwareVersion',
    'esxi_software_version': :'esxiSoftwareVersion',
    'compartment_id': :'compartmentId',
    'clusters_count': :'clustersCount',
    'vcenter_fqdn': :'vcenterFqdn',
    'nsx_manager_fqdn': :'nsxManagerFqdn',
    'vcenter_private_ip_id': :'vcenterPrivateIpId',
    'nsx_manager_private_ip_id': :'nsxManagerPrivateIpId',
    'vcenter_username': :'vcenterUsername',
    'nsx_manager_username': :'nsxManagerUsername',
    'ssh_authorized_keys': :'sshAuthorizedKeys',
    'nsx_edge_uplink_ip_id': :'nsxEdgeUplinkIpId',
    'hcx_private_ip_id': :'hcxPrivateIpId',
    'hcx_fqdn': :'hcxFqdn',
    'hcx_mode': :'hcxMode',
    'initial_configuration': :'initialConfiguration',
    'is_hcx_pending_downgrade': :'isHcxPendingDowngrade',
    'hcx_on_prem_licenses': :'hcxOnPremLicenses',
    'time_hcx_billing_cycle_end': :'timeHcxBillingCycleEnd',
    'time_hcx_license_status_updated': :'timeHcxLicenseStatusUpdated',
    'is_single_host_sddc': :'isSingleHostSddc',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



284
285
286
287
288
289
290
291
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
 
# File 'lib/oci/ocvp/models/sddc.rb', line 284

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'vmware_software_version': :'String',
    'esxi_software_version': :'String',
    'compartment_id': :'String',
    'clusters_count': :'Integer',
    'vcenter_fqdn': :'String',
    'nsx_manager_fqdn': :'String',
    'vcenter_private_ip_id': :'String',
    'nsx_manager_private_ip_id': :'String',
    'vcenter_username': :'String',
    'nsx_manager_username': :'String',
    'ssh_authorized_keys': :'String',
    'nsx_edge_uplink_ip_id': :'String',
    'hcx_private_ip_id': :'String',
    'hcx_fqdn': :'String',
    'hcx_mode': :'String',
    'initial_configuration': :'OCI::Ocvp::Models::InitialConfiguration',
    'is_hcx_pending_downgrade': :'BOOLEAN',
    'hcx_on_prem_licenses': :'Array<OCI::Ocvp::Models::HcxLicenseSummary>',
    'time_hcx_billing_cycle_end': :'DateTime',
    'time_hcx_license_status_updated': :'DateTime',
    'is_single_host_sddc': :'BOOLEAN',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/oci/ocvp/models/sddc.rb', line 561

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    vmware_software_version == other.vmware_software_version &&
    esxi_software_version == other.esxi_software_version &&
    compartment_id == other.compartment_id &&
    clusters_count == other.clusters_count &&
    vcenter_fqdn == other.vcenter_fqdn &&
    nsx_manager_fqdn == other.nsx_manager_fqdn &&
    vcenter_private_ip_id == other.vcenter_private_ip_id &&
    nsx_manager_private_ip_id == other.nsx_manager_private_ip_id &&
    vcenter_username == other.vcenter_username &&
    nsx_manager_username == other.nsx_manager_username &&
    ssh_authorized_keys == other.ssh_authorized_keys &&
    nsx_edge_uplink_ip_id == other.nsx_edge_uplink_ip_id &&
    hcx_private_ip_id == other.hcx_private_ip_id &&
    hcx_fqdn == other.hcx_fqdn &&
    hcx_mode == other.hcx_mode &&
    initial_configuration == other.initial_configuration &&
    is_hcx_pending_downgrade == other.is_hcx_pending_downgrade &&
    hcx_on_prem_licenses == other.hcx_on_prem_licenses &&
    time_hcx_billing_cycle_end == other.time_hcx_billing_cycle_end &&
    time_hcx_license_status_updated == other.time_hcx_license_status_updated &&
    is_single_host_sddc == other.is_single_host_sddc &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/oci/ocvp/models/sddc.rb', line 618

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


598
599
600
 
# File 'lib/oci/ocvp/models/sddc.rb', line 598

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



607
608
609
 
# File 'lib/oci/ocvp/models/sddc.rb', line 607

def hash
  [id, display_name, vmware_software_version, esxi_software_version, compartment_id, clusters_count, vcenter_fqdn, nsx_manager_fqdn, vcenter_private_ip_id, nsx_manager_private_ip_id, vcenter_username, nsx_manager_username, ssh_authorized_keys, nsx_edge_uplink_ip_id, hcx_private_ip_id, hcx_fqdn, hcx_mode, initial_configuration, is_hcx_pending_downgrade, hcx_on_prem_licenses, time_hcx_billing_cycle_end, time_hcx_license_status_updated, is_single_host_sddc, time_created, time_updated, lifecycle_state, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



651
652
653
654
655
656
657
658
659
660
 
# File 'lib/oci/ocvp/models/sddc.rb', line 651

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



645
646
647
 
# File 'lib/oci/ocvp/models/sddc.rb', line 645

def to_s
  to_hash.to_s
end