Correlating Container States between the CLI/API and Management GUI (KBA1793)
This document describes the differences between how container states are reported between the Management interface and CLI/API.
Container States in the Management Interface
In the Datasets screen of the Delphix Engine's Management interface (GUI), each container shows:
- The container's name and type
- A brief summary of the container's status
- A warning icon, if there is an active fault
The state reported by the Management interface is a summary, calculated using several pieces of state information available for the container.
Container States in the CLI/API
Using the Delphix Engine's Command Line Interface (CLI), most information about container states can be gathered using the "source list" CLI command:
mydelphixengine> cd /source mydelphixengine source> list display=name,type,runtime.status,runtime.enabled,ingestionStrategy.type NAME TYPE RUNTIME.STATUS RUNTIME.ENABLED AdventureWorks2014 MSSqlLinkedSource RUNNING ENABLED scenario11 MSSqlLinkedSource RUNNING ENABLED qadb MSSqlVirtualSource UNKNOWN DISABLED devdb MSSqlVirtualSource UNKNOWN ENABLED 42134618-dfb3-bfdd-954b-104b8e7ffd00-staging-1 MSSqlStagingSource UNKNOWN ENABLED 42134618-dfb3-bfdd-954b-104b8e7ffd00-staging-12 MSSqlStagingSource UNKNOWN ENABLED
Note that only LinkedSource and VirtualSource containers are directly visible from the Management interface.
Additional information about status of each StagingSource, which are used by SQL Server and SAP ASE dSources, is available from the "database list" command:
mydelphixengine> cd /database mydelphixengine database> list display=group,name,runtime.preProvisioningStatus.preProvisioningState,runtime.preProvisioningStatus.status GROUP NAME RUNTIME.PREPROVISIONINGSTATUS.PREPROVISIONINGSTATE 9 - Sources AdventureWorks2014 INACTIVE 1 - Dev Copies Dev vDB - 2 - QA Copies QA vDB - Scenarios scenario11 INACTIVE 9 - Sources delphix -
How to Map VDB Status to GUI Status
The following table describes how VDB status from the CLI/API is used to provide information for the Management interface.
| Runtime.Enabled | Runtime.Status | State in GUI |
| DISABLED | [Any] | Stopped |
| ENABLED | INACTIVE | Stopped |
| ENABLED | UNKNOWN | Cannot monitor (<5.2: Cannot contact database) |
| ENABLED | FAILED | Provision problem |
| ENABLED | PENDING | Setting up timeflow |
| ENABLED | RUNNING | Running |
How to Map dSource Status to GUI Status
The following table describes how dSource status from the CLI/API is used to provide information for the Management interface.
| RDBMS Type | Runtime.Enabled | Runtime.Status | Staging Status | State in GUI |
| Any [Detached / Unlinked] | [Any] | [Any] | [Any] | Detached |
| Any | DISABLED | [Any] | [Any] | Inactive |
| Any | ENABLED | INACTIVE | [Any] | Inactive |
| Any | ENABLED | UNKNOWN | [Any] | Cannot monitor (<5.2: Cannot contact source) |
| Any | ENABLED | CHECKING | [Any] | Contacting source |
| Oracle LiveSource | ENABLED | RUNNING | RUNNING | [LiveSource Status] |
| Oracle (All others) | ENABLED | RUNNING | RUNNING | Running |
| SQL Server / ASE | ENABLED | RUNNING | INACTIVE | Inactive |
| SQL Server / ASE | ENABLED | RUNNING | FAULTED | Faulted |
| SQL Server / ASE | ENABLED | RUNNING | UNKNOWN | Unknown |
| SQL Server / ASE | ENABLED | RUNNING | [Not found] | Inactive |
| SQL Server / ASE | ENABLED | RUNNING | RUNNING | Running |
| All Others | ENABLED | RUNNING | [Any] | Running |
For SQL Server and SAP ASE dSources, the staging status can be determined using the "database list" command shown above. This may report INACTIVE status for a variety of reasons, including:
- The dSource is configured using "Delphix Managed Backups", and the Source does not need to be polled for backups; or
- The Staging source has been explicitly disabled by the CLI (this will also throw a fault, which will be visible in the GUI)