PutServer
Adds a new Replicate/Compose Server or updates the server definition (Connection Properties) if the specified server already exists. This method can be used together with AemGetServer in order to update the connection properties of an existing server.
First call AemGetServer, then edit the returned properties as required, and finally, call AemPutServer.
Required User Role: See Required Enterprise Manager permissions.
Syntax
public void PutServer(
AemServer payload,
string server
);
Parameters
Parameter | Type | Description |
---|---|---|
payload |
AemServer |
AemReplicateServer or AemComposeServer that is inherited from AemServer. |
Name |
string |
The name of the server. |
Description |
string |
The server description. |
Host |
string |
The host name or IP address of the server. |
Port |
string |
The port through which the server is accessed. |
Username |
string |
The user name to connect to the Replicate/Compose Server. |
Password |
string |
The password to connect to the Replicate/Compose Server. Information noteThe password identifier (GUID) that is returned by GetServer is valid only for the session in which it was generated. Using it in another session (for example as input for PutServer) will result in exception.
|
VerifyServerCertificate |
bool |
Set to "true" to ensure the Server certificate is trusted. As a rule, to reduce the chance of "man-in-the-middle" attacks, this option should always be set to "true".
For information on the different ways of connecting to Qlik Replicate, see Qlik Replicate Server Requirements in the Qlik Enterprise Manager Help. |
Monitored |
bool |
Whether to retrieve tasks and messages from this server or not. |
server |
string |
The name of the server. |
Return values
N/A
Errors
All of the general errors as well as the errors listed in the table below.