Configuring zAdviser Enterprise On-Prem as a single node in On-prem Linux Ubuntu

This topic describes how to configure zAdviser Enterprise On-Prem as a single node in on-premises Linux Ubuntu.

Task 1: Applying a license for zAdviser Enterprise On-Prem

zAdviser Enterprise On-Prem follows the BMC V3 licensing model. You must obtain and apply the license password using the same process as other BMC legacy products. zAdviser Enterprise On-Prem is licensed based on a Per-Enterprise metric, meaning only one LPAR needs to have the license file applied, regardless of how many LPARs (e.g., 1 or 25) are transmitting data to zAdviser On-Prem.

Step 1: Obtain and manage the license password

Refer to the following official documentation for instructions on applying and managing passwords using the batch interface:
Applying and managing passwords with the batch interface

Step 2: Verify and apply the license in zAdviser

To ensure zAdviser On-Prem is properly licensed, complete the following steps:

Navigate to the License section within the Administration page of the zAdviser On-Prem interface.

Fill in the following fields:

Field	Description
LPAR Host	The hostname of the LPAR where the JCL will execute.
LPAR Port	The port number used for JCL submission, typically the FTP port (default: 21).
Username	The user ID under which the JCL will run. This user must have login access to the specified LPAR.
Password	The password for the specified user ID.
Load Library	The load library that contains the program BLFSEC3B. Refer to Step 1 for locating this library.
Password Dataset	The dataset (from Step 1) where the license password was added.

Task 2: To obtain an Elastic certificate file for the configuration

Use the SCP tool to navigate to installationFolder/certs/ca/ on your installation server.
Copy the crt file to the VM machine. This certificate is used to configure the zAdviser.

Task 3: Elastic and Kibana configuration

Use the following details to configure connections to Elasticsearch and Kibana. Ensure that the domain part of the URL remains unchanged, and do not modify it to include extensions such as .bmc.com.

Field

Description

Elasticsearch URL

https://url-of-elastic

If you access zAdviser using the URL http://abc-xyz, then the Elasticsearch URL should be https://abc-xyz.

Make sure that the domain remains unchanged. Do not modify it to include extensions like .bmc.com (for example, https://abc-xyz.comp.com is incorrect).

Elasticsearch Port

9200

Username

elastic

Password

Password set in the Ansible playbook

Certificate file

ca.crt file saved in the previous step

Kibana URL

http://url-of-kibana

If you access zAdviser using the URL http://abc-xyz, then the Kibana URL should be http://abc-xyz.

Make sure that the domain remains unchanged. Do not modify it to include extensions like .bmc.com (for example, https://abc-xyz.comp.com is incorrect).

Kibana Port

5601

Task 4: LDAP Configuration

This section explains how to configure the LDAP connection parameters required to integrate the application with your organization’s directory service. The configuration enables centralized user authentication and access management through LDAP. Ensure that all required fields marked with an asterisk (*) are completed before saving the configuration.

Field	Description	Notes
LDAP URL	The URL of your LDAP server, including the port (if applicable). Example: ldap://example.com:389 or ldaps://example.com:636
User Search Base DN	The Base Distinguished Name (DN) where user searches begin.
Admin DN	The DN of the LDAP administrator or service (bind) user.
Admin Password	The password associated with the Admin DN user.
Username Attribute	The LDAP attribute used to identify the username (for login).
Full Name Attribute	The LDAP attribute used to retrieve the user’s full name (for display).
Your Username and Password	Credentials used temporarily to register you as a user; they are not saved as part of the configuration. Temporary input only
TLS Settings	Set to true for ldaps://, and false for ldap://.
CA Certificate File	The single file containing the complete CA certificate for your LDAPS server. Mandatory when TLS is enabled.
Client Certificate File	Client certificate required by some LDAPS servers. Only if TLS enabled
Client Key File	Client key required by some LDAPS servers. Only if TLS enabled

Task 5: To configure SMTP server for generative AI reporting

In the zAdviser Enterprise administration pane, expand Generative AI reporting.
Select Email.

Enter the following details:

Field	Description
Host	SMTP server address
Port	Appropriate port for your setup
Start with TLS	Select based on your servers security settings
Username	SMTP user name
Password	SMTP password
From address	Email address used to send emails
Recipient(s)	One or more recipient email addresses (comma-separated for multiple addresses)

To save the configuration, click Apply.

Important

Make sure that you receive a test email confirming the successful setup of the SMTP server.

Task 6: To configure LLM for generative AI reporting

In the zAdviser Enterprise administration pane, expand Generative AI reporting.
Select Large language model (LLM).
Select a Platform: BYOLLM (Bring Your Own LLM) or AMI Platform
Provide the required configuration details based on the selected deployment platform.
BYOLLM configuration
Field
Description
URL
The endpoint for the LLM.
Model
LLM name
Token
An authentication token required to access the LLM.
Headers
Specify any additional custom headers to be included.
AMI Platform configuration
Field
Description
Integration Path
Specify the AMI Platform Integration Path.
Integration Key
Enter the AMI Platform Integration Key.
Integration ID
Provide the AMI Platform Integration ID.
To save the configuration, click Apply.

Field	Description
URL	The endpoint for the LLM.
Model	LLM name
Token	An authentication token required to access the LLM.
Headers	Specify any additional custom headers to be included.

Field	Description
Integration Path	Specify the AMI Platform Integration Path.
Integration Key	Enter the AMI Platform Integration Key.
Integration ID	Provide the AMI Platform Integration ID.

Important

To help you make the most of our platform capabilities, we have outlined the following key information:

The configuration supports the OpenAI API Specification for REST API.
You are welcome to integrate your own LLM, but we cannot guarantee response accuracy due to the nature of LLMs. For best results, we recommend using Anthropic Claude-3.5-Sonnet.
Our GenAI feature requires sufficient data to generate an analysis. If there is not enough data, you will be notified via email.

Task 7: To configure Git Settings

To configure Git settings, provide the required information in the Git Settings page. These settings establish a secure connection between your Git repository (such as GitHub, GitLab, or Bitbucket) and the application, enabling integration for version control, issue tracking, and automation.

Field	Description
Release Branch Prefix	Enter the prefix of your release branches. For example, if your release branch is named release/v1.0.0, enter release.
Secret	A secret key used to verify incoming webhook requests.This ensures that only trusted sources (for example, GitHub) can trigger events by validating the request signature.
GitHub API URL	The GitHub API URL. Example: https://api.github.com
GitHub Access Token	Enter your GitHub Personal Access Token (PAT). This token authenticates with GitHub APIs and provides access to repositories, workflows, issues, and other resources, depending on the scopes assigned to the token.
Issue Labels	Specify the issue labels separated by commas. Labels are tags or categories applied to issues and pull requests in GitHub, GitLab, Bitbucket, or Jira to help organize, filter, and prioritize work.
GitHub Version	Select the appropriate GitHub version from the dropdown. This option determines the supported API set based on the selected plan.

Task 8: Jira Configuration

The JIRA Settings page enables integration between the application and your JIRA instance for issue tracking and workflow synchronization.
Depending on your environment, you can connect to either JIRA Server/Data Center or JIRA Cloud.

The following are the steps to configure your JIRA connection:

Step 1: Select Connection Type

On the JIRA Settings page, select your JIRA instance type:

Server / Data Center : Select this option if you are using a self-hosted JIRA Server or JIRA Data Center instance.
Cloud: Select this option if you are using Atlassian-hosted JIRA Cloud.

Note: The fields displayed will vary depending on your selected connection type.

Step 2: Enter Base URL

In the Base URL field, enter the base URL of your JIRA instance.
Examples:

For JIRA Cloud: https://your-domain.atlassian.net
For JIRA Server/Data Center: http://your-jira-server

This URL allows the application to communicate directly with your JIRA instance.

Step 3: Provide Authentication Details

Depending on your selected connection type:

For JIRA Cloud:
- Enter your Email Address associated with your Atlassian account.
- Enter your Personal Access Token (API token) generated from your Atlassian account.
For JIRA Server/Data Center:
- Enter the Personal Access Token generated and provided by your JIRA administrator.

This token is used to securely authenticate your connection and authorize access to your JIRA data.

Step 4: Specify the JIRA Project

Enter the JIRA Project key or name that you want to connect to. Although optional, providing a project name is recommended for better integration and filtering of issues.

Step 5: Review Additional Configuration Guidelines

Before applying your settings, ensure the following prerequisites are met:

If your proxy restricts API calls, whitelist the User-Agent "zadviser".
The configured JIRA user must have permission to browse the project.
Required Permission: Browse Projects

Step 6: Save Configuration

Once all fields are completed:

Click Apply to save your JIRA configuration.
If you wish to discard the changes, click Cancel.

After successful configuration, your JIRA connection is ready for use.

Task 9: To configure LPARs

On the configuration page, navigate to LPAR Definitions section and enter all relevant information about the LPARs used by your organization.

You can update the LPAR settings at any time.

Task 10: To enable zAdviser Enterprise On-Prem support

You can skip this step if HTTPS support is already enabled for zAdviser Enterprise On-Prem.

Apply PTF CXSK99A (included in the October 2024 maintenance for ECC).
If you are using BMC AMI DevX Code Pipeline, apply the following PTF for a smooth and successful startup:
Version
PTF
22.01
IWH265A
18.02
IWG531A

Version	PTF
22.01	IWH265A
18.02	IWG531A

Make the following changes to your BMC AMI PARMLIB:

Purpose	Action
Enable the on-premises mode	ZADVISER = ON_PREM
Set the on-premises IP address	ZADVISER_ONPREM IP = ipAddress Replace ipAddress with your zAdviser Enterprise On-Prem instance (for example, 127.0.0.1).
Configure the port number	ZADVISER_ONPREM_PORT = portNumber Replace portNumber with the port number for sending zAdviser data to zAdviser Enterprise On-Prem. .

Important

The system automatically uses the port value specified in the PARMLIB, allowing for a flexible and dynamic port configuration.

Task 11: Configuring AMI Assistant

The AMI Assistant Configuration page allows you to enable onboarding with the AMI Assistant, which integrates zAdviser Enterprise with the AMI Platform for AI-powered insights and assistance.

The following are the steps to configure AMI Assistant:

Navigate to Administration -> AMI Assistant Configuration.
In the AMI Assistant Onboarding section, enter the following details:
- API URL
  Enter the AMI Platform API URL that connects zAdviser Enterprise to the AMI Assistant service.
  For example, https://api.platform.bmc.com/amiassistant
- API Key
  Enter the API key generated from your AMI Platform account. This key authenticates communication between zAdviser Enterprise and the AMI Assistant.
  Click the eye icon to view or hide the entered key.
Click Apply to save the configuration or Cancel to discard the changes.

Both fields (API URL and API Key) are mandatory.
To obtain these values, refer to the AMI Platform documentation on XWiki for instructions on generating and managing your API credentials.
Once configured, AMI Assistant will enable intelligent recommendations and conversational support for your zAdviser data.

Configuring zAdviser Enterprise On-Prem as a single node in On-prem Linux Ubuntu

Task 1: Applying a license for zAdviser Enterprise On-Prem

Task 2: To obtain an Elastic certificate file for the configuration

Task 3: Elastic and Kibana configuration

Task 4: LDAP Configuration

Task 5: To configure SMTP server for generative AI reporting

Task 6: To configure LLM for generative AI reporting

Task 7: To configure Git Settings

Task 8: Jira Configuration

Task 9: To configure LPARs

Task 10: To enable zAdviser Enterprise On-Prem support

Task 11: Configuring AMI Assistant

BMC AMI zAdviser Enterprise On-Prem 26.03.00

On this page