/**
* Database Service API
* The API for the Database Service. Use this API to manage resources such as databases and DB Systems. For more information, see [Overview of the Database Service](https://docs.oracle.com/iaas/Content/Database/Concepts/databaseoverview.htm).
* OpenAPI spec version: 20160918
* Contact: sic_dbaas_cp_us_grp@oracle.com
*
* NOTE: This class is auto generated by OracleSDKGenerator.
* Do not edit the class manually.
*
* Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
import * as model from "../model";
/**
* Details of the cloud VM cluster. Applies to Exadata Cloud Service instances only.
*
*/
export interface CloudVmClusterSummary {
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud VM cluster.
*/
"id": string;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
*/
"compartmentId": string;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
*/
"subscriptionId"?: string;
/**
* The name of the availability domain that the cloud Exadata infrastructure resource is located in.
*/
"availabilityDomain": string;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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.
*
*/
"subnetId": string;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the cloud VM cluster.
*
**Subnet Restriction:** See the subnet restrictions information for **subnetId**.
*
*/
"backupSubnetId"?: string;
/**
* The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm).
* **NsgIds restrictions:**
* - A network security group (NSG) is optional for Autonomous AI Databases with private access. The nsgIds list can be empty.
*
*/
"nsgIds"?: Array;
/**
* A list of the [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems.
*
*/
"backupNetworkNsgIds"?: Array;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last maintenance update history entry. This value is updated when a maintenance update starts.
*/
"lastUpdateHistoryEntryId"?: string;
/**
* The model name of the Exadata hardware running the cloud VM cluster.
*
*/
"shape": string;
/**
* The port number configured for the listener on the cloud VM cluster. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"listenerPort"?: number;
"liveImageVersionDetails"?: model.ExadataLiveImageVersionDetails;
/**
* Oracle Linux version for the respective Exadata Image.
*/
"oracleLinuxVersion"?: string;
/**
* The current state of the cloud VM cluster.
*/
"lifecycleState": CloudVmClusterSummary.LifecycleState;
/**
* The number of nodes in the cloud VM cluster.
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"nodeCount"?: number;
/**
* The storage allocation for the disk group, in gigabytes (GB). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"storageSizeInGBs"?: number;
/**
* The user-friendly name for the cloud VM cluster. The name does not need to be unique.
*/
"displayName": string;
/**
* The date and time that the cloud VM cluster was created.
*/
"timeCreated"?: Date;
/**
* Additional information about the current lifecycle state.
*/
"lifecycleDetails"?: string;
/**
* The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](https://docs.oracle.com/iaas/Content/Database/References/timezones.htm).
*/
"timeZone"?: string;
/**
* The hostname for the cloud VM cluster.
*/
"hostname": string;
/**
* The domain name for the cloud VM cluster.
*/
"domain": string;
/**
* The number of CPU cores enabled on the cloud VM cluster. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"cpuCoreCount": number;
/**
* The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"ocpuCount"?: number;
/**
* The memory to be allocated in GBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"memorySizeInGBs"?: number;
/**
* The local node storage to be allocated in GBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"dbNodeStorageSizeInGBs"?: number;
/**
* The data disk group size to be allocated in TBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"dataStorageSizeInTBs"?: number;
/**
* The list of DB servers.
*/
"dbServers"?: Array;
/**
* 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.
*
*/
"clusterName"?: string;
/**
* The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](https://docs.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage.
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"dataStoragePercentage"?: number;
/**
* The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](https://docs.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage.
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"recoStoragePercentage"?: number;
/**
* The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](https://docs.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage.
* Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"sparseStoragePercentage"?: number;
/**
* 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.
*
*/
"isLocalBackupEnabled"?: boolean;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure.
*/
"cloudExadataInfrastructureId": string;
/**
* If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.
*
*/
"isSparseDiskgroupEnabled"?: boolean;
/**
* A valid Oracle Grid Infrastructure (GI) software version.
*/
"giVersion"?: string;
/**
* Operating system version of the image.
*/
"systemVersion"?: string;
/**
* The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.
*/
"sshPublicKeys": Array;
/**
* The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.
*
*/
"licenseModel"?: CloudVmClusterSummary.LicenseModel;
/**
* The type of redundancy configured for the cloud Vm cluster.
* NORMAL is 2-way redundancy.
* HIGH is 3-way redundancy.
*
*/
"diskRedundancy"?: CloudVmClusterSummary.DiskRedundancy;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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.
*
*/
"scanIpIds"?: Array;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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.
*
*/
"vipIds"?: Array;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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.
*
*/
"scanIpv6Ids"?: Array;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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.
*
*/
"vipv6Ids"?: Array;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.
*
*/
"scanDnsRecordId"?: 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](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
Example: {@code {\"Department\": \"Finance\"}}
*
*/
"freeformTags"?: {
[key: string]: string;
};
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
* For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
*/
"definedTags"?: {
[key: string]: {
[key: string]: any;
};
};
/**
* Security Attributes for this resource. Each key is predefined and scoped to a namespace.
* For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
* Example: {@code {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"audit\"}}}}
*
*/
"securityAttributes"?: {
[key: string]: {
[key: string]: any;
};
};
/**
* System tags for this resource. Each key is predefined and scoped to a namespace.
* For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
*/
"systemTags"?: {
[key: string]: {
[key: string]: any;
};
};
/**
* The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.
*
*/
"scanDnsName"?: string;
/**
* The OCID of the zone the cloud VM cluster is associated with.
*
*/
"zoneId"?: string;
/**
* The TCP Single Client Access Name (SCAN) port. The default port is 1521. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"scanListenerPortTcp"?: number;
/**
* The TCPS Single Client Access Name (SCAN) port. The default port is 2484. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"scanListenerPortTcpSsl"?: number;
"dataCollectionOptions"?: model.DataCollectionOptions;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type {@code GRID_IMAGE}.
*/
"giSoftwareImageId"?: string;
/**
* Details of the file system configuration of the VM cluster.
*/
"fileSystemConfigurationDetails"?: Array;
"cloudAutomationUpdateDetails"?: model.CloudAutomationUpdateDetails;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault.
*/
"exascaleDbStorageVaultId"?: string;
/**
* Specifies the type of storage management for the Cloud VM Cluster if its ASM or Exascale.
*/
"storageManagementType"?: CloudVmClusterSummary.StorageManagementType;
/**
* The vmcluster type for the VM cluster/Cloud VM cluster.
*/
"vmClusterType"?: CloudVmClusterSummary.VmClusterType;
/**
* The compute model of the Autonomous AI Database. This is required if using the {@code computeCount} parameter. If using {@code cpuCoreCount} then it is an error to specify {@code computeModel} to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.
*/
"computeModel"?: CloudVmClusterSummary.ComputeModel;
/**
* Details of the multi cloud identity connectors of the VM cluster.
*/
"multiCloudIdentityConnectorConfigs"?: Array;
/**
* TDE keystore type
*/
"tdeKeyStoreType"?: CloudVmClusterSummary.TdeKeyStoreType;
/**
* Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL
*/
"vmFileSystemStorageType"?: CloudVmClusterSummary.VmFileSystemStorageType;
/**
* Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL
*/
"vmBackupStorageType"?: CloudVmClusterSummary.VmBackupStorageType;
}
export declare namespace CloudVmClusterSummary {
enum LifecycleState {
Provisioning = "PROVISIONING",
Available = "AVAILABLE",
Updating = "UPDATING",
Terminating = "TERMINATING",
Terminated = "TERMINATED",
Failed = "FAILED",
MaintenanceInProgress = "MAINTENANCE_IN_PROGRESS",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum LicenseModel {
LicenseIncluded = "LICENSE_INCLUDED",
BringYourOwnLicense = "BRING_YOUR_OWN_LICENSE",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum DiskRedundancy {
High = "HIGH",
Normal = "NORMAL",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum StorageManagementType {
Asm = "ASM",
Exascale = "EXASCALE",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum VmClusterType {
Regular = "REGULAR",
Developer = "DEVELOPER",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum ComputeModel {
Ecpu = "ECPU",
Ocpu = "OCPU",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum TdeKeyStoreType {
Azure = "AZURE",
Oci = "OCI",
Gcp = "GCP",
Aws = "AWS",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum VmFileSystemStorageType {
Local = "LOCAL",
Exascale = "EXASCALE",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum VmBackupStorageType {
Local = "LOCAL",
Exascale = "EXASCALE",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
function getJsonObj(obj: CloudVmClusterSummary): object;
function getDeserializedJsonObj(obj: CloudVmClusterSummary): object;
}