v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1466450398.1 KB

Creates a VM cluster on the specified Exadata infrastructure.

post/#X-Amz-Target=Odb.CreateCloudVmCluster

Headers

X-Amz-Target'Odb.CreateCloudVmCluster' required

Request body

cloudExadataInfrastructureIdstring required

The unique identifier of the Exadata infrastructure for this VM cluster.

cpuCoreCountinteger required

The number of CPU cores to enable on the VM cluster.

displayNamestring required

A user-friendly name for the VM cluster.

giVersionstring required
<p>A valid software version of Oracle Grid Infrastructure (GI). To get the list of valid values, use the <code>ListGiVersions</code> operation and specify the shape of the Exadata infrastructure.</p> <p>Example: <code>19.0.0.0</code> </p>
hostnamestring required
<p>The host name for the VM cluster.</p> <p>Constraints:</p> <ul> <li> <p>Can't be "localhost" or "hostname".</p> </li> <li> <p>Can't contain "-version".</p> </li> <li> <p>The maximum length of the combined hostname and domain is 63 characters.</p> </li> <li> <p>The hostname must be unique within the subnet.</p> </li> </ul>
sshPublicKeysString[] required

The public key portion of one or more key pairs used for SSH access to the VM cluster.

odbNetworkIdstring required

The unique identifier of the ODB network for the VM cluster.

clusterNamestring

A name for the Grid Infrastructure cluster. The name isn't case sensitive.

dataStorageSizeInTBsnumber double

The size of the data disk group, in terabytes (TBs), to allocate for the VM cluster.

dbNodeStorageSizeInGBsinteger

The amount of local node storage, in gigabytes (GBs), to allocate for the VM cluster.

dbServersString[]

The list of database servers for the VM cluster.

tagsobject

The list of resource tags to apply to the VM cluster.

isLocalBackupEnabledboolean

Specifies whether to enable database backups to local Exadata storage for the VM cluster.

isSparseDiskgroupEnabledboolean

Specifies whether to create a sparse disk group for the VM cluster.

licenseModel'BRING_YOUR_OWN_LICENSE' | 'LICENSE_INCLUDED'
<p>The Oracle license model to apply to the VM cluster.</p> <p>Default: <code>LICENSE_INCLUDED</code> </p>
memorySizeInGBsinteger

The amount of memory, in gigabytes (GBs), to allocate for the VM cluster.

systemVersionstring

The version of the operating system of the image for the VM cluster.

timeZonestring
<p>The time zone for the VM cluster. For a list of valid values for time zone, you can check the options in the console.</p> <p>Default: UTC</p>
clientTokenstring

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.

scanListenerPortTcpinteger
<p>The port number for TCP connections to the single client access name (SCAN) listener. </p> <p>Valid values: <code>1024–8999</code> with the following exceptions: <code>2484</code>, <code>6100</code>, <code>6200</code>, <code>7060</code>, <code>7070</code>, <code>7085</code>, and <code>7879</code> </p> <p>Default: <code>1521</code> </p>

Response

Success

displayNamestring

The user-friendly name for the VM cluster.

status'AVAILABLE' | 'FAILED' | 'PROVISIONING' | 'TERMINATED' | 'TERMINATING' | 'UPDATING' | 'MAINTENANCE_IN_PROGRESS'

The current status of the VM cluster.

statusReasonstring

Additional information about the status of the VM cluster.

cloudVmClusterIdstring required

The unique identifier for the VM cluster.