docs: sanitize examples (#256)

- Updated `Request-HardwareOverview.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Request-NetworkOverview.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Request-NsxtAlert.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Request-NsxtAuthentication.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Request-NsxtComputeManagerStatus.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Request-NsxtEdgeSnapshotStatus.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Request-NsxtManagerBackupStatus.md` doc to sanitize all the example variables, add brackets and punctuation.

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

Author: andybeltz

docs/documentation/functions/Request-HardwareOverview.md

@@ -2,7 +2,7 @@
 
 ## Synopsis
 
-Returns Hardware Overview.
+Returns hardware overview.
 
 ## Syntax
 
@@ -15,18 +15,18 @@ Request-HardwareOverview [-server] <String> [-user] <String> [-pass] <String> [<
 The `Request-VcfOverview` cmdlet returns an overview of the hardware in an SDDC Manager instance.
 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
-- Collects the hardware details
+- Validates that network connectivity is available to the SDDC Manager instance.
+- Collects the hardware details.
 
 ## Examples
 
 ### Example 1
 
 ```powershell
-Request-HardwareOverview -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1!
+Request-HardwareOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password]
 ```
 
-This example will return an overview of the SDDC Manager instance.
+This example will return a hardware overview of the SDDC Manager instance.
 
 ## Parameters
 

docs/documentation/functions/Request-NetworkOverview.md

@@ -15,23 +15,23 @@ Request-NetworkOverview [-server] <String> [-user] <String> [-pass] <String> [-a
 The `Request-NetworkOverview` cmdlet returns an overview of the networking managed by SDDC Manager.
 The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
 
-- Validates that network connectivity and authentication to the SDDC Manager instance
-- Collects the networking overview detail
+- Validates that network connectivity and authentication to the SDDC Manager instance.
+- Collects the networking overview detail.
 
 ## Examples
 
 ### Example 1
 
 ```powershell
-Request-NetworkOverview -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1!
+Request-NetworkOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password]
 ```
 
 This example will return an overview of the networking managed by the SDDC Manager instance.
 
 ### Example 2
 
 ```powershell
-Request-NetworkOverview -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -anonymized
+Request-NetworkOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -anonymized
 ```
 
 This example will return an overview of the networking managed by the SDDC Manager instance, but will anonymize the output.

docs/documentation/functions/Request-NsxtAlert.md

@@ -2,7 +2,7 @@
 
 ## Synopsis
 
-Returns alarms from an NSX Manager cluster.
+Returns alarms from NSX.
 
 ## Syntax
 
@@ -12,31 +12,31 @@ Request-NsxtAlert [-server] <String> [-user] <String> [-pass] <String> [-domain]
 
 ## Description
 
-The `Request-NsxtAlert` cmdlet returns all alarms from an NSX Manager cluster.
+The `Request-NsxtAlert` cmdlet returns all alarms from NSX.
 The cmdlet connects to the NSX Manager using the `-server`, `-user`, and `-pass` values:
 
-- Validates that network connectivity is available to the NSX Manager cluster
-- Validates that network connectivity is available to the vCenter Server instance
-- Gathers the details for the NSX Manager cluster
-- Collects the alerts
+- Validates that network connectivity is available to NSX.
+- Validates that network connectivity is available to the vCenter instance.
+- Gathers the details for NSX.
+- Collects the alerts.
 
 ## Examples
 
 ### Example 1
 
 ```powershell
-Request-NsxtAlert -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01
+Request-NsxtAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name]
 ```
 
-This example will return alarms of an NSX Manager cluster managed by SDDC Manager for a workload domain.
+This example will return alarms of NSX managed by SDDC Manager for a specified workload domain.
 
 ### Example 2
 
 ```powershell
-Request-NsxtAlert -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01 -failureOnly
+Request-NsxtAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly
 ```
 
-This example will return alarms of an NSX Manager cluster managed by SDDC Manager for a workload domain but only for the failed items.
+This example will return alarms of NSX managed by SDDC Manager for a specified workload domain but only reports issues.
 
 ## Parameters
 

docs/documentation/functions/Request-NsxtAuthentication.md

@@ -2,55 +2,55 @@
 
 ## Synopsis
 
-Checks API authentication to NSX Manager cluster.
+Checks API authentication to NSX.
 
 ## Syntax
 
 ### All-WorkloadDomains
 
 ```powershell
-Request-NsxtAuthentication -server <String> -user <String> -pass <String> [-allDomains] [-failureOnly] [<CommonParameters>]
+Request-NsxtAuthentication [-server] <String> [-user] <String> [-pass] <String> [-allDomains] [-failureOnly] [<CommonParameters>]
 ```
 
 ### Specific-WorkloadDomains
 
 ```powershell
-Request-NsxtAuthentication -server <String> -user <String> -pass <String> -workloadDomain <String> [-failureOnly] [<CommonParameters>]
+Request-NsxtAuthentication [-server] <String> [-user] <String> [-pass] <String> [-workloadDomain] <String> [-failureOnly] [<CommonParameters>]
 ```
 
 ## Description
 
-The `Request-NsxtAuthentication` cmdlets checks the authentication to NSX Manager cluster.
+The `Request-NsxtAuthentication` cmdlets checks the authentication to NSX.
 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
-- Validates that network connectivity is available to the NSX Manager cluster
+- Validates that network connectivity is available to the SDDC Manager instance.
+- Validates that network connectivity is available to NSX.
 
 ## Examples
 
 ### Example 1
 
 ```powershell
-Request-NsxtAuthentication -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains
+Request-NsxtAuthentication -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
 ```
 
-This example will check authentication to NSX Manager API for all NSX Manager clusters managed by SDDC Manager.
+This example will check authentication to the NSX API for all instances of NSX managed by SDDC Manager.
 
 ### Example 2
 
 ```powershell
-Request-NsxtAuthentication -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01
+Request-NsxtAuthentication -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
 ```
 
-This example will check authentication to NSX Manager API for a single workload domain
+This example will check authentication to the NSX API for a specified workload domain.
 
 ### Example 3
 
 ```powershell
-Request-NsxtAuthentication -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -failureOnly
+Request-NsxtAuthentication -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
 ```
 
-This example will check authentication to NSX Manager API for all NSX Manager clusters but only reports issues.
+This example will check authentication to the NSX API for all instances of NSX managed by SDDC Manager but only reports issues.
 
 ## Parameters
 

docs/documentation/functions/Request-NsxtComputeManagerStatus.md

@@ -2,7 +2,7 @@
 
 ## Synopsis
 
-Returns the status of the compute managers attached to an NSX Manager cluster.
+Returns the status of the compute managers attached to NSX.
 
 ## Syntax
 
@@ -12,31 +12,31 @@ Request-NsxtComputeManagerStatus [-server] <String> [-user] <String> [-pass] <St
 
 ## Description
 
-The `Request-NsxtComputeManagerStatus` cmdlet returns the status of the compute managers attached to an NSX Manager cluster.
+The `Request-NsxtComputeManagerStatus` cmdlet returns the status of the compute managers attached to NSX.
 The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
 
-- Validates network connectivity and authentication to the SDDC Manager instance
-- Gathers the details for the NSX Manager cluster from the SDDC Manager
-- Validates network connectivity and authentication to the NSX Local Manager cluster
-- Collects the status of the compute managers
+- Validates network connectivity and authentication to the SDDC Manager instance.
+- Gathers the details for NSX from the SDDC Manager.
+- Validates network connectivity and authentication to NSX.
+- Collects the status of the compute managers.
 
 ## Examples
 
 ### Example 1
 
 ```powershell
-Request-NsxtComputeManagerStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01
+Request-NsxtComputeManagerStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name]
 ```
 
-This example will return the status of the compute managers attached to an NSX Manager cluster managed by SDDC Manager for a workload domain.
+This example will return the status of the compute managers attached to NSX managed by SDDC Manager for a specified workload domain.
 
 ### Example 2
 
 ```powershell
-Request-NsxtComputeManagerStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01 -failureOnly
+Request-NsxtComputeManagerStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly
 ```
 
-This example will return the status of the compute managers attached to an NSX Manager cluster managed by SDDC Manager for a workload domain but only reports issues.
+This example will return the status of the compute managers attached to NSX managed by SDDC Manager for a specified workload domain but only reports issues.
 
 ## Parameters
 

docs/documentation/functions/Request-NsxtEdgeSnapshotStatus.md

@@ -2,7 +2,7 @@
 
 ## Synopsis
 
-Request the snapshot status for NSX Edge nodes.
+Request the snapshot status for NSX edge nodes.
 
 ## Syntax
 
@@ -12,31 +12,31 @@ Request-NsxtEdgeSnapshotStatus [-server] <String> [-user] <String> [-pass] <Stri
 
 ## Description
 
-The `Request-NsxtEdgeSnapshotStatus` cmdlet checks the snapshot status for NSX Edge nodes.
+The `Request-NsxtEdgeSnapshotStatus` cmdlet checks the snapshot status for NSX edge nodes.
 The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
 
-- Validates network connectivity and authentication to the SDDC Manager instance
-- Gathers the NSX Manager and NSX Edge node details from the SDDC Manager
-- Validates network connectivity and authentication to the vCenter Server instance
-- Performs checks on the snapshot status and outputs the results
+- Validates network connectivity and authentication to the SDDC Manager instance.
+- Gathers the NSX service and edge node details from the SDDC Manager.
+- Validates network connectivity and authentication to the vCenter instance.
+- Performs checks on the snapshot status and outputs the results.
 
 ## Examples
 
 ### Example 1
 
 ```powershell
-Request-NsxtEdgeSnapshotStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01
+Request-NsxtEdgeSnapshotStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name]
 ```
 
-This example will publish the snapshot status for all NSX Edge nodes managed by SDDC Manager for a specific workload domain.
+This example will publish the snapshot status for all NSX edge nodes managed by SDDC Manager for a specified workload domain.
 
 ### Example 2
 
 ```powershell
-Request-NsxtEdgeSnapshotStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01 -failureOnly
+Request-NsxtEdgeSnapshotStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly
 ```
 
-This example will publish the snapshot status for all NSX Edge nodes managed by SDDC Manager for a specific workload domain. but only failed items.
+This example will publish the snapshot status for all NSX edge nodes managed by SDDC Manager for a specified workload domain but only reports issues.
 
 ## Parameters
 

docs/documentation/functions/Request-NsxtManagerBackupStatus.md

@@ -2,7 +2,7 @@
 
 ## Synopsis
 
-Returns the status of the latest file-level backup of an NSX Manager cluster.
+Returns the status of the latest file-level backup of an NSX.
 
 ## Syntax
 
@@ -12,31 +12,31 @@ Request-NsxtManagerBackupStatus [-server] <String> [-user] <String> [-pass] <Str
 
 ## Description
 
-The `Request-NsxtManagerBackupStatus` cmdlet returns the status of the latest backup of an NSX Manager cluster.
+The `Request-NsxtManagerBackupStatus` cmdlet returns the status of the latest backup of an NSX instance.
 The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
 
-- Validates network connectivity and authentication to the SDDC Manager instance
-- Gathers the details for the NSX Manager cluster from the SDDC Manager
-- Validates network connectivity and authentication to the NSX Manager cluster
-- Collects the file-level backup status details
+- Validates network connectivity and authentication to the SDDC Manager instance.
+- Gathers the details for NSX from the SDDC Manager.
+- Validates network connectivity and authentication to NSX.
+- Collects the file-level backup status details.
 
 ## Examples
 
 ### Example 1
 
 ```powershell
-Request-NsxtManagerBackupStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01
+Request-NsxtManagerBackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name]
 ```
 
-This example will return the status of the latest file-level backup of an NSX Manager cluster managed by SDDC Manager for a workload domain.
+This example will return the status of the latest file-level backup of NSX managed by SDDC Manager for a specified workload domain.
 
 ### Example 2
 
 ```powershell
-Request-NsxtManagerBackupStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01 -failureOnly
+Request-NsxtManagerBackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly
 ```
 
-This example will return the status of the latest file-level backup of an NSX Manager cluster managed by SDDC Manager for a workload domain but only reports issues.
+This example will return the status of the latest file-level backup of NSX managed by SDDC Manager for a specified workload domain but only reports issues.
 
 ## Parameters