PATROL Agent configuration variables
BMC PATROL for OpenStack supports configuration of the KM without the usage of PATROL Console. This can be performed using PCM.
The KM installation contains a rule set file for PCM. The rule set file path file is:$PATROL_HOME/rulesets/Shipped/pos/1_0_00/openstack_ruleSet.cfg.
This file is installed either during custom install of the KM or when it is installed on a host where PCM already exists. The rule set file contains configuration rules required to configure an OpenStack environment and to enable options for debug reporting.
Agent configuration variables are the means by which the characteristics of a PATROL Agent are defined. To configure an OpenStack host for monitoring by using PATROL Configuration Manager, add the following set of agent configuration variables, and apply it on the BMC PATROL Agent that runs BMC PATROL for OpenStack:
Directory path and variable | Description | Required or optional variable | Example |
|---|---|---|---|
/POS/OpenStack/<<environment name>>/envName | Provides the name to monitor an OpenStack environment. | Required | "/POS/OpenStack/env19_v3/envName" = {REPLACE = "env19_v3"}, |
/POS/OpenStack/EnvList | Each OpenStack environment name you add should be on this list. Use "\n" as a separator between environment names. | Required | "/POS/OpenStack/V3EnvList" = {REPLACE = "env19_v3"}, |
/POS/OpenStack/<<environment name>>/healthMonitoring | Type of monitoring
| Required | "/POS/OpenStack/env19_v3/healthMonitoring" = {REPLACE = "2"}, |
/POS/OpenStack/<<environment name>>/Selection | The numbers of monitored groups separated by "," separator. For example, if you insert number "1,2", you want to monitor only OpenStack groups 1 and 2. Each group number exists in its own xml file under Patrol3/openstack/xml directory.
| Optional
| "/POS/OpenStack/env19_v3/monitoredGroupIdList" = {REPLACE = "11,22,33,111,222,333"}, |
/POS/OpenStack/<<environment name>>/jvmArgs | Java Virtual Machine arguments for the java collector. | Optional | "/POS/OpenStack/env19_v3/jvmArgs" = {REPLACE = "1"}, |
/POS/OpenStack/<<environment name>>/BPPMI2D | When set to 0, this variable disables instance 2 device mapping. The host instance is not created as a device in the TrueSight Presentation Server (1 or 0). | Optional | "/POS/OpenStack/env19_v3/BPPMI2D" = {REPLACE = "0"}, |
/POS/OpenStack/<<environment name>>/logging | Enables PSL and Java logging.
| Required | "/POS/OpenStack/env19_v3/Logging" = {REPLACE = "0"}, |
/POS/OpenStack/<<environment name>>/dataCollector | The variable to set the collection interval for attributes (in seconds). | Required | "/POS/OpenStack/env19_v3/dataCollector" = {REPLACE = "600"}, |
/POS/OpenStack/<<environment name>>/availabilityCollector | The variable to set the collection interval for availability attributes (in seconds). | Required | "/POS/OpenStack/env19_v3/availabilityCollector" = {REPLACE = "60"}, |
/POS/OpenStack/<<environment name>>/javaHome | The Java home used to run the Java collector, must be v1.8 or later. You can also enter an environment variable, such as $JAVA_HOME. | Required | "/POS/OpenStack/env19_v3/javaHome" = {REPLACE = "C:\\Program Files\\Java\\jre1.8.0_91"}, |
/POS/OpenStack/<<environment name>>/endpoint | The endpoint for the OpenStack Keystone server. | Required | "/POS/OpenStack/env19_v3/endpoint" = {REPLACE = "http://123.11.222.33:<port_number>/v3"}, |
/POS/OpenStack/<<environment name>>/projectList | Define which OpenStack projects to monitor. If this variable is blank or contains *, all projects are monitored. To monitor multiple projects, use comma "," as a separator. | Optional | "/POS/OpenStack/env19_v3/projectList" = {REPLACE = "*"}, |
/POS/OpenStack/<<environment name>>/scope_project | Required only when the OpenStack monitor type is set to Keystone API V3. Defines the OpenStack project to connect. | Required (Only for Keystone API V3) | "/POS/OpenStack/env19_v3/scope_project" = {REPLACE = "admin"}, |
/POS/OpenStack/<<environment name>>/scope_domain | Required only when the OpenStack monitor type is set to Keystone API V3. Choose which OpenStack domain to connect. | Required (Only for Keystone API V3) | "/POS/OpenStack/env19_v3/scope_domain" = {REPLACE = "default"}, |
/SecureStore/OPENSTACK_MAIN/OpenStack/<<environment name>>/OpenStackCredentials | Enter the OpenStack user's password. | Required | "/SecureStore/OPENSTACK_MAIN/OpenStack/env19_v3/OSCredentials" = {REPLACE = "OPENSTACK_SETUPV3;OPENSTACK_MAIN;OPENSTACK_ENVIRONMENT/patrol/<password>"} |
Related topic