Class CloudVmClusterSummary

[Required(ErrorMessage = "AvailabilityDomain is required.")]
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }

Property Value

Type	Description
string	The name of the availability domain that the cloud Exadata infrastructure resource is located in.

Remarks

Required

BackupNetworkNsgIds

Declaration

[JsonProperty(PropertyName = "backupNetworkNsgIds")]
public List<string> BackupNetworkNsgIds { get; set; }

Property Value

Type	Description
List<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.

BackupSubnetId

Declaration

[JsonProperty(PropertyName = "backupSubnetId")]
public string BackupSubnetId { get; set; }

Property Value

Type	Description
string	The OCID of the backup network subnet associated with the cloud VM cluster. Subnet Restriction: See the subnet restrictions information for subnetId.

CloudAutomationUpdateDetails

Declaration

[JsonProperty(PropertyName = "cloudAutomationUpdateDetails")]
public CloudAutomationUpdateDetails CloudAutomationUpdateDetails { get; set; }

Property Value

Type	Description
CloudAutomationUpdateDetails

CloudExadataInfrastructureId

Declaration

[Required(ErrorMessage = "CloudExadataInfrastructureId is required.")]
[JsonProperty(PropertyName = "cloudExadataInfrastructureId")]
public string CloudExadataInfrastructureId { get; set; }

Property Value

Type	Description
string	The OCID of the cloud Exadata infrastructure.

Remarks

Required

ClusterName

Declaration

[JsonProperty(PropertyName = "clusterName")]
public string ClusterName { get; set; }

Property Value

Type	Description
string	The cluster name for cloud VM cluster. 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.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

ComputeModel

Declaration

[JsonProperty(PropertyName = "computeModel")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CloudVmClusterSummary.ComputeModelEnum? ComputeModel { get; set; }

Property Value

Type	Description
CloudVmClusterSummary.ComputeModelEnum?	The compute model of the Autonomous Database. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.

CpuCoreCount

Declaration

[Required(ErrorMessage = "CpuCoreCount is required.")]
[JsonProperty(PropertyName = "cpuCoreCount")]
public int? CpuCoreCount { get; set; }

Property Value

Type	Description
int?	The number of CPU cores enabled on the cloud VM cluster.

Remarks

Required

DataCollectionOptions

Declaration

[JsonProperty(PropertyName = "dataCollectionOptions")]
public DataCollectionOptions DataCollectionOptions { get; set; }

Property Value

Type	Description
DataCollectionOptions

DataStoragePercentage

Declaration

[JsonProperty(PropertyName = "dataStoragePercentage")]
public int? DataStoragePercentage { get; set; }

Property Value

Type	Description
int?	The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

Type

Description

int?

The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

DataStorageSizeInTBs

Declaration

[JsonProperty(PropertyName = "dataStorageSizeInTBs")]
public double DataStorageSizeInTBs { get; set; }

Property Value

Type	Description
double	The data disk group size to be allocated in TBs.

DbNodeStorageSizeInGBs

Declaration

[JsonProperty(PropertyName = "dbNodeStorageSizeInGBs")]
public int? DbNodeStorageSizeInGBs { get; set; }

Property Value

Type	Description
int?	The local node storage to be allocated in GBs.

DbServers

Declaration

[JsonProperty(PropertyName = "dbServers")]
public List<string> DbServers { get; set; }

Property Value

Type	Description
List<string>	The list of DB servers.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DiskRedundancy

Declaration

[JsonProperty(PropertyName = "diskRedundancy")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CloudVmClusterSummary.DiskRedundancyEnum? DiskRedundancy { get; set; }

Property Value

Type	Description
CloudVmClusterSummary.DiskRedundancyEnum?	The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The user-friendly name for the cloud VM cluster. The name does not need to be unique.

Remarks

Required

Domain

Declaration

[Required(ErrorMessage = "Domain is required.")]
[JsonProperty(PropertyName = "domain")]
public string Domain { get; set; }

Property Value

Type	Description
string	The domain name for the cloud VM cluster.

Remarks

Required

FileSystemConfigurationDetails

Declaration

[JsonProperty(PropertyName = "fileSystemConfigurationDetails")]
public List<FileSystemConfigurationDetail> FileSystemConfigurationDetails { get; set; }

Property Value

Type	Description
List<FileSystemConfigurationDetail>	Details of the file system configuration of the VM cluster.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<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"}

GiSoftwareImageId

Declaration

[JsonProperty(PropertyName = "giSoftwareImageId")]
public string GiSoftwareImageId { get; set; }

Property Value

Type	Description
string	The OCID of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`.

GiVersion

Declaration

[JsonProperty(PropertyName = "giVersion")]
public string GiVersion { get; set; }

Property Value

Type	Description
string	A valid Oracle Grid Infrastructure (GI) software version.

Hostname

Declaration

[Required(ErrorMessage = "Hostname is required.")]
[JsonProperty(PropertyName = "hostname")]
public string Hostname { get; set; }

Property Value

Type	Description
string	The hostname for the cloud VM cluster.

Remarks

Required

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the cloud VM cluster.

Remarks

Required

IsLocalBackupEnabled

Declaration

[JsonProperty(PropertyName = "isLocalBackupEnabled")]
public bool? IsLocalBackupEnabled { get; set; }

Property Value

Type	Description
bool?	If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

IsSparseDiskgroupEnabled

Declaration

[JsonProperty(PropertyName = "isSparseDiskgroupEnabled")]
public bool? IsSparseDiskgroupEnabled { get; set; }

Property Value

Type	Description
bool?	If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

LastUpdateHistoryEntryId

Declaration

[JsonProperty(PropertyName = "lastUpdateHistoryEntryId")]
public string LastUpdateHistoryEntryId { get; set; }

Property Value

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

LicenseModel

Declaration

[JsonProperty(PropertyName = "licenseModel")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CloudVmClusterSummary.LicenseModelEnum? LicenseModel { get; set; }

Property Value

Type	Description
CloudVmClusterSummary.LicenseModelEnum?	The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	Additional information about the current lifecycle state.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CloudVmClusterSummary.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
CloudVmClusterSummary.LifecycleStateEnum?	The current state of the cloud VM cluster.

Remarks

Required

ListenerPort

Declaration

[JsonProperty(PropertyName = "listenerPort")]
public long? ListenerPort { get; set; }

Property Value

Type	Description
long?	The port number configured for the listener on the cloud VM cluster.

MemorySizeInGBs

Declaration

[JsonProperty(PropertyName = "memorySizeInGBs")]
public int? MemorySizeInGBs { get; set; }

Property Value

Type	Description
int?	The memory to be allocated in GBs.

NodeCount

Declaration

[JsonProperty(PropertyName = "nodeCount")]
public int? NodeCount { get; set; }

Property Value

Type	Description
int?	The number of nodes in the cloud VM cluster.

NsgIds

Declaration

[JsonProperty(PropertyName = "nsgIds")]
public List<string> NsgIds { get; set; }

Property Value

Type	Description
List<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.

Type

Description

List<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.

OcpuCount

Declaration

[JsonProperty(PropertyName = "ocpuCount")]
public float? OcpuCount { get; set; }

Property Value

Type	Description
float?	The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

ScanDnsName

Declaration

[JsonProperty(PropertyName = "scanDnsName")]
public string ScanDnsName { get; set; }

Property Value

Type	Description
string	The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

ScanDnsRecordId

Declaration

[JsonProperty(PropertyName = "scanDnsRecordId")]
public string ScanDnsRecordId { get; set; }

Property Value

Type	Description
string	The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

ScanIpIds

Declaration

[JsonProperty(PropertyName = "scanIpIds")]
public List<string> ScanIpIds { get; set; }

Property Value

Type	Description
List<string>	The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the cloud VM cluster. SCAN IPv4 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.

ScanIpv6Ids

Declaration

[JsonProperty(PropertyName = "scanIpv6Ids")]
public List<string> ScanIpv6Ids { get; set; }

Property Value

Type	Description
List<string>	The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the cloud VM cluster. SCAN IPv6 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.

ScanListenerPortTcp

Declaration

[JsonProperty(PropertyName = "scanListenerPortTcp")]
public int? ScanListenerPortTcp { get; set; }

Property Value

Type	Description
int?	The TCP Single Client Access Name (SCAN) port. The default port is 1521.

ScanListenerPortTcpSsl

Declaration

[JsonProperty(PropertyName = "scanListenerPortTcpSsl")]
public int? ScanListenerPortTcpSsl { get; set; }

Property Value

Type	Description
int?	The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

SecurityAttributes

Declaration

[JsonProperty(PropertyName = "securityAttributes")]
public Dictionary<string, Dictionary<string, object>> SecurityAttributes { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<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"}}}

Shape

Declaration

[Required(ErrorMessage = "Shape is required.")]
[JsonProperty(PropertyName = "shape")]
public string Shape { get; set; }

Property Value

Type	Description
string	The model name of the Exadata hardware running the cloud VM cluster.

Remarks

Required

SshPublicKeys

Declaration

[Required(ErrorMessage = "SshPublicKeys is required.")]
[JsonProperty(PropertyName = "sshPublicKeys")]
public List<string> SshPublicKeys { get; set; }

Property Value

Type	Description
List<string>	The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

Remarks

Required

StorageSizeInGBs

Declaration

[JsonProperty(PropertyName = "storageSizeInGBs")]
public int? StorageSizeInGBs { get; set; }

Property Value

Type	Description
int?	The storage allocation for the disk group, in gigabytes (GB).

SubnetId

Declaration

[Required(ErrorMessage = "SubnetId is required.")]
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }

Property Value

Type	Description
string	The OCID of the subnet associated with the cloud VM cluster. Subnet Restrictions: For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

Type

Description

string

The OCID of the subnet associated with the cloud VM cluster.
Subnet Restrictions:

For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

Remarks

Required

SubscriptionId

Declaration

[JsonProperty(PropertyName = "subscriptionId")]
public string SubscriptionId { get; set; }

Property Value

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

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

SystemVersion

Declaration

[JsonProperty(PropertyName = "systemVersion")]
public string SystemVersion { get; set; }

Property Value

Type	Description
string	Operating system version of the image.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time that the cloud VM cluster was created.

TimeZone

Declaration

[JsonProperty(PropertyName = "timeZone")]
public string TimeZone { get; set; }

Property Value

Type	Description
string	The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

VipIds

Declaration

[JsonProperty(PropertyName = "vipIds")]
public List<string> VipIds { get; set; }

Property Value

Type	Description
List<string>	The OCID of the virtual IP (VIP) IPv4 addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP IPv4 address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. Note: For a single-node DB system, this list is empty.

Vipv6Ids

Declaration

[JsonProperty(PropertyName = "vipv6Ids")]
public List<string> Vipv6Ids { get; set; }

Property Value

Type	Description
List<string>	The OCID of the virtual IP (VIP) IPv6 addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP IPv6 address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. Note: For a single-node DB system, this list is empty.

VmClusterType

Declaration

[JsonProperty(PropertyName = "vmClusterType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CloudVmClusterSummary.VmClusterTypeEnum? VmClusterType { get; set; }

Property Value

Type	Description
CloudVmClusterSummary.VmClusterTypeEnum?	The vmcluster type for the VM cluster/Cloud VM cluster.

ZoneId

Declaration

[JsonProperty(PropertyName = "zoneId")]
public string ZoneId { get; set; }

Property Value

Type	Description
string	The OCID of the zone the cloud VM cluster is associated with.