Python Module for VMware Cloud Foundation Health Monitoring in vRealize Operations
Project description
Python Module for VMware Cloud Foundation Health Monitoring in vRealize Operations
Table of Contents
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 via the respective management packs.
Requirements
Platforms
- VMware Cloud Foundation 4.4 or later
Operating Systems
- VMware Photon OS 3.0 and 4.0
- Microsoft Windows Server 2019 and 2022
Python Version
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
- PowerShell Core 7.2.0 or later
- Microsoft Windows PowerShell 5.1
PowerShell Modules
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
-
VCF Health Rollup
-
VCF Backup Health
-
VCF Certificate Health
-
VCF Compute Health
-
VCF Connectivity Health
-
VCF DNS Health
-
VCF Hardware Compatibility
-
VCF Networking Health
-
VCF NTP Health
-
VCF Password Health
-
VCF SDDC Manager and vCenter Services Health
-
VCF Snapshot Health
-
VCF Storage Health
-
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 vReaize Operations dashboards depend on the name.
To set the Product Name for the vCenter Server, follow the below steps -
- Log in to the management domain vCenter Server at
https://<management_vcenter_server_fqdn/ui
asadministrator@vsphere.local
. - In the
VMs and templates
inventory, expand themanagement domain vCenter Server
tree and expand the management domain data center. - Select the first
management domain vCenter Server virtual machine
and selectConfigure
tab. - In the
Settings
pane selectvApp Options
. - Click the
Edit
button. TheEdit vApp Options
dialog box opens. - If vApp options are disabled, select the
Enable vApp options
check box and clickOK
. - Click the
Details
tab and enterVMware vCenter Server Appliance
as product name in theName
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.
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:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for vmware-cloud-foundation-health-monitoring-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b291ede01aabb41d0e8459657b067d0c35ec6e3ff71f23252a0ab57099e86718 |
|
MD5 | c7d2a51f533164a299bd1b8c7cc44026 |
|
BLAKE2b-256 | feecc25eeb681f0201aa86817e95b8b3842ced42ab107679e76c519688a0448d |
Hashes for vmware_cloud_foundation_health_monitoring-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4331b5634eb12377a16ce84084e48a7aab304e7c20f385949398d2afceb13faa |
|
MD5 | 2a5b125ba28f5ebf0d85d4c10ce1ffae |
|
BLAKE2b-256 | d5370992189ca6d826aa1e5882dab44d4a93c508a4e8111bc802097ef4fc9af9 |