fix: exclude /dev/mapper/archive_vg-archive output (#167)

- Updated `Request-VcenterStorageHealth` to exclude `/dev/mapper/archive_vg-archive` from the output per KB 76563. - Corrected Example 1 for `Request-VcenterStorageHealth`. - Updated "Out-NULL" to "Out-Null", where applicable. - Updated `CHANGELOG.md` - Updated module version and build to 2.4.0.1000. Ref: #165 Signed-off-by: Ryan Johnson <johnsonryan@vmware.com>
vmware · Aug 22, 2023 · e49943d · e49943d
1 parent 44b6f85
commit e49943d
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Release History
 
+> Release Date: Unreleased
+
+## [v2.4.0](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/releases/tag/v2.4.0)
+
+Bugfix:
+
+- Updated `Request-VcenterStorageHealth` to exclude `/dev/mapper/archive_vg-archive` from the output per [KB 76563](https://kb.vmware.com/s/article/76563).
+
+
 ## [v2.3.0](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/releases/tag/v2.3.0)
 
 > Release Date: 2023-07-25

diff --git a/VMware.CloudFoundation.Reporting.psd1 b/VMware.CloudFoundation.Reporting.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: VMware, Inc.
 #
-# Generated on: 2023-07-25
+# Generated on: 2023-08-29
 #
 
 @{
@@ -12,7 +12,7 @@
     RootModule = '.\VMware.CloudFoundation.Reporting.psm1'
 
     # Version number of this module.
-    ModuleVersion = '2.3.0.1000'
+    ModuleVersion = '2.4.0.1000'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()

diff --git a/VMware.CloudFoundation.Reporting.psm1 b/VMware.CloudFoundation.Reporting.psm1
@@ -1027,7 +1027,7 @@ Function Request-SoSHealthJson {
 					$createPathCounter++
 				}
 			}
-			New-Item -Path $outFilePath -ItemType Directory | Out-NULL
+			New-Item -Path $outFilePath -ItemType Directory | Out-Null
 
             # Use REST API method to request the health summary.
             $healthSummaryPayloadJson = Join-Path -Path $outFilePath -childPath "healthSummaryPayload.json"
@@ -1042,7 +1042,7 @@ Function Request-SoSHealthJson {
             # Retrieve the request status.
             $response = Get-VCFHealthSummaryTask -id $requestID
             $escapeCounter = 0
-			While (($escapeCounter -lt 30) -and !($response.status -match "COMPLETED")) {
+			while (($escapeCounter -lt 30) -and !($response.status -match "COMPLETED")) {
 				sleep(30)
 				$escapeCounter++
                 $response = Get-VCFHealthSummaryTask -id $requestID
@@ -1054,24 +1054,24 @@ Function Request-SoSHealthJson {
 
             # Download the health summary bundle file to a temporary directory.
             Request-VCFHealthSummaryBundle -id $requestID
-			$outFile = Join-Path -Path $outFilePath  -childPath "health-summary.tar.gz"
+			$outFile = Join-Path -Path $outFilePath -childPath "health-summary.tar.gz"
 			$savedFile = "health-summary-"+$requestID+".tar"
 			if (Test-Path -Path $savedFile) {
-				Copy-Item $savedFile $outFile | Out-NULL
-				Remove-Item -Force $savedFile  | Out-NULL
+				Copy-Item $savedFile $outFile | Out-Null
+				Remove-Item -Force $savedFile | Out-Null
 			} else {
 				Write-Error "An error was encountered downloading the health summary bundle."
 				Return $false
 			}
 
             # Untar the tar.gz file and extract health-results.json file.
-			tar -xzf $outFile -C $outFilePath | Out-NULL
+			tar -xzf $outFile -C $outFilePath | Out-Null
 			$healthSummaryPath = gci -recurse -filter "health-results.json" -Path $outFilePath
 			$healthSummaryFile = Join-Path -Path $healthSummaryPath.DirectoryName -childPath "health-results.json"
-			Copy-Item $healthSummaryFile $reportDestination  | Out-NULL
+			Copy-Item $healthSummaryFile $reportDestination | Out-Null
 
 			# Remove the temporary directory.
-			Remove-Item -Recurse -Force $outFilePath  | Out-NULL
+			Remove-Item -Recurse -Force $outFilePath | Out-Null
 
             # Convert to JSON.
             $temp = Get-Content -Path $reportDestination; $temp = $temp -replace '""', '"-"'; $temp | Out-File $reportDestination
@@ -5030,7 +5030,7 @@ Function Request-VcenterStorageHealth {
         - Checks disk usage against thresholds and outputs the results
 
         .EXAMPLE
-        Request-VcenterStorageHealth -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01
+        Request-VcenterStorageHealth -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01
         This example will check disk usage for a single workload domain
 
         .EXAMPLE
@@ -5067,11 +5067,13 @@ Function Request-VcenterStorageHealth {
                 if (($vcfVcenterDetails = Get-vCenterServerDetail -server $server -user $user -pass $pass -domainType MANAGEMENT)) {
                     if (Test-VsphereConnection -server $($vcfVcenterDetails.fqdn)) {
                         if (Test-VsphereAuthentication -server $vcfVcenterDetails.fqdn -user $vcfVcenterDetails.ssoAdmin -pass $vcfVcenterDetails.ssoAdminPass) {
-                            $command = 'df -h | grep -e "^/" | grep -v "/dev/loop"' # Define Command for Retriveing Disk Information
+                            # Define the command for retrieving the disk information.
+                            # Ignore the loopback device and the archive volume from the output.
+                            # Reference: https://kb.vmware.com/s/article/76563.
+                            $command = 'df -h | grep -e "^/" | grep -v "/dev/loop" | grep -v "/dev/mapper/archive_vg-archive"'
                             $vcenter = (Get-VCFWorkloadDomain | Where-Object { $_.name -eq $domain }).vcenters
                             $rootPass = (Get-VCFCredential | Where-Object { $_.credentialType -eq "SSH" -and $_.resource.resourceName -eq $vcenter.fqdn }).password
                             $dfOutput = Invoke-VMScript -VM ($vcenter.fqdn.Split(".")[0]) -ScriptText $command -GuestUser root -GuestPassword $rootPass -Server $vcfVcenterDetails.fqdn
-
                             if ($PsBoundParameters.ContainsKey("failureOnly")) {
                                 Format-DfStorageHealth -dfOutput $dfOutput -systemFqdn $vcenter.fqdn -failureOnly
                             } else {
@@ -5137,8 +5139,10 @@ Function Request-SddcManagerStorageHealth {
     )
 
     Try {
-        $command = 'df -h | grep -e "^/" | grep -v "/dev/loop"' # Define Command for Retriveing Disk Information
-        $dfOutput = Invoke-SddcCommand -server $server -user $user -pass $pass -vmUser $localUser -vmPass $localPass -command $command # Get Disk Information from SDDC Manager
+        # Define the command for retrieving the disk information.
+        # Ignore the loopback device from the output.
+        $command = 'df -h | grep -e "^/" | grep -v "/dev/loop"'
+        $dfOutput = Invoke-SddcCommand -server $server -user $user -pass $pass -vmUser $localUser -vmPass $localPass -command $command
 
         if ($PsBoundParameters.ContainsKey("failureOnly")) {
             Format-DfStorageHealth -dfOutput $dfOutput -systemFqdn $server -failureOnly

diff --git a/docs/documentation/functions/Request-VcenterStorageHealth.md b/docs/documentation/functions/Request-VcenterStorageHealth.md
@@ -25,7 +25,7 @@ The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass
 ### Example 1
 
 ```powershell
-Request-VcenterStorageHealth -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01
+Request-VcenterStorageHealth -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01
 ```
 
 This example will check disk usage for a single workload domain