vmware-cloud-foundation-health-monitoring 2.0.0.1004

Python Module for VMware Cloud Foundation Health Monitoring in vRealize Operations

Python Module for VMware Cloud Foundation Health Monitoring in vRealize Operations

        

Table of Contents

• Health Reporting and Monitoring for VMware Cloud Foundation
  • Table of Contents
  • Introduction
  • Requirements
  • Implementation
  • vRealize Operations Dashboards Preview
  • Known Issues
  • Support

Introduction

This content supports the Health Reporting and Monitoring for VMware Cloud Foundation validated solution which enables the user to monitor the operational state of your VMware Cloud Foundation environment through custom dashboards, alerts, and notifications. These custom dashboards are intended to serve as an extension to native vRealize Operations dashboards and dashboards that are enabled using the respective management packs.

Requirements

Platforms

• VMware Cloud Foundation 5.0
• VMware Cloud Foundation 4.5
• VMware Cloud Foundation 4.4

Operating Systems

• Microsoft Windows Server 2019 and 2022
• VMware Photon OS 3.0 and 4.0

Python Version

• Python 3.x

Follow the Python Beginners Guide to download and install Python.

Python Libraries

Install requried Python libraries by running the following commands on the host virtual machine:

pip install requests
pip install setuptools
pip install paramiko
pip install maskpass==0.3.1

PowerShell Editions and Versions

• Microsoft Windows PowerShell 5.1
• PowerShell Core 7.2.0 or later

PowerShell Modules

• PowerShell Module for VMware Cloud Foundation Reporting - latest version

Implementation

Follow the Implementation of Health Reporting and Monitoring for VMware Cloud Foundation from Health Reporting and Monitoring for VMware Cloud Foundation

vRealize Operations Dashboards Preview

1. VCF Health Rollup

2. VCF Backup Health

3. VCF Certificate Health

4. VCF Compute Health

5. VCF Connectivity Health

6. VCF DNS Health

7. VCF Hardware Compatibility

8. VCF Networking Health

9. VCF NTP Health

10. VCF Password Health

11. VCF SDDC Manager and vCenter Services Health

12. VCF Snapshot Health

13. VCF Storage Health

14. VCF vSAN Health

Known Issues

1. Remove FQDN suffix dependency in the name when configuring an NSX-T cloud account in vRealize Operations

   Please make sure that your NSX-T account name is configured as mentioned in this issue.

2. The vCenter Server name needs to be updated in VMware Cloud Foundation 4.4.x. The filters on the vRealize Operations dashboards depend on the name.

   To set the Product Name for the vCenter Server, follow the below steps:

   1. Log in to the management domain vCenter Server at https://<management_vcenter_server_fqdn>/ui as [e-mail].
   2. In the VMs and templates inventory, expand the management domain vCenter Server tree and expand the management domain data center.
   3. Select the first management domain vCenter Server virtual machine and select Configure tab.
   4. In the Settings pane select vApp Options.
   5. Click the Edit button. The Edit vApp Options dialog box opens.
   6. If vApp options are disabled, select the Enable vApp options check box and click OK.
   7. Click the Details tab and enter VMware vCenter Server Appliance as product name in the Name field.

3. Shades of red, green, and yellow may vary on vRealize Operations widgets

   Shades of red, green, and yellow may be different in different widgets but they represent the same thing. Ignore the shades as this is a vRealize Operations product limitation.

Support

This Python module is not supported by VMware Support Services.

We welcome you to use the GitHub Issues to report bugs or suggest enhancements.

In order to have a good experience with our community, we recommend that you read the contributing guidelines.

When filing an issue, please check existing open, or recently closed, issues to make sure someone else hasn't already reported the issue.

Please try to include as much information as you can. Details like these are incredibly useful:

• A reproducible test case or series of steps.
• Any modifications you've made relevant to the bug.
• Anything unusual about your environment or deployment.

License

Copyright 2023 VMware, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.