16.10 - PUT (Specified Server) - Teradata Ecosystem Manager

Teradata Ecosystem Manager API Reference

prodname
Teradata Ecosystem Manager
vrm_release
16.10
created_date
June 2017
category
Programming Reference
featnum
B035-3204-067K

Purpose

Registers a server.

URL

/emrest/datadiscovery/servers/{server-name}

HTTP Method

PUT

Request Parameters

  • Path variable:server-name
  • Request body in JSON with following parameters:
Name Data Type Description Notes
server_type String Type of server Required. Use one of the following values:
  • APP
  • AST
  • BAR
  • BI
  • BUS
  • DMC
  • ETL
  • HDP
  • LAG
  • LS
  • RS
  • VP
  • USL
  • TD
data_center Data Center String Required
script_exec_user A user on the server String Required if script_exec_password is provided
script_exec_password Password for script_exec_user String Optional
alias_list List of server aliases JSON array
"alias_list": [ { "alias_name": "string", "alias_type": "string" }, ... ... ]
Optional
td_packrate Packrate for server of server_type TD Integer
  • Relevant and optional for server_type TD
  • Default value 10
webhcatalog_server_name WebHCatalog server name Integer Relevant and optional for server_type HDP
webhcatalog_port WebHCatalog server port number Integer
  • Default 50111
  • Relevant and optional for server_type HDP
dm_job_control Flag to see if Data Mover jobs can be instrumented from Ecosystem Manager Boolean
  • Relevant and optional for server_type DMC
  • Default false
dm_security Flag to see if security is enabled on Data Mover Boolean
  • Relevant and optional for server_type DMC
  • Default false
dm_job_user Data Mover job username String Required and conditional for server_type DMC when dm_security is set to true
dm_job_password DM job password String Required and conditional for server_type DMC when dm_security is set to true
dm_rest_encryption Flag to see if Data Mover ssl is enabled Boolean Relevant and optional for server_type DMC
dm_rest_port Port number for Data Mover REST Integer
  • Default 1080
  • Relevant and optional for server_type DMC

Response

A JSON response indicates success or error.

Status Code

A status code of 200 is returned on a successful completion. A non-200 status code is returned if an error occurs.

Example: Registering a Server

{
    "data_center": "Test",
    "server_name": "banjo",
    "server_type": "TD",
    "td_packrate": 15
}