Skip to main content Skip to complementary content

get_server

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

def get_server(

self,

server

)

Parameters

Parameters
Parameter Type Description
server string The name of the server to retrieve.

Return values

AemServer (AemReplicateServer or AemComposeServer that are inherited from AemServer)

Return values
Value Type Description

host

string

The host name or IP address of the server.

name

string

The name of the server.

description

string

The server description.

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.Note The 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.

verify_server_certificate

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 put_server.

monitored

bool

Whether to retrieve tasks and messages from this server or not.

Errors

See general errors.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!