Environment variables
BMC AMI Ops Insight architecture
Set values for the following environment variables:
Variable | Default value | Description | Where to set this variable | Which address space uses this variable |
|---|---|---|---|---|
AMI_LOG_LEVEL | INFO | Sets the log level for BMC AMI Manager logs Valid values are DEBUG, INFO, WARN, and ERROR | amipdt.properties | BMC AMI MGR |
AMI_MGR_HOST | None | Host of BMC AMI Manager | amipdt.properties | BMC AMI MGR |
AMI_MGR_PORT | 48944 | BMC AMI Managerport number | amipdt.properties | BMC AMI MGR |
AMIMGR_LOG_SIZE | 20 MB | Setup value for max BMC AMI Manager log size | run_manager.sh | BMC AMI MGR |
AMIMGR_ROLL_MAX | 10 | Setup value of number of BMC AMI Manager log files to keep | run_manager.sh | BMC AMI MGR |
SMFHDL_LOG_SIZE | 20 MB | Setup value for max SMF Record Handler log size | run_smf_handler.sh | BMC AMI SMF Record Handler |
SMFHDL_ROLL_MAX | 10 | Setup value of number of SMF Record Handler log files to keep | run_smf_handler.sh | BMC AMI SMF Record Handler |
TCAT_SERVLET_LOG_SIZE | 10 MB | Setup value for max size of Tomcat log file (amimf.log) in <Install path>/aoihome/tomcat9/default/logs | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
TCAT_SERVLET_ROLL_MAX | 30 | Setup value of number of Tomcat log files to keep in <Install path>/aoihome/tomcat9/default/logs | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
(Optional) SORTWRK_MAXSS | NA | Maximum Storage to be used | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
(Optional) SORTWRK_UNIT | NA | Storage unit for sort work files | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
(Optional) SORTWRK_STORCLAS
| NA | Storage class for sort work files | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
(Optional) SORTWRK_DATACLAS
| NA | Data class for sort work files | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
(Optional) SORTWRK_MGMTCLAS
| NA | Management class for sort work files | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
IBM_JAVA_ZOS_TDUMP
| NO | Indicates if DUMP to be created in case of failure | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
(Optional) JAVA_DUMP_TDUMP_PATTERN
| NA | Name template for TDUMP file This is required if IBM_JAVA_ZOS_TDUMP is YES. | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
(Optional) GENINGEST_MEMORY
| 10 GB | Configurable Java heap size for training or playback file creation process | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
(Optional) GENERIC_INGEST_JOBNAME
| NA | Jobname to be used for data ingest process | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
(Optional) MAX_STREAM_MEMORY
| 4 GB | Configurable maximum JAVA heap size for streaming process | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
(Optional) AMIOI_PIPE_PATH | /tmp | Path of pipe file used for RCA in Tomcat servlet | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
RESUME_TRAIN_REQUESTS | false | Set it to true to start training models when BMC AMI Manager restarts for all training request, which were either running or were scheduled to run but couldn't because BMC AMI Manager was down. | amipdt.properties | BMC 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 is exported as an environment variable in the run_manager.sh file before calling Java. This ensures that the desired pattern is used for any BMC AMI Manager TDUMP. | amipdt.properties | BMC AMI MGR |
MLEAP_PORT | 48945 | Scoring Engine port number | amipdt.properties | BMC AMI MGR (MLeap component) |
PDTDB_PORT | 9001 | Database port number | amipdt.properties | BMC AMI MGR (Database component) |
DATA_PREP_ADDRESS_SPACE | AMIADM01 | Data preparation address space name | amipdt.properties |
|
TOMCAT_PROTOCOL | http | Tomcat protocol (either http or https) | amipdt.properties | BMC AMI MGR |
TOMCAT_HOST | <localHost> | Host on which the Tomcat REST Interface component is running | amipdt.properties | Tomcat address space |
TOMCAT_PORT | 15545 | Port on which the Tomcat REST Interface component is running You can refer the value in UBMCSAMP(SERVVARS) member of the Tomcat REST Interface. | amipdt.properties,
| Tomcat address space |
GENINGEST_JAVA_OPTS | NA | Set IBM Java options for the data ingest process Example (without long value): export GENINGEST_JAVA_OPTS="-verbose:class" Example (with long value): GJO="-Xtrace:maximal={j9vm.612-626," GJO="${GJO}j9vm.576-577,j9vm.233-237,j9vm.48-49}" export GENINGEST_JAVA_OPTS="$GJO " | <HLQ>.XXSAMP(AMITCEN7) | Tomcat address space |
KEYSTORE_PATH | <yourKeystorePath> | Location of the keystore file | amipdt.properties | BMC AMI MGR |
KEYSTORE_PWD | <yourKeystorePassword> | Password for your keystore | amipdt.properties | BMC AMI MGR |
KEYSTORE_TYPE | <yourKeystoretype> | Type of keystore Valid values are JKS, PKCS12, and JCERACFKS | amipdt.properties | BMC AMI MGR |
KEY_ALIAS | <yourKeystoreAlias> | Alias for your keystore | amipdt.properties | BMC AMI MGR |
TRUSTSTORE_TYPE | <yourTruststoretype> | Type of truststore Valid values are JKS, PKCS12, and JCERACFKS | amipdt.properties | BMC AMI MGR |
TRUSTSTORE_PATH | <yourTruststorepath> | Path to the truststore containing the certificate | amipdt.properties | BMC AMI MGR |
TRUSTSTORE_PWD | <yourTruststorePassword> | Password used to generate the certificate | amipdt.properties | BMC AMI MGR |
DISCOVERY_URL |
| URL of the BMC AMI Ops UI Discovery server | amipdt.properties |
|
DOCKER_PROTOCOL | https | Docker protocol (either https or http) | amipdt.properties | BMC AMI MGR |
DOCKER_HOST | <yourDockerHost> | (For Timeline and Event Progression graphs) Host name for the machine on which Docker is running | amipdt.properties | BMC AMI MGR |
DOCKER_PORT | 48949 | Port number for the container running on the DOCKER_HOST | amipdt.properties | BMC AMI MGR |
postgre_host | <yourDockerHost> | (For Workload graphs) Host name for the machine on which Docker is running | amipdt.properties | BMC AMI MGR |
postgre_port | 5433 | Port number for the PostgreSQL DB running on the postgre_host | amipdt.properties | BMC AMI MGR |
ENABLE_RCA | false | (For BMC AMI Ops Monitor products) Setting ENABLE_RCA to true enables:
You must define the CAS ID parameter in data preparation address space JCL. | amipdt.properties |
|
SMF_RECORD_HANDLER_URL
| http://<localhost>: <server.port> | URL for SMF Record Handler | amipdt.properties | BMC AMI MGR |
stream.port
| 32000 | Data preparation port in the Installation System for socket listener to connect to BMC AMI Datastream for Ops Insight to receive records | custom.properties | SMF Record Handler |
server.port | 54321 | Port for SMF Record Handler server | custom.properties | SMF Record Handler |
server.address | NA | Address of the SMF Record Handler server To bind the SMFRH address for security reasons, specify the host name using server.address. | custom.properties | SMF Record Handler |
wto.routecodes | None | Route codes for Write To Operator (WTO) The wto.routecodes are specified as comma-separated integers with no embedded spaces to route to specific consoles. For example, wto.routecodes=1,3,4 | custom.properties | SMF Record Handler |
USS_DISK_WARN_THRESHOLD
| 524288000 | Warning threshold value for USS disk storage in bytes, enabling the BMC AMI Manager to monitor the available USS disk storage | amipdt.properties | BMC AMI MGR |
USS_DISK_ERROR_THRESHOLD
| 104857600 | Error threshold value for USS disk storage in bytes, enabling the BMC AMI Manager to monitor the available USS disk storage | amipdt.properties | BMC AMI MGR |
db_cleanup | true | Database clean up | amipdt.properties | BMC AMI MGR |
db_cleanup_time | 0_15_0_?_*_* (at 00:15:00 AM every day)
| CRON expression that specifies when the database clean up will run | amipdt.properties | BMC AMI MGR |
db_cleanup_scoringHistory | true | Clean up of scoring history from database | amipdt.properties | BMC AMI MGR |
db_cleanup_scoring_history_ttl | 60_H (60 hours) | Time-to-live indicates the length of time in days or hours the scoring history is stored before removal from the database. | amipdt.properties | BMC AMI MGR |
** | true | Clean up for Db2 restart detection history from the database | amipdt.properties | BMC AMI MGR |
** | 30_D (30 days) | Time-to-live indicates the length of time in days or hours the Db2 restart detection history is stored before removal from the database. | amipdt.properties | BMC AMI MGR |
db_cleanup_analytics | true | Clean up analytics history from the database | amipdt.properties | BMC AMI MGR |
db_cleanup_analytics_ttl | 30_D (30 days) | Time-to-live indicates the length of time in days or hours the Analytics history is stored before removal from the database. | amipdt.properties | BMC AMI MGR |
db_cleanup_playback | true | Clean up historical playback files from database | amipdt.properties | BMC AMI MGR |
db_cleanup_playback_ttl | 90_D | Time-to-live indicates the length of time in days or hours the Historical playback files are stored before removal from the database. | amipdt.properties | BMC AMI MGR |
db_backup | true | Backup database | amipdt.properties | BMC AMI MGR |
db_backup_time | 0_05_0_?_*_* (at 00:05:00 AM every day)
| CRON expression that specifies when database back up will run | amipdt.properties | BMC AMI MGR |
db_backup_count | 2 | Number of latest database backups to store | amipdt.properties | BMC AMI MGR |
db_backup_directory | None | Directory name where database backups are stored | amipdt.properties | BMC AMI MGR |
enable_db_checkpoint_onboot | true | Enables or disables database defragmentation when BMC AMI Manager starts | amipdt.properties | BMC AMI MGR |
| (Optional) MODEL_HEALTH_DATA_SIZE | 60 minutes | Number of ingests data to be collected for model health evaluation | amipdt.properties | BMC AMI MGR |
| Health_check_file_space_enabled | true | Turn off the error and warning messages for storage. If false, the error or warning messages related to storage are turned off. | amipdt.properties | BMC AMI MGR |
| Daily_scheduled_defrag_enabled | true | Schedule the db defrag 15 minutes after the cleanup is completed. If true, the defrag is scheduled 15 minutes after cleanup. We recommend not setting this to false to avoid any storage issues. | amipdt.properties | BMC 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 |