2026/10/26 - odb - 1 new8 updated api methods
Changes Adds support for Exascale storage with Oracle Exadata Database Service on Dedicated Infrastructure
Configures or updates the Exascale storage on an Exadata infrastructure. After you configure Exascale storage, you can create Exascale storage vaults on the infrastructure and VM clusters that use Exascale storage.
See also: AWS API Documentation
Request Syntax
client.update_exascale_cloud_exadata_infrastructure(
cloudExadataInfrastructureId='string',
totalStorageSizeInGBs=123,
totalVmStorageSizeInGBs=123
)
string
[REQUIRED]
The unique identifier or Amazon Resource Name (ARN) of the Exadata infrastructure to update.
integer
[REQUIRED]
The total amount of Exascale storage, in gigabytes (GB), to configure on the Exadata infrastructure.
integer
The total amount of Exascale storage, in gigabytes (GB), to allocate for VM storage on the Exadata infrastructure. VM clusters that store their VM file systems or VM backups in Exascale storage use this capacity.
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name of the updated Exadata infrastructure.
status (string) --
The current status of the Exadata infrastructure after the update operation.
statusReason (string) --
Additional information about the status of the Exadata infrastructure after the update operation.
cloudExadataInfrastructureId (string) --
The unique identifier of the updated Exadata infrastructure.
{'exascaleDbStorageVaultId': 'string',
'fileSystemConfigurationDetails': [{'fileSystemSizeInGBs': 'integer',
'mountPoint': 'string'}],
'vmBackupStorageType': 'LOCAL | EXASCALE',
'vmFileSystemStorageType': 'LOCAL | EXASCALE'}
Creates a VM cluster on the specified Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.create_cloud_vm_cluster(
cloudExadataInfrastructureId='string',
exascaleDbStorageVaultId='string',
vmFileSystemStorageType='LOCAL'|'EXASCALE',
vmBackupStorageType='LOCAL'|'EXASCALE',
fileSystemConfigurationDetails=[
{
'mountPoint': 'string',
'fileSystemSizeInGBs': 123
},
],
cpuCoreCount=123,
displayName='string',
giVersion='string',
hostname='string',
sshPublicKeys=[
'string',
],
odbNetworkId='string',
clusterName='string',
dataCollectionOptions={
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
dataStorageSizeInTBs=123.0,
dbNodeStorageSizeInGBs=123,
dbServers=[
'string',
],
tags={
'string': 'string'
},
isLocalBackupEnabled=True|False,
isSparseDiskgroupEnabled=True|False,
licenseModel='BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
memorySizeInGBs=123,
systemVersion='string',
timeZone='string',
clientToken='string',
scanListenerPortTcp=123
)
string
[REQUIRED]
The unique identifier of the Exadata infrastructure for this VM cluster.
string
The unique identifier or Amazon Resource Name (ARN) of the Exascale storage vault to use for the VM cluster. Specify this value to create a VM cluster that uses Exascale storage on dedicated Exadata infrastructure.
string
The type of storage to use for the VM file systems. Specify EXASCALE to store the VM file systems in Exascale storage on the storage servers, or LOCAL to store them on the database servers.
string
The type of storage to use for VM backups. Specify EXASCALE to store VM backups in Exascale storage on the storage servers, or LOCAL to store them on the database servers.
list
The list of file system configurations for the VM cluster. Each entry specifies the mount point of a file system and its size, in gigabytes (GB).
(dict) --
The configuration of a file system on a VM cluster.
mountPoint (string) --
The mount point of the file system.
fileSystemSizeInGBs (integer) --
The size of the file system, in gigabytes (GB).
integer
[REQUIRED]
The number of CPU cores to enable on the VM cluster.
string
[REQUIRED]
A user-friendly name for the VM cluster.
string
[REQUIRED]
A valid software version of Oracle Grid Infrastructure (GI). To get the list of valid values, use the ListGiVersions operation and specify the shape of the Exadata infrastructure.
Example: 19.0.0.0
string
[REQUIRED]
The host name for the VM cluster.
Constraints:
Can't be "localhost" or "hostname".
Can't contain "-version".
The maximum length of the combined hostname and domain is 63 characters.
The hostname must be unique within the subnet.
list
[REQUIRED]
The public key portion of one or more key pairs used for SSH access to the VM cluster.
(string) --
string
[REQUIRED]
The unique identifier of the ODB network for the VM cluster.
string
A name for the Grid Infrastructure cluster. The name isn't case sensitive.
dict
The set of preferences for the various diagnostic collection options for the VM cluster.
isDiagnosticsEventsEnabled (boolean) --
Indicates whether diagnostic collection is enabled for the VM cluster.
isHealthMonitoringEnabled (boolean) --
Indicates whether health monitoring is enabled for the VM cluster.
isIncidentLogsEnabled (boolean) --
Indicates whether incident logs are enabled for the cloud VM cluster.
float
The size of the data disk group, in terabytes (TBs), to allocate for the VM cluster.
integer
The amount of local node storage, in gigabytes (GB), to allocate for the VM cluster.
list
The list of database servers for the VM cluster.
(string) --
dict
The list of resource tags to apply to the VM cluster.
(string) --
(string) --
boolean
Specifies whether to enable database backups to local Exadata storage for the VM cluster.
boolean
Specifies whether to create a sparse disk group for the VM cluster.
string
The Oracle license model to apply to the VM cluster.
Default: LICENSE_INCLUDED
integer
The amount of memory, in gigabytes (GB), to allocate for the VM cluster.
string
The version of the operating system of the image for the VM cluster.
string
The time zone for the VM cluster. For a list of valid values for time zone, you can check the options in the console.
Default: UTC
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.
This field is autopopulated if not provided.
integer
The port number for TCP connections to the single client access name (SCAN) listener.
Valid values: 1024–8999 with the following exceptions: 2484, 6100, 6200, 7060, 7070, 7085, and 7879
Default: 1521
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudVmClusterId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name for the VM cluster.
status (string) --
The current status of the VM cluster.
statusReason (string) --
Additional information about the status of the VM cluster.
cloudVmClusterId (string) --
The unique identifier for the VM cluster.
{'cloudExadataInfrastructureId': 'string'}
Creates an Exascale storage vault.
To create the Exascale storage vault on dedicated Exadata infrastructure, specify cloudExadataInfrastructureId.
See also: AWS API Documentation
Request Syntax
client.create_exascale_db_storage_vault(
displayName='string',
highCapacityDatabaseStorageTotalSizeInGBs=123,
additionalFlashCacheInPercent=123,
autoscaleLimitInGBs=123,
cloudExadataInfrastructureId='string',
availabilityZoneId='string',
availabilityZone='string',
description='string',
isAutoscaleEnabled=True|False,
tags={
'string': 'string'
},
timeZone='string',
clientToken='string'
)
string
[REQUIRED]
A user-friendly name for the Exascale storage vault.
integer
[REQUIRED]
The total size of the high-capacity database storage, in gigabytes (GB), for the Exascale storage vault.
integer
The additional flash cache percentage for the Exascale storage vault.
integer
The autoscale limit in gigabytes (GB) for the Exascale storage vault.
string
The unique identifier or Amazon Resource Name (ARN) of the Exadata infrastructure on which to create the Exascale storage vault. Specify this value to create the Exascale storage vault on dedicated Exadata infrastructure that has Exascale storage configured. If you specify availabilityZone or availabilityZoneId, the value must match the Availability Zone of the Exadata infrastructure. If you specify neither, the service uses the Availability Zone of the Exadata infrastructure.
string
The Availability Zone ID for the Exascale storage vault.
string
The Availability Zone for the Exascale storage vault.
string
A description of the Exascale storage vault.
boolean
Specifies whether autoscaling is enabled for the Exascale storage vault.
dict
The list of resource tags to apply to the Exascale storage vault.
(string) --
(string) --
string
The time zone for the Exascale storage vault.
string
A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you submit the same request twice with the same client token, the service ignores the second request and returns the result of the first. If you don't specify a client token, the AWS SDK automatically generates one. The client token is valid for up to 24 hours after it's first used.
This field is autopopulated if not provided.
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'exascaleDbStorageVaultId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name for the Exascale storage vault.
status (string) --
The current status of the Exascale storage vault.
statusReason (string) --
Additional information about the status of the Exascale storage vault.
exascaleDbStorageVaultId (string) --
The unique identifier of the Exascale storage vault.
{'cloudExadataInfrastructure': {'exascaleConfiguration': {'availableStorageSizeInGBs': 'integer',
'availableVmStorageSizeInGBs': 'integer',
'totalStorageSizeInGBs': 'integer',
'totalVmStorageSizeInGBs': 'integer'}}}
Returns information about the specified Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.get_cloud_exadata_infrastructure(
cloudExadataInfrastructureId='string'
)
string
[REQUIRED]
The unique identifier of the Exadata infrastructure.
dict
Response Syntax
{
'cloudExadataInfrastructure': {
'cloudExadataInfrastructureId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureArn': 'string',
'activatedStorageCount': 123,
'additionalStorageCount': 123,
'availableStorageSizeInGBs': 123,
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'computeCount': 123,
'cpuCount': 123,
'customerContactsToSendToOCI': [
{
'email': 'string'
},
],
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServerVersion': 'string',
'lastMaintenanceRunId': 'string',
'maintenanceWindow': {
'customActionTimeoutInMins': 123,
'daysOfWeek': [
{
'name': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY'
},
],
'hoursOfDay': [
123,
],
'isCustomActionTimeoutEnabled': True|False,
'leadTimeInWeeks': 123,
'months': [
{
'name': 'JANUARY'|'FEBRUARY'|'MARCH'|'APRIL'|'MAY'|'JUNE'|'JULY'|'AUGUST'|'SEPTEMBER'|'OCTOBER'|'NOVEMBER'|'DECEMBER'
},
],
'patchingMode': 'ROLLING'|'NONROLLING',
'preference': 'NO_PREFERENCE'|'CUSTOM_PREFERENCE',
'skipRu': True|False,
'weeksOfMonth': [
123,
]
},
'maxCpuCount': 123,
'maxDataStorageInTBs': 123.0,
'maxDbNodeStorageSizeInGBs': 123,
'maxMemoryInGBs': 123,
'memorySizeInGBs': 123,
'monthlyDbServerVersion': 'string',
'monthlyStorageServerVersion': 'string',
'nextMaintenanceRunId': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'ocid': 'string',
'shape': 'string',
'storageCount': 123,
'storageServerVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'totalStorageSizeInGBs': 123,
'percentProgress': ...,
'databaseServerType': 'string',
'storageServerType': 'string',
'computeModel': 'ECPU'|'OCPU',
'exascaleConfiguration': {
'totalStorageSizeInGBs': 123,
'availableStorageSizeInGBs': 123,
'totalVmStorageSizeInGBs': 123,
'availableVmStorageSizeInGBs': 123
}
}
}
Response Structure
(dict) --
cloudExadataInfrastructure (dict) --
The Exadata infrastructure.
cloudExadataInfrastructureId (string) --
The unique identifier for the Exadata infrastructure.
displayName (string) --
The user-friendly name for the Exadata infrastructure.
status (string) --
The current status of the Exadata infrastructure.
statusReason (string) --
Additional information about the status of the Exadata infrastructure.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) for the Exadata infrastructure.
activatedStorageCount (integer) --
The number of storage servers requested for the Exadata infrastructure.
additionalStorageCount (integer) --
The number of storage servers requested for the Exadata infrastructure.
availableStorageSizeInGBs (integer) --
The amount of available storage, in gigabytes (GB), for the Exadata infrastructure.
availabilityZone (string) --
The name of the Availability Zone (AZ) where the Exadata infrastructure is located.
availabilityZoneId (string) --
The AZ ID of the AZ where the Exadata infrastructure is located.
computeCount (integer) --
The number of database servers for the Exadata infrastructure.
cpuCount (integer) --
The total number of CPU cores that are allocated to the Exadata infrastructure.
customerContactsToSendToOCI (list) --
The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.
(dict) --
A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure.
email (string) --
The email address of the contact.
dataStorageSizeInTBs (float) --
The size of the Exadata infrastructure's data disk group, in terabytes (TB).
dbNodeStorageSizeInGBs (integer) --
The size of the Exadata infrastructure's local node storage, in gigabytes (GB).
dbServerVersion (string) --
The software version of the database servers (dom0) in the Exadata infrastructure.
lastMaintenanceRunId (string) --
The Oracle Cloud Identifier (OCID) of the last maintenance run for the Exadata infrastructure.
maintenanceWindow (dict) --
The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
customActionTimeoutInMins (integer) --
The custom action timeout in minutes for the maintenance window.
daysOfWeek (list) --
The days of the week when maintenance can be performed.
(dict) --
An enumeration of days of the week used for scheduling maintenance windows.
name (string) --
The name of the day of the week.
hoursOfDay (list) --
The hours of the day when maintenance can be performed.
(integer) --
isCustomActionTimeoutEnabled (boolean) --
Indicates whether custom action timeout is enabled for the maintenance window.
leadTimeInWeeks (integer) --
The lead time in weeks before the maintenance window.
months (list) --
The months when maintenance can be performed.
(dict) --
An enumeration of months used for scheduling maintenance windows.
name (string) --
The name of the month.
patchingMode (string) --
The patching mode for the maintenance window.
preference (string) --
The preference for the maintenance window scheduling.
skipRu (boolean) --
Indicates whether to skip release updates during maintenance.
weeksOfMonth (list) --
The weeks of the month when maintenance can be performed.
(integer) --
maxCpuCount (integer) --
The total number of CPU cores available on the Exadata infrastructure.
maxDataStorageInTBs (float) --
The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.
maxDbNodeStorageSizeInGBs (integer) --
The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.
maxMemoryInGBs (integer) --
The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.
monthlyDbServerVersion (string) --
The monthly software version of the database servers installed on the Exadata infrastructure.
monthlyStorageServerVersion (string) --
The monthly software version of the storage servers installed on the Exadata infrastructure.
nextMaintenanceRunId (string) --
The OCID of the next maintenance run for the Exadata infrastructure.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the Exadata infrastructure.
ociUrl (string) --
The HTTPS link to the Exadata infrastructure in OCI.
ocid (string) --
The OCID of the Exadata infrastructure.
shape (string) --
The model name of the Exadata infrastructure.
storageCount (integer) --
The number of storage servers that are activated for the Exadata infrastructure.
storageServerVersion (string) --
The software version of the storage servers on the Exadata infrastructure.
createdAt (datetime) --
The date and time when the Exadata infrastructure was created.
totalStorageSizeInGBs (integer) --
The total amount of storage, in gigabytes (GB), on the Exadata infrastructure.
percentProgress (float) --
The amount of progress made on the current operation on the Exadata infrastructure, expressed as a percentage.
databaseServerType (string) --
The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
storageServerType (string) --
The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
computeModel (string) --
The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
exascaleConfiguration (dict) --
The Exascale storage configuration of the Exadata infrastructure. This value is present only when Exascale storage is configured on the infrastructure.
totalStorageSizeInGBs (integer) --
The total amount of Exascale storage, in gigabytes (GB), configured on the Exadata infrastructure.
availableStorageSizeInGBs (integer) --
The amount of Exascale storage, in gigabytes (GB), that's available on the Exadata infrastructure.
totalVmStorageSizeInGBs (integer) --
The total amount of Exascale VM storage, in gigabytes (GB), on the Exadata infrastructure. VM clusters use Exascale VM storage for their VM file systems and VM backups.
availableVmStorageSizeInGBs (integer) --
The amount of Exascale VM storage, in gigabytes (GB), that's available on the Exadata infrastructure.
{'cloudVmCluster': {'exascaleDbStorageVaultArn': 'string',
'exascaleDbStorageVaultId': 'string',
'fileSystemConfigurationDetails': [{'fileSystemSizeInGBs': 'integer',
'mountPoint': 'string'}],
'storageManagementType': 'ASM | EXASCALE',
'vmBackupStorageType': 'LOCAL | EXASCALE',
'vmFileSystemStorageType': 'LOCAL | EXASCALE'}}
Returns information about the specified VM cluster.
See also: AWS API Documentation
Request Syntax
client.get_cloud_vm_cluster(
cloudVmClusterId='string'
)
string
[REQUIRED]
The unique identifier of the VM cluster.
dict
Response Syntax
{
'cloudVmCluster': {
'cloudVmClusterId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudVmClusterArn': 'string',
'cloudExadataInfrastructureId': 'string',
'cloudExadataInfrastructureArn': 'string',
'exascaleDbStorageVaultId': 'string',
'exascaleDbStorageVaultArn': 'string',
'storageManagementType': 'ASM'|'EXASCALE',
'vmFileSystemStorageType': 'LOCAL'|'EXASCALE',
'vmBackupStorageType': 'LOCAL'|'EXASCALE',
'fileSystemConfigurationDetails': [
{
'mountPoint': 'string',
'fileSystemSizeInGBs': 123
},
],
'clusterName': 'string',
'cpuCoreCount': 123,
'dataCollectionOptions': {
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'diskRedundancy': 'HIGH'|'NORMAL',
'giVersion': 'string',
'hostname': 'string',
'iormConfigCache': {
'dbPlans': [
{
'dbName': 'string',
'flashCacheLimit': 'string',
'share': 123
},
],
'lifecycleDetails': 'string',
'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
},
'isLocalBackupEnabled': True|False,
'isSparseDiskgroupEnabled': True|False,
'lastUpdateHistoryEntryId': 'string',
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'listenerPort': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'domain': 'string',
'scanDnsName': 'string',
'scanDnsRecordId': 'string',
'scanIpIds': [
'string',
],
'shape': 'string',
'sshPublicKeys': [
'string',
],
'storageSizeInGBs': 123,
'systemVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'timeZone': 'string',
'vipIds': [
'string',
],
'odbNetworkId': 'string',
'odbNetworkArn': 'string',
'percentProgress': ...,
'computeModel': 'ECPU'|'OCPU',
'iamRoles': [
{
'iamRoleArn': 'string',
'status': 'ASSOCIATING'|'DISASSOCIATING'|'FAILED'|'CONNECTED'|'DISCONNECTED'|'PARTIALLY_CONNECTED'|'UNKNOWN',
'statusReason': 'string',
'awsIntegration': 'KmsTde'
},
]
}
}
Response Structure
(dict) --
cloudVmCluster (dict) --
The VM cluster.
cloudVmClusterId (string) --
The unique identifier of the VM cluster.
displayName (string) --
The user-friendly name for the VM cluster.
status (string) --
The current status of the VM cluster.
statusReason (string) --
Additional information about the status of the VM cluster.
cloudVmClusterArn (string) --
The Amazon Resource Name (ARN) of the VM cluster.
cloudExadataInfrastructureId (string) --
The unique identifier of the Exadata infrastructure that this VM cluster belongs to.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) of the Exadata infrastructure that this VM cluster belongs to.
exascaleDbStorageVaultId (string) --
The unique identifier of the Exascale storage vault that the VM cluster uses. This value is present only for VM clusters that use an Exascale storage vault.
exascaleDbStorageVaultArn (string) --
The Amazon Resource Name (ARN) of the Exascale storage vault that the VM cluster uses. This value is present only for VM clusters that use an Exascale storage vault.
storageManagementType (string) --
The type of storage management for the VM cluster. A value of ASM indicates Oracle Automatic Storage Management, and EXASCALE indicates Exascale storage.
vmFileSystemStorageType (string) --
The type of storage that the VM cluster uses for its VM file systems.
vmBackupStorageType (string) --
The type of storage that the VM cluster uses for VM backups.
fileSystemConfigurationDetails (list) --
The list of file system configurations for the VM cluster.
(dict) --
The configuration of a file system on a VM cluster.
mountPoint (string) --
The mount point of the file system.
fileSystemSizeInGBs (integer) --
The size of the file system, in gigabytes (GB).
clusterName (string) --
The name of the Grid Infrastructure (GI) cluster.
cpuCoreCount (integer) --
The number of CPU cores enabled on the VM cluster.
dataCollectionOptions (dict) --
The set of diagnostic collection options enabled for the VM cluster.
isDiagnosticsEventsEnabled (boolean) --
Indicates whether diagnostic collection is enabled for the VM cluster.
isHealthMonitoringEnabled (boolean) --
Indicates whether health monitoring is enabled for the VM cluster.
isIncidentLogsEnabled (boolean) --
Indicates whether incident logs are enabled for the cloud VM cluster.
dataStorageSizeInTBs (float) --
The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
dbNodeStorageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
dbServers (list) --
The list of database servers for the VM cluster.
(string) --
diskRedundancy (string) --
The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
giVersion (string) --
The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostname (string) --
The host name for the VM cluster.
iormConfigCache (dict) --
The ExadataIormConfig cache details for the VM cluster.
dbPlans (list) --
An array of IORM settings for all the database in the Exadata DB system.
(dict) --
The IORM configuration settings for the database.
dbName (string) --
The database name. For the default DbPlan, the dbName is default.
flashCacheLimit (string) --
The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share (integer) --
The relative priority of this database.
lifecycleDetails (string) --
Additional information about the current lifecycleState.
lifecycleState (string) --
The current state of IORM configuration for the Exadata DB system.
objective (string) --
The current value for the IORM objective. The default is AUTO.
isLocalBackupEnabled (boolean) --
Indicates whether database backups to local Exadata storage is enabled for the VM cluster.
isSparseDiskgroupEnabled (boolean) --
Indicates whether the VM cluster is configured with a sparse disk group.
lastUpdateHistoryEntryId (string) --
The Oracle Cloud ID (OCID) of the last maintenance update history entry.
licenseModel (string) --
The Oracle license model applied to the VM cluster.
listenerPort (integer) --
The port number configured for the listener on the VM cluster.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
nodeCount (integer) --
The number of nodes in the VM cluster.
ocid (string) --
The OCID of the VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the VM cluster.
ociUrl (string) --
The HTTPS link to the VM cluster in OCI.
domain (string) --
The domain of the VM cluster.
scanDnsName (string) --
The fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
scanDnsRecordId (string) --
The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.
scanIpIds (list) --
The OCID of the SCAN IP addresses that are associated with the VM cluster.
(string) --
shape (string) --
The hardware model name of the Exadata infrastructure that's running the VM cluster.
sshPublicKeys (list) --
The public key portion of one or more key pairs used for SSH access to the VM cluster.
(string) --
storageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
systemVersion (string) --
The operating system version of the image chosen for the VM cluster.
createdAt (datetime) --
The date and time when the VM cluster was created.
timeZone (string) --
The time zone of the VM cluster.
vipIds (list) --
The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
(string) --
odbNetworkId (string) --
The unique identifier of the ODB network for the VM cluster.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network associated with this VM cluster.
percentProgress (float) --
The amount of progress made on the current operation on the VM cluster, expressed as a percentage.
computeModel (string) --
The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
iamRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) service roles associated with the VM cluster.
(dict) --
Information about an Amazon Web Services Identity and Access Management (IAM) service role associated with a resource.
iamRoleArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role.
status (string) --
The current status of the Amazon Web Services Identity and Access Management (IAM) service role.
statusReason (string) --
Additional information about the current status of the Amazon Web Services Identity and Access Management (IAM) service role, if applicable.
awsIntegration (string) --
The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role.
{'exascaleDbStorageVault': {'cloudExadataInfrastructureArn': 'string',
'cloudExadataInfrastructureId': 'string',
'vaultType': 'EXASCALE_INFRASTRUCTURE | '
'DEDICATED_INFRASTRUCTURE'}}
Returns information about the specified Exascale storage vault.
See also: AWS API Documentation
Request Syntax
client.get_exascale_db_storage_vault(
exascaleDbStorageVaultId='string'
)
string
[REQUIRED]
The unique identifier of the Exascale storage vault.
dict
Response Syntax
{
'exascaleDbStorageVault': {
'exascaleDbStorageVaultId': 'string',
'additionalFlashCacheInPercent': 123,
'attachedShapeAttributes': [
'SMART_STORAGE'|'BLOCK_STORAGE',
],
'autoscaleLimitInGBs': 123,
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'cloudExadataInfrastructureArn': 'string',
'cloudExadataInfrastructureId': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'displayName': 'string',
'vmClusterArns': [
'string',
],
'vmClusterCount': 123,
'vmClusterIds': [
'string',
],
'exascaleDbStorageVaultArn': 'string',
'highCapacityDatabaseStorage': {
'availableSizeInGBs': 123,
'totalSizeInGBs': 123
},
'isAutoscaleEnabled': True|False,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'percentProgress': ...,
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'timeZone': 'string',
'vaultType': 'EXASCALE_INFRASTRUCTURE'|'DEDICATED_INFRASTRUCTURE'
}
}
Response Structure
(dict) --
exascaleDbStorageVault (dict) --
The Exascale storage vault.
exascaleDbStorageVaultId (string) --
The unique identifier of the Exascale storage vault.
additionalFlashCacheInPercent (integer) --
The additional flash cache percentage for the Exascale storage vault.
attachedShapeAttributes (list) --
The list of shape attributes attached to the Exascale storage vault.
(string) --
autoscaleLimitInGBs (integer) --
The autoscale limit in gigabytes (GB) for the Exascale storage vault.
availabilityZone (string) --
The Availability Zone for the Exascale storage vault.
availabilityZoneId (string) --
The Availability Zone ID for the Exascale storage vault.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) of the Exadata infrastructure that hosts the Exascale storage vault. This value is present only for vaults on dedicated Exadata infrastructure.
cloudExadataInfrastructureId (string) --
The unique identifier of the Exadata infrastructure that hosts the Exascale storage vault. This value is present only for vaults on dedicated Exadata infrastructure.
createdAt (datetime) --
The date and time when the Exascale storage vault was created.
description (string) --
The description of the Exascale storage vault.
displayName (string) --
The user-friendly name for the Exascale storage vault.
vmClusterArns (list) --
The list of Amazon Resource Names (ARNs) of the VM clusters associated with this Exascale storage vault.
(string) --
vmClusterCount (integer) --
The number of VM clusters associated with this Exascale storage vault.
vmClusterIds (list) --
The list of unique identifiers of the VM clusters associated with this Exascale storage vault.
(string) --
exascaleDbStorageVaultArn (string) --
The Amazon Resource Name (ARN) of the Exascale storage vault.
highCapacityDatabaseStorage (dict) --
The high-capacity database storage details for the Exascale storage vault.
availableSizeInGBs (integer) --
The available storage size, in gigabytes (GB).
totalSizeInGBs (integer) --
The total storage size, in gigabytes (GB).
isAutoscaleEnabled (boolean) --
Specifies whether autoscaling is enabled for the Exascale storage vault.
ocid (string) --
The OCID of the Exascale storage vault.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the Exascale storage vault.
ociUrl (string) --
The HTTPS link to the Exascale storage vault in Oracle Cloud Infrastructure (OCI).
percentProgress (float) --
The amount of progress made on the current operation on the Exascale storage vault, expressed as a percentage.
status (string) --
The current status of the Exascale storage vault.
statusReason (string) --
Additional information about the status of the Exascale storage vault.
timeZone (string) --
The time zone of the Exascale storage vault.
vaultType (string) --
The type of infrastructure that hosts the Exascale storage vault.
{'cloudExadataInfrastructures': {'exascaleConfiguration': {'availableStorageSizeInGBs': 'integer',
'availableVmStorageSizeInGBs': 'integer',
'totalStorageSizeInGBs': 'integer',
'totalVmStorageSizeInGBs': 'integer'}}}
Returns information about the Exadata infrastructures owned by your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_cloud_exadata_infrastructures(
maxResults=123,
nextToken='string'
)
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default: 10
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
dict
Response Syntax
{
'nextToken': 'string',
'cloudExadataInfrastructures': [
{
'cloudExadataInfrastructureId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureArn': 'string',
'activatedStorageCount': 123,
'additionalStorageCount': 123,
'availableStorageSizeInGBs': 123,
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'computeCount': 123,
'cpuCount': 123,
'customerContactsToSendToOCI': [
{
'email': 'string'
},
],
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServerVersion': 'string',
'lastMaintenanceRunId': 'string',
'maintenanceWindow': {
'customActionTimeoutInMins': 123,
'daysOfWeek': [
{
'name': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY'
},
],
'hoursOfDay': [
123,
],
'isCustomActionTimeoutEnabled': True|False,
'leadTimeInWeeks': 123,
'months': [
{
'name': 'JANUARY'|'FEBRUARY'|'MARCH'|'APRIL'|'MAY'|'JUNE'|'JULY'|'AUGUST'|'SEPTEMBER'|'OCTOBER'|'NOVEMBER'|'DECEMBER'
},
],
'patchingMode': 'ROLLING'|'NONROLLING',
'preference': 'NO_PREFERENCE'|'CUSTOM_PREFERENCE',
'skipRu': True|False,
'weeksOfMonth': [
123,
]
},
'maxCpuCount': 123,
'maxDataStorageInTBs': 123.0,
'maxDbNodeStorageSizeInGBs': 123,
'maxMemoryInGBs': 123,
'memorySizeInGBs': 123,
'monthlyDbServerVersion': 'string',
'monthlyStorageServerVersion': 'string',
'nextMaintenanceRunId': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'ocid': 'string',
'shape': 'string',
'storageCount': 123,
'storageServerVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'totalStorageSizeInGBs': 123,
'percentProgress': ...,
'databaseServerType': 'string',
'storageServerType': 'string',
'computeModel': 'ECPU'|'OCPU',
'exascaleConfiguration': {
'totalStorageSizeInGBs': 123,
'availableStorageSizeInGBs': 123,
'totalVmStorageSizeInGBs': 123,
'availableVmStorageSizeInGBs': 123
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
cloudExadataInfrastructures (list) --
The list of Exadata infrastructures along with their properties.
(dict) --
Information about an Exadata infrastructure.
cloudExadataInfrastructureId (string) --
The unique identifier for the Exadata infrastructure.
displayName (string) --
The user-friendly name for the Exadata infrastructure.
status (string) --
The current status of the Exadata infrastructure.
statusReason (string) --
Additional information about the status of the Exadata infrastructure.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) for the Exadata infrastructure.
activatedStorageCount (integer) --
The number of storage servers requested for the Exadata infrastructure.
additionalStorageCount (integer) --
The number of storage servers requested for the Exadata infrastructure.
availableStorageSizeInGBs (integer) --
The amount of available storage, in gigabytes (GB), for the Exadata infrastructure.
availabilityZone (string) --
The name of the Availability Zone (AZ) where the Exadata infrastructure is located.
availabilityZoneId (string) --
The AZ ID of the AZ where the Exadata infrastructure is located.
computeCount (integer) --
The number of database servers for the Exadata infrastructure.
cpuCount (integer) --
The total number of CPU cores that are allocated to the Exadata infrastructure.
customerContactsToSendToOCI (list) --
The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.
(dict) --
A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure.
email (string) --
The email address of the contact.
dataStorageSizeInTBs (float) --
The size of the Exadata infrastructure's data disk group, in terabytes (TB).
dbNodeStorageSizeInGBs (integer) --
The size of the Exadata infrastructure's local node storage, in gigabytes (GB).
dbServerVersion (string) --
The software version of the database servers on the Exadata infrastructure.
lastMaintenanceRunId (string) --
The Oracle Cloud Identifier (OCID) of the last maintenance run for the Exadata infrastructure.
maintenanceWindow (dict) --
The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
customActionTimeoutInMins (integer) --
The custom action timeout in minutes for the maintenance window.
daysOfWeek (list) --
The days of the week when maintenance can be performed.
(dict) --
An enumeration of days of the week used for scheduling maintenance windows.
name (string) --
The name of the day of the week.
hoursOfDay (list) --
The hours of the day when maintenance can be performed.
(integer) --
isCustomActionTimeoutEnabled (boolean) --
Indicates whether custom action timeout is enabled for the maintenance window.
leadTimeInWeeks (integer) --
The lead time in weeks before the maintenance window.
months (list) --
The months when maintenance can be performed.
(dict) --
An enumeration of months used for scheduling maintenance windows.
name (string) --
The name of the month.
patchingMode (string) --
The patching mode for the maintenance window.
preference (string) --
The preference for the maintenance window scheduling.
skipRu (boolean) --
Indicates whether to skip release updates during maintenance.
weeksOfMonth (list) --
The weeks of the month when maintenance can be performed.
(integer) --
maxCpuCount (integer) --
The total number of CPU cores available on the Exadata infrastructure.
maxDataStorageInTBs (float) --
The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.
maxDbNodeStorageSizeInGBs (integer) --
The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.
maxMemoryInGBs (integer) --
The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.
monthlyDbServerVersion (string) --
The monthly software version of the database servers (dom0) installed on the Exadata infrastructure.
monthlyStorageServerVersion (string) --
The monthly software version of the storage servers installed on the Exadata infrastructure.
nextMaintenanceRunId (string) --
The OCID of the next maintenance run for the Exadata infrastructure.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the Exadata infrastructure.
ociUrl (string) --
The HTTPS link to the Exadata infrastructure in OCI.
ocid (string) --
The OCID of the Exadata infrastructure.
shape (string) --
The model name of the Exadata infrastructure.
storageCount (integer) --
The number of storage servers that are activated for the Exadata infrastructure.
storageServerVersion (string) --
The software version of the storage servers on the Exadata infrastructure.
createdAt (datetime) --
The date and time when the Exadata infrastructure was created.
totalStorageSizeInGBs (integer) --
The total amount of storage, in gigabytes (GB), on the Exadata infrastructure.
percentProgress (float) --
The amount of progress made on the current operation on the Exadata infrastructure, expressed as a percentage.
databaseServerType (string) --
The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
storageServerType (string) --
The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
computeModel (string) --
The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
exascaleConfiguration (dict) --
The Exascale storage configuration of the Exadata infrastructure. This value is present only when Exascale storage is configured on the infrastructure.
totalStorageSizeInGBs (integer) --
The total amount of Exascale storage, in gigabytes (GB), configured on the Exadata infrastructure.
availableStorageSizeInGBs (integer) --
The amount of Exascale storage, in gigabytes (GB), that's available on the Exadata infrastructure.
totalVmStorageSizeInGBs (integer) --
The total amount of Exascale VM storage, in gigabytes (GB), on the Exadata infrastructure. VM clusters use Exascale VM storage for their VM file systems and VM backups.
availableVmStorageSizeInGBs (integer) --
The amount of Exascale VM storage, in gigabytes (GB), that's available on the Exadata infrastructure.
{'cloudVmClusters': {'exascaleDbStorageVaultArn': 'string',
'exascaleDbStorageVaultId': 'string',
'fileSystemConfigurationDetails': [{'fileSystemSizeInGBs': 'integer',
'mountPoint': 'string'}],
'storageManagementType': 'ASM | EXASCALE',
'vmBackupStorageType': 'LOCAL | EXASCALE',
'vmFileSystemStorageType': 'LOCAL | EXASCALE'}}
Returns information about the VM clusters owned by your Amazon Web Services account or only the ones on the specified Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.list_cloud_vm_clusters(
maxResults=123,
nextToken='string',
cloudExadataInfrastructureId='string'
)
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default: 10
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
string
The unique identifier of the Oracle Exadata infrastructure.
dict
Response Syntax
{
'nextToken': 'string',
'cloudVmClusters': [
{
'cloudVmClusterId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudVmClusterArn': 'string',
'cloudExadataInfrastructureId': 'string',
'cloudExadataInfrastructureArn': 'string',
'exascaleDbStorageVaultId': 'string',
'exascaleDbStorageVaultArn': 'string',
'storageManagementType': 'ASM'|'EXASCALE',
'vmFileSystemStorageType': 'LOCAL'|'EXASCALE',
'vmBackupStorageType': 'LOCAL'|'EXASCALE',
'fileSystemConfigurationDetails': [
{
'mountPoint': 'string',
'fileSystemSizeInGBs': 123
},
],
'clusterName': 'string',
'cpuCoreCount': 123,
'dataCollectionOptions': {
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'diskRedundancy': 'HIGH'|'NORMAL',
'giVersion': 'string',
'hostname': 'string',
'iormConfigCache': {
'dbPlans': [
{
'dbName': 'string',
'flashCacheLimit': 'string',
'share': 123
},
],
'lifecycleDetails': 'string',
'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
},
'isLocalBackupEnabled': True|False,
'isSparseDiskgroupEnabled': True|False,
'lastUpdateHistoryEntryId': 'string',
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'listenerPort': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'domain': 'string',
'scanDnsName': 'string',
'scanDnsRecordId': 'string',
'scanIpIds': [
'string',
],
'shape': 'string',
'sshPublicKeys': [
'string',
],
'storageSizeInGBs': 123,
'systemVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'timeZone': 'string',
'vipIds': [
'string',
],
'odbNetworkId': 'string',
'odbNetworkArn': 'string',
'percentProgress': ...,
'computeModel': 'ECPU'|'OCPU',
'iamRoles': [
{
'iamRoleArn': 'string',
'status': 'ASSOCIATING'|'DISASSOCIATING'|'FAILED'|'CONNECTED'|'DISCONNECTED'|'PARTIALLY_CONNECTED'|'UNKNOWN',
'statusReason': 'string',
'awsIntegration': 'KmsTde'
},
]
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
cloudVmClusters (list) --
The list of VM clusters along with their properties.
(dict) --
Information about a VM cluster.
cloudVmClusterId (string) --
The unique identifier of the VM cluster.
displayName (string) --
The user-friendly name for the VM cluster.
status (string) --
The current status of the VM cluster.
statusReason (string) --
Additional information about the status of the VM cluster.
cloudVmClusterArn (string) --
The Amazon Resource Name (ARN) of the VM cluster.
cloudExadataInfrastructureId (string) --
The unique identifier of the Exadata infrastructure that this VM cluster belongs to.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) of the Exadata infrastructure that this VM cluster belongs to.
exascaleDbStorageVaultId (string) --
The unique identifier of the Exascale storage vault that the VM cluster uses. This value is present only for VM clusters that use an Exascale storage vault.
exascaleDbStorageVaultArn (string) --
The Amazon Resource Name (ARN) of the Exascale storage vault that the VM cluster uses. This value is present only for VM clusters that use an Exascale storage vault.
storageManagementType (string) --
The type of storage management for the VM cluster. A value of ASM indicates Oracle Automatic Storage Management, and EXASCALE indicates Exascale storage.
vmFileSystemStorageType (string) --
The type of storage that the VM cluster uses for its VM file systems.
vmBackupStorageType (string) --
The type of storage that the VM cluster uses for VM backups.
fileSystemConfigurationDetails (list) --
The list of file system configurations for the VM cluster.
(dict) --
The configuration of a file system on a VM cluster.
mountPoint (string) --
The mount point of the file system.
fileSystemSizeInGBs (integer) --
The size of the file system, in gigabytes (GB).
clusterName (string) --
The name of the Grid Infrastructure (GI) cluster.
cpuCoreCount (integer) --
The number of CPU cores enabled on the VM cluster.
dataCollectionOptions (dict) --
Information about the data collection options enabled for a VM cluster.
isDiagnosticsEventsEnabled (boolean) --
Indicates whether diagnostic collection is enabled for the VM cluster.
isHealthMonitoringEnabled (boolean) --
Indicates whether health monitoring is enabled for the VM cluster.
isIncidentLogsEnabled (boolean) --
Indicates whether incident logs are enabled for the cloud VM cluster.
dataStorageSizeInTBs (float) --
The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
dbNodeStorageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
dbServers (list) --
The list of database servers for the VM cluster.
(string) --
diskRedundancy (string) --
The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
giVersion (string) --
The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostname (string) --
The host name for the VM cluster.
iormConfigCache (dict) --
The IORM settings of the Exadata DB system.
dbPlans (list) --
An array of IORM settings for all the database in the Exadata DB system.
(dict) --
The IORM configuration settings for the database.
dbName (string) --
The database name. For the default DbPlan, the dbName is default.
flashCacheLimit (string) --
The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share (integer) --
The relative priority of this database.
lifecycleDetails (string) --
Additional information about the current lifecycleState.
lifecycleState (string) --
The current state of IORM configuration for the Exadata DB system.
objective (string) --
The current value for the IORM objective. The default is AUTO.
isLocalBackupEnabled (boolean) --
Indicates whether database backups to local Exadata storage is enabled for the VM cluster.
isSparseDiskgroupEnabled (boolean) --
Indicates whether the VM cluster is configured with a sparse disk group.
lastUpdateHistoryEntryId (string) --
The Oracle Cloud ID (OCID) of the last maintenance update history entry.
licenseModel (string) --
The Oracle license model applied to the VM cluster.
listenerPort (integer) --
The port number configured for the listener on the VM cluster.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
nodeCount (integer) --
The number of nodes in the VM cluster.
ocid (string) --
The OCID of the VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the VM cluster.
ociUrl (string) --
The HTTPS link to the VM cluster in OCI.
domain (string) --
The domain of the VM cluster.
scanDnsName (string) --
The fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
scanDnsRecordId (string) --
The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.
scanIpIds (list) --
The OCID of the SCAN IP addresses that are associated with the VM cluster.
(string) --
shape (string) --
The hardware model name of the Exadata infrastructure that's running the VM cluster.
sshPublicKeys (list) --
The public key portion of one or more key pairs used for SSH access to the VM cluster.
(string) --
storageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
systemVersion (string) --
The operating system version of the image chosen for the VM cluster.
createdAt (datetime) --
The date and time when the VM cluster was created.
timeZone (string) --
The time zone of the VM cluster.
vipIds (list) --
The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
(string) --
odbNetworkId (string) --
The unique identifier of the ODB network for the VM cluster.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network associated with this VM cluster.
percentProgress (float) --
The amount of progress made on the current operation on the VM cluster, expressed as a percentage.
computeModel (string) --
The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
iamRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) service roles associated with the VM cluster in the summary information.
(dict) --
Information about an Amazon Web Services Identity and Access Management (IAM) service role associated with a resource.
iamRoleArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role.
status (string) --
The current status of the Amazon Web Services Identity and Access Management (IAM) service role.
statusReason (string) --
Additional information about the current status of the Amazon Web Services Identity and Access Management (IAM) service role, if applicable.
awsIntegration (string) --
The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role.
{'cloudExadataInfrastructureId': 'string',
'vaultType': 'EXASCALE_INFRASTRUCTURE | DEDICATED_INFRASTRUCTURE'}
Response {'exascaleDbStorageVaults': {'cloudExadataInfrastructureArn': 'string',
'cloudExadataInfrastructureId': 'string',
'vaultType': 'EXASCALE_INFRASTRUCTURE | '
'DEDICATED_INFRASTRUCTURE'}}
Returns information about the Exascale storage vaults owned by your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_exascale_db_storage_vaults(
maxResults=123,
nextToken='string',
cloudExadataInfrastructureId='string',
vaultType='EXASCALE_INFRASTRUCTURE'|'DEDICATED_INFRASTRUCTURE'
)
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
string
The unique identifier or Amazon Resource Name (ARN) of an Exadata infrastructure. If you specify this value, the operation returns only the Exascale storage vaults on that infrastructure that you own or that are shared with you. The infrastructure can be one that's shared with you through Amazon Web Services Resource Access Manager (Amazon Web Services RAM). You can't combine this filter with a vaultType of EXASCALE_INFRASTRUCTURE.
string
The type of Exascale storage vaults to return. Specify DEDICATED_INFRASTRUCTURE to return Exascale storage vaults on dedicated Exadata infrastructure, or EXASCALE_INFRASTRUCTURE to return Exascale storage vaults for Exascale VM clusters. If you don't specify a value, the operation returns both types. You can't combine EXASCALE_INFRASTRUCTURE with the cloudExadataInfrastructureId filter.
dict
Response Syntax
{
'nextToken': 'string',
'exascaleDbStorageVaults': [
{
'exascaleDbStorageVaultId': 'string',
'additionalFlashCacheInPercent': 123,
'attachedShapeAttributes': [
'SMART_STORAGE'|'BLOCK_STORAGE',
],
'autoscaleLimitInGBs': 123,
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'cloudExadataInfrastructureArn': 'string',
'cloudExadataInfrastructureId': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'displayName': 'string',
'vmClusterArns': [
'string',
],
'vmClusterCount': 123,
'vmClusterIds': [
'string',
],
'exascaleDbStorageVaultArn': 'string',
'highCapacityDatabaseStorage': {
'availableSizeInGBs': 123,
'totalSizeInGBs': 123
},
'isAutoscaleEnabled': True|False,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'percentProgress': ...,
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'timeZone': 'string',
'vaultType': 'EXASCALE_INFRASTRUCTURE'|'DEDICATED_INFRASTRUCTURE'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
exascaleDbStorageVaults (list) --
The list of Exascale storage vaults.
(dict) --
Summary information about an Exascale storage vault.
exascaleDbStorageVaultId (string) --
The unique identifier of the Exascale storage vault.
additionalFlashCacheInPercent (integer) --
The additional flash cache percentage for the Exascale storage vault.
attachedShapeAttributes (list) --
The list of shape attributes attached to the Exascale storage vault.
(string) --
autoscaleLimitInGBs (integer) --
The autoscale limit in gigabytes (GB) for the Exascale storage vault.
availabilityZone (string) --
The Availability Zone for the Exascale storage vault.
availabilityZoneId (string) --
The Availability Zone ID for the Exascale storage vault.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) of the Exadata infrastructure that hosts the Exascale storage vault. This value is present only for vaults on dedicated Exadata infrastructure.
cloudExadataInfrastructureId (string) --
The unique identifier of the Exadata infrastructure that hosts the Exascale storage vault. This value is present only for vaults on dedicated Exadata infrastructure.
createdAt (datetime) --
The date and time when the Exascale storage vault was created.
description (string) --
The description of the Exascale storage vault.
displayName (string) --
The user-friendly name for the Exascale storage vault.
vmClusterArns (list) --
The list of Amazon Resource Names (ARNs) of the VM clusters associated with this Exascale storage vault.
(string) --
vmClusterCount (integer) --
The number of VM clusters associated with this Exascale storage vault.
vmClusterIds (list) --
The list of unique identifiers of the VM clusters associated with this Exascale storage vault.
(string) --
exascaleDbStorageVaultArn (string) --
The Amazon Resource Name (ARN) of the Exascale storage vault.
highCapacityDatabaseStorage (dict) --
The high-capacity database storage details for the Exascale storage vault.
availableSizeInGBs (integer) --
The available storage size, in gigabytes (GB).
totalSizeInGBs (integer) --
The total storage size, in gigabytes (GB).
isAutoscaleEnabled (boolean) --
Specifies whether autoscaling is enabled for the Exascale storage vault.
ocid (string) --
The OCID of the Exascale storage vault.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the Exascale storage vault.
ociUrl (string) --
The HTTPS link to the Exascale storage vault in Oracle Cloud Infrastructure (OCI).
percentProgress (float) --
The amount of progress made on the current operation on the Exascale storage vault, expressed as a percentage.
status (string) --
The current status of the Exascale storage vault.
statusReason (string) --
Additional information about the status of the Exascale storage vault.
timeZone (string) --
The time zone of the Exascale storage vault.
vaultType (string) --
The type of infrastructure that hosts the Exascale storage vault.