odb / Client / create_cloud_vm_cluster

create_cloud_vm_cluster

odb.Client.create_cloud_vm_cluster(**kwargs)

Creates a VM cluster on the specified Exadata infrastructure.

See also: AWS API Documentation

Request Syntax

response = client.create_cloud_vm_cluster(
    cloudExadataInfrastructureId='string',
    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
)

Parameters:

• cloudExadataInfrastructureId (string) –

  [REQUIRED]

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

• cpuCoreCount (integer) –

  [REQUIRED]

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

• displayName (string) –

  [REQUIRED]

  A user-friendly name for the VM cluster.

• giVersion (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

• hostname (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.

• sshPublicKeys (list) –

  [REQUIRED]

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

  • (string) –

• odbNetworkId (string) –

  [REQUIRED]

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

• clusterName (string) – A name for the Grid Infrastructure cluster. The name isn’t case sensitive.

• dataCollectionOptions (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.

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

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

• dbServers (list) –

  The list of database servers for the VM cluster.

  • (string) –

• tags (dict) –

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

  • (string) –

    • (string) –

• isLocalBackupEnabled (boolean) – Specifies whether to enable database backups to local Exadata storage for the VM cluster.

• isSparseDiskgroupEnabled (boolean) – Specifies whether to create a sparse disk group for the VM cluster.

• licenseModel (string) –

  The Oracle license model to apply to the VM cluster.

  Default: LICENSE_INCLUDED

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

• systemVersion (string) – The version of the operating system of the image for the VM cluster.

• timeZone (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

• clientToken (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.

• scanListenerPortTcp (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

Return type:

dict

Returns:

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.

Exceptions

• odb.Client.exceptions.ThrottlingException

• odb.Client.exceptions.ServiceQuotaExceededException

• odb.Client.exceptions.ValidationException

• odb.Client.exceptions.ConflictException

• odb.Client.exceptions.AccessDeniedException

• odb.Client.exceptions.InternalServerException

• odb.Client.exceptions.ResourceNotFoundException