Class: OCI::Database::Models::ExadbVmCluster

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/exadb_vm_cluster.rb

Overview

Details of the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_MAINTENANCE_IN_PROGRESS = 'MAINTENANCE_IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
GRID_IMAGE_TYPE_ENUM =
[
  GRID_IMAGE_TYPE_RELEASE_UPDATE = 'RELEASE_UPDATE'.freeze,
  GRID_IMAGE_TYPE_CUSTOM_IMAGE = 'CUSTOM_IMAGE'.freeze,
  GRID_IMAGE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LICENSE_MODEL_ENUM =
[
  LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'.freeze,
  LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'.freeze,
  LICENSE_MODEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExadbVmCluster

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
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
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 444

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.iorm_config_cache = attributes[:'iormConfigCache'] if attributes[:'iormConfigCache']

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

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

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

  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.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.backup_subnet_id = attributes[:'backupSubnetId'] if attributes[:'backupSubnetId']

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

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

  self.backup_network_nsg_ids = attributes[:'backupNetworkNsgIds'] if attributes[:'backupNetworkNsgIds']

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

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

  self.last_update_history_entry_id = attributes[:'lastUpdateHistoryEntryId'] if attributes[:'lastUpdateHistoryEntryId']

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

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

  self.listener_port = attributes[:'listenerPort'] if attributes[:'listenerPort']

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

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

  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.node_count = attributes[:'nodeCount'] if attributes[:'nodeCount']

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

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

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

  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.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.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.time_zone = attributes[:'timeZone'] if attributes[:'timeZone']

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

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

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

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

  self.cluster_name = attributes[:'clusterName'] if attributes[:'clusterName']

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

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

  self.gi_version = attributes[:'giVersion'] if attributes[:'giVersion']

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

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

  self.grid_image_id = attributes[:'gridImageId'] if attributes[:'gridImageId']

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

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

  self.grid_image_type = attributes[:'gridImageType'] if attributes[:'gridImageType']

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

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

  self.system_version = attributes[:'systemVersion'] if attributes[:'systemVersion']

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

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

  self.ssh_public_keys = attributes[:'sshPublicKeys'] if attributes[:'sshPublicKeys']

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

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

  self.license_model = attributes[:'licenseModel'] if attributes[:'licenseModel']

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

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

  self.scan_ip_ids = attributes[:'scanIpIds'] if attributes[:'scanIpIds']

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

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

  self.vip_ids = attributes[:'vipIds'] if attributes[:'vipIds']

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

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

  self.scan_dns_record_id = attributes[:'scanDnsRecordId'] if attributes[:'scanDnsRecordId']

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

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

  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']

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

  self.scan_dns_name = attributes[:'scanDnsName'] if attributes[:'scanDnsName']

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

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

  self.zone_id = attributes[:'zoneId'] if attributes[:'zoneId']

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

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

  self.scan_listener_port_tcp = attributes[:'scanListenerPortTcp'] if attributes[:'scanListenerPortTcp']

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

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

  self.scan_listener_port_tcp_ssl = attributes[:'scanListenerPortTcpSsl'] if attributes[:'scanListenerPortTcpSsl']

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

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

  self.private_zone_id = attributes[:'privateZoneId'] if attributes[:'privateZoneId']

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

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

  self.data_collection_options = attributes[:'dataCollectionOptions'] if attributes[:'dataCollectionOptions']

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

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

  self.total_e_cpu_count = attributes[:'totalECpuCount'] if attributes[:'totalECpuCount']

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

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

  self.enabled_e_cpu_count = attributes[:'enabledECpuCount'] if attributes[:'enabledECpuCount']

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

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

  self.vm_file_system_storage = attributes[:'vmFileSystemStorage'] if attributes[:'vmFileSystemStorage']

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

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

  self.snapshot_file_system_storage = attributes[:'snapshotFileSystemStorage'] if attributes[:'snapshotFileSystemStorage']

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

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

  self.total_file_system_storage = attributes[:'totalFileSystemStorage'] if attributes[:'totalFileSystemStorage']

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

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

  self.exascale_db_storage_vault_id = attributes[:'exascaleDbStorageVaultId'] if attributes[:'exascaleDbStorageVaultId']

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

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

  self.memory_size_in_gbs = attributes[:'memorySizeInGBs'] if attributes[:'memorySizeInGBs']

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

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

  self.cluster_placement_group_id = attributes[:'clusterPlacementGroupId'] if attributes[:'clusterPlacementGroupId']

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

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

  self.subscription_id = attributes[:'subscriptionId'] if attributes[:'subscriptionId']

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

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

Instance Attribute Details

#availability_domainString

[Required] The name of the availability domain in which the Exadata VM cluster on Exascale Infrastructure is located.

Returns:

  • (String)


50
51
52
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 50

def availability_domain
  @availability_domain
end

#backup_network_nsg_idsArray<String>

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

Returns:

  • (Array<String>)


72
73
74
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 72

def backup_network_nsg_ids
  @backup_network_nsg_ids
end

#backup_subnet_idString

[Required] The OCID of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure.

Returns:

  • (String)


60
61
62
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 60

def backup_subnet_id
  @backup_subnet_id
end

#cluster_nameString

The cluster name for Exadata VM cluster on Exascale Infrastructure. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

Returns:

  • (String)


135
136
137
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 135

def cluster_name
  @cluster_name
end

#cluster_placement_group_idString

The OCID of the cluster placement group of the Exadata Infrastructure.

Returns:

  • (String)


272
273
274
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 272

def cluster_placement_group_id
  @cluster_placement_group_id
end

#compartment_idString

[Required] The OCID of the compartment.

Returns:

  • (String)


45
46
47
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 45

def compartment_id
  @compartment_id
end

#data_collection_optionsOCI::Database::Models::DataCollectionOptions



239
240
241
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 239

def data_collection_options
  @data_collection_options
end

#defined_tagsHash<String, Hash<String, Object>>

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

Returns:

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


199
200
201
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 199

def defined_tags
  @defined_tags
end

#display_nameString

[Required] The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique.

Returns:

  • (String)


98
99
100
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 98

def display_name
  @display_name
end

#domainString

[Required] A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only.

Returns:

  • (String)


130
131
132
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 130

def domain
  @domain
end

#enabled_e_cpu_countInteger

[Required] The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure.

Returns:

  • (Integer)


249
250
251
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 249

def enabled_e_cpu_count
  @enabled_e_cpu_count
end

#exascale_db_storage_vault_idString

[Required] The OCID of the Exadata Database Storage Vault.

Returns:

  • (String)


263
264
265
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 263

def exascale_db_storage_vault_id
  @exascale_db_storage_vault_id
end

#freeform_tagsHash<String, String>

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>)


193
194
195
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 193

def freeform_tags
  @freeform_tags
end

#gi_versionString

A valid Oracle Grid Infrastructure (GI) software version.

Returns:

  • (String)


139
140
141
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 139

def gi_version
  @gi_version
end

#grid_image_idString

Grid Setup will be done using this grid image id.

The grid image ID can be obtained using the API /20160918/giVersions/majorVersion/minorVersions?compartmentId=<compartmentId>&shapeFamily=EXADB_XS&availabilityDomain=<AD name>. The list of supported major versions can be obtained using the API /20160918/giVersions?compartmentId=<compartmentId>&shape=ExaDbXS&availabilityDomain=<AD name>

Returns:

  • (String)


147
148
149
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 147

def grid_image_id
  @grid_image_id
end

#grid_image_typeString

The type of Grid Image

Returns:

  • (String)


151
152
153
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 151

def grid_image_type
  @grid_image_type
end

#hostnameString

[Required] The hostname for the Exadata VM cluster on Exascale Infrastructure. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). For Exadata systems, the maximum length of the hostname is 12 characters.

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, then the Exadata VM cluster on Exascale Infrastructure will fail to provision.

Returns:

  • (String)


122
123
124
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 122

def hostname
  @hostname
end

#idString

[Required] The OCID of the Exadata VM cluster on Exascale Infrastructure.

Returns:

  • (String)


41
42
43
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 41

def id
  @id
end

#iorm_config_cacheOCI::Database::Models::ExadataIormConfig



37
38
39
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 37

def iorm_config_cache
  @iorm_config_cache
end

#last_update_history_entry_idString

The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

Returns:

  • (String)


76
77
78
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 76

def last_update_history_entry_id
  @last_update_history_entry_id
end

#license_modelString

The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE.

Returns:

  • (String)


164
165
166
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 164

def license_model
  @license_model
end

#lifecycle_detailsString

Additional information about the current lifecycle state.

Returns:

  • (String)


106
107
108
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 106

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

[Required] The current state of the Exadata VM cluster on Exascale Infrastructure.

Returns:

  • (String)


84
85
86
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 84

def lifecycle_state
  @lifecycle_state
end

#listener_portInteger

The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure.

Returns:

  • (Integer)


80
81
82
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 80

def listener_port
  @listener_port
end

#memory_size_in_gbsInteger

The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved.

Returns:

  • (Integer)


268
269
270
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 268

def memory_size_in_gbs
  @memory_size_in_gbs
end

#node_countInteger

[Required] The number of nodes in the Exadata VM cluster on Exascale Infrastructure.

Returns:

  • (Integer)


89
90
91
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 89

def node_count
  @node_count
end

#nsg_idsArray<String>

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions: - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

Returns:

  • (Array<String>)


67
68
69
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 67

def nsg_ids
  @nsg_ids
end

#private_zone_idString

The private zone ID in which you want DNS records to be created.

Returns:

  • (String)


236
237
238
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 236

def private_zone_id
  @private_zone_id
end

#scan_dns_nameString

The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure.

Returns:

  • (String)


217
218
219
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 217

def scan_dns_name
  @scan_dns_name
end

#scan_dns_record_idString

The OCID of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure.

Returns:

  • (String)


185
186
187
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 185

def scan_dns_record_id
  @scan_dns_record_id
end

#scan_ip_idsArray<String>

The OCID of the Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.

Note: For a single-node DB system, this list is empty.

Returns:

  • (Array<String>)


173
174
175
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 173

def scan_ip_ids
  @scan_ip_ids
end

#scan_listener_port_tcpInteger

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

Returns:

  • (Integer)


226
227
228
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 226

def scan_listener_port_tcp
  @scan_listener_port_tcp
end

#scan_listener_port_tcp_sslInteger

The Secured Communication (TCPS) protocol Single Client Access Name (SCAN) port. The default port is 2484.

Returns:

  • (Integer)


231
232
233
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 231

def scan_listener_port_tcp_ssl
  @scan_listener_port_tcp_ssl
end

#security_attributesHash<String, Hash<String, Object>>

Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"audit\"}}}

Returns:

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


206
207
208
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 206

def security_attributes
  @security_attributes
end

#shapeString

[Required] The shape of the Exadata VM cluster on Exascale Infrastructure resource

Returns:

  • (String)


94
95
96
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 94

def shape
  @shape
end

#snapshot_file_system_storageOCI::Database::Models::ExadbVmClusterStorageDetails



256
257
258
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 256

def snapshot_file_system_storage
  @snapshot_file_system_storage
end

#ssh_public_keysArray<String>

[Required] The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure.

Returns:

  • (Array<String>)


159
160
161
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 159

def ssh_public_keys
  @ssh_public_keys
end

#subnet_idString

[Required] The OCID of the subnet associated with the Exadata VM cluster on Exascale Infrastructure.

Returns:

  • (String)


55
56
57
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 55

def subnet_id
  @subnet_id
end

#subscription_idString

The OCID of the subscription with which resource needs to be associated with.

Returns:

  • (String)


276
277
278
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 276

def subscription_id
  @subscription_id
end

#system_tagsHash<String, Hash<String, Object>>

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

Returns:

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


212
213
214
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 212

def system_tags
  @system_tags
end

#system_versionString

Operating system version of the image.

Returns:

  • (String)


155
156
157
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 155

def system_version
  @system_version
end

#time_createdDateTime

The date and time that the Exadata VM cluster on Exascale Infrastructure was created.

Returns:

  • (DateTime)


102
103
104
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 102

def time_created
  @time_created
end

#time_zoneString

The time zone to use for the Exadata VM cluster on Exascale Infrastructure. For details, see Time Zones.

Returns:

  • (String)


111
112
113
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 111

def time_zone
  @time_zone
end

#total_e_cpu_countInteger

[Required] The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure.

Returns:

  • (Integer)


244
245
246
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 244

def total_e_cpu_count
  @total_e_cpu_count
end

#total_file_system_storageOCI::Database::Models::ExadbVmClusterStorageDetails



259
260
261
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 259

def total_file_system_storage
  @total_file_system_storage
end

#vip_idsArray<String>

The OCID of the virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, then the VIP is reassigned to another active node in the cluster.

Returns:

  • (Array<String>)


180
181
182
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 180

def vip_ids
  @vip_ids
end

#vm_file_system_storageOCI::Database::Models::ExadbVmClusterStorageDetails

This attribute is required.



253
254
255
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 253

def vm_file_system_storage
  @vm_file_system_storage
end

#zone_idString

The OCID of the zone with which the Exadata VM cluster on Exascale Infrastructure is associated.

Returns:

  • (String)


222
223
224
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 222

def zone_id
  @zone_id
end

Class Method Details

.attribute_mapObject

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



279
280
281
282
283
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 279

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'iorm_config_cache': :'iormConfigCache',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'availability_domain': :'availabilityDomain',
    'subnet_id': :'subnetId',
    'backup_subnet_id': :'backupSubnetId',
    'nsg_ids': :'nsgIds',
    'backup_network_nsg_ids': :'backupNetworkNsgIds',
    'last_update_history_entry_id': :'lastUpdateHistoryEntryId',
    'listener_port': :'listenerPort',
    'lifecycle_state': :'lifecycleState',
    'node_count': :'nodeCount',
    'shape': :'shape',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'lifecycle_details': :'lifecycleDetails',
    'time_zone': :'timeZone',
    'hostname': :'hostname',
    'domain': :'domain',
    'cluster_name': :'clusterName',
    'gi_version': :'giVersion',
    'grid_image_id': :'gridImageId',
    'grid_image_type': :'gridImageType',
    'system_version': :'systemVersion',
    'ssh_public_keys': :'sshPublicKeys',
    'license_model': :'licenseModel',
    'scan_ip_ids': :'scanIpIds',
    'vip_ids': :'vipIds',
    'scan_dns_record_id': :'scanDnsRecordId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes',
    'system_tags': :'systemTags',
    'scan_dns_name': :'scanDnsName',
    'zone_id': :'zoneId',
    'scan_listener_port_tcp': :'scanListenerPortTcp',
    'scan_listener_port_tcp_ssl': :'scanListenerPortTcpSsl',
    'private_zone_id': :'privateZoneId',
    'data_collection_options': :'dataCollectionOptions',
    'total_e_cpu_count': :'totalECpuCount',
    'enabled_e_cpu_count': :'enabledECpuCount',
    'vm_file_system_storage': :'vmFileSystemStorage',
    'snapshot_file_system_storage': :'snapshotFileSystemStorage',
    'total_file_system_storage': :'totalFileSystemStorage',
    'exascale_db_storage_vault_id': :'exascaleDbStorageVaultId',
    'memory_size_in_gbs': :'memorySizeInGBs',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'subscription_id': :'subscriptionId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
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
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 335

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'iorm_config_cache': :'OCI::Database::Models::ExadataIormConfig',
    'id': :'String',
    'compartment_id': :'String',
    'availability_domain': :'String',
    'subnet_id': :'String',
    'backup_subnet_id': :'String',
    'nsg_ids': :'Array<String>',
    'backup_network_nsg_ids': :'Array<String>',
    'last_update_history_entry_id': :'String',
    'listener_port': :'Integer',
    'lifecycle_state': :'String',
    'node_count': :'Integer',
    'shape': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'lifecycle_details': :'String',
    'time_zone': :'String',
    'hostname': :'String',
    'domain': :'String',
    'cluster_name': :'String',
    'gi_version': :'String',
    'grid_image_id': :'String',
    'grid_image_type': :'String',
    'system_version': :'String',
    'ssh_public_keys': :'Array<String>',
    'license_model': :'String',
    'scan_ip_ids': :'Array<String>',
    'vip_ids': :'Array<String>',
    'scan_dns_record_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'scan_dns_name': :'String',
    'zone_id': :'String',
    'scan_listener_port_tcp': :'Integer',
    'scan_listener_port_tcp_ssl': :'Integer',
    'private_zone_id': :'String',
    'data_collection_options': :'OCI::Database::Models::DataCollectionOptions',
    'total_e_cpu_count': :'Integer',
    'enabled_e_cpu_count': :'Integer',
    'vm_file_system_storage': :'OCI::Database::Models::ExadbVmClusterStorageDetails',
    'snapshot_file_system_storage': :'OCI::Database::Models::ExadbVmClusterStorageDetails',
    'total_file_system_storage': :'OCI::Database::Models::ExadbVmClusterStorageDetails',
    'exascale_db_storage_vault_id': :'String',
    'memory_size_in_gbs': :'Integer',
    'cluster_placement_group_id': :'String',
    'subscription_id': :'String'
    # 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



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 769

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

  self.class == other.class &&
    iorm_config_cache == other.iorm_config_cache &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    availability_domain == other.availability_domain &&
    subnet_id == other.subnet_id &&
    backup_subnet_id == other.backup_subnet_id &&
    nsg_ids == other.nsg_ids &&
    backup_network_nsg_ids == other.backup_network_nsg_ids &&
    last_update_history_entry_id == other.last_update_history_entry_id &&
    listener_port == other.listener_port &&
    lifecycle_state == other.lifecycle_state &&
    node_count == other.node_count &&
    shape == other.shape &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    lifecycle_details == other.lifecycle_details &&
    time_zone == other.time_zone &&
    hostname == other.hostname &&
    domain == other.domain &&
    cluster_name == other.cluster_name &&
    gi_version == other.gi_version &&
    grid_image_id == other.grid_image_id &&
    grid_image_type == other.grid_image_type &&
    system_version == other.system_version &&
    ssh_public_keys == other.ssh_public_keys &&
    license_model == other.license_model &&
    scan_ip_ids == other.scan_ip_ids &&
    vip_ids == other.vip_ids &&
    scan_dns_record_id == other.scan_dns_record_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    security_attributes == other.security_attributes &&
    system_tags == other.system_tags &&
    scan_dns_name == other.scan_dns_name &&
    zone_id == other.zone_id &&
    scan_listener_port_tcp == other.scan_listener_port_tcp &&
    scan_listener_port_tcp_ssl == other.scan_listener_port_tcp_ssl &&
    private_zone_id == other.private_zone_id &&
    data_collection_options == other.data_collection_options &&
    total_e_cpu_count == other.total_e_cpu_count &&
    enabled_e_cpu_count == other.enabled_e_cpu_count &&
    vm_file_system_storage == other.vm_file_system_storage &&
    snapshot_file_system_storage == other.snapshot_file_system_storage &&
    total_file_system_storage == other.total_file_system_storage &&
    exascale_db_storage_vault_id == other.exascale_db_storage_vault_id &&
    memory_size_in_gbs == other.memory_size_in_gbs &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    subscription_id == other.subscription_id
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



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 846

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


826
827
828
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 826

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



835
836
837
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 835

def hash
  [iorm_config_cache, id, compartment_id, availability_domain, subnet_id, backup_subnet_id, nsg_ids, backup_network_nsg_ids, last_update_history_entry_id, listener_port, lifecycle_state, node_count, shape, display_name, time_created, lifecycle_details, time_zone, hostname, domain, cluster_name, gi_version, grid_image_id, grid_image_type, system_version, ssh_public_keys, license_model, scan_ip_ids, vip_ids, scan_dns_record_id, freeform_tags, defined_tags, security_attributes, system_tags, scan_dns_name, zone_id, scan_listener_port_tcp, scan_listener_port_tcp_ssl, private_zone_id, data_collection_options, total_e_cpu_count, enabled_e_cpu_count, vm_file_system_storage, snapshot_file_system_storage, total_file_system_storage, exascale_db_storage_vault_id, memory_size_in_gbs, cluster_placement_group_id, subscription_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



879
880
881
882
883
884
885
886
887
888
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 879

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



873
874
875
# File 'lib/oci/database/models/exadb_vm_cluster.rb', line 873

def to_s
  to_hash.to_s
end