chore: update examples (#262)

- Updated VMware.CloudFoundation.Reporting.psd1 doc to update version.
- Updated VMware.CloudFoundation.Reporting.psm1 doc to sanitize all the example variables, add brackets and punctuation.
- Updated Invoke-VcfUpgradePrecheck.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-BackupStatus.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-CertificateHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-ClusterConfiguration.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-ClusterDrsRule.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-ComponentConnectivityHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-ComponentConnectivityHealthNonSOS.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-ConnectivityHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-DnsHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-EsxiAlert.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-EsxiConnectionHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-EsxiCoreDumpConfig.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-EsxiHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-HardwareCompatibilityHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-NsxtCombinedHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-NsxtEdgeClusterHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-NsxtEdgeNodeHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-NsxtHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-NsxtHealthNonSOS.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-NtpHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-PasswordHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-PingConnectivityHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-ResourcePool.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-SddcManagerFreePool.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-ServiceHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-StorageCapacityHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-VcenterAlert.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-VcenterHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-VersionHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-VmConnectedCdrom.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-StorageCapacityHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-VsanHealth.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Publish-VsanStoragePolicy.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Request-ClusterDrsRule.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Request-SddcManagerFreePool.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Request-SoSHealthJson.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated Request-VcfOverview.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated alert-report.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated configuration-report.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated health-report.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated overview-report.md doc to sanitize all the example variables, add brackets and punctuation.
- Updated vars-domain.ps1 doc to sanitize all the example variables, add brackets and punctuation.
- Updated vars-health.ps1 doc to sanitize all the example variables, add brackets and punctuation.
- Updated vars-vcf.ps1 doc to sanitize all the example variables, add brackets and punctuation.
- Updated vars-windows.ps1 doc to sanitize all the example variables, add brackets and punctuation.

Signed-off-by: Andy Beltz <andy.beltz@broadcom.com>

Author: andybeltz

VMware.CloudFoundation.Reporting.psd1

@@ -12,7 +12,7 @@
     RootModule        = '.\VMware.CloudFoundation.Reporting.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '2.7.0.1000'
+    ModuleVersion     = '2.7.0.1001'
 
     # ID used to uniquely identify this module
     GUID              = '043bbd4d-206a-4520-87f5-070450379d72'

VMware.CloudFoundation.Reporting.psm1

@@ -2,7 +2,7 @@
 
 ## Synopsis
 
-Perform upgrade precheck.
+Perform an upgrade precheck.
 
 ## Syntax
 

docs/documentation/functions/Invoke-VcfUpgradePrecheck.md

@@ -25,8 +25,7 @@ The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass
 
 - Validates that network connectivity is available to the SDDC Manager instance.
 - Performs checks on the backup status and outputs the results.
-- outputJson parameter takes in name of the folder to save the json.
-Filename is autogenerated.
+- outputJson parameter takes in name of the folder to save the json. Filename is autogenerated.
 
 ## Examples
 

docs/documentation/functions/Publish-BackupStatus.md

@@ -2,7 +2,7 @@
 
 ## Synopsis
 
-Formats the certificate health data from the SOS JSON output.
+Formats the certificate health data from the SoS JSON output.
 
 ## Syntax
 
@@ -12,7 +12,7 @@ Publish-CertificateHealth [-json] <String> [-html] [-failureOnly] [<CommonParame
 
 ## Description
 
-The `Publish-CertificateHealth` cmdlet formats the certificate health data from the SOS JSON output and publishes it as either a standard PowerShell object or an HTML object.
+The `Publish-CertificateHealth` cmdlet formats the certificate health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object.
 
 ## Examples
 
@@ -44,7 +44,7 @@ This example extracts and formats the certificate health data as a PowerShell ob
 
 ### -json
 
-The path to the JSON file containing the SOS health summary data.
+The path to the JSON file containing the SoS health summary data.
 
 ```yaml
 Type: String

docs/documentation/functions/Publish-CertificateHealth.md

@@ -35,7 +35,7 @@ The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass
 Publish-ClusterConfiguration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
 ```
 
-This example will return cluster configuration from all clusters in vCenter Server managed by SDDC Manager for all workload domains.
+This example will return cluster configuration from all clusters in vCenter managed by SDDC Manager for all workload domains.
 
 ### Example 2
 

docs/documentation/functions/Publish-ClusterConfiguration.md

@@ -35,15 +35,15 @@ The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass
 Publish-ClusterDrsRule -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
 ```
 
-This example will return cluster DRS rules from all clusters in vCenter managed by SDDC Manager for all workload domains.
+This example will return cluster DRS rules from all clusters in vCenters managed by SDDC Manager for all workload domains.
 
 ### Example 2
 
 ```powershell
 Publish-ClusterDrsRule -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
 ```
 
-This example will return cluster DRS rules from all clusters in vCenter managed by SDDC Manager for a specified workload domain named.
+This example will return cluster DRS rules from all clusters in vCenter managed by SDDC Manager for a specified workload domain.
 
 ## Parameters
 

docs/documentation/functions/Publish-ClusterDrsRule.md

@@ -31,23 +31,23 @@ The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass
 ### Example 1
 
 ```powershell
-Publish-ComponentConnectivityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
+Publish-ComponentConnectivityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -json [json-file] -allDomains
 ```
 
 This example checks the component connectivity for all workload domains across the VMware Cloud Foundation instance.
 
 ### Example 2
 
 ```powershell
-Publish-ComponentConnectivityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
+Publish-ComponentConnectivityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -json [json-file] -workloadDomain [workload_domain_name]
 ```
 
 This example checks the component connectivity for a specified workload domain in a VMware Cloud Foundation instance.
 
 ### Example 3
 
 ```powershell
-Publish-ComponentConnectivityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
+Publish-ComponentConnectivityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -json [json-file] -allDomains -failureOnly
 ```
 
 This example checks the component connectivity for all workload domains across the VMware Cloud Foundation instance but only reports issues.

docs/documentation/functions/Publish-ComponentConnectivityHealth.md

@@ -2,7 +2,7 @@
 
 ## Synopsis
 
-Request and publish component connectivity health only for health checks which are not a part of SOS Utility health.
+Request and publish component connectivity health only for health checks which are not a part of SoS Utility health.
 Data obtained is a subset of Publish-ComponentConnectivityHealth cmdlet.
 
 ## Syntax
@@ -35,31 +35,31 @@ The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass
 Publish-ComponentConnectivityHealthNonSOS -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
 ```
 
-This example checks the component connectivity outside of SOS utility for all workload domains across the VMware Cloud Foundation instance.
+This example checks the component connectivity outside of SoS utility for all workload domains across the VMware Cloud Foundation instance.
 
 ### Example 2
 
 ```powershell
 Publish-ComponentConnectivityHealthNonSOS -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password]  -workloadDomain [workload_domain_name]
 ```
 
-This example checks the component connectivity outside of SOS utility for a single workload domain in a VMware Cloud Foundation instance.
+This example checks the component connectivity outside of SoS utility for a single workload domain in a VMware Cloud Foundation instance.
 
 ### Example 3
 
 ```powershell
 Publish-ComponentConnectivityHealthNonSOS -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
 ```
 
-This example checks the component connectivity outside of SOS utility for all workload domains across the VMware Cloud Foundation instance but only reports issues.
+This example checks the component connectivity outside of SoS utility for all workload domains across the VMware Cloud Foundation instance but only reports issues.
 
 ### Example 4
 
 ```powershell
 Publish-ComponentConnectivityHealthNonSOS -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -jsonOutput [report_path]
 ```
 
-This example checks the component connectivity outside of SOS utility for all workload domains across the VMware Cloud Foundation instance and saves it under [report_path] with filename `<timestamp>-componentconnectivityhealthnonsos-status.json`.
+This example checks the component connectivity outside of SoS utility for all workload domains across the VMware Cloud Foundation instance and saves it under [report_path] with filename `<timestamp>-componentconnectivityhealthnonsos-status.json`.
 
 ## Parameters
 

docs/documentation/functions/Publish-ComponentConnectivityHealthNonSOS.md

@@ -2,7 +2,7 @@
 
 ## Synopsis
 
-Formats the connectivity health data from the SOS JSON output.
+Formats the connectivity health data from the SoS JSON output.
 
 ## Syntax
 
@@ -12,30 +12,30 @@ Publish-ConnectivityHealth [-json] <String> [-html] [-failureOnly] [<CommonParam
 
 ## Description
 
-The `Publish-ConnectivityHealth` cmdlet formats the connectivity health data from the SOS JSON output and publishes it as either a standard PowerShell object or an HTML object.
+The `Publish-ConnectivityHealth` cmdlet formats the connectivity health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object.
 
 ## Examples
 
 ### Example 1
 
 ```powershell
-Publish-ConnectivityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password]
+Publish-ConnectivityHealth -json [file_name]
 ```
 
 This example extracts and formats the connectivity health data as a PowerShell object from the JSON file.
 
 ### Example 2
 
 ```powershell
-Publish-ConnectivityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -html
+Publish-ConnectivityHealth -json [file_name] -html
 ```
 
 This example extracts and formats the connectivity health data as an HTML object from the JSON file.
 
 ### Example 3
 
 ```powershell
-Publish-ConnectivityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -failureOnly
+Publish-ConnectivityHealth -json [file_name] -failureOnly
 ```
 
 This example extracts and formats the connectivity health data as a PowerShell object from the JSON file for only the failed items.
@@ -44,7 +44,7 @@ This example extracts and formats the connectivity health data as a PowerShell o
 
 ### -json
 
-The path to the JSON file containing the SOS health summary data.
+The path to the JSON file containing the SoS health summary data.
 
 ```yaml
 Type: String