How to Disable the Data Control Tower SaaS Agent (Connector) (KBA9914)
KBA
KBA# 9914Applicable Delphix Versions
- Click here to view the versions of the Delphix engine to which this article applies
-
Date Release Feb 13, 2023 8.0.0.0 Jan 12, 2023 7.0.0.0 Releases Prior to 2023 Major Release All Sub Releases 6.0 6.0.0.0, 6.0.1.0, 6.0.1.1, 6.0.2.0, 6.0.2.1, 6.0.3.0, 6.0.3.1, 6.0.4.0, 6.0.4.1, 6.0.4.2, 6.0.5.0, 6.0.6.0, 6.0.6.1, 6.0.7.0, 6.0.8.0, 6.0.8.1, 6.0.9.0, 6.0.10.0, 6.0.10.1, 6.0.11.0, 6.0.12.0, 6.0.12.1, 6.0.13.0, 6.0.13.1, 6.0.14.0, 6.0.15.0, 6.0.16.0, 6.0.17.0, 6.0.17.1, 6.0.17.2
5.3
5.3.0.0, 5.3.0.1, 5.3.0.2, 5.3.0.3, 5.3.1.0, 5.3.1.1, 5.3.1.2, 5.3.2.0, 5.3.3.0, 5.3.3.1, 5.3.4.0, 5.3.5.0, 5.3.6.0, 5.3.7.0, 5.3.7.1, 5.3.8.0, 5.3.8.1, 5.3.9.0 5.2
5.2.2.0, 5.2.2.1, 5.2.3.0, 5.2.4.0, 5.2.5.0, 5.2.5.1, 5.2.6.0, 5.2.6.1
5.1
5.1.0.0, 5.1.1.0, 5.1.2.0, 5.1.3.0, 5.1.4.0, 5.1.5.0, 5.1.5.1, 5.1.6.0, 5.1.7.0, 5.1.8.0, 5.1.8.1, 5.1.9.0, 5.1.10.0
5.0
5.0.1.0, 5.0.1.1, 5.0.2.0, 5.0.2.1, 5.0.2.2, 5.0.2.3, 5.0.3.0, 5.0.3.1, 5.0.4.0, 5.0.4.1, 5.0.5.0, 5.0.5.1, 5.0.5.2, 5.0.5.3, 5.0.5.4
Connector Disable
Due to the EOL of Data Control Tower (SaaS) in May 2023, it is recommended to disable the Agent (Connector) service if it had been previously enabled on the Engine. Prior to disabling the DCT Connector on an Engine, the Engine must be disconnected from DCT SaaS. The method for this can be found at:
https://docs.delphix.com/dct/dct-saas/removing-engines
The method to disable is not available through GUI or CLI, but is available via API.
As the DCT Service will be discontinued, Engines where the DCT Connector service is still enabled will attempt to update the Connector every 12 hours, and failed Actions associated therewith may be expected after May 2023.
API Script to Disable Connector
The following shell script may be created on any host that can communicate with the Engine(s) in question. The script will require replacement of the placeholders for the Engine name (IP address, hostname, or FQDN), and the sysadmin user password. It also assumes placement of cookies under the user home directory; this can also be modified as desired, ensuring that all three curl commands reference the same location.
This script is the only option available; it may be modified or otherwise automated for the infrastructure as needed, or the API calls can be executed in Postman, et cetera. Further customization of any scripts to perform this action will be out of scope for Delphix Support; if any assistance is needed in further automation, engage Professional Services or your Account Team.
delphix_engine=<YOUR ENGINE NAME>
delphix_user=sysadmin
delphix_pass=<YOUR SYSADMIN PASSWORD>
echo "creating session"
curl -X POST --data @- "http://$delphix_engine/resources/json/delphix/session" \
-c ~/cookies.txt -H "Content-Type: application/json" <<EOF
{
"type": "APISession",
"version": {
"type": "APIVersion",
"major": 1,
"minor": 4,
"micro": 3
}
}
EOF
echo "logging in"
curl -X POST --data @- "http://$delphix_engine/resources/json/delphix/login" \
-b ~/cookies.txt -c ~/cookies2.txt -H "Content-Type: application/json" <<EOF
{
"type": "LoginRequest",
"username": "$delphix_user",
"password": "$delphix_pass",
"target": "SYSTEM"
}
EOF
echo "disabling cloud"
curl -X POST "http://$delphix_engine/resources/json/delphix/service/cloud/disable" \
-b ~/cookies2.txt -H "Content-Type: application/json"
An example of the expected output is provided below, where successful session creation and CURL results will be echoed. The action ID will vary based on Engine history. If status: OK for all three OKResult lines, and an Action is created, the procedure was successful.
creating session
{"type":"OKResult","status":"OK","result":{"type":"APISession","version":{"type":"APIVersion","major":1,"minor":4,"micro":3},"locale":null,"client":null},"job":null,"action":null}logging in
{"type":"OKResult","status":"OK","result":"USER-1","job":null,"action":null}disabling cloud
{"type":"OKResult","status":"OK","result":"","job":null,"action":"ACTION-23"}%
The System Setup UI will also indicate a successful/completed action for the disable:
Related Articles
The following articles may provide more information or related information to this article: