Package: vmware-cloud-foundation-health-monitoring
Python Module for VMware Cloud Foundation Health Monitoring in VMware Aria OperationsTable of ContentsHealth Reporting and Monitoring for VMware Cloud FoundationTable of ContentsIntroductionRequirementsImplementationInstall the Python Module in a Disconnected EnvironmentUpdating the Python Module to the Latest VersionVMware Aria Operations Dashboards PreviewKnown IssuesSupportIntroductionThis content supports theHealth Reporting and Monitoring for VMware Cloud Foundationvalidated solution which enables the user to monitor the operational state of yourVMware Cloud Foundationenvironment through custom dashboards, alerts, and notifications. These custom dashboards are intended to serve as an extension to native VMware Aria Operations dashboards and dashboards that are enabled using the respective management packs.RequirementsPlatformsVMware Cloud Foundation 5.1VMware Cloud Foundation 5.0VMware Cloud Foundation 4.5Operating SystemsMicrosoft Windows Server 2019 and 2022VMware Photon OS3.0 and 4.0Python VersionPython 3.xFollow thePython Beginners Guideto download and install Python.Python LibrariesInstall required Python libraries by running the following commands on the host virtual machine:pipinstallrequestspipinstallsetuptoolspipinstallparamikopipinstallmaskpass==0.3.1PowerShell Editions and VersionsMicrosoft Windows PowerShell 5.1PowerShell Core 7.2.0 or laterPowerShell ModulesPowerShell Module for VMware Cloud Foundation Reporting- latest versionImplementationFollow theImplementation of Health Reporting and Monitoring for VMware Cloud FoundationfromHealth Reporting and Monitoring for VMware Cloud FoundationInstall the Python Module in a Disconnected EnvironmentFor environments disconnected from the Internet (e.g., dark-site, air-gapped), you can save the Health Reporting and Monitoring Python module and its dependencies from the PyPI using the below instructions.For Photon OS -On the target system, create a directory to save the Python modulesmkdir -p /opt/vmware/hrm-modulesFrom a system with an Internet connection, make a modules directory and create a new filerequirements.txtinside it.mkdir -p /home/hrm-modules/
  cd /home/hrm-modules/
  vi requirements.txtAdd below content to therequirements.txtfile and save it.requests
setuptools
paramiko
maskpass==0.3.1Create another filemodule.txtin the same location.vi module.txtAdd below content to themodule.txtfile and save it.vmware-cloud-foundation-health-monitoringFrom a system with an Internet connection, save the module and its dependencies from PyPI by running the following commands in the terminal:pip download -r module.txt
  pip download -r requirements.txtFrom the system with an Internet connection, copy the module and its dependencies to a target system by running the following commands in the terminal:scp -r /home/vcf/hrm-modules/* username@remote_host:/opt/vmware/hrm-modules/On the target system, install the module and its dependencies by running the following commands in the terminal:cd /opt/vmware/hrm-modules
  pip install -r requirements.txt --no-index --find-links .
  pip install -r module.txt --no-index --find-links . -t /opt/vmware/hrm-<sddc_manager_vm_name>For Windows Server -From a system with an Internet connection, make a modules folderF:\hrm-modules.Create a new filerequirements.txtinside the modules folder.Add the below content to therequirements.txtfile and save it.requests
setuptools
paramiko
maskpass==0.3.1In the modules folderf:\hrm-modules, create a new filemodule.txtAdd below content tomodule.txtfile and save it.vmware-cloud-foundation-health-monitoringFrom a system with an Internet connection, save the module and its dependencies from PyPI by running the following commands from cmdline:cd f:\hrm-modules
  pip download -r module.txt 
  pip download -r requirements.txtFrom the system with the Internet connection, copy the module and its dependencies to a target system by running the following commands in the PowerShell console:Copy-Item -Path F:\hrm-modules\* -Destination '\\<destination_host>\C$\vmware\hrm-modulesOn the target system, install the module and its dependencies by running the following commands in the terminal:cd c:\vmware\hrm-modules
  pip install -r requirements.txt --no-index --find-links .
  pip install -r module.txt --no-index --find-links . -t c:\vmware\hrm-<sddc_manager_vm_name>Once the Python modules are installed, continue to follow theImplementation of Health Reporting and Monitoring for VMware Cloud FoundationfromHealth Reporting and Monitoring for VMware Cloud FoundationUpdating the Python Module to the Latest VersionFor Photon OS -Log in to the host virtual machine at<host_virtual_machine_fqdn>:22as therootuser by using a Secure Shell (SSH) client.Update the Python Module for Health Reporting and Monitoring in VMware Aria Operations.pip install vmware-cloud-foundation-health-monitoring --target=/opt/vmware/hrm-<sddc_manager_vm_name> --upgradeProvide execute permissions to the files in thehrm-<sddc_manager_vm_name>directory.chmod -R 755 /opt/vmware/hrm-<sddc_manager_vm_name>Switch to thehrm-<sddc_manager_vm_name>/maindirectory.cd /opt/vmware/hrm-<sddc_manager_vm_name>/mainEdit theenv.jsonfile and configure the values according to your VMware Cloud Foundation Planning and Preparation Workbook.vi env.jsonEncrypt the service account passwords.python encrypt-passwords.pyEnter the password for the VMware Aria Operations service account.Enter the password for the SDDC Manager service account.Enter the password for the SDDC Manager appliance local user.Repeat this procedure for each VMware Cloud Foundation instance.For Windows Server -Log in to the host virtual machine at<host_virtual_machine_fqdn>as theAdministratoruser by using a Remote Desktop Connection (RDC) client and open a PowerShell console.Start Windows Command Prompt.Update the Python Module for Health Reporting and Monitoring in VMware Aria Operations.pip install vmware-cloud-foundation-health-monitoring --target=C:\vmware\hrm-<sddc_manager_vm_name>\ --upgradeChange to thehrm-<sddc_manager_vm_name>\mainfolder.cd c:\vmware\hrm-<sddc_manager_vm_name>\mainEdit theenv.jsonfile and configure the values according to your VMware Cloud Foundation Planning and Preparation Workbook.notepad env.jsonEncrypt the service account passwords.python encrypt-passwords.pyEnter the password for the VMware Aria Operations service account.Enter the password for the SDDC Manager service account.Enter the password for the SDDC Manager appliance local user.Repeat this procedure for each VMware Cloud Foundation instance.VMware Aria Operations Dashboards PreviewVCF Health RollupVCF Backup HealthVCF Certificate HealthVCF Compute HealthVCF Connectivity HealthVCF DNS HealthVCF Hardware CompatibilityVCF Networking HealthVCF NTP HealthVCF Password HealthVCF SDDC Manager and vCenter Services HealthVCF Snapshot HealthVCF Storage HealthVCF vSAN HealthVCF Version HealthKnown IssuesRemove FQDN suffix dependency in the name when configuring an NSX-T cloud account in VMware Aria OperationsPlease make sure that your NSX-T account name is configured as mentioned in this issue.The vCenter Server name needs to be updated in VMware Cloud Foundation 4.4.x. The filters on the VMware Aria 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 athttps://<management_vcenter_server_fqdn>/uiasadministrator@vsphere.local.In theVMs and templatesinventory, expand themanagement domain vCenter Servertree and expand the management domain data center.Select the firstmanagement domain vCenter Server virtual machineand selectConfiguretab.In theSettingspane selectvApp Options.Click theEditbutton. TheEdit vApp Optionsdialog box opens.If vApp options are disabled, select theEnable vApp optionscheck box and clickOK.Click theDetailstab and enterVMware vCenter Server Applianceas product name in theNamefield.Shades of red, green, and yellow may vary on VMware Aria Operations widgetsShades of red, green, and yellow may be different in different widgets but they represent the same thing. Ignore the shades as this is a VMware Aria Operations product limitation.SupportThis Python module is not supported by VMware Support Services.We welcome you to use theGitHub Issuesto report bugs or suggest enhancements.In order to have a good experience with our community, we recommend that you read thecontributing 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.LicenseCopyright 2023 Broadcom. All Rights Reserved.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.