Agents Administration - Tests
 

Configuration of VmKernelTest

The VmKernelTest monitors the vmkernel log file of a VMware ESX server to which the activities of the ESX server and its virtual machines are logged. The test scans the log file for entries matching configured patterns, and alerts administrators whenever such entries are logged in the log file.

The default parameters associated with this test are as follows:

  • The TEST PERIOD list box helps the user to decide how often this test needs to be executed.

  • In the HOST text box, the host name of the server for which the test is to be configured has to be specified.

  • The port number to which the server is listening is to be provided in the PORT text box. By default, this will be NULL.

  • To enable this test to read the log file and report metrics, the test should be configured with an ESX USER and ESX PASSWORD. Typically, a user with Administrator privileges to the target ESX server can be set as the ESX USER. However, if, owing to security constraints, you cannot expose the credentials of the Administrator, then you can create a special role for this purpose in the ESX server, and grant the Diagnostics permission to this role. You can then add a new user to the ESX server, and assign the newly created role to that user. The credentials of this user can then be passed to the ESX USER and ESX PASSWORD parameters. The detailed procedure for accomplishing this task is available in the Monitoring VMware Infrastructures document.

  • Confirm the password by retyping it in the CONFIRM PASSWORD text box.

  • By default, the ESX server is SSL-enabled. Accordingly, the SSL flag is set to Yes by default. This indicates that the eG agent will communicate with the ESX server via HTTPS by default.

  • In the VMKERNEL PATTERNS text box, specify the pattern to search for in the log file in the following format: <PatternName>:<Pattern>, where <PatternName> is the pattern name that will be displayed in the monitor interface and <Pattern> is an expression of the form - *expr* or expr or *expr or expr*, etc. A leading '*' signifies any number of leading characters, while a trailing '*' signifies any number of trailing characters.

    For example, say you specify VM:VM-* in the VMKERNEL PATTERNS text box. This indicates that "VM" is the pattern name that will be displayed as a descriptor of this test in the monitor interface. "VM-*" indicates that the test will monitor only those lines in the log file which start with the term "VM-". Similarly, if your pattern specification reads: offline:*offline, then it means that the pattern name is offline and that the test will monitor those lines in the log which end with the term offline.  

    Multiple search patterns can be specified as a comma-separated list. For example: VM:VM-*,offline:*offline*,online:*online. If you want to monitor all the entries in the log file, your specification would be all:all.

  • In the IGNORE VMKERNEL LINES text box, specify the pattern of entries that is to be excluded from monitoring. For example, if you want the test to disregard those entries which begin with the term VM, then specify VM* in the IGNORE VMKERNEL LINES text box. Multiple search patterns can be specified as a comma-separated list. For example, VM*,*VM. A leading '*' signifies any number of leading characters, while a trailing '*' signifies any number of trailing characters. If no lines are to be ignored, then enter none here. If you want to ignore all the lines in the log file, your specification would be all:all.

  • If multiple components of the same component type are awaiting configuration, then an APPLY TO OTHER COMPONENTS check box will appear in this page. Clicking on this check box will allow you to apply the configuration to all/selected components of that type.

  • Once the necessary values have been provided, clicking on the Update button will register the changes made.

When changing the configuration for specific servers, a “*” beside the text box corresponding to the parameter signifies that these values have to be manually configured by the user. The parameter values that require to be configured will typically be prefixed with a “$” or contain a series of “*”. A value of "none" in the parameter value indicates that the corresponding parameter value can be changed if required.