Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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.

Properties

compartmentId

compartmentId: string

The OCID of the compartment.

Optional databaseSoftwareImageId

databaseSoftwareImageId: undefined | string

The database software image OCID

dbHomeLocation

dbHomeLocation: string

The location of the Oracle Database Home.

Optional dbSystemId

dbSystemId: undefined | string

The OCID of the DB system.

dbVersion

dbVersion: string

The Oracle Database version.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

displayName

displayName: string

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

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the Database Home.

Optional isUnifiedAuditingEnabled

isUnifiedAuditingEnabled: undefined | false | true

Indicates whether unified autiding is enabled or not.

Optional kmsKeyId

kmsKeyId: undefined | string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

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 lifecycle state.

lifecycleState

lifecycleState: LifecycleState

The current state of the Database Home.

Optional oneOffPatches

oneOffPatches: Array<string>

List of one-off patches for Database Homes.

Optional timeCreated

timeCreated: Date

The date and time the Database Home was created.

Optional vmClusterId

vmClusterId: undefined | string

The OCID of the VM cluster.

Functions

getDeserializedJsonObj

getJsonObj