- Test period - How often should the test be executed
- Host - The host for which the test is to be configured.
- port - The port at which the specified host listens. By default, this is NULL.
esx user and esx password - To enable this test to read the log file and report metrics, the test should be configured with an ESX USER and ESX PASSWORD.
If the metrics are to be collected by directly connecting to the ESX server in question (i.e., if the VIRTUAL CENTER parameter is set to none), then 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 detailed procedure for accomplishing this task is available inVmKWarning Log Monitor Test section.
On the other hand, if the test needs to connect to vCenter for collecting the log-file related metrics (i.e., if the IP address of vCenter is specified against the VIRTUAL CENTER parameter), then a user with Administrator privileges to vCenter must be set as the ESX USER. Here again, if you cannot expose the credentials of the Administrator due to security restrictions imposed by your environment, then, you can create a special role in vCenter, grant Diagnostics permission to this role, and then assign this role to a local/domain user to vCenter. The credentials of this user can then be passed to the ESX USER and ESX PASSWORD parameters. The steps for creating such a role in vCenter and assigning the role to a local/domain user are documented in VmKWarning Log Monitor Test section.
- confirm password - Confirm the password by retyping it here.
ssl - 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.
Like the ESX sever, the vCenter is also SSL-enabled by default. If you have chosen to use the vCenter for monitoring, then you have to set the SSL flag to Yes.
webport - By default, in most virtualized environments, the vSphere/ESX server and vCenter listen on port 80 (if not SSL-enabled) or on port 443 (if SSL-enabled). This implies that while monitoring an SSL-enabled vSphere/ESX server directly, the eG agent, by default, connects to port 443 of the vSphere/ESX server to pull out metrics, and while monitoring a non-SSL-enabled server, the eG agent connects to port 80. Similarly, while monitoring a vSphere/ESX server via an SSL-enabled vCenter, the eG agent connects to port 443 of vCenter to pull out the metrics, and while monitoring via a non-SSL-enabled vCenter, the eG agent connects to port 80 of vCenter.
Accordingly, the webport parameter is set to 80 or 443 depending upon the status of the ssl flag. In some environments however, the default ports 80 or 443 might not apply. In such a case, against the webport parameter, you can specify the exact port at which the vSphere/ESX server or vCenter in your environment listens so that the eG agent communicates with that port.
VIRTUAL CENTER - If the eG manager had discovered the target ESX server by connecting to vCenter, then the IP address of the vCenter server used for discovering this ESX server would be automatically displayed against the vIRTUAL center parameter; similarly, the esx user and esx password text boxes will be automatically populated with the vCenter user credentials, using which ESX discovery was performed.
If this ESX server has not been discovered using vCenter, but you still want to monitor the ESX server via vCenter, then select the IP address of the vCenter host that you wish to use for monitoring the ESX server from the vIRTUAL center list. By default, this list is populated with the IP address of all vCenter hosts that were added to the eG Enterprise system at the time of discovery. Upon selection, the esx user and esx password that were pre-configured for that vCenter server will be automatically displayed against the respective text boxes.
On the other hand, if the IP address of the vCenter server of interest to you is not available in the list, then, you can add the details of the vCenter server on-the-fly, by selecting the Other option from the vIRTUAL center list. This will invoke the add vcenter server details page. Refer to Adding the Details of a vCenter Server for Guest Discovery section to know how to add a vCenter server using this page. Once the vCenter server is added, its IP address, esx user, and esx password will be displayed against the corresponding text boxes.
On the other hand, if you want the eG agent to behave in the default manner -i.e., communicate with each ESX server for monitoring it - then set the VIRTUAL CENTER parameter to ‘none’. In this case, the ESX USER and ESX PASSWORD parameters can be configured with the credentials of a user who has at least ‘Read-only’ privileges to the target ESX server.
vmkwarning patterns - In the vmkwarning 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 vmkwarning 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.
- ignore vmkwarning lines - In the IGNORE vmkwarning 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 vmkwarning 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.
dd frequency - Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD FREQUENCY.
DETAILED DIAGNOSIS – To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option.
The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:
- The eG manager license should allow the detailed diagnosis capability
- Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.