odb / Client / update_cloud_vm_cluster

update_cloud_vm_cluster

odb.Client.update_cloud_vm_cluster(**kwargs)

Updates the properties of the specified VM cluster.

See also: AWS API Documentation

Request Syntax

response = client.update_cloud_vm_cluster(
    cloudVmClusterId='string',
    cpuCoreCount=123,
    dataCollectionOptions={
        'isDiagnosticsEventsEnabled': True|False,
        'isHealthMonitoringEnabled': True|False,
        'isIncidentLogsEnabled': True|False
    },
    dataStorageSizeInTBs=123.0,
    dbNodeStorageSizeInGBs=123,
    displayName='string',
    sshPublicKeys=[
        'string',
    ],
    licenseModel='BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
    memorySizeInGBs=123,
    storageSizeInGBs=123
)
Parameters:

  • cloudVmClusterId (string) –

    [REQUIRED]

    The unique identifier of the VM cluster to update.

  • cpuCoreCount (integer) – The number of CPU cores to enable on the VM cluster. If you don’t specify a value, the existing number of CPU cores is retained.

  • dataCollectionOptions (dict) –

    The set of preferences for the 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 (TB), to allocate for the VM cluster.

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

  • displayName (string) – A new user-friendly name for the VM cluster.

  • sshPublicKeys (list) –

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

    • (string) –

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

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

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

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 of the updated VM cluster.

    • status (string) –

      The current status of the VM cluster.

    • statusReason (string) –

      Additional information about the current status of the VM cluster, if applicable.

    • cloudVmClusterId (string) –

      The unique identifier of the updated VM cluster.

Exceptions