GetServer
Retrieves the definition (Connection Properties) of the specified server. This method can be used together with PutServer in order to update the connection properties of an existing server. First, call GetServer, then edit the returned properties as required, and finally, call PutServer.
Required User Role: See Required Enterprise Manager permissions.
Syntax
public AemServer GetServer(
string server
);
Parameters
Parameter | Type | Description |
---|---|---|
server | string | The name of the server to retrieve. |
Return values
AemServer (AemReplicateServer or AemComposeServer that inherited from AemServer)
Parameter | Type | Description |
---|---|---|
Host |
string |
The host name or IP address of the server. |
Port |
string |
The port through which the server is accessed. |
Name |
string |
The name of the server. |
Description |
string |
The server description. |
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 |
When "true", Qlik Enterprise Manager verifies that the Server certificate is trusted, thereby reducing the chance of "man-in-the-middle" attacks. For details on setting this option, see PutServer. |
Monitored |
bool |
Whether to retrieve tasks and messages from this server or not. |
Errors
See general errors.