Release History¶
v2.6.3¶
Release Date: 2024-07-24
Enhancement:
- Adds support for VMware Cloud Foundation 5.2. GH-217
Bugfix:
- Updates
Request-DatastoreStorageCapacity
to handle datastores with a size of 0. GH-217
Chore:
- Updated
PowerValidatedSolutions
from v2.10.0 to v2.11.0. GH-226
v2.6.2¶
Release Date: 2024-05-28
Bugfix:
- Updated
Invoke-VcfHealthReport
cmdlet to handle.
or-
in the report path. GH-217 - Updated
Invoke-VcfAlertReport
cmdlet to handle.
or-
in the report path. GH-217 - Updated
Invoke-VcfConfigReport
cmdlet to handle.
or-
in the report path. GH-217 - Updated
Invoke-VcfUpgradePrecheck
cmdlet to handle.
or-
in the report path. GH-217 - Updated
Invoke-VcfOverviewReport
cmdlet to handle.
or-
in the report path. GH-217
Chore:
- Updated
VMware.PowerCLI
from v13.1.0 to v13.2.1 GH-218 - Updated
PowerValidatedSolutions
from v2.8.0 to v2.10.0. GH-218
v2.6.1¶
Release Date: 2024-02-06
Bugfix:
- Updated
Request-VcenterStorageHealth
cmdlet to output an error message if authentication to vCenter Server fails. GH-209
v2.6.0¶
Release Date: 2024-01-30
Enhancement:
- Updated
Publish-VmConnectedCdrom
function to generate JSON output. GH-204 - Updated
Publish-EsxiConnectionHealth
function to generate JSON output. GH-204 - Updated
Publish-SddcManagerFreePool
function to generate JSON output. GH-204
Chore:
- Updated
PowerVCF
from v2.4.0 to v2.1.0. GH-206 - Updated
PowerValidatedSolutions
from v2.7.0 to v2.8.0. GH-206
v2.5.0¶
Release Date: 2023-12-15
Breaking Change:
- Removes support for Microsoft Windows PowerShell 5.1. Please use Microsoft PowerShell 7.2.0 or later. GH-200
Enhancement:
- Added a prerequisite check to
Invoke-VcfHealthReport
function to verify that the tar utility is present on Windows if using Windows PowerShell 5.1 (Desktop) or PowerShell 7 (Core). Thetar
utility is included with Windows Server 2019 and later and is noted as a system requirement in the documentation. GH-191 - Added support for use of secure strings for sensitive parameters. GH-199
Chore:
- Updated
PowerVCF
from v2.3.0 to v2.4.0. GH-200 - Updated
PowerValidatedSolutions
from v2.6.0 to v2.7.0. GH-200
v2.4.2¶
Release Date: 2023-10-18
Bugfix:
- Updated
Start-Create*
andInvoke-*
functions to address file path generation issues in Linux. GH-182
v2.4.1¶
Release Date: 2023-09-25
Chore:
- Updated code to use
Join-Path
for file paths to simplify the code and better support Windows and Linux.
v2.4.0¶
Release Date: 2023-08-29
Bugfix:
- Updated
Request-VcenterStorageHealth
to exclude/dev/mapper/archive_vg-archive
from the output per KB 76563. GH-167
Chore:
- Updated
VMware.PowerCLI
from v13.0.0 to v13.1.0. GH-171 - Updated
PowerValidatedSolutions
from v2.5.0 to v2.6.0. GH-171 - Added PowerShell Gallery downloads badge to the
docs/index.md
GH-171
v2.3.0¶
Release Date: 2023-07-25
Enhancement:
- Added the
RequiredModules
key to the module manifest to specify the minimum dependencies required to install and run the PowerShell module. GH-155 - Updated
Test-VcfReportingPrereq
to verify that the minimum dependencies are met to run the PowerShell module based on the module's manifest. GH-155
Chore:
- Updated
PowerValidatedSolutions
from v2.4.0 to v2.5.0. GH-155
v2.2.0¶
Release Date: 2023-06-27
Bugfix:
Chore:
- Updated
PowerValidatedSolutions
from v2.3.0 to v2.4.0. GH-150
v2.1.0¶
Release Date: 2023-05-30
Bugfix:
- Updates
Publish-NsxtTier0BgpStatus
to correctly format the HTML output if the NSX Tier-0 is not configured for BGP. GH-134
Enhancement:
- Added
Publish-HardwareCompatibilityHealth
to return the hardware compatibility health from the SoS Health Summary JSON data. GH-129 - Updated
Invoke-VcfHealthReport
to include the hardware compatibility health using thePublish-HardwareCompatibilityHealth
cmdlet. GH-129 - Added component size checks for vCenter Server instances and NSX Local Manager clusters to the overview report. GH-130
- Added
Publish-PingConnectivityHealth
to return the ping connectivity health from the SoS Health Summary JSON data. GH-132 - Updated
Publish-ComponentConnectivityHealth
to include the ping connectivity health using thePublish-PingConnectivityHealth
cmdlet. GH-132
Refactor:
- Updated
Request-VcenterAuthentication
to support isolated workload domains. GH-131 - Updated
Request-DatastoreStorageCapacity
to support isolated workload domains. GH-131
Chore:
- Updated the NSX product name and terms. GH-135
- Added
.PARAMETER
entries for user-facing functions. GH-141
v2.0.1¶
Release Date: 2023-05-12
Bug Fix:
- Updated
Request-SoSHealthJson
to omit theprecheckReport
andversionHealth
from the SoS API request payload if the version is not VMware Cloud Foundation 4.5.0 or later.
v2.0.0¶
Release Date: 2023-04-25
Enhancement:
- Updated
Publish-CertificateHealth
with thresholds based on certificate expiration. GH-107 - Updated
Publish-CertificateHealth
to include an "Expires In (Days)" column. GH-107 - Updated
Publish-CertificateHealth
to include ESXi host certificates. GH-107 - Updated
Publish-PasswordHealth
to include an "Expires In (Days)" column. GH-111 - Added
Publish-VersionHealth
to return the version health from the SoS Health Summary JSON data. GH-123 - Updated
Invoke-VcfHealthReport
to include the version health using thePublish-VersionHealth
cmdlet. GH-123 - Added
Show-ReportingOutput
cmdlet to format output to the console whenPowerVCF
is not installed. GH-121 - Updated
Publish-VsanHealth
to include the results for capacity utilization and the active resync of objects GH-124 - Updated
Publish-VsanHealth
to include the results for stretched cluster health and stretched cluster tests. GH-126
Refactor:
- Breaking: Updated
Invoke-VcfReportingPrereq
to: - Use
-sddcManagerFqdn
,sddcManagerUser
, andsddcManagerPass
parameters to check the SDDC Manager version. GH-117 - Use
Write-LogMessage
to apply colors to the output and log the output to a file using the-logPath
parameter. GH-117 - Breaking: Updated
Invoke-VcfHealthReport
to use-sddcManagerLocalUser
and-sddcManagerLocalPass
parameters instead of-SddcManagerRootPass
. Examples use the localvcf
user account for the SDDC Manager virtual appliance. GH-113 - Breaking: Updated
Publish-StorageCapacityHealth
to use-localUser
and-localPass
parameters instead of-rootPass
. Examples use the localvcf
user account for the SDDC Manager virtual appliance. GH-113 - Breaking: Updated
Request-SddcManagerStorageHealth
to use-localUser
and-localPass
parameters instead of-rootPass
. Examples use the localvcf
user account for the SDDC Manager virtual appliance. GH-113 - Breaking: Removed
Invoke-VcfPasswordPolicy
and supporting content. Please use theVMware.CloudFoundation.PasswordManagement
module. GH-118 - Breaking: Renamed
Request-VrealizeOverview
toRequest-VMwareAriaSuiteOverview
and updated outputs to the rebranded product names. GH-128 - Updated
Request-SoSHealthJson
to use the API to retrieve the SoS Health Summary JSON results. GH-102 - Updated
Publish-PasswordHealth
to return the results from the SoS Health Summary JSON data. GH-111 - Updated
Invoke-VcfHealthReport
to use thePublish-PasswordHealth
cmdlet. GH-111 - Removed
Publish-LocalUserExpiry
and supporting functions in favor of thePublish-PasswordHealth
cmdlet. GH-111 - Removed
Request-LocalUserExpiry
which supported thePublish-LocalUserExpiry
cmdlet. Results are now returned from the SoS Health Summary JSON data. GH-120 - Removed
Request-SddcManagerUserExpiry
which supported thePublish-LocalUserExpiry
cmdlet. GH-120 - Removed
Request-vCenterUserExpiry
which supported thePublish-LocalUserExpiry
cmdlet. GH-120 - Removed
Request-NsxtManagerUserExpiry
which supported thePublish-LocalUserExpiry
cmdlet. GH-120 - Removed
Request-NsxtEdgeUserExpiry
which supported thePublish-LocalUserExpiry
cmdlet. GH-120 - Removed
Request-Request-vRslcmUserExpiry
which supported thePublish-LocalUserExpiry
cmdlet. GH-120
Chore:
- Updated
PowerVCF
from v2.2.0 to v2.3.0. GH-125 - Updated
PowerValidatedSolutions
from v2.0.1 to v2.2.0. GH-117 - Updated
VMware.PowerCLI
from v12.7.0 to v13.0.0. GH-117 - Updated
VMware.vSphere.SsoAdmin
from v1.3.8 to v1.3.9. GH-117
v1.1.0¶
Release Date: 2023-02-28
Bugfix:
- Updated
Request-VcenterBackupStatus
backup message to remove the SDDC Manager FQDN when backups are located on the SDDC Manager. Required for Health Monitoring and Reporting solution alerts. GH-95 - Updated
Publish-vCenterHealth
to correctly link and display the vCenter Server Ring Topology Health from SoS. GH-94 - Resolves an issue with the display name of the vRealize Log Insight product name in the
Request-VrealizeOverview
due to an upstream error in the.SYNOPSIS
ofGet-VCFvRLI
inPowerVCF
. GH-86 - Updated
Test-VcfReportingPrereq
to return results when run on Photon OS. GH-82
Enhancements:
- Updated
Publish-*
cmdlets to support JSON generation. Required for Health Monitoring and Reporting solution. GH-79 Publish-BackupStatus
Publish-NsxtTransportNodeStatus
Publish-NsxtTier0BgpStatus
Publish-SnapshotStatus
Publish-LocalUserExpiry
Publish-StorageCapacityHealth
- Added
Publish-NsxtHealthNonSOS
andPublish-ComponentConnectivityHealthNonSOS
cmdlets. Required for Health Monitoring and Reporting solution. GH-79 - Updated in
Publish-*
cmdlets that support JSON generation to specify encoding needed for Python to read it the content. Required for Health Monitoring and Reporting solution alerts. GH-93 - Added CPU Cores per Socket to the ESXi Host Overview on the overview report. GH-85
- Added an option to
Request-ESXiOverview
to report on the VCF+ subscription cores and export the results to CSV. GH-87
Documentation:
- Updated
README.md
to remove the Known Issues section and adds references to the GitHub issue tracker for support. GH-88 - Updated
README.md
documentation to include support for DellEMC VxRAIL. GH-98
Chore:
- Removed the password policy functions that were moved to
PowerValidatedSolutions
v2.0.0. GH-100 - Updated
PowerValidatedSolutions
from v2.0.0 to v2.0.1. GH-99
v1.0.6¶
Release Date: 2023-01-31
Bugfix:
- Updated
Request0VcenterOverview
to use the PowerVCF cmdlets to return the workload domain's cluster and host counts from the SDDC Manager inventory versus directly from the vSphere inventory. This will ensure that the host count does not include any HCX nodes. GH-65 - Updated
Publish-NsxtCombinedHealth
to use$json
when callingPublish-NsxtHealth
. GH-59 - Updated
Request-NsxtEdgeUserExpiry
to resolve error if an NSX Edgeroot
password is different from an NSX Managerroot
password. GH-75
Enhancement:
- Updated
Invoke-VcfPasswordPolicy
cmdlet with new password expiration, complexity and account lockout details. GH-53
Documentation:
- Added a section for Updating the Module to the
README.md
documentation. GH-57
Chore:
- Updated
PowerValidatedSolutions
from v1.10.0 to v2.0.0. GH-35
Refactor:
- Refactored
Publish-StorageCapacityHealth
for code efficiency. GH-64 - Refactored
Invoke-VcfPasswordPolicy
for code efficiency. GH-63 - Refactored
Invoke-VcfConfigReport
for code efficiency. GH-62 - Refactored
Invoke-VcfAlertReport
for code efficiency. GH-61 - Refactored
Invoke-VcfHealthReport
for code efficiency. GH-60 - Transferred
Publish-EsxiPasswordPolicy
toPowerValidatedSolutions
module. GH-55
v1.0.5¶
Release Date: 2022-12-20
Bugfix:
- Updated
Request-NsxtVidmStatus
andRequest-NsxtComputeManagerStatus
functions to resolve an issue supporting workload domains with shared NSX Local Managers on the health report. GH-25 - Updated
Request-NsxtComputeManagerStatus
function to resolve an issue with supporting workload domains with shared NSX Local Managers on the health report; a false negative for "rogue" compute managers (vCenter Server instances) registered in NSX Local Managers. GH-42 - Updated
Publish-CertificateHealth
function to resolve an issue accurately displaying the certificate health on the health report. GH-43 - Updated
Request-SddcManagerFreePool
function to resolve an issue returning the free pool health for the Health report if the ESXi host license is expired. GH-32 - Updated
Test-VcfReportingPrereq
to display an error on the PowerShell console if the version of a PowerShell module dependency does not meet the minimum requirements. GH-35
Enhancement:
- Added support for including the number of ESXi hosts per cluster in the system overview Report. GH-46
- Added
Request-EsxiOverview
and updatesPublish-VcfSystemOverview
functions to return the high-level status of each ESXi host on the system overview report. GH-33 - Added support for vRealize Log Insight, vRealize Operations, vRealize Automation, and Workspace ONE Access in the
Request-LocalUserExpiry
function. GH-32 - Removed the
Test-VcfReportingPrereq
from theInvoke-*
function which reduces report initialization time. GH-24 - Updated
Test-VcfReportingPrereq
to display the version of an installed PowerShell module dependency. GH-27
Refactor:
- Replaces local
getNsxtServerDetail
function withGet-NsxtServerDetail
function exported fromPowerValidatedSolutions
. GH-35
Chore:
- Updated
PowerValidatedSolutions
from v1.7.0 to v1.10.0. GH-35 - Updated
VMware.PowerCLI
from v12.4.1 to v12.7.0. GH-35 - Updated
VMware.vSphere.SsoAdmin
from v1.3.7 to v1.3.8. GH-35
v1.0.4¶
Release Date: 2022-10-10
Initial availability of the PowerShell module for VMware Cloud Foundation Reporting.