Managing CAKM Database Instances

The CAKM DB Instances page offers a centralized view of all CAKM database instances configured on CipherTrust Manager, along with their corresponding health statuses.

Creating CAKM DB Instances

Currently, the DB instances can be created only from the API playground.

1. Access the REST interface of CipherTrust Manager, see REST Interface.

2. In the left pane of the API playground, click Data Protection/Database Instances.

3. Under Database Protection, click Create – post /v1/data-protection/database-instances.

4. In the body field, specify the following parameters with their values, as shown below.

   Parameter	Description
   app_connector_type	Type of connector. Currently, only CAKM for Oracle TDE is supported.
   name	Name of the database instance.
   client_configurations	Configurations including client, connection settings, and client_autorenewal flag to be used by the client. This parameter is not required when database_instance_id is provided
   database_clients	Database clients to be associated with database instance. This parameter includes: — client_mode: Mode of the database client. The client can be in either united mode or isolated mode. This parameter is only applicable when client_type is PDB. — client_type: The type of the client. Supported types are: CDB and PDB — name: Name of the database instance.
   database_instance_id	Database instance identifier. Use this parameter to replicate the configurations of an existing instance.
   description	Description of the database instance.

   Note

   The client_configurations and database_instance_id can't be supplied simultaneously.

5. Click POST. From response, copy the Database_instance_id and client_configuration_id.

Create Client Profile

After creating the database instance, define client profile. Use any of the following options:

• API Playground

• GUI

Using API Playground

1. In the left pane of the API playground, click Client Profile.

2. Under Database Protection, click Create – post /v1/data-protection/client-profiles.

3. In the body field, specify the following parameters with their values, as shown below.

   Parameter	Description
   app_connector_type	Type of the connector.
   name	Unique name for client profile.
   client_configuration_id	Identifier of the client profile.

4. Click POST. From response, copy the client profile ID.

Associate Client Profile to Database Client

1. In the left pane of the API playground, click Database Clients.

2. Under Database Protection, click Create – get /v1/data-protection/database-clients.

3. Copy the IDs of the CDB and PDBs mentioned in the database instance.

4. Click patch – /v1/data-protection/database-clients{id}. Replace the {id} with the actual database client ID. In the body field, enter the client_profile_id.

5. Click PATCH.

After this step, the registration token gets associated to CDBs and PDBs. The PDBs that are in united mode use the same registration token as CDB. For isolated mode PDBs, repeat steps 4 and 5.

Viewing CAKM DB Instances

To view CAKM DB instances:

1. Open Application Data Protection.

2. In the left pane, click CAKM DB Instances. The CAKM Database Instances list shows the following details:

   Column	Description
   Name	Name of the DB instance.
   Type	Type of the DB instance.
   Description	Description of the DB instance.

Viewing Details of DB Instance

Click instance name to view its details. The detailed view shows:

• Type: Type of the CAKM DB instance. Currently, only CAKM for Oracle TDE is supported.

• CDB: Provides the details of container databases associated with the CAKM database instance, including the health status, name, and registration token.

• PDB: Provides the details of pluggable databases associated with the CAKM database instance, including their health status, name, type, and registration token.

• Settings: Provides details of the parameters that were used while creating CAKM DB instance.

Delete DB Instance

1. Open Application Data Protection.

2. In the left pane, click CAKM DB Instances. The list of CAKM DB instances is displayed on the screen.

3. Click the trash icon ( corresponding to the DB instance that you want to delete. A dialog box appears prompting to confirm the action.

4. Click Delete. A message, <db_instance_name> has been deleted successfully appears on the screen.

   Warning

   Deleting a database instance may impact the operations performed by the clients. So, before deleting, ensure all the mapped clients are not in use.