odb / Client / get_cloud_vm_cluster

get_cloud_vm_cluster¶

odb.Client.get_cloud_vm_cluster(**kwargs)¶

Returns information about the specified VM cluster.

Request Syntax

response = client.get_cloud_vm_cluster(
    cloudVmClusterId='string'
)

Parameters:

cloudVmClusterId (string) –

[REQUIRED]

The unique identifier of the VM cluster.

Return type:

dict

Returns:

Response Syntax

{
    'cloudVmCluster': {
        'cloudVmClusterId': 'string',
        'displayName': 'string',
        'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
        'statusReason': 'string',
        'cloudVmClusterArn': 'string',
        'cloudExadataInfrastructureId': 'string',
        'clusterName': 'string',
        'cpuCoreCount': 123,
        'dataCollectionOptions': {
            'isDiagnosticsEventsEnabled': True|False,
            'isHealthMonitoringEnabled': True|False,
            'isIncidentLogsEnabled': True|False
        },
        'dataStorageSizeInTBs': 123.0,
        'dbNodeStorageSizeInGBs': 123,
        'dbServers': [
            'string',
        ],
        'diskRedundancy': 'HIGH'|'NORMAL',
        'giVersion': 'string',
        'hostname': 'string',
        'iormConfigCache': {
            'dbPlans': [
                {
                    'dbName': 'string',
                    'flashCacheLimit': 'string',
                    'share': 123
                },
            ],
            'lifecycleDetails': 'string',
            'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
            'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
        },
        'isLocalBackupEnabled': True|False,
        'isSparseDiskgroupEnabled': True|False,
        'lastUpdateHistoryEntryId': 'string',
        'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
        'listenerPort': 123,
        'memorySizeInGBs': 123,
        'nodeCount': 123,
        'ocid': 'string',
        'ociResourceAnchorName': 'string',
        'ociUrl': 'string',
        'domain': 'string',
        'scanDnsName': 'string',
        'scanDnsRecordId': 'string',
        'scanIpIds': [
            'string',
        ],
        'shape': 'string',
        'sshPublicKeys': [
            'string',
        ],
        'storageSizeInGBs': 123,
        'systemVersion': 'string',
        'createdAt': datetime(2015, 1, 1),
        'timeZone': 'string',
        'vipIds': [
            'string',
        ],
        'odbNetworkId': 'string',
        'percentProgress': ...,
        'computeModel': 'ECPU'|'OCPU'
    }
}

Response Structure

(dict) –
- cloudVmCluster (dict) –
  
  The VM cluster.
  - cloudVmClusterId (string) –
    
    The unique identifier of the VM cluster.
  - 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.
  - cloudVmClusterArn (string) –
    
    The Amazon Resource Name (ARN) of the VM cluster.
  - cloudExadataInfrastructureId (string) –
    
    The unique identifier of the Exadata infrastructure that this VM cluster belongs to.
  - clusterName (string) –
    
    The name of the Grid Infrastructure (GI) cluster.
  - cpuCoreCount (integer) –
    
    The number of CPU cores enabled on the VM cluster.
  - dataCollectionOptions (dict) –
    
    The set of diagnostic collection options enabled 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), that’s allocated for the VM cluster.
  - dbNodeStorageSizeInGBs (integer) –
    
    The amount of local node storage, in gigabytes (GB), that’s allocated for the VM cluster.
  - dbServers (list) –
    
    The list of database servers for the VM cluster.
    - (string) –
  - diskRedundancy (string) –
    
    The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
  - giVersion (string) –
    
    The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
  - hostname (string) –
    
    The host name for the VM cluster.
  - iormConfigCache (dict) –
    
    The ExadataIormConfig cache details for the 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.
  - isLocalBackupEnabled (boolean) –
    
    Indicates whether database backups to local Exadata storage is enabled for the VM cluster.
  - isSparseDiskgroupEnabled (boolean) –
    
    Indicates whether the VM cluster is configured with a sparse disk group.
  - lastUpdateHistoryEntryId (string) –
    
    The Oracle Cloud ID (OCID) of the last maintenance update history entry.
  - licenseModel (string) –
    
    The Oracle license model applied to the VM cluster.
  - listenerPort (integer) –
    
    The port number configured for the listener on the VM cluster.
  - memorySizeInGBs (integer) –
    
    The amount of memory, in gigabytes (GB), that’s allocated for the VM cluster.
  - nodeCount (integer) –
    
    The number of nodes in the VM cluster.
  - ocid (string) –
    
    The OCID of the VM cluster.
  - ociResourceAnchorName (string) –
    
    The name of the OCI resource anchor for the VM cluster.
  - ociUrl (string) –
    
    The HTTPS link to the VM cluster in OCI.
  - domain (string) –
    
    The domain of the VM cluster.
  - scanDnsName (string) –
    
    The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
  - scanDnsRecordId (string) –
    
    The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.
  - scanIpIds (list) –
    
    The OCID of the SCAN IP addresses that are associated with the VM cluster.
    - (string) –
  - shape (string) –
    
    The hardware model name of the Exadata infrastructure that’s running the VM cluster.
  - sshPublicKeys (list) –
    
    The public key portion of one or more key pairs used for SSH access to the VM cluster.
    - (string) –
  - storageSizeInGBs (integer) –
    
    The amount of local node storage, in gigabytes (GB), that’s allocated to the VM cluster.
  - systemVersion (string) –
    
    The operating system version of the image chosen for the VM cluster.
  - createdAt (datetime) –
    
    The date and time when the VM cluster was created.
  - timeZone (string) –
    
    The time zone of the VM cluster.
  - vipIds (list) –
    
    The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle’s Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
    - (string) –
  - odbNetworkId (string) –
    
    The unique identifier of the ODB network for the VM cluster.
  - percentProgress (float) –
    
    The amount of progress made on the current operation on the VM cluster, expressed as a percentage.
  - computeModel (string) –
    
    The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.

get_cloud_vm_cluster¶

Request Syntax

Response Syntax

Response Structure

Exceptions