Environment variables


This topic explains the environment variables for BMC AMI Ops Insight product.



Related topic

BMC AMI Ops Insight architecture

(BMC.AMIOPS.SPE2304)

image-2023-7-17_13-14-36.png

Set the following environment variables to the provided values:

Variable

Default value

Description

Where are these specified

Which address space uses this

AMI_LOG_LEVEL

INFO

Set Log level for BMC AMI Manager logs

The possible values are DEBUG/INFO/WARN/ERROR

amipdt.properties

AMI MGR

AMI_MGR_HOST


Host of BMC AMI Manager

amipdt.properties

AMI MGR

AMI_MGR_PORT

48944

BMC AMI Manager port number

amipdt.properties

AMI MGR

TDUMP

NO

The TDUMP name template uses the default value when the user sets enable_tdump=YES unless the user also specifies a value for tdump_pattern.

If a tdump_pattern is entered, it will be exported as an environment variable in the run_manager.sh before calling Java. This ensures that the desired pattern is used for any BMC AMI Manager TDUMP.

amipdt.properties

AMI MGR

MLEAP_PORT

48945

Scoring Engine port number

amipdt.properties

AMI MGR (MLeap component)

PDTDB_PORT

9001

Database port number

amipdt.properties

AMI MGR (Database component)

DATA_PREP_ADDRESS_SPACE

AMIADM01

Data Preparation address space name

amipdt.properties

  • AMI MGR 
  • Data Preparation address space

TOMCAT_HOST

Localhost

Host on which the Stream and Train services (Tomcat) run

amipdt.properties

Tomcat address space

TOMCAT_PORT

15545

Port number for the Stream and Train (Tomcat) services (HTTP)

amipdt.properties, UBMCSAMP(SERVVARS)

Tomcat address space

KEYSTORE_PATH

yourKeystorePath

Location of the keystore file

amipdt.properties

AMI MGR

KEYSTORE_PWD

yourKeystorePassword

Password for your keystore

amipdt.properties

AMI MGR

KEYSTORE_TYPE

yourKeystoretype

The type of keystore JKS/PKCS12/JCERACFKS

amipdt.properties

AMI MGR

KEY_ALIAS

yourKeystoreAlias

Alias for your keystore

amipdt.properties

AMI MGR

TRUSTSTORE_TYPE

yourTruststoretype

The type of truststore JKS/PKCS12/JCERACFKS

amipdt.properties

AMI MGR

TRUSTSTORE_PATH

yourTruststorepath

The path to the truststore containing the certificate

amipdt.properties

AMI MGR

TRUSTSTORE_PWD

yourTruststorePassword

The password used to generate the certificate

amipdt.properties

AMI MGR

DISCOVERY_URL


URL of the BMC AMI Ops UI Discovery server

amipdt.properties


DOCKER_PROTOCOL 

BMC.AMIOPS.SPE2310 

https

Docker protocol that is either https or http


amipdt.properties

AMI MGR

DOCKER_HOST

yourDockerHost

(For Timeline and Event Progression graphs) Host name for the machine on which Docker is running

amipdt.properties

AMI MGR

DOCKER_PORT

48949

Port number for the container running on the DOCKER_HOST

amipdt.properties

AMI MGR

yourDockerHost

(For Workload graphs) Host name for the machine on which Docker is running

amipdt.properties

AMI MGR

5433

Port number for the PostgreSQL DB running on the postgre_host

amipdt.properties

AMI MGR

ENABLE_RCA

false

When using BMC AMI Ops Monitor products, set ENABLE_RCA to true to enable the:

  • Viewing of the Detailed Analysis
  • Links going to the BMC Ops UI Monitor views 

You must define the CAS ID parameter in Data Preparation address space JCL.

amipdt.properties

  • AMI MGR
  • Data Preparation address space

SMF_RECORD_HANDLER_URL

(BMC.AMIOPS.SPE2304)

http://<localhost>: <server.port>

URL for SMF Record Handler 

amipdt.properties

AMI MGR

32000 

Port for socket listener to connect to BMC AMI Datastream for Ops Insight to receive records

(Data preparation port in the Installation System)

custom.properties

SMF Record Handler

54321

Port for SMF Record Handler server

custom.properties

SMF Record Handler

USS_DISK_WARN_THRESHOLD

BMC.AMIOPS.SPE2310 

524288000

Warning threshold for USS disk storage in bytes

This value enables the AMIManager to monitor the available USS disk storage.

amipdt.properties

AMI MGR

USS_DISK_ERROR_THRESHOLD

BMC.AMIOPS.SPE2310 

104857600

Error threshold for USS disk storage in bytes

This values enables the AMIManager to monitor the available USS disk storage.

amipdt.properties

AMI MGR

Set the following INSTANCE variables to the provided values:

Variable

Default value

Description

Where are these specified 

Which address space uses this

ID

AMIADM01

Unique instance ID on the LPAR for the address space

This ID is used for internal communication between BMC AMI Manager and data preparation address spaces. This ID is also specified in the amipdt.properties of BMC AMI Manager.

Valid IDs contain one to eight characters (for example, AMISWD11 or AMIOISTC). This ID can be the same as the address space name or the STC name. 

STC proc

Data Preparation address space

INSTANCE

aoiinst

Running instance or occurrence of a specific BMC AMI Manager

The aoiinst value is used in environment variable to form the AMI_DATA path of the USS directory (for example, &AMIINST/aoidata/&INSTANCE). For BMC AMI Manager STC, the default value of INSTANCE is aoiinst.

You can configure multiple instances of BMC AMI Manager to run by using different INSTANCE variable values (for example, aoiinst1 and aoiinst2). 

To create a different or separate instance of BMC AMI Manager, use AMICREAT job in PDRSAMP or BMCSAMP library.

STC proc

BMC AMI MGR

INSTANCE

srhinst

Indicates the running instance or occurrence of a specific SMF Record Handler

The srhinst value is used in environment variable to form the AMI_DATA path of USS directory (for example, &AMIINST/aoidata/&INSTANCE). For SMF Record Handler STC the value of INSTANCE is srhinst.

You can configure multiple instances of SMF Record Handler to run by using different INSTANCE variable values (for example, srhinst1 and srhinst2)

To create a different or separate instance of SMF Record Handler, use AMICREAT job in PDRSAMP or BMCSAMP library.

STC proc

SMF Record Handler

INSTANCE

*

(Optional) Name for the running instance of BMC AMI Datastream for Ops Insight

Specifies a BMC AMI Datastream instance number between 8 and 255 inclusive, or * (asterisk) to use the next available instance number. The use of the default, * (an asterisk) is generally recommended.

Instances allow you to start more than one copy of BMC AMI Datastream in a single LPAR. The multiple instances run completely independently and could specify different SIEM collectors, different SMF records, different formatting options, and so forth. If you specify the number of an instance that is already running you receive an error message.

If you omit INSTANCE, the default * (the next available instance number) is used.

For more information, see START command.

STC proc

BMC AMI Datastream

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*