Skip to content

Commit 69dca26

Browse files
authored
docs: sanitize examples (#259)
- Updated Request-ValidatedSolutionOverview.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-VcenterAlert.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-VcenterAuthentication.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-VcenterBackupStatus.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-VcenterOverview.md doc to sanitize all the example variables, add brackets and punctuation. Signed-off-by: Andy Beltz <andy.beltz@broadcom.com>
1 parent 8826ab0 commit 69dca26

5 files changed

Lines changed: 48 additions & 47 deletions

File tree

docs/documentation/functions/Request-ValidatedSolutionOverview.md

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

33
## Synopsis
44

5-
Returns VMware Validated Solution Overview.
5+
Returns VMware Validated Solution overview.
66

77
## Syntax
88

@@ -12,21 +12,21 @@ Request-ValidatedSolutionOverview [-server] <String> [-user] <String> [-pass] <S
1212

1313
## Description
1414

15-
The `Request-ValidatedSolutionOverview` cmdlet returns an overview of VMware Validated Solutions deployed.
15+
The `Request-ValidatedSolutionOverview` cmdlet returns an overview of VMware Validated Solutions that are deployed.
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-
- Collects the VMware Validated Solution details
18+
- Validates that network connectivity is available to the SDDC Manager instance.
19+
- Collects the VMware Validated Solution details.
2020

2121
## Examples
2222

2323
### Example 1
2424

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

29-
This example will return an overview of VMware Validated Solutions.
29+
This example will return an overview of VMware Validated Solutions that are deployed.
3030

3131
## Parameters
3232

docs/documentation/functions/Request-VcenterAlert.md

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

33
## Synopsis
44

5-
Returns alarms from vCenter Server managed by SDDC Manager.
5+
Returns alarms from a vCenter instance managed by SDDC Manager.
66

77
## Syntax
88

@@ -12,38 +12,38 @@ Request-VcenterAlert [-server] <String> [-user] <String> [-pass] <String> [-doma
1212

1313
## Description
1414

15-
The `Request-VcenterAlert` cmdlet returns all alarms from vCenter Server managed by SDDC Manager.
15+
The `Request-VcenterAlert` cmdlet returns all alarms from a vCenter instance 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 alerts 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 alerts from vCenter.
2121

2222
## Examples
2323

2424
### Example 1
2525

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

30-
This example will return alarms of a vCenter Server managed by SDDC Manager for a workload domain named sfo-w01.
30+
This example will return alarms of a vCenter managed by SDDC Manager for a specified workload domain.
3131

3232
### Example 2
3333

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

38-
This example will return alarms from ESXi hosts of a vCenter Server managed by SDDC Manager for a workload domain named sfo-w01.
38+
This example will return alarms from ESX hosts of a vCenter managed by SDDC Manager for a specified workload domain.
3939

4040
### Example 3
4141

4242
```powershell
43-
Request-VcenterAlert -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01 -failureOnly
43+
Request-VcenterAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly
4444
```
4545

46-
This example will return alarms from vSAN clusters of a vCenter Server managed by SDDC Manager for a workload domain but only for the failed items.
46+
This example will return alarms from vSAN clusters of a vCenter managed by SDDC Manager for a specified workload domain but only reports issues.
4747

4848
## Parameters
4949

docs/documentation/functions/Request-VcenterAuthentication.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,55 +2,56 @@
22

33
## Synopsis
44

5-
Checks API authentication to vCenter Server instance.
5+
Checks API authentication to a vCenter instance.
66

77
## Syntax
88

99
### All-WorkloadDomains
1010

1111
```powershell
12-
Request-VcenterAuthentication -server <String> -user <String> -pass <String> [-allDomains] [-failureOnly] [<CommonParameters>]
12+
Request-VcenterAuthentication [-server] <String> [-user] <String> [-pass] <String> [-allDomains] [-failureOnly] [<CommonParameters>]
1313
```
1414

1515
### Specific-WorkloadDomains
1616

1717
```powershell
18-
Request-VcenterAuthentication -server <String> -user <String> -pass <String> -workloadDomain <String> [-failureOnly] [<CommonParameters>]
18+
Request-VcenterAuthentication [-server] <String> [-user] <String> [-pass] <String> [-workloadDomain] <String> [-failureOnly] [<CommonParameters>]
1919
```
2020

2121
## Description
2222

23-
The `Request-VcenterAuthentication` cmdlets checks the authentication to vCenter Server instance.
23+
The `Request-VcenterAuthentication` cmdlets checks the authentication to a vCenter instance.
2424
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
2525

26-
- Validates that network connectivity is available to the SDDC Manager instance
27-
- Validates that network connectivity is available to the vCenter Server instance
26+
- Validates that network connectivity is available to the SDDC Manager instance.
27+
- Validates the authentication to vCenter with credentials from SDDC Manager.
28+
- Validates that network connectivity is available to the vCenter instance.
2829

2930
## Examples
3031

3132
### Example 1
3233

3334
```powershell
34-
Request-VcenterAuthentication -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains
35+
Request-VcenterAuthentication -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
3536
```
3637

37-
This example will check authentication to vCenter Server API for all vCenter Server instances managed by SDDC Manager.
38+
This example will check authentication to vCenter API for all vCenter instances managed by SDDC Manager.
3839

3940
### Example 2
4041

4142
```powershell
42-
Request-VcenterAuthentication -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01
43+
Request-VcenterAuthentication -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
4344
```
4445

45-
This example will check authentication to vCenter Server API for a single workload domain
46+
This example will check authentication to vCenter API for a specified workload domain.
4647

4748
### Example 3
4849

4950
```powershell
50-
Request-VcenterAuthentication -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -failureOnly
51+
Request-VcenterAuthentication -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
5152
```
5253

53-
This example will check authentication to vCenter Server API for all vCenter Server instances but only reports issues.
54+
This example will check authentication to vCenter API for all vCenter instances managed by SDDC Manager but only reports issues.
5455

5556
## Parameters
5657

docs/documentation/functions/Request-VcenterBackupStatus.md

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

33
## Synopsis
44

5-
Returns the status of the file-level latest backup of a vCenter Server instance.
5+
Returns the status of the latest file-level backup of a vCenter instance.
66

77
## Syntax
88

@@ -12,31 +12,31 @@ Request-VcenterBackupStatus [-server] <String> [-user] <String> [-pass] <String>
1212

1313
## Description
1414

15-
The `Request-VcenterBackupStatus` cmdlet returns the status of the latest backup of a vCenter Server instance.
15+
The `Request-VcenterBackupStatus` cmdlet returns the status of the latest file-level backup of a vCenter instance.
1616
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
1717

18-
- Validates network connectivity and authentication to the SDDC Manager instance
19-
- Gathers the details for the NvCenter Server instance from the SDDC Manager
20-
- Validates network connectivity and authentication to the vCenter Server instance
21-
- Collects the file-level backup status details
18+
- Validates network connectivity and authentication to the SDDC Manager instance.
19+
- Gathers the details for the vCenter instance from the SDDC Manager.
20+
- Validates network connectivity and authentication to the vCenter instance.
21+
- Collects the file-level backup status details.
2222

2323
## Examples
2424

2525
### Example 1
2626

2727
```powershell
28-
Request-VcenterBackupStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01
28+
Request-VcenterBackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name]
2929
```
3030

31-
This example will return the status of the latest file-level backup of a vCenter Server instance managed by SDDC Manager for a workload domain.
31+
This example will return the status of the latest file-level backup of a vCenter instance managed by SDDC Manager for a specified workload domain.
3232

3333
### Example 2
3434

3535
```powershell
36-
Request-VcenterBackupStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01 -failureOnly
36+
Request-VcenterBackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly
3737
```
3838

39-
This example will return the status of the latest file-level backup of a vCenter Server instance managed by SDDC Manager for a workload domain but only reports issues.
39+
This example will return the status of the latest file-level backup of a vCenter instance managed by SDDC Manager for a specified workload domain but only reports issues.
4040

4141
## Parameters
4242

docs/documentation/functions/Request-VcenterOverview.md

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

33
## Synopsis
44

5-
Returns overview of vSphere.
5+
Returns an overview of vSphere.
66

77
## Syntax
88

@@ -15,27 +15,27 @@ Request-VcenterOverview [-server] <String> [-user] <String> [-pass] <String> [-a
1515
The `Request-VcenterOverview` cmdlet returns an overview of the vSphere environment 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-
- Validates that network connectivity and authentication to the vCenter Server instances
20-
- Collects the vSphere overview detail
18+
- Validates that network connectivity and authentication is available to the SDDC Manager instance.
19+
- Validates that network connectivity and authentication is available to the vCenter instances.
20+
- Collects the vSphere overview detail.
2121

2222
## Examples
2323

2424
### Example 1
2525

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

30-
This example will return an overview of the vSphere environment managed by the SDDC Manager instance.
30+
This example will return an overview of the vSphere environment managed by SDDC Manager.
3131

3232
### Example 2
3333

3434
```powershell
35-
Request-VcenterOverview -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -aanonymized
35+
Request-VcenterOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -anonymized
3636
```
3737

38-
This example will return an overview of the vSphere environment managed by the SDDC Manager instance, but will anonymize the output.
38+
This example will return an overview of the vSphere environment managed by SDDC Manager, but will anonymize the output.
3939

4040
## Parameters
4141

0 commit comments

Comments
 (0)