odb / Client / get_exadb_vm_cluster

get_exadb_vm_cluster¶

odb.Client.get_exadb_vm_cluster(**kwargs)¶

Returns information about the specified Exascale VM cluster.

Request Syntax

response = client.get_exadb_vm_cluster(
    exadbVmClusterId='string'
)

Parameters:

exadbVmClusterId (string) –

[REQUIRED]

The unique identifier of the Exascale VM cluster.

Return type:

dict

Returns:

Response Syntax

{
    'exadbVmCluster': {
        'exadbVmClusterId': 'string',
        'clusterName': 'string',
        'createdAt': datetime(2015, 1, 1),
        'dataCollectionOptions': {
            'isDiagnosticsEventsEnabled': True|False,
            'isHealthMonitoringEnabled': True|False,
            'isIncidentLogsEnabled': True|False
        },
        'displayName': 'string',
        'domain': 'string',
        'enabledEcpuCount': 123,
        'exadbVmClusterArn': 'string',
        'exascaleDbStorageVaultArn': 'string',
        'exascaleDbStorageVaultId': 'string',
        'giVersion': 'string',
        'gridImageId': 'string',
        'gridImageType': 'RELEASE_UPDATE'|'CUSTOM_IMAGE',
        'hostname': 'string',
        'iamRoles': [
            {
                'iamRoleArn': 'string',
                'status': 'ASSOCIATING'|'DISASSOCIATING'|'FAILED'|'CONNECTED'|'DISCONNECTED'|'PARTIALLY_CONNECTED'|'UNKNOWN',
                'statusReason': 'string',
                'awsIntegration': 'KmsTde'
            },
        ],
        'iormConfigCache': {
            'dbPlans': [
                {
                    'dbName': 'string',
                    'flashCacheLimit': 'string',
                    'share': 123
                },
            ],
            'lifecycleDetails': 'string',
            'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
            'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
        },
        'lastUpdateHistoryEntryId': 'string',
        'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
        'listenerPort': 123,
        'memorySizeInGBs': 123,
        'nodeCount': 123,
        'ocid': 'string',
        'ociResourceAnchorName': 'string',
        'ociUrl': 'string',
        'odbNetworkArn': 'string',
        'odbNetworkId': 'string',
        'percentProgress': ...,
        'scanDnsName': 'string',
        'scanDnsRecordId': 'string',
        'scanIpIds': [
            'string',
        ],
        'scanListenerPortTcp': 123,
        'scanListenerPortTcpSsl': 123,
        'shape': 'string',
        'shapeAttribute': 'SMART_STORAGE'|'BLOCK_STORAGE',
        'snapshotFileSystemStorage': {
            'totalSizeInGBs': 123
        },
        'sshPublicKeys': [
            'string',
        ],
        'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
        'statusReason': 'string',
        'systemVersion': 'string',
        'timeZone': 'string',
        'totalEcpuCount': 123,
        'totalFileSystemStorage': {
            'totalSizeInGBs': 123
        },
        'vipIds': [
            'string',
        ],
        'vmFileSystemStorage': {
            'totalSizeInGBs': 123
        }
    }
}

Response Structure

(dict) –
- exadbVmCluster (dict) –
  
  The Exascale VM cluster.
  - exadbVmClusterId (string) –
    
    The unique identifier of the Exascale VM cluster.
  - clusterName (string) –
    
    The name of the Grid Infrastructure (GI) cluster.
  - createdAt (datetime) –
    
    The date and time when the Exascale VM cluster was created.
  - dataCollectionOptions (dict) –
    
    The set of diagnostic collection options enabled 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.
  - displayName (string) –
    
    The user-friendly name for the Exascale VM cluster.
  - domain (string) –
    
    The domain of the Exascale VM cluster.
  - enabledEcpuCount (integer) –
    
    The number of elastic compute processing units (ECPUs) enabled on the Exascale VM cluster.
  - exadbVmClusterArn (string) –
    
    The Amazon Resource Name (ARN) of the Exascale VM cluster.
  - exascaleDbStorageVaultArn (string) –
    
    The Amazon Resource Name (ARN) of the Exascale storage vault associated with this Exascale VM cluster.
  - exascaleDbStorageVaultId (string) –
    
    The unique identifier of the Exascale storage vault associated with this Exascale VM cluster.
  - giVersion (string) –
    
    The software version of the Oracle Grid Infrastructure (GI) for the Exascale VM cluster.
  - gridImageId (string) –
    
    The Grid Infrastructure software image ID for the Exascale VM cluster.
  - gridImageType (string) –
    
    The type of Grid Infrastructure image for the Exascale VM cluster.
  - hostname (string) –
    
    The host name for the Exascale VM cluster.
  - iamRoles (list) –
    
    The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Exascale 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.
  - iormConfigCache (dict) –
    
    The I/O Resource Management (IORM) configuration cache details for the Exascale 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.
  - lastUpdateHistoryEntryId (string) –
    
    The Oracle Cloud ID (OCID) of the last maintenance update history entry.
  - licenseModel (string) –
    
    The Oracle license model applied to the Exascale VM cluster.
  - listenerPort (integer) –
    
    The port number configured for the listener on the Exascale VM cluster.
  - memorySizeInGBs (integer) –
    
    The amount of memory, in gigabytes (GB), that’s allocated for the Exascale VM cluster.
  - nodeCount (integer) –
    
    The number of nodes in the Exascale VM cluster.
  - ocid (string) –
    
    The OCID of the Exascale VM cluster.
  - ociResourceAnchorName (string) –
    
    The name of the OCI resource anchor for the Exascale VM cluster.
  - ociUrl (string) –
    
    The HTTPS link to the Exascale VM cluster in Oracle Cloud Infrastructure (OCI).
  - odbNetworkArn (string) –
    
    The Amazon Resource Name (ARN) of the ODB network associated with this Exascale VM cluster.
  - odbNetworkId (string) –
    
    The unique identifier of the ODB network for the Exascale VM cluster.
  - percentProgress (float) –
    
    The amount of progress made on the current operation on the Exascale VM cluster, expressed as a percentage.
  - 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 Exascale VM cluster.
  - scanDnsRecordId (string) –
    
    The OCID of the DNS record for the SCAN IP addresses that are associated with the Exascale VM cluster.
  - scanIpIds (list) –
    
    The OCID of the SCAN IP addresses that are associated with the Exascale VM cluster.
    - (string) –
  - scanListenerPortTcp (integer) –
    
    The port number for TCP connections to the single client access name (SCAN) listener for the Exascale VM cluster.
  - scanListenerPortTcpSsl (integer) –
    
    The port number for TCP connections with SSL to the single client access name (SCAN) listener for the Exascale VM cluster.
  - shape (string) –
    
    The hardware model name of the Exadata infrastructure that’s running the Exascale VM cluster.
  - shapeAttribute (string) –
    
    The shape attribute for the Exascale VM cluster.
  - snapshotFileSystemStorage (dict) –
    
    The snapshot file system storage details for the Exascale VM cluster.
    - totalSizeInGBs (integer) –
      
      The total storage size, in gigabytes (GB).
  - sshPublicKeys (list) –
    
    The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster.
    - (string) –
  - status (string) –
    
    The current status of the Exascale VM cluster.
  - statusReason (string) –
    
    Additional information about the status of the Exascale VM cluster.
  - systemVersion (string) –
    
    The operating system version of the image chosen for the Exascale VM cluster.
  - timeZone (string) –
    
    The time zone of the Exascale VM cluster.
  - totalEcpuCount (integer) –
    
    The total number of ECPUs for the Exascale VM cluster.
  - totalFileSystemStorage (dict) –
    
    The total file system storage details for the Exascale VM cluster.
    - totalSizeInGBs (integer) –
      
      The total storage size, in gigabytes (GB).
  - vipIds (list) –
    
    The virtual IP (VIP) addresses associated with the Exascale VM cluster. One VIP address is assigned per node to support failover. If a node fails, its VIP is reassigned to another active node in the cluster.
    - (string) –
  - vmFileSystemStorage (dict) –
    
    The VM file system storage details for the Exascale VM cluster.
    - totalSizeInGBs (integer) –
      
      The total storage size, in gigabytes (GB).

Exceptions

odb.Client.exceptions.ThrottlingException
odb.Client.exceptions.ValidationException
odb.Client.exceptions.AccessDeniedException
odb.Client.exceptions.InternalServerException
odb.Client.exceptions.ResourceNotFoundException