get_server_details
Retrieves details about the specified server.
Required User Role: See Required Enterprise Manager permissions.
Syntax
def get_server_details(
self,
server
)
Parameters
| Parameter | Type | Description |
|---|---|---|
| server | string | The specified server name in Qlik Enterprise Manager. |
Return values
AemGetServerDetailsResp
| Value | Type | Description |
|---|---|---|
|
server_details |
AemServerDetails |
ReplicateServerDetails or ComposeServerDetails that are inherited from AemServerDetails. |
|
configuration |
- | - |
|
host |
string | The host name or IP address of the Replicate/Compose Server machine. |
|
platform |
AemPlatform { UNKNOWN = 0, WINDOWS = 1, LINUX = 2 } |
The platform on which the Replicate/Compose Server machine is installed. |
|
port |
string | The port through which the Replicate/Compose Server machine is accessed. |
|
user_name |
string | The user name for connecting to the Replicate/Compose Server machine. |
|
description |
string | The server description. |
|
last_connection |
string | The date and time of the last successful sync/retrieval of tasks and messages. |
|
license |
ApiLicense |
- |
|
days_to_expiration |
int |
The number of days left before the license expires. |
|
expiration |
string |
The expiration date of the server license. |
|
issue_date |
string |
When the license was issued. |
|
state |
AemLicenseState { VALID_LICENSE = 0, INVALID_LICENSE_CHECKSUM = 1, EXPIRED_LICENSE = 2, NO_LICENSE = 3, MACHINE_NOT_LICENSED = 4, INVALID_LICENSE = 5 } |
The current license state (for example, valid, expired, and so on). |
|
message |
string |
The error message if Qlik Enterprise Manager fails to connect to the Replicate/Compose Server machine. |
|
name |
string |
The name of the server in Qlik Enterprise Manager. |
|
resource_utilization |
AemServerUtilization |
- |
|
attunity_cpu_percentage |
int |
The sum of CPU percentage of Replicate server and all running tasks processes. |
|
disk_usage_mb |
long |
The amount of disk space that the server is currently consuming, in MB. This is the sum of disk usage for all tasks on this server. |
|
machine_cpu_percentage |
int |
The CPU percentage of the machine where Replicate is installed. |
|
memory_mb |
long |
The amount of memory that the server is currently consuming, in MB. This is the sum of memory usage for all active tasks on this server, excluding stopped tasks. |
|
state |
AemServerState { NOT_MONITORED = 0, MONITORED = 1, ERROR = 2 } |
The state of the server. |
|
aem_tasks_summary |
TaskSummary |
- |
|
error |
int |
The number of tasks that encountered a fatal error. |
|
recovering |
int |
The number of recovering tasks |
|
running |
int |
The number of running tasks. |
|
stopped |
int |
The number of stopped tasks. |
|
total |
int |
The total number of tasks, regardless of state. |
|
version |
string |
The Replicate/Compose Server version. |
- The return value -1 means N/A.
- Parameters related to Disk, Memory, Qlik CPU, and Machine CPU usage are not available for Compose servers. For Compose servers, these parameters will be returned as -1.
- Parameters related to Qlik CPU and Machine CPU usage are only available for Replicate 6.2 and above. For earlier Replicate versions, these parameters will be returned as -1.
- For servers that are in an error state or not monitored, parameters related to Disk and Memory usage will be returned as -1.
Errors
| Error | Message | Description |
|---|---|---|
|
AEM_SERVER_NOT_FOUND |
Replicate server {server} could not be found. | Server name unknown to Qlik Enterprise Manager. |
See Error handling.