• Public
  • Public/Protected
  • All

Module DbHomeSummary

A directory where Oracle Database software is installed. A bare metal or Exadata DB system can have multiple Database Homes and each Database Home can run a different supported version of Oracle Database. A virtual machine DB system can have only one Database Home. For more information, see Bare Metal and Virtual Machine DB Systems and Exadata DB Systems.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.



compartmentId: string

The OCID of the compartment.


dbHomeLocation: string

The location of the Oracle Database Home.

Optional dbSystemId

dbSystemId: undefined | string

The OCID of the DB system.


dbVersion: string

The Oracle Database version.


displayName: string

The user-provided name for the Database Home. The name does not need to be unique.


id: string

The OCID of the Database Home.

Optional lastPatchHistoryEntryId

lastPatchHistoryEntryId: undefined | string

The OCID of the last patch history. This value is updated as soon as a patch operation is started.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current lifecycleState.


lifecycleState: LifecycleState

The current state of the Database Home.

Optional timeCreated

timeCreated: Date

The date and time the Database Home was created.

Optional vmClusterId

vmClusterId: undefined | string

The OCID of the VM cluster.