Data Assurance Configuration

The following API commands enable you to configure Data Assurance:

config server:agent:dataAssurance:configuration::get

The config server:agent:dataAssurance:configuration::get command enables you to see connection settings between the Data Assurance plug-in and Data Assurance Server, which is described in Data Assurance Installation.

  • CLI

  • REST

ctm config server:agent:dataAssurance:configuration::get <server> <agent>

The following example shows the REST API syntax for the config server:agent:dataAssurance:configuration::get command in cURL:

Copy 
server=
agent=
AuthHeader="x-api-key: $token"
#AuthHeader="Authorization: Bearer $token" for a session token

curl -X 'GET' "$AuthHeader" "$endpoint/config/server/$server/agent/$agent/dataAssurance/configuration"

To select the AuthHeader value ("Authorization: Bearer $token" or "x-api-key: $token"), see Authentication Tokens.

The following table describes the config server:agent:dataAssurance:configuration::get command parameters.

Parameter

Description

server

Defines the Control-M/Server hostname.

agent

Defines the Data Assurance plug-in hostname.

Response

The response contains the following information:

  • Data Assurance plug-in logical name

  • Port number

  • Number of request attempts

  • Interval between request attempts

  • Ping interval

Copy 
{
   "dataAssuranceServerHost": "vl-da-agent1",
   "dataAssuranceServerPort": 32190,
   "requestRetriesNumber": 3,
   "requestRetriesIntervalMillis": 2000,
   "dataAssuranceServerPingInterval": 30
}

config server:agent:dataAssurance:configuration::set

The config server:agent:dataAssurance:configuration::set command enables you to configure the connection settings between the Data Assurance plug-in and Data Assurance Server, which is described in Data Assurance Installation.

  • CLI

  • REST

ctm config server:agent:dataAssurance:configuration::set <server> <agent> [<dataAssuranceServerHost> <dataAssuranceServerPort> <requestRetriesNumber> <requestRetriesIntervalMillis> <dataAssuranceServerPingInterval>] [-f <configurationFile>]

The following example shows the REST API syntax for the config server:agent:dataAssurance:configuration::set command in cURL:

Copy 
server=
agent=
AuthHeader="x-api-key: $token"
# AuthHeader="Authorization: Bearer $token" for a session token

curl -X 'POST' -H "$AuthHeader" -H "Content-Type: application/json" -H 'accept: application/json' \
-d '{  "dataAssuranceServerHost": "string", "dataAssuranceServerPort": 0, "requestRetriesNumber": 0, \
       "requestRetriesIntervalMillis": 0,  "dataAssuranceServerPingInterval": 0}' \
"$endpoint/config/server/$server/agent/$agent/dataAssurance/configuration"

To select the AuthHeader value ("Authorization: Bearer $token" or "x-api-key: $token"), see Authentication Tokens.

The following table describes the config server:agent:dataAssurance:configuration::set command parameters.

Parameter

Description

server

Defines the Control-M/Server hostname.

agent

Defines the Data Assurance plug-in hostname.

dataAssuranceServerHost

Defines the Data Assurance Server name.

dataAssuranceServerPort

Defines the Data Assurance Server listening port number.

requestRetriesNumber

Defines the number of times to attempt a request.

requestRetriesIntervalMillis

Defines the interval (in milliseconds) between request attempts.

dataAssuranceServerPingInterval

Defines the interval (in seconds) between pings.

configurationFile

Defines a JSON file that contains the parameters that are described above.

If annotation is enabled for the Configuration Management category in the CCM or Configuration domain, you must also provide an annotation to justify your action. For more information, see Annotation Input.

Response

The response contains the following information:

  • Data Assurance plug-in logical name

  • Port number

  • Number of request attempts

  • Interval between request attempts

  • Ping interval

Copy 
{
   "dataAssuranceServerHost": "Snowflake_DA_Plug-in",
   "dataAssuranceServerPort": 32501,
   "requestRetriesNumber": 5,
   "requestRetriesIntervalMillis": 3000,
   "dataAssuranceServerPingInterval": 20
}