docs: sanitize examples

docs/documentation/functions/Invoke-VcfAlertReport.md

@@ -54,7 +54,7 @@ This example generates the alert report for a specific workload domain in a VMwa
 Invoke-VcfAlertReport -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -reportPath [report_path] -workloadDomain [workload_domain_name] -failureOnly
 ```
 
-This example generates the alert report for a specific workload domain in a VMware Cloud Foundation instance but for only failed items.
+This example generates the alert report for a specific workload domain in a VMware Cloud Foundation instance but only reports issues.
 
 ## Parameters
 

docs/documentation/functions/Invoke-VcfHealthReport.md

@@ -46,7 +46,7 @@ This example runs a health check for a specific workload domain within a VMware
 Invoke-VcfHealthReport -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -sddcManagerLocalUser [local_username] -sddcManagerLocalPass [local_password] -reportPath [report_path] -allDomains -failureOnly
 ```
 
-This example runs a health check across a VMware Cloud Foundation instance but only ouputs issues to the HTML report.
+This example runs a health check across a VMware Cloud Foundation instance but only reports issues.
 
 ## Parameters
 

docs/documentation/functions/Publish-ClusterConfiguration.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 a all workload domains.
+This example will return cluster configuration from all clusters in vCenter Server managed by SDDC Manager for all workload domains.
 
 ### Example 2
 

docs/documentation/functions/Publish-ComponentConnectivityHealth.md

@@ -39,10 +39,10 @@ This example checks the component connectivity for all workload domains across t
 ### Example 2
 
 ```powershell
-Publish-ComponentConnectivityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain sfo-w01
+Publish-ComponentConnectivityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
 ```
 
-This example checks the component connectivity for a single workload domain in a VMware Cloud Foundation instance.
+This example checks the component connectivity for a specified workload domain in a VMware Cloud Foundation instance.
 
 ### Example 3
 

docs/documentation/functions/Publish-ConnectivityHealth.md

@@ -76,7 +76,7 @@ Accept wildcard characters: False
 
 ### -failureOnly
 
-Specifies that the output should only contain failed items.
+Switch to only output issues to the report.
 
 ```yaml
 Type: SwitchParameter

docs/documentation/functions/Publish-EsxiAlert.md

@@ -35,23 +35,23 @@ The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass
 Publish-EsxiAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
 ```
 
-This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for a all workload domains.
+This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for all workload domains.
 
 ### Example 2
 
 ```powershell
 Publish-EsxiAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
 ```
 
-This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for a all workload domains but only for the failed items.
+This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for all workload domains but only reports issues.
 
 ### Example 3
 
 ```powershell
 Publish-EsxiAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
 ```
 
-This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for a workload domain named [workload_domain_name].
+This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for a specified workload domain.
 
 ## Parameters
 

docs/documentation/functions/Publish-EsxiConnectionHealth.md

@@ -51,15 +51,15 @@ This example will publish the connection status of ESX hosts in a workload domai
 Publish-EsxiConnectionHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
 ```
 
-This example will publish the connection status of ESX hosts in all workload domains but only for failures.
+This example will publish the connection status of ESX hosts in all workload domains but only reports issues.
 
 ### Example 4
 
 ```powershell
 Publish-EsxiConnectionHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -outputJson [report_path]
 ```
 
-This example will generate a json for the connection status of ESX hosts in all workload domains and saves it under [report_path] with filename `<timestamp>-esxi-connection-status.json`.
+This example will generate a json for the connection status of ESX hosts in all workload domains and saves it under the specified report path with filename `<timestamp>-esxi-connection-status.json`.
 
 ## Parameters
 

docs/documentation/functions/Publish-EsxiSecurityConfiguration.md

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

docs/documentation/functions/Publish-NsxtCombinedHealth.md

@@ -50,7 +50,7 @@ This example checks NSX health for a specified workload domain in a VMware Cloud
 Publish-NsxtCombinedHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
 ```
 
-This example checks NSX health for all workload domains across the VMware Cloud Foundation instance but only for the failed items.
+This example checks NSX health for all workload domains across the VMware Cloud Foundation instance but only reports issues.
 
 ## Parameters
 
@@ -104,7 +104,7 @@ Accept wildcard characters: False
 
 ### -json
 
-{{ Fill json Description }}
+The path to the JSON file containing the SOS health summary data.
 
 ```yaml
 Type: String

docs/documentation/functions/Publish-NsxtHealthNonSOS.md

@@ -54,7 +54,7 @@ This example checks NSX health outside the SOS Utility for a a specified workloa
 Publish-NsxtHealthNonSOS -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
 ```
 
-This example checks NSX health outside the SOS Utility for all workload domains across the VMware Cloud Foundation instance but for only the failed items.
+This example checks NSX health outside the SOS Utility for all workload domains across the VMware Cloud Foundation instance but only reports issues.
 
 
 ### Example 4

docs/documentation/functions/Publish-NsxtTier0BgpStatus.md

@@ -9,57 +9,57 @@ Request and publish the BGP status for the NSX Tier-0 gateways.
 ### All-WorkloadDomains
 
 ```powershell
-Publish-NsxtTier0BgpStatus -server <String> -user <String> -pass <String> [-allDomains] [-failureOnly] [-outputJson <String>] [<CommonParameters>]
+Publish-NsxtTier0BgpStatus [-server] <String> [-user] <String> [-pass] <String> [-allDomains] [-failureOnly] [-outputJson <String>] [<CommonParameters>]
 ```
 
 ### Specific-WorkloadDomain
 
 ```powershell
-Publish-NsxtTier0BgpStatus -server <String> -user <String> -pass <String> -workloadDomain <String> [-failureOnly] [-outputJson <String>] [<CommonParameters>]
+Publish-NsxtTier0BgpStatus [-server] <String> [-user] <String> [-pass] <String> [-workloadDomain] <String> [-failureOnly] [-outputJson <String>] [<CommonParameters>]
 ```
 
 ## Description
 
 The `Publish-NsxtTier0BgpStatus` cmdlet checks the BGP status for the NSX Tier-0 gateways in a VMware Cloud Foundation instance and prepares the data to be published to an HTML report.
 The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
 
-- Validates that network connectivity is available to the SDDC Manager instance
-- Performs checks on the BGP status and outputs the results
+- Validates that network connectivity is available to the SDDC Manager instance.
+- Performs checks on the BGP status and outputs the results.
 
 ## Examples
 
 ### Example 1
 
 ```powershell
-Publish-NsxtTier0BgpStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains
+Publish-NsxtTier0BgpStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
 ```
 
 This example will publish the BGP status for all NSX Tier-0 gateways in a VMware Cloud Foundation instance.
 
 ### Example 2
 
 ```powershell
-Publish-NsxtTier0BgpStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -failureOnly
+Publish-NsxtTier0BgpStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
 ```
 
 This example will publish the BGP status for all NSX Tier-0 gateways in a VMware Cloud Foundation instance but only for the failed items.
 
 ### Example 3
 
 ```powershell
-Publish-NsxtTier0BgpStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01
+Publish-NsxtTier0BgpStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
 ```
 
-This example will publish the BGP status for the NSX Tier-0 gateways in a VMware Cloud Foundation instance for a workload domain named sfo-w01.
+This example will publish the BGP status for the NSX Tier-0 gateways in a VMware Cloud Foundation instance for a specified workload domain.
 
 ### Example 4
 
 ```powershell
-Publish-NsxtTier0BgpStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -outputJson F:\Reporting
+Publish-NsxtTier0BgpStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -outputJson [report_path]
 ```
 
 This example will generate a json for the BGP status for all NSX Tier-0 gateways in a VMware Cloud Foundation instance.
-and saves it under F:\Reporting with filename <timestamp>-nsxttier0bgp-status.json
+and saves it under the specified report path with filename `<timestamp>-nsxttier0bgp-status.json`
 
 ## Parameters
 

docs/documentation/functions/Publish-NsxtTransportNodeStatus.md

@@ -2,64 +2,64 @@
 
 ## Synopsis
 
-Request and publish the status of NSX transport nodes managed by an NSX Manager cluster.
+Request and publish the status of NSX transport nodes.
 
 ## Syntax
 
 ### All-WorkloadDomains
 
 ```powershell
-Publish-NsxtTransportNodeStatus -server <String> -user <String> -pass <String> [-allDomains] [-failureOnly] [-outputJson <String>] [<CommonParameters>]
+Publish-NsxtTransportNodeStatus [-server] <String> [-user] <String> [-pass] <String> [-allDomains] [-failureOnly] [-outputJson <String>] [<CommonParameters>]
 ```
 
 ### Specific-WorkloadDomain
 
 ```powershell
-Publish-NsxtTransportNodeStatus -server <String> -user <String> -pass <String> -workloadDomain <String> [-failureOnly] [-outputJson <String>] [<CommonParameters>]
+Publish-NsxtTransportNodeStatus [-server] <String> [-user] <String> [-pass] <String> [-workloadDomain] <String> [-failureOnly] [-outputJson <String>] [<CommonParameters>]
 ```
 
 ## Description
 
-The `Publish-NsxtTransportNodeStatus` cmdlet checks the status NSX transport nodes managed by an NSX Manager cluster and prepares the data to be published to an HTML report.
+The `Publish-NsxtTransportNodeStatus` cmdlet checks the status NSX transport nodes and prepares the data to be published to an HTML report.
 The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
 
-- Validates that network connectivity is available to the SDDC Manager instance
-- Performs checks on the NSX transport node status and outputs the results
+- Validates that network connectivity is available to the SDDC Manager instance.
+- Performs checks on the NSX transport node status and outputs the results.
 
 ## Examples
 
 ### Example 1
 
 ```powershell
-Publish-NsxtTransportNodeStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains
+Publish-NsxtTransportNodeStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
 ```
 
-This example will publish the status of all NSX transport nodes in a VMware Cloud Foundation instance.
+This example will publish the status of all the NSX transport nodes in a VMware Cloud Foundation instance.
 
 ### Example 2
 
 ```powershell
-Publish-NsxtTransportNodeStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -failureOnly
+Publish-NsxtTransportNodeStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
 ```
 
-This example will publish thestatus of all NSX transport nodes in a VMware Cloud Foundation instance but only reports issues.
+This example will publish the status of all the NSX transport nodes in a VMware Cloud Foundation instance but only reports issues.
 
 ### Example 3
 
 ```powershell
-Publish-NsxtTransportNodeStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01
+Publish-NsxtTransportNodeStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
 ```
 
-This example will publish the BGP status for the NSX transport nodes in a VMware Cloud Foundation instance for a workload domain named sfo-w01.
+This example will publish the status of all the NSX transport nodes in a VMware Cloud Foundation instance for a specified workload domain.
 
 ### Example 4
 
 ```powershell
-Publish-NsxtTransportNodeStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -outputJson F:\Reporting
+Publish-NsxtTransportNodeStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -outputJson [report_path]
 ```
 
-This example will generate a json for the status of all NSX transport nodes in a VMware Cloud Foundation instance.
-and saves it under F:\Reporting with filename <timestamp>-nsxttransportnode-status.json
+This example will generate a json for the status of all the NSX transport nodes in a VMware Cloud Foundation instance.
+and saves it under the specified report path with filename `<timestamp>-nsxttransportnode-status.json`
 
 ## Parameters
 

docs/documentation/functions/Publish-NsxtTransportNodeTunnelStatus.md

@@ -9,56 +9,56 @@ Request and publish the status of NSX transport node tunnels.
 ### All-WorkloadDomains
 
 ```powershell
-Publish-NsxtTransportNodeTunnelStatus -server <String> -user <String> -pass <String> [-allDomains] [-failureOnly] [-outputJson <String>] [<CommonParameters>]
+Publish-NsxtTransportNodeTunnelStatus [-server] <String> [-user] <String> [-pass] <String> [-allDomains] [-failureOnly] [-outputJson <String>] [<CommonParameters>]
 ```
 
 ### Specific-WorkloadDomain
 
 ```powershell
-Publish-NsxtTransportNodeTunnelStatus -server <String> -user <String> -pass <String> -workloadDomain <String> [-failureOnly] [-outputJson <String>] [<CommonParameters>]
+Publish-NsxtTransportNodeTunnelStatus [-server] <String> [-user] <String> [-pass] <String> [-workloadDomain] <String> [-failureOnly] [-outputJson <String>] [<CommonParameters>]
 ```
 
 ## Description
 
-The P`ublish-NsxtTransportNodeStatus` cmdlet checks the status NSX transport node tunnels and prepares the data to be published to an HTML report.
+The `Publish-NsxtTransportNodeStatus` cmdlet checks the status NSX transport node tunnels and prepares the data to be published to an HTML report.
 The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
 
-- Validates that network connectivity is available to the SDDC Manager instance
-- Performs checks on the NSX transport node tunnel status and outputs the results
+- Validates that network connectivity is available to the SDDC Manager instance.
+- Performs checks on the NSX transport node tunnel status and outputs the results.
 
 ## Examples
 
 ### Example 1
 
 ```powershell
-Publish-NsxtTransportNodeTunnelStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains
+Publish-NsxtTransportNodeTunnelStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
 ```
 
-This example will publish the status of all NSX transport node tunnels in a VMware Cloud Foundation instance.
+This example will publish the status of all the NSX transport node tunnels in a VMware Cloud Foundation instance.
 
 ### Example 2
 
 ```powershell
-Publish-NsxtTransportNodeTunnelStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -failureOnly
+Publish-NsxtTransportNodeTunnelStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
 ```
 
-This example will publish thestatus of all NSX transport node tunnels in a VMware Cloud Foundation instance but only reports issues.
+This example will publish thestatus of all the NSX transport node tunnels in a VMware Cloud Foundation instance but only reports issues.
 
 ### Example 3
 
 ```powershell
-Publish-NsxtTransportNodeTunnelStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01
+Publish-NsxtTransportNodeTunnelStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
 ```
 
-This example will publish the BGP status for the NSX transport node tunnels in a VMware Cloud Foundation instance for a workload domain named sfo-w01.
+This example will publish the BGP status for the NSX transport node tunnels in a VMware Cloud Foundation instance for a specified workload domain.
 
 ### Example 4
 
 ```powershell
-Publish-NsxtTransportNodeTunnelStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -outputJson F:\Reporting
+Publish-NsxtTransportNodeTunnelStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -outputJson [report_path]
 ```
 
-This example will generate a json for the status of all NSX transport node tunnels in a VMware Cloud Foundation instance and saves it under F:\Reporting with filename <timestamp>-nsxttntunnel-status.json
+This example will generate a JSON for the status of all of the NSX transport node tunnels in a VMware Cloud Foundation instance and saves it under the specified report path with filename `<timestamp>-nsxttntunnel-status.json`
 
 ## Parameters