odb / Client / create_exadb_vm_cluster

create_exadb_vm_cluster

odb.Client.create_exadb_vm_cluster(**kwargs)

Creates an Exascale VM cluster.

See also: AWS API Documentation

Request Syntax

response = client.create_exadb_vm_cluster(
    displayName='string',
    enabledEcpuCount=123,
    exascaleDbStorageVaultId='string',
    gridImageId='string',
    hostname='string',
    nodeCount=123,
    odbNetworkId='string',
    shape='string',
    sshPublicKeys=[
        'string',
    ],
    totalEcpuCount=123,
    vmFileSystemStorageTotalSizeInGBs=123,
    clusterName='string',
    dataCollectionOptions={
        'isDiagnosticsEventsEnabled': True|False,
        'isHealthMonitoringEnabled': True|False,
        'isIncidentLogsEnabled': True|False
    },
    licenseModel='BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
    scanListenerPortTcp=123,
    scanListenerPortTcpSsl=123,
    shapeAttribute='SMART_STORAGE'|'BLOCK_STORAGE',
    systemVersion='string',
    tags={
        'string': 'string'
    },
    timeZone='string',
    clientToken='string'
)
Parameters:
  • displayName (string) –

    [REQUIRED]

    A user-friendly name for the Exascale VM cluster.

  • enabledEcpuCount (integer) –

    [REQUIRED]

    The number of ECPUs to enable for the Exascale VM cluster.

  • exascaleDbStorageVaultId (string) –

    [REQUIRED]

    The unique identifier of the Exascale storage vault for this Exascale VM cluster.

  • gridImageId (string) –

    [REQUIRED]

    The Grid Infrastructure software image ID for the Exascale VM cluster.

  • hostname (string) –

    [REQUIRED]

    The host name for the Exascale VM cluster.

  • nodeCount (integer) –

    [REQUIRED]

    The number of nodes in the Exascale VM cluster.

  • odbNetworkId (string) –

    [REQUIRED]

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

  • shape (string) –

    [REQUIRED]

    The shape of the Exascale VM cluster.

  • sshPublicKeys (list) –

    [REQUIRED]

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

    • (string) –

  • totalEcpuCount (integer) –

    [REQUIRED]

    The total number of ECPUs for the Exascale VM cluster.

  • vmFileSystemStorageTotalSizeInGBs (integer) –

    [REQUIRED]

    The total amount of file system storage, in gigabytes (GB), for the Exascale 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 Exascale 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.

  • licenseModel (string) – The Oracle license model to apply to the Exascale VM cluster.

  • scanListenerPortTcp (integer) – The port number for TCP connections to the single client access name (SCAN) listener.

  • scanListenerPortTcpSsl (integer) – The port number for TCP connections with SSL to the single client access name (SCAN) listener.

  • shapeAttribute (string) – The shape attribute for the Exascale VM cluster.

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

  • tags (dict) –

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

    • (string) –

      • (string) –

  • timeZone (string) – The time zone for the Exascale VM cluster.

  • 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 one 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.

Return type:

dict

Returns:

Response Syntax

{
    'displayName': 'string',
    'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
    'statusReason': 'string',
    'exadbVmClusterId': 'string'
}

Response Structure

  • (dict) –

    • displayName (string) –

      The user-friendly name for the Exascale VM cluster.

    • status (string) –

      The current status of the Exascale VM cluster.

    • statusReason (string) –

      Additional information about the status of the Exascale VM cluster.

    • exadbVmClusterId (string) –

      The unique identifier of the Exascale 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