This topic describes the processes of creating, updating, and deleting an OKV client with CLI.

An OKV client object on Delphix Engine represents the metadata of an OKV client software installed on a host, which contains the following information of the OKV client software required by Delphix workflows:

  • name: a unique name to represent this OKV client object on the Engine.

  • host: the host on which the OKV client software is installed.

  • password: the password used by the OKV client software to connect to the OKV server. It’s not required if the OKV client software has an external store configured.

  • path: the path of the directory where the OKV client software is installed.

Create an OKV client

  1. Log into the CLI using admin or a user with Admin privileges and go to host/oracle/okvclient.

    ssh admin@yourEngine yourEngine > host/oracle/okvclient

  2. Select the create operation, set the properties and commit.

    yourEngine host oracle okvclient> create
yourEngine host oracle okvclient create *> ls
Properties
type: OracleOKVClient
name: (required)
host: (required)
password: (unset)
path: (required)
yourEngine host oracle okvclient create *> set name=yourOKVclientName
yourEngine host oracle okvclient create *> set password=yourOkvClientPwd
yourEngine host oracle okvclient create *> set host=yourHost
yourEngine host oracle okvclient create *> set path=/yourOKVClientPath
yourEngine host oracle okvclient create *> commit

Update an OKV client

  1. Log into the CLI using admin or a user with Admin privileges and go to host/oracle/okvclient.

    ssh admin@yourEngine yourEngine > host/oracle/okvclient

  2. Select the OKV client object you want to update and select the update operation. Set new values for the properties you want to update and commit the change.

    yourEngine host oracle okvclient> select yourOKVclientName
yourEngine host oracle okvclient 'yourOKVclientName'> update
yourEngine host oracle okvclient 'yourOKVclientName' update *> set name=yourOKVclientNewName
yourEngine host oracle okvclient 'yourOKVclientName' update *> commit

Delete an OKV client

  1. Log into the CLI using admin or a user with Admin privileges and go to host/oracle/okvclient.

    ssh admin@yourEngine yourEngine > host/oracle/okvclient

  2. Select the OKV client object you want to delete and select the delete operation. Commit the change.

    yourEngine host oracle okvclient> select yourOKVclientName
yourEngine host oracle okvclient 'yourOKVclientName'> delete
yourEngine host oracle okvclient 'yourOKVclientName' delete *> commi
Last updated
Oct 9, 2026