Machines Under Maintenance Report

Administrators can use this report to figure out the virtual machines /virtual desktops (belonging to a Citrix Delivery group) that were put under maintenance. This report helps administrators in identifying the Citrix Delivery group to which the virtual machine/desktop belongs to, the date on which the virtual machine/virtual desktop was put under maintenance. This report helps administrators in figuring out the delivery groups from which the virtual machines/desktops were more frequently put under maintenance.

To generate this report, do the following:

  1. Follow the menu sequence: REPORTS BY FUNCTION -> Domain-specific Reports -> Virtual Applications / Desktops (Citrix XenApp / XenDesktop) -> Citrix Connection Brokering -> Unregistered Machines.

  2. Figure 1 then appears. In Figure 1, select a criteria for analysis from the Analyze By list box.

    Figure 1 : Specifying the criteria for generating the Machines Under Maintenance report

  3. Using this report, you can analyze the distribution of unregistered machines in the delivery groups available on one/more managed components, or those that are part of a zone, service or segment. The options provided by the Analyze By list box are discussed hereunder:

    • Component: Select this option to choose the component(s) from across all the managed components in the environment.
    • Zone: To generate a report for one/more components that are included in a zone, pick the Zone option. A Zone drop-down list will then appear, from which you would have to select the zone to which the components of interest to you belong. A Sub zone flag also appears. Indicate whether the components present within the sub-zones of the chosen zone are also to be to be considered for report generation, by setting the Sub zone flag to Yes.
    • Segment: If you want to generate a report for one/more chosen components that belong to a segment, select the Segment option from Analyze By list box, and then pick the Segment from the drop-down list that appears.
    • Service: If you want to generate a report for one/more components involved in the delivery of a service, select the Service option from Analyze By, and then pick the required Service from the drop-down list that appears.
  4. By default, Desktop is chosen from the Machine Type list indicating that this report will be generated for the Desktop OS machines alone by default. If you wish to generate this report for Server OS machines, then choose Server from this list. Choosing the All option will generate this report for both Desktop and Server OS machines.
  5. The delivery groups containing the machines of the chosen machine type will be listed in the Delivery Groups list. By default, All option is chosen from this list. If you wish to generate this report for a chosen delivery group, then you can choose that particular delivery group alone and proceed with other specifications needed for generating the report.
  6. By default, Current option is chosen from the Report For list indicating that this report will be generated with the details of those machines that were unregistered in the target environment at present. If you wish to generate a report with the details of unregistered machines over a period of time, then, you can choose Historical option from this list.
  7. Choose a Component Type for which the report is to be generated.
  8. The Components list will now be populated with all the components that are managed in your environment for the chosen component type. If the Components list consists of too many components, then viewing all the components and selecting the ones you need for report generation could require endless scrolling. To avoid this, you can click the button next to the Components list. A Components pop up window will then appear using which you can view almost all the components in a single interface and Select the ones to be included in this report.

  9. Then, specify the Timeline for generating this report. You can either provide a fixed time line such as 1 hour, 2 days, etc., or select the Any option from the list to provide a From and To date/time for report generation.

    Note:

    For every user registered with the eG Enterprise system, the administrator can indicate the maximum timeline for which that user can generate a report. Once the maximum timeline is set for a user, then, whenever that user logs into eG Reporter and attempts to generate a report, the Timeline list box in the report page will display options according to the maximum timeline setting of that user. For instance, if a user can generate a report for a maximum period of 3 days only, then 3 days will be the highest option displayed in the Timeline list - i.e., 3 days will be the last option in the fixed Timeline list. Similarly, if the user chooses the Any option from the Timeline list and proceeds to provide a start date and end date for report generation using the From and To specifications, eG Enterprise will first check if the user's Timeline specification conforms to his/her maximum timeline setting. If not, report generation will fail. For instance, for a user who is allowed to generate reports spanning over a maximum period of 3 days only, the difference between the From and To dates should never be over 3 days. If it is, then, upon clicking the Run Report button a message box will appear, prompting the user to change the From and To specification.

  10. In addition to the settings discussed above, this report comes with a set of default specifications. These settings are hidden by default. If you do not want to disturb these default settings, then you can proceed to generate the report by clicking the Run Report button soon after you pick one/more components for report generation. However, if you want to view and then alter these settings (if required), click on the icon. The default settings will then appear in the MORE OPTIONS drop down window (See Figure 2). The steps below discuss each of these settings and how they can be customized.

    Figure 2 : The default settings for generating the report

  11. If the timeline specified for the report needs to exclude the data collected during the Weekends, then set Exclude weekends to Yes. If not, select No.

    Note:

    By default, the weekend constitutes Saturday and Sunday. To override this default setting, do the following:

    • Edit the eg_report.ini file in the <EG_INSTALL_DIR>\manager\config directory.
    • In the [EXCLUDE_WEEKEND] section of the file, the Days parameter is set to Saturday,Sunday by default. You can modify this by setting the Days parameter to a comma-separated list of other days of the week - say Friday,Saturday.
    • Save the file after making the required changes.

  12. Next, indicate the report Time period.

    Note:

    By default, the Time period is set to 24 hours. Accordingly, the From and To parameters in the [timeframe] section of the eg_report.ini file (in the <eg_install_dir>\manager\config directory) are set to 00:00 and 24:00 respectively. If need be, you can override this default setting by configuring a different timeframe against the From and/or To parameters. 

  13. In large environments, reports generated using months of data can take a long time to complete. Administrators now have the option of generating reports on-line or in the background. When a report is scheduled for background generation, administrators can proceed with their other monitoring, diagnosis, and reporting tasks, while the eG manager is processing the report. This saves the administrator valuable time. To schedule background processing of a report, you can either select the Background Save - PDF option from the Report Generation list. To process reports in the foreground, select the Foreground Generation - HTML option from this list.

    Note:

    • The Report Generation list will appear only if the EnableBackgroundReport flag in the [BACKGROUND_PROCESS] section of the eg_report.ini file (in the <EG_INSTALL_DIR>\manager\config directory) is set to Yes.
    • The default selection in the Report Generation list will change according to the Timeline specified for the report. If the Timeline set is greater than or equal to the number of days specified against the MinDurationForReport parameter in the [BACKGROUND_PROCESS] section of the eg_report.ini file, then the default selection in the Report Generation list will be Background Save - PDF. On the other hand, if the Timeline set for the report is lesser than the value of the MinDurationForReport parameter, then the default selection in the Report Generation list will be Foreground. This is because, the MinDurationForReport setting governs when reports are to be processed in the background. By default, this parameter is set to 2 weeks - this indicates that by default, reports with a timeline of 2 weeks and above will be processed in the background.
  14. Click the Done button if any changes were made to the More Options drop down window.
  15. Finally, click the Run Report button to generate the report.

  16. If the Report type is Foreground Generation - HTML and the Report For is Current, then Figure 3 will appear as soon as you click the Run Report button.

    Figure 3 : The generated Machines Under Maintenance report

    The SUMMARY section in Figure 3 reveals the count of machines that were in maintenance mode over a chosen period of time and the count of delivery groups that contained those machines.

    The next section reveals the name of the component, the name of the machine that is under maintenance and the delivery group to which the machine belongs to. The timestamp/date on which the machine was under maintenance will be displayed in the report if the report is generated for a chosen time period (choose Report For option as Historical) . Using this report, administrators can figure out the machines that were frequently put under maintenance.