Skip to content

Commit 424a50b

Browse files
authored
docs: sanitize examples (#261)
- Updated `Request-VmOverride.md` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Request-VMwareAriaSuiteOverview.md` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Request-VsanAlert.md` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Test-VcfReportingPrereq.md` doc to sanitize all the example variables, add brackets and punctuation. Signed-off-by: Andy Beltz <andy.beltz@broadcom.com>
1 parent c277d48 commit 424a50b

4 files changed

Lines changed: 22 additions & 23 deletions

File tree

docs/documentation/functions/Request-VMwareAriaSuiteOverview.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,26 @@ Request-VMwareAriaSuiteOverview [-server] <String> [-user] <String> [-pass] <Str
1515
The `Request-VMwareAriaSuiteOverview` cmdlet returns an overview of VMware Aria Suite products managed by SDDC Manager.
1616
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
1717

18-
- Validates that network connectivity and authentication to the SDDC Manager instance
19-
- Collects the VMware Aria Suite product overview detail
18+
- Validates that network connectivity and authentication to the SDDC Manager instance.
19+
- Collects the VMware Aria Suite product overview detail.
2020

2121
## Examples
2222

2323
### Example 1
2424

2525
```powershell
26-
Request-VMwareAriaSuiteOverview -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1!
26+
Request-VMwareAriaSuiteOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password]
2727
```
2828

2929
This example will return an overview of VMware Aria Suite products managed by the SDDC Manager instance.
3030

3131
### Example 2
3232

3333
```powershell
34-
Request-VMwareAriaSuiteOverview -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -anonymized
34+
Request-VMwareAriaSuiteOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -anonymized
3535
```
3636

37-
This example will return an overview of VMware Aria Suite products managed by the SDDC Manager instance, but
38-
will anonymize the output.
37+
This example will return an overview of VMware Aria Suite products managed by the SDDC Manager instance, but will anonymize the output.
3938

4039
## Parameters
4140

docs/documentation/functions/Request-VmOverride.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Synopsis
44

5-
Gets VM Override setting from a vCenter Server instance.
5+
Gets the VM override setting from a vCenter instance.
66

77
## Syntax
88

@@ -12,22 +12,22 @@ Request-VmOverride [-server] <String> [-user] <String> [-pass] <String> [-domain
1212

1313
## Description
1414

15-
The `Request-VmOverride` cmdlets gets VM Override setting for a vCenter Server instance.
15+
The `Request-VmOverride` cmdlets gets the VM override setting for a vCenter instance.
1616
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
1717

18-
- Validates that network connectivity is available to the SDDC Manager instance
19-
- Validates that network connectivity is available to the vCenter Server instance
20-
- Gathers the VM Override settings from vCenter Server
18+
- Validates that network connectivity is available to the SDDC Manager instance.
19+
- Validates that network connectivity is available to the vCenter instance.
20+
- Gathers the VM override settings from vCenter.
2121

2222
## Examples
2323

2424
### Example 1
2525

2626
```powershell
27-
Request-VmOverride -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-m01
27+
Request-VmOverride -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name]
2828
```
2929

30-
This example gets the VM Override setting for a vCenter Server instance based on the workload domain provided.
30+
This example gets the VM override setting for a vCenter instance based on a specified workload domain.
3131

3232
## Parameters
3333

docs/documentation/functions/Request-VsanAlert.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Synopsis
44

5-
Returns vSAN Healthcheck alarms from a vCenter Server instance.
5+
Returns vSAN health check alarms from a vCenter instance.
66

77
## Syntax
88

@@ -12,30 +12,30 @@ Request-VsanAlert [-server] <String> [-user] <String> [-pass] <String> [-domain]
1212

1313
## Description
1414

15-
The `Request-VsanAlert` cmdlet returns vSAN Healthcheck alarms from vCenter Server managed by SDDC Manager.
15+
The `Request-VsanAlert` cmdlet returns vSAN health check alarms from vCenter managed by SDDC Manager.
1616
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
1717

18-
- Validates that network connectivity is available to the vCenter Server instance
19-
- Validates the authentication to vCenter Server with credentials from SDDC Manager
20-
- Collects the vSAN Healthcheck alarms from vCenter Server
18+
- Validates that network connectivity is available to the vCenter instance.
19+
- Validates the authentication to vCenter with credentials from SDDC Manager.
20+
- Collects the vSAN health check alarms from vCenter.
2121

2222
## Examples
2323

2424
### Example 1
2525

2626
```powershell
27-
Request-VsanAlert -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01
27+
Request-VsanAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name]
2828
```
2929

30-
This example will return vSAN Healthcheck alarms of a vCenter Server managed by SDDC Manager for a workload domain.
30+
This example will return vSAN health check alarms of a vCenter managed by SDDC Manager for a specified workload domain.
3131

3232
### Example 2
3333

3434
```powershell
35-
Request-VsanAlert -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01 -failureOnly
35+
Request-VsanAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly
3636
```
3737

38-
This example will return vSAN Healthcheck alarms of a vCenter Server managed by SDDC Manager for a workload domain but only for the failed items.
38+
This example will return vSAN health check alarms of a vCenter managed by SDDC Manager for a workload domain but only reports issues.
3939

4040
## Parameters
4141

docs/documentation/functions/Test-VcfReportingPrereq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The `Test-VcfReportingPrereq` cmdlet checks that all the prerequisites have been
1919
### Example 1
2020

2121
```powershell
22-
Test-VcfReportingPrereq -sddcManagerFqdn sfo-vcf01.sfo.rainpole.io -sddcManagerUser admin@local -sddcManagerPass VMw@re1!VMw@re1!
22+
Test-VcfReportingPrereq -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password]
2323
```
2424

2525
This example runs the prerequisite validation.

0 commit comments

Comments
 (0)