Configuring Enterprise Manager using the CLI

You can use the Enterprise Manager command line interface (CLI) to modify the data directory, change the default configuration settings, and manage the Qlik Enterprise Manager service during installation or when configuring Enterprise Manager to run on a cluster.

All commands should be run from <PRODUCT_INSTALLATION_DIRECTORY>\bin

To get help when using the command line, you can run the Help command. For example, for help about the parameters available with the service command, run the following command (shown with the default installation path):

C:\Program Files\Attunity\Enterprise Manager\bin>aemctl.exe service help

This brings up the list of help parameters.

Or, for a list of the available commands, run:

aemctl.exe help

When the Enterprise Manager data directory is installed in a non-default location, the -d <data_directory> parameter must be included in all commands, where data directory is the location of the data directory.

Running CLI commands requires the admin role. For more information, see User permissions.

The login authentication method is also set using the CLI. For more information, see Setting the login authentication method.

Setting the Enterprise Manager host address

To set the host address, run the following command:

aemctl.exe configuration set --address hostAddress

where hostAddress is the address of the Enterprise Manager server machine.

When using a Load Balancer, hostAddress should be the Load Balancer host address.

Abbreviated parameter: -a

Setting the Enterprise Manager HTTP port

To set the HTTP port, run the following command:

aemctl.exe configuration set --http_port port

Abbreviated parameter: -p

Default: 80

Setting the Enterprise Manager HTTPS port

To set the HTTPS port, run the following command:

aemctl.exe configuration set --https_port port

Abbreviated parameter: -s

Default: 443

Setting the Enterprise Manager root URL

To set the root URL, run the following command:

aemctl.exe configuration set --root_url url

Abbreviated parameter: -r

Showing the Enterprise Manager version

To show the version, run the following command:

aemctl.exe configuration set --version

Showing the Enterprise Manager CLI Help

To show the Help, run the following command:

aemctl.exe configuration set --help

Service Commands

To stop the Qlik Enterprise Manager service, run the following command:

aemctl.exe service stop --name servicename [--timeout seconds]

Where:

servicename is the name of the Enterprise Manager service

seconds is the time to wait in seconds before stopping the service

To start the Qlik Enterprise Manager service, run the following command:

aemctl.exe service start --name servicename [--timeout seconds]

Where:

servicename is the name of the Enterprise Manager service

seconds is the time to wait in seconds before starting the service

To bring up a list of other service-related parameters, run the following command:

aemctl.exe service

Cleaning the self-signed certificate

To clean (i.e. clear) the self-signed certificate, run the following command:

aemctl.exe cerificate clean

Setting the audit trail retention size and age

To see the audit trail size and/or age limit, run the following command:

aemctl.exe audit_trail control [--age hours] [--size megabytes]

Where:

hours is the number of hours to retain the audit trail file. The default is 168 hours, which is one week.

megabytes is the maximum size of the audit file to retain. The default is 500 MB.

Master User Password commands

The following section describes commands that can be used to generate a Master User Password, set the Master User Key, and change the Master User Key.

For more information on the role of the master user password and the master user key, see Replacing the Master User Password.

Generating a random Master User Password

To generate a random master user password, run the following command:

aemctl.exe utils genpassword

Setting or changing the MUK (Master User Key)

Run this command to set the Enterprise Manager MUK (Master User Key) as part of the corporate security policy or when configuring Enterprise Manager to work in a cluster.

For information on installing Enterprise Manager on a cluster, see Installing Qlik Enterprise Manager in a Windows cluster

The password must be at least 32 characters.

If you add the --prompt parameter to the command and omit the -p and -c parameters, the CLI will prompt you for the password. When you enter the password, it will be obfuscated. This is especially useful if you do not want passwords to be retained in the command prompt history.

Syntax:

aemctl.exe [-d data_directory] masterukey set --prompt

To set the MUK, run the following command:

aemctl.exe [--data data_directory] masterukey set --password password

Where:

--data (or -d in its abbreviated form) is used to specify the location of the Enterprise Manager data folder, but is only required if the data folder is not on the same drive as the bin folder.

To change the MUK, run the following command:

aemctl.exe [--data data_directory] masterukey set --password new_password --current-password old_password

Where:

--data (or -d in its abbreviated form) is used to specify the location of the Enterprise Manager data folder, but is only required if the data folder is not on the same drive as the bin folder.

Setting or changing the Java MUK (Master User Key)

Run this command to set the Enterprise Manager MUK (Master User Key) as part of the corporate security policy or when configuring Enterprise Manager to work in a cluster.

For information on installing Enterprise Manager on a cluster, see Installing Qlik Enterprise Manager in a Windows cluster

The password must be at least 32 characters.

To set the Java MUK, run the following command:

atajs.bat [--data JavaDataFolderFullPath] masterukey set password

Where:

--data (or -d in its abbreviated form) is used to specify the location of the Enterprise Manager data folder, but is only required if the data folder is not on the same drive as the bin folder.

To change the Java MUK, run the following command:

atajs.bat [--data JavaDataFolderFullPath] masterukey set new_password old_password

Where:

--data (or -d in its abbreviated form) is used to specify the location of the Enterprise Manager data folder, but is only required if the data folder is not on the same drive as the bin folder.
new_password is the new password.
old_password is the current password.

Showing the connectivity and login settings

To show the current connectivity and login settings, run the following command:

aemctl configuration show

The output will be as shown below.

Connectivity settings

-a, --address - The Enterprise Manager host address.
-p, --http_port - The HTTP port through which Enterprise Manager is accessed.
-s, --https_port - The HTTPS port through which Enterprise Manager is accessed.
-r, --root_url - The Enterprise Manager URL root.
-u, --user_timeout - The user idle timeout (minutes).
-m, --domain - The Enterprise Manager domain name.
--authentication_method - FORM, SSO or SAML.

SAML settings

If SAML was configured in the past, these parameters will always be shown (even if SAML is not the current authentication method).

--idp_url - The SAML IdP URL.
--idp_issuer - The unique identity of the SAML IdP.
--idp_certificate_file - A file containing the certificate from the SAML IdP.
--idp_username_attribute - The user name specified in the SAML assertion document.
--idp_user_displayname_attribute - The user display name specified in the SAML assertion document.
--idp_user_groups_attribute - The group name specified in the SAML assertion document.

For information on setting up SAML and other types of authentication, see Setting the login authentication method.

Fine tuning performance

This section describes various parameters that you can set to tweak performance.

Turning off the Analytics Server

If you have configured the Analytics module and you are running multiple instances of Enterprise Manager, for each Enterprise Manager instance there will be a corresponding Analytics Server instance. As only one Analytics Server instance is required, you can turn off the other instances to improve performance.

To do this:

Run the following command:

aemctl analytics set --noserver
Restart the Qlik Enterprise Manager service.

To turn the Analytics Server back on:

Run the following command:

aemctl analytics set --runserver
Restart the Qlik Enterprise Manager service.

Changing the update intervals

If you are encountering performance issues due to a large number of monitored tasks or servers (Replicate or Compose), increasing the update intervals should significantly improve performance.

Changing the server update interval

The server update interval determines how often Enterprise Manager queries all of the monitored servers for updated statistics on tasks, views, and tags.

To change the interval, run the following command (replacing your-interval with the desired interval in seconds):

aemctl manager set --server_update_interval your-interval

Abbreviated parameter: -u

Default: 5 seconds

Changing the web console refresh interval for servers

The web console update interval for servers determines how often the browser queries Enterprise Manager in order to refresh the associated pages.

To change the interval, run the following command (replacing your-interval with the desired interval in seconds):

aemctl manager set --web_update_server_interval your-interval

Abbreviated parameter: -s

Default: 3 seconds

Changing the web console refresh interval for tasks

The web console update interval for tasks determines how often the browser queries Enterprise Manager in order to refresh the associated pages.

To change the interval, run the following command (replacing your-interval with the desired interval in seconds):

aemctl manager set --web_update_task_interval your-interval

Abbreviated parameter: -t

Default: 5 seconds

Changing the data tree cache interval

The data tree cache interval determines how often a cache of Enterprise Manager's data is created. When set, the web console will read from the cached copy instead of the main data tree according to the specified interval. Usually, this parameter does not need to be changed. However, if changing the other performance parameters does not resolve your performance issues, adjusting this parameter might help.

The minimum interval that can be set is five seconds.

To change the interval, run the following command (replacing your-interval with the desired interval in seconds):

aemctl manager set --data_tree_cache_interval your-interval

Abbreviated parameter: -c

To turn off data tree caching, set your-interval to -1

Default: Off

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!

Leave your feedback here