Skip to main content

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

Note:

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.

Changing the data directory

To change the "data" directory, run the following command:

aemctl.exe --data

Abbreviated parameter: -d

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.

Note:

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

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

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

aemctl.exe service

Cleaning the self-signed certificate

aemctl.exe cerificate clean

Setting the audit trail retention size and age

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

Where:

weeks is the number of weeks to retain the audit trail file (default 2 weeks)

megabytes is the maximum size of the audit file to retain (default 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

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

Note:

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

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.

aemctl.exe [--data data_directory] masterukey set --password new_password --current 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

Note:

The password must be at least 32 characters.

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.

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

SAML settings

Note:

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.