Learn about the agent configuration variables for VMware environment. For more information, see Defining a monitoring policy.
| |
|---|
/VSM/VC/vCenterName/EnableVsan | Set this variable to 1 to enable the vSAN and 0 to disable the vSAN. |
/VSM/VC/vCenterName/FilterDatastores | Set this variable to include or exclude datastores from monitoring.
For example: regex Ctrl+A inclusion_option - regex: This is a regular expression or a comma-separated list of cluster names (default value is .*).
- Ctrl+A or \A: These are separator characters. You can use any one of these characters.
inclusion_option: Enter 1 for inclusion and 2 for exclusion (default value is 1).
Note Ctrl+A is a special character. You can copy this character from the following file: %patrol_home%\..\pconfmgr\rulesets\Shipped\vsm\vsm_rulesets.cfg.
|
/VSM/VC/vCenterName/InvalidConnAttempts | Set this variable to restrict number of connection attempts to vCenter server in case of invalid login error. Valid values > 0.
|
| Set this variable to the directory path of the JRE. |
/AS/EVENTSPRING/PARAM_SETTINGS /
POLLTIMES/ VSM_HOST/ESXServerPath/
ESXCollector/ interval | Set this variable by using the Event Management knowledge module (KM) to change polling cycle for the ESX server that is configured for distributed or failover data collection.The default value for this variable is 10 minutes. |
/VSM/VC/vCenterName/ annotations | Set this variable to 0 to stop generating annotation reports. |
/VSM/VC/vCenterName/ esxHAExcludeList | Stores the comma-separated list of ESX servers that are excluded from failover data collection, however, qualify for any of the regular expressions. |
/VSM/VC/vCenterName/ esxHAList | Stores the comma-separated list of ESX servers that are configured for failover data collection. |
/VSM/VC/vCenterName/ esxLBExcludeList | Stores the comma-separated list of ESX servers that are excluded from distributed data collection, however, qualify for any of the regular expressions. |
/VSM/VC/vCenterName/ esxLBList | Stores the comma-separated list of ESX servers that are configured for distributed data collection. |
/VSM/VC/vCenterName/esxRegExHAList | Stores the comma-separated list of regular expressions of ESX servers that are configured for failover data collection. |
/VSM/VC/vCenterName/ esxRegExLBList | Stores the comma-separated list of regular expressions of ESX servers that are configured for distributed data collection. |
/VSM/VC/vCenterName/
ESXserverNameOrRegEx.userAccount | Stores the user names provided for an individual ESX server or ESX servers that satisfy the regular expression used to configure them for distributed or failover data collection. |
/VSM/VC/vCenterName/NEWEVENTFORMAT | Set this variable to 1 to generate custom events in the new format. If the value of this variable is set to 0, then a standard event will be generated in the old format. By default, standard event catalog (class 41) is used to generate custom events. In the new format, a custom event will be generated with an origin as ESXi host or a virtual machine. The following are the event classes that are used from VSM_VC catalog: - CONFIGCHANGES for the following Hot plug events:
- MEMORY_SIZE_CHANGED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> Memory Size has been reconfigured from <previous value> to <new value> - CPU_NUM_CHANGED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> CPU number is changed from %s to %s - DISK_SIZE_CHANGED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> DISK=<Disk name> Previous_size=<previous value> Current_size=<new value> - NEW_DISK_ADDED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> DISK=<Disk name> size=<value>
- HOSTFAILED for Host failed event:
- HOSTFAILED
A possible host failure has been detected by HA on Host=<ESXi name> in Cluster=<Cluster name> in vCenter=<vCenter name>
- VMRELOCATION for relocation event:
- RELOCATION
VM=<VM name> Relocation completed successfully fromHost=<ESXi name> toHost=<ESXi name> in Cluster=<Clsuter name> in vCenter=<vCenter name>
- DRSVMMIGRATION for migration event:
- DRSVMMIGRATION
VM=<VM name> DRS Migration completed successfully fromHost=<ESXi name> toHost=<ESXi name> in Cluster=<Clsuter name> in vCenter=<vCenter name>
- VMMIGRATION for migration event:
- MIGRATION
VM=<VM name> Migration completed successfully fromHost=<ESXi name> toHost=<ESXi name> in Cluster=<Clsuter name> in vCenter=<vCenter name>
|
/VSM/VC/vCenterName/ StopHotPlugEvents | Set this variable to 1 if you do not want to generate any of the following custom configuration change related events: - MEMORY_SIZE_CHANGED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> Memory Size has been reconfigured from <previous value> to <new value> - CPU_NUM_CHANGED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> CPU number is changed from %s to %s - DISK_SIZE_CHANGED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> DISK=<Disk name> Previous_size=<previous value> Current_size=<new value> - NEW_DISK_ADDED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> DISK=<Disk name> size=<value>
|
/VSM/VC/vCenterName/ TurnOffEvents | Set this variable to 1 to stop generating the following custom events: - Hot plug events
- MEMORY_SIZE_CHANGED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> Memory Size has been reconfigured from <previous value> to <new value> - CPU_NUM_CHANGED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> CPU number is changed from %s to %s - DISK_SIZE_CHANGED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> DISK=<Disk name> Previous_size=<previous value> Current_size=<new value> - NEW_DISK_ADDED
vCenter=<vCenterName> Host=<ESXi name> VM=<VM name> DISK=<Disk name> size=<value>
- Host failed event
- HOSTFAILED
A possible host failure has been detected by HA on Host=<ESXi name> in Cluster=<Cluster name> in vCenter=<vCenter name>
- VM migration events
- RELOCATION
VM=<VM name> Relocation completed successfully fromHost=<ESXi name> toHost=<ESXi name> in Cluster=<Clsuter name> in vCenter=<vCenter name> - DRSVMMIGRATION
VM=<VM name> DRS Migration completed successfully fromHost=<ESXi name> toHost=<ESXi name> in Cluster=<Clsuter name> in vCenter=<vCenter name> - MIGRATION
VM=<VM name> Migration completed successfully fromHost=<ESXi name> toHost=<ESXi name> in Cluster=<Cluster name> in vCenter=<vCenter name>
- Host CPU utilization events
- Processor total utilization <value> for <ESXi name>(physical host) in <vCenter name>(vCenter) exceeds the warn level
- Processor total utilization <value> for <ESXi name>(physical host) in <vCenter name>(vCenter) exceeds the alarm level
- VM CPU utilization events
- Processor total utilization <value> for <VM name>(virtual machine) located at <ESXi name>(physical host) in <vCenter name>(vCenter) exceeds the warn level
- Processor total utilization <value> for <VM name>(virtual machine) located at <ESXi name>(physical host) in <vCenter name>(vCenter) exceeds the alarm level
|
/VSM/VC/vCenterName/filters/ childList | Stores the names of the filters that are configured for eventmonitoring . |
/VSM/VC/vCenterName/filters/ eventAnnotation | A flag indicating whether annotation report will be visible for the event filtering parameters.
Valid values are: - 1: (default) Displays annotation report for the event filtering parameters
- 0: Does not display annotation report for the event filtering parameters
Note When you create an event filter, annotations are enabled, by default. To disable annotations, you can either manually set the value of this variable to 0 or use the Annotations > Off menu command available under KM commands. |
/VSM/VC/vCenterName/filters/
filterName objectName | Stores the name of the managed object that you want to monitor through an event filter. |
/VSM/VC/vCenterName/filters/
filterName objectType | Stores the type of the managed object that you want to monitor through an event filter. |
/VSM/VC/vCenterName/filters/
filterName eventSeverity | Stores the severity of the event that you want to monitor through an event filter. |
/VSM/VC/vCenterName/filters/
filterName eventType | Stores the types of the events that you want to monitor through an event filter. |
/VSM/VC/vCenterName/filters/
filterName eventUsers | Stores the user accounts for whom you want to monitor events through an event filter. |
/VSM/VC/vCenterName/filters/
filterName systemUser | A flag indicating whether system-generated events will be monitored for a managed object. |
/VSM/VC/vCenterName/filters/
filterName childObjects | A flag indicating whether events for the child objects of a managed object will be monitored. |
/VSM/VC/vCenterName/filters/
filterName filterDescription | Stores the description of an event filter. |
/VSM/VC/vCenterName/
vsm_main.maxHeapSize | Sets maximum heap size value for the java.exe process which collects inventory data of vCenter Default values: - 32-bit Java Runtime Environment (JRE): 1200
- 64-bit JRE: 3200 Valid values are: 256, 512, 1200, and 1500 This variable can be used to increase or decrease the maxHeapSize value for the java.exe process. For example: You must increase the maxHeapSize value if the following occur:
- The Comm_Status parameter will go in an alarm state and an out of memory error will be shown in the annotation information.
- There will be no inventory for the vCenter discovered on the PATROL console.
|
/VSM/VC/vCenterName/
vsm_esx.maxHeapSize | Sets maximum heap size value for the java.exe process which collects performance data of hosts which are configured for distributed or failover data collection Default values: - 32-bit JRE: 1200
- 64-bit JRE: 3200 Valid values are: 256, 512, 1200, and 1500 This variable can be used to increase or decrease the maxHeapSize value for the java.exe process. For example, you must increase the maxHeapSize value if you find that the distributed or failover data collection is not taking place for the configured ESX servers on the PATROL console.
|
/VSM/VC/vCenterName/
vsm_events.maxHeapSize | Sets maximum heap size value for the java.exe process which monitors events of a vCenter Default is 256. Valid values are 256, 512, 1200, and 1500 This variable can be used to increase or decrease the maxHeapSize value for the java.exe process.For example, you must increase the maxHeapSize value if you find that you are unable to monitor the vCenter events on the PATROL console. |
/VSM/VC/vCenterName/
chunkMetricLimit | Set this variable to dynamically control the number of entities that can be part of a chunk, depending on the number of metrics to be collected for the entities.The default value of this variable is 15000. A chunk consists of entities (virtual machines and ESX servers) for which performance data is collected in a single request to the vCenter. Each entity can have a different number of metrics to be collected, which can create varied data-size chunks. Use the chunkMetricLimit variable to control the number of entities in a chunk according to the number of metrics being collected for the entities. |
/VSM/VC/vCenterName/FilterClusters | Set this variable to include or exclude clusters from monitoring. For example: cluster_regexCtrl+Ainclusion_option - cluster_regex: This is a regular expression or comma separated list of cluster names (default value is .*)
- Ctrl+A: This is a separator character.
- inclusion_option: Enter 1 for inclusion and 2 for exclusion (default value is 1).
Note Ctrl+A is a special character. You can copy this character from the following file: %patrol_home%\..\pconfmgr\rulesets\Shipped\vsm\vsm_ rulesets.cfg. |
/VSM/VC/vCenterName/ FilterHosts | Set this variable to include or exclude physical hosts from monitoring. For example: host_regexCtrl+Ainclusion_option - host_regex: This is a regular expression or a comma separated list of host names (default value is .*)
- Ctrl+A: This is a separator character.
- inclusion_option: Enter 1 for inclusion and 2 for exclusion (default value is 1).
Note Ctrl+A is a special character. You can copy this character from the following file: %patrol_home%\..\pconfmgr\rulesets\Shipped\vsm\vsm_ rulesets.cfg. |
/VSM/VC/vCenterName/ FilterVMSDNS | Set this variable to filter virtual machines according to their DNS names. The value is a comma-separated list or a regular expression of DNS names that you want to include or exclude from monitoring. For example: dns_name_regexCtrl+Ainclusion_option ■ dns_name_regex: This is a regular expression or a comma-separated list of DNS names. (default value is .*) - Ctrl+A: This is a separator character.
inclusion_option: Enter 1 for inclusion and 2 for exclusion (default value is 1).
Note Ctrl+A is a special character. You can copy this character from the following file: %patrol_home%\..\pconfmgr\rulesets\Shipped\vsm\v sm_rulesets.cfg. The format of this pconfig variable is the same as that of the existing pconfig variables that are used for filtering of clusters, hosts, and virtual machines. - If the DNS name is not available for a particular virtual machine, the DNS name is set according to the DeviceHostnameLookupOrder variable. After that, the DNS name is used for filtering. You can use this variable to include or exclude virtual machines for monitoring according to their DNS names. For example, you can filter out virtual machines that do not carry a DNS name by using the ^$Ctrl+A2 regular expression.
|
/VSM/VC/vCenterName/FilterVMS | Set this variable to include or exclude virtual machines from monitoring. For example: vm_regexCtrl+Ainclusion_option - vm_regex: This is a regular expression or a comma separated list of virtual machines (default value is .*)
- Ctrl+A: This is a separator character.
- inclusion_option: Enter 1 for inclusion and 2 for exclusion (default value is 1).
Note Ctrl+A is a special character. You can copy this character from the following file: %patrol_home%\..\pconfmgr\rulesets\Shipped\vsm\vsm_ rulesets.cfg. |
/VSM/VC/vCenterName/ FilterVMSDNS | Set this variable to filter virtual machines according to their DNS names. The value is a comma-separated list or a regular expression of DNS names that you want to include or exclude from monitoring. For example: dns_name_regexCtrl+Ainclusion_option - dns_name_regex: This is a regular expression or a comma-separated list of DNS names. (default value is .*)
- Ctrl+A: This is a separator character.
- inclusion_option: Enter 1 for inclusion and 2 for exclusion (default value is 1).
Note Ctrl+A is a special character. You can copy this character from the following file: %patrol_home%\..\pconfmgr\rulesets\Shipped\vsm\v sm_rulesets.cfg. The format of this pconfig variable is the same as that of the existing pconfig variables that are used for filtering of clusters, hosts, and virtual machines. If the DNS name is not available for a particular virtual machine, the DNS name is set according to the DeviceHostnameLookupOrder variable. After that, the DNS name is used for filtering. You can use this variable to include or exclude virtual machines for monitoring according to their DNS names. For example, you can filter out virtual machines that do not carry a DNS name by using the ^$Ctrl+A2 regular expression. |
/VSM/VC/vCenterName/FilterVMSIP | Set this variable to filter virtual machines according to their IP addresses.
For example: ip_address_regexCtrl+Ainclusion_option - ip_address_regex: This is a regular expression or a comma separated list of IP addresses (default value is .*)
- Ctrl+A: This is a separator character.
- inclusion_option: Enter 1 for inclusion and 2 for exclusion (default value is 1).
Ctrl+A is a special character. You can copy this character from the following file:
%patrol_home%\..\pconfmgr\rulesets\Shipped\vsm\vsm_rulesets.cfg.
The format of this pconfig variable is the same as that of the existing pconfig variables that are used for filtering of clusters, hosts, and virtual machines.
You can use this variable to include or exclude virtual machines for monitoring according to their IP addresses. For example, you can filter out virtual machines that do not carry an IP address by using the ^$Ctrl+A2 regular expression. |
/VSM/VC/vCenterName/DeviceHostnameLookupOrder | Set this variable to define the lookup order for the hostname of the virtual machine.
The namespace variable for the hostname of the VSM_VM application class (InfoBox: DNS name) is set according to the value defined in this configuration variable. Valid values of this variable are: - DNSNAME: (default) The KM sets the hostname variable as the DNS name of the virtual machine (as reported by the VMware tools). If the DNS name of the virtual machine is not available, the hostname is set to an empty string.
- VMNAME: The KM sets the hostname variable as the virtual machine name if the virtual machine name is a valid DNS name. Otherwise, the hostname is set to an empty string.
- DNSNAME, VMNAME: The KM sets the hostname variable as the DNS name of the virtual machine (as reported by the VMware tools). If the DNS name is not available, the KM sets the hostname variable as the virtual machine name, provided that virtual machine name is a valid DNS name. If the virtual machine name is not a valid DNS name, the hostname is set to an empty string.
|
/VSM/VC/vCenterName/jre64 | Set this variable to enable the 32-bit or 64-bit JRE that is used to launch the Java process. Valid values are: - 1: Enables the 64-bit JRE (default)
- 0: Enables the 32-bit JRE
Note This variable is applicable for 64-bit platform only. |
/VSM/VC/vCenterName/HostScsiExclude | Set this variable to include or exclude the SCSI devices from monitoring.
Valid values are: - 1: Excludes the SCSI devices from monitoring
- 0: (default) Includes the SCSI devices for monitoring
Note The following are the observations made in the KM version 4.0.20 and prior to version 4.0.20 respectively: - If the VMware environment contains a very large number of SCSI devices (LUNs), PATROL for VMware vSphere (v4.0.20) cannot discover the inventory. The symptom of this problem is unusual high memory utilization by the java.exe process. In such a case, use this variable to exclude SCSI devices from monitoring. If you exclude the SCSI devices from monitoring, the data for VSM_DISK_PERF application class is not collected.
- If the VMware environment contains a very large number of SCSI devices (LUNs), PATROL for VMware vSphere (prior to v4.0.20) cannot discover the inventory. The symptom of this problem is unusual high memory utilization by the java.exe process. In such a case, use this variable to exclude SCSI devices from monitoring. If you exclude the SCSI devices from monitoring, the data for the Status parameter of the VSM_SCSI_LUN and VSM_DISK_PERF application class is not collected.
|
/VSM/Global/CollectorType | Set this variable to change the collection mode for the VMware environment.
Valid values are: - 0: (default) Collects metrics for the Enterprise mode only
- 1: Collects metrics for Cloud Lifecycle Management (CLM) mode only
|
/VSM/VC/vCenterName/FilterDatacenters | Set this variable to include or exclude data centers from monitoring.
For example: regexCtrl+Ainclusion_option - regex: This is a regular expression or a comma separated list of cluster names (default value is .*).
- Ctrl+A or \A: These are separator characters. You can use any one of these characters.
inclusion_option: Enter 1 for inclusion and 2 for exclusion (default value is 1). Note Ctrl+A is a special character. You can copy this character from the following file:
%patrol_home%\..\pconfmgr\rulesets\Shipped\vsm\vsm_rulesets.cfg.
|
/VSM/VC/vCenterName/IncludeVMTemplates | Set this variable to include or exclude virtual machine templates from monitoring. Version 3.1.00 onwards, in BMC PATROL for VMware vSphere, virtual machine (VM) templates will not be
discovered, by default. Valid values are: - 1: Includes virtual machine templates for monitoring
- 0: (default) Excludes VM templates from monitoring
Note BMC does not recommend you to include VM templates for monitoring because VM templates do not provide any runtime data, such as CPU usage, disk usage, network usage, or
memory usage, which can be monitored. |
/VSM/VC/<vc_name>/debugEvents | |
/VSM/VC/<vc_name>/debugInventory | |
/VSM/VC/<vc_name>/debugKm | |
/VSM/VC/<vc_name>/debugPerformance | |