Skip to main content
Skip table of contents

GUI API mapping

This topic describes how to map from GUI operations to the corresponding CLI operation.

It is not always straightforward to convert from the visual layout of the GUI to the corresponding CLI operations. This topic outlines some common operations and indicates how they are represented in the CLI. web services, and the API documentation.

dSource operations

GUI

CLI

API topic

Input object

Web services

Link

database link

Container

LinkParameters

POST /resources/json/delphix/database/link

Show configuration

database "name" get
source "name" get 

Container
Source 

-

GET /resources/json/delphix/database/{ref}
GET /resources/json/delphix/source/{ref} 

Sync

database "name" sync

Container

SyncParameters

POST /resources/json/delphix/database/{ref}/sync

Update

database "name" update

Container

Container

POST /resources/json/delphix/database/{ref}

Delete

database "name" delete

Container

DeleteParameters

POST /resources/json/delphix/database/{ref}/delete

Detach

database "name" detachSource

Container

DetachSourceParameters

POST /resources/json/delphix/database/{ref}/detachSource

Attach

database "name" attachSource

Container

AttachSourceParameters

POST /resources/json/delphix/database/{ref}/attachSource

Disable

source "name" disable

Source

SourceDisableParameters

POST /resources/json/delphix/source/{ref}/disable

Enable

source "name" enable

Source

SourceEnableParameters

POST /resources/json/delphix/source/{ref}/enable

VDB operations

GUI

CLI

API topic

Input object

Web services

Provision

database provision

Container

ProvisionParameters

POST /resources/json/delphix/database/provision

V2P

database export

Container

ExportParameters

POST /resources/json/delphix/database/export

Refresh

database "name" refresh

Container

RefreshParameters

POST /resources/json/delphix/database/{ref}/refresh

Snapshot

database "name" sync

Container

SyncParameters

POST /resources/json/delphix/database/{ref}/sync

Update

database "name" update

Container

Container

POST /resources/json/delphix/database/{ref}

Delete

database "name" delete

Container

DeleteParameters

POST /resources/json/delphix/database/{ref}/delete

Start

source "name" start

Source

StartParameters

POST /resources/json/delphix/source/{ref}/start

Stop

source "name" stop

Source

StopParameters

POST /resources/json/delphix/source/{ref}/stop

Enable

source "name" enable

Source

SourceEnableParameters

POST /resources/json/delphix/source/{ref}/enable

Disable

source "name" disable

Source

SourceDisableParameters

POST /resources/json/delphix/source/{ref}/disable

Environment operations

GUI

CLI

API topic

Input object

Web services

Add environment

environment create

SourceEnvironment

SourceEnvironmentCreateParameters

POST /resources/json/delphix/environment

Update

environment "name" update

SourceEnvironment

Environment

POST /resources/json/delphix/environment/{ref}

Delete

environment "name" delete

SourceEnvironment

-

DELETE /resources/json/delphix/environment/{ref}

Refresh

environment "name" refresh

SourceEnvironment

-

POST /resources/json/delphix/environment/{ref}/refresh

Enable

environment "name" enable

SourceEnvironment

-

POST /resources/json/delphix/environment/{ref}/enable

Disable

environment "name" disable

SourceEnvironment

-

POST /resources/json/delphix/environment/{ref}/disable

Add manual repository

repository create

SourceRepository

SourceRepository

POST /resources/json/delphix/repository

Update repository

repository "name" update

SourceRepository

SourceRepository

POST /resources/json/delphix/repository/{ref}

Remove manual repository

repository "name" delete

SourceRepository

-

DELETE /resources/json/delphix/repository/{ref}

Show host details

host "name" get

Host

-

GET /resources/json/delphix/host/{ref}

Add cluster node

environment oracle clusternode create

OracleClusterNode

OracleClusterNode

POST /resources/json/delphix/environment/oracle/clusternode

Update cluster node

environment oracle clusternode "name" update

OracleClusterNode

OracleClusterNode

POST /resources/json/delphix/environment/oracle/clusternode/{ref}

Remove cluster node

environment oracle clusternode "name" delete

OracleClusterNode

-

DELETE /resources/json/delphix/environment/oracle/clusternode/{ref}

Add listener

environment oracle listener create

OracleListener

OracleListener

POST /resources/json/delphix/environment/oracle/listener

Update listener

environment oracle listener "name" update

OracleListener

OracleListener

POST /resources/json/delphix/environment/oracle/listener/{ref}

Remove listener

environment oracle listener "name" delete

OracleListener

-

DELETE /resources/json/delphix/environment/oracle/listener/{ref}


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.