Skip to content

Commit 8826ab0

Browse files
authored
docs: sanitize examples (#258)
- Updated `Request-SddcManagerBackupStatus.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-SddcManagerSnapshotStatus.md` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Request-SddcManagerStorageHealth.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. Signed-off-by: Andy Beltz <andy.beltz@broadcom.com>
1 parent 6f3a7a1 commit 8826ab0

5 files changed

Lines changed: 34 additions & 34 deletions

File tree

docs/documentation/functions/Request-SddcManagerBackupStatus.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,23 @@ Request-SddcManagerBackupStatus [-server] <String> [-user] <String> [-pass] <Str
1515
The `Request-SddcManagerBackupStatus` cmdlet returns the status of the latest file-level backup task in an SDDC Manager 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-
- Collects the latest file-level backup status details
18+
- Validates network connectivity and authentication to the SDDC Manager instance.
19+
- Collects the latest file-level backup status details.
2020

2121
## Examples
2222

2323
### Example 1
2424

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

2929
This example will return the status of the latest file-level backup task in an SDDC Manager instance.
3030

3131
### Example 2
3232

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

3737
This example will return the status of the latest file-level backup task in an SDDC Manager instance but only reports issues.

docs/documentation/functions/Request-SddcManagerFreePool.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 the status of the ESXi hosts in the free pool.
5+
Returns the status of the ESX hosts in the free pool managed by SDDC Manager..
66

77
## Syntax
88

@@ -12,29 +12,29 @@ Request-SddcManagerFreePool [-server] <String> [-user] <String> [-pass] <String>
1212

1313
## Description
1414

15-
The `Request-SddcManagerFreePool` cmdlet returns status of the ESXi hosts in the free pool.
15+
The `Request-SddcManagerFreePool` cmdlet returns status of the ESX hosts in the free pool 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 is possible to the SDDC Manager instance
19-
- Gathers the details for the ESXi hosts in the free pool
18+
- Validates that network connectivity and authentication is possible to the SDDC Manager instance.
19+
- Gathers the details for the ESX hosts in the free pool.
2020

2121
## Examples
2222

2323
### Example 1
2424

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

29-
This example will return the ESXi hosts in the free pool managed by SDDC Manager for a workload domain.
29+
This example will return the ESX hosts in the free pool managed by SDDC Manager.
3030

3131
### Example 2
3232

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

37-
This example will return the ESXi hosts in the free pool managed by SDDC Manager for a workload domain but only reports issues.
37+
This example will return the ESX hosts in the free pool managed by SDDC Manager for a workload domain but only reports issues.
3838

3939
## Parameters
4040

docs/documentation/functions/Request-SddcManagerSnapshotStatus.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,28 @@ Request-SddcManagerSnapshotStatus [-server] <String> [-user] <String> [-pass] <S
1515
The `Request-SddcManagerSnapshotStatus` cmdlet checks the snapshot status for SDDC Manager.
1616
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
1717

18-
- Validates network connectivity and authenticaton to the SDDC Manager instance
19-
- Gathers the details for the vCenter Server instance from the SDDC Manager
20-
- Validates network connectivity and authentication to the vCenter Server instance
21-
- Performs checks on the snapshot status and outputs the results
18+
- Validates network connectivity and authenticaton 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+
- Performs checks on the snapshot status and outputs the results.
2222

2323
## Examples
2424

2525
### Example 1
2626

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

3131
This example will publish the snapshot status for the SDDC Manager in a VMware Cloud Foundation instance.
3232

3333
### Example 2
3434

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

39-
This example will publish the snapshot status for the SDDC Manager in a VMware Cloud Foundation instance, but for only failed items.
39+
This example will publish the snapshot status for the SDDC Manager in a VMware Cloud Foundation instance but only reports issues.
4040

4141
## Parameters
4242

docs/documentation/functions/Request-SddcManagerStorageHealth.md

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

33
## Synopsis
44

5-
Checks the storage health (capacity) in an SDDC Manager appliance.
5+
Checks the storage health capacity in an SDDC Manager appliance.
66

77
## Syntax
88

@@ -12,28 +12,28 @@ Request-SddcManagerStorageHealth [-server] <String> [-user] <String> [-pass] <St
1212

1313
## Description
1414

15-
The `Request-SddcManagerStorageHealth` cmdlet checks the disk free space on the SDDC Manager appliance.
15+
The `Request-SddcManagerStorageHealth` cmdlet checks the hard disk space in an SDDC Manager appliance.
1616
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, -`pass`, `-localUser`, and `-localPass` values:
1717

18-
- Performs checks on the local storage used space and outputs the results
18+
- Performs checks on the local storage used space in an SDDC Manager appliance and outputs the results.
1919

2020
## Examples
2121

2222
### Example 1
2323

2424
```powershell
25-
Request-SddcManagerStorageHealth -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -localUser vcf -localPass VMw@re1!
25+
Request-SddcManagerStorageHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -localUser [local_username] -localPass [local_password]
2626
```
2727

28-
This example checks the hard disk space in the SDDC Manager appliance.
28+
This example checks the hard disk space in an SDDC Manager appliance.
2929

3030
### Example 2
3131

3232
```powershell
33-
Request-SddcManagerStorageHealth -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -localUser vcf -localPass VMw@re1! -failureOnly
33+
Request-SddcManagerStorageHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -localUser [local_username] -localPass [local_password] -failureOnly
3434
```
3535

36-
This example checks the hard disk space in the SDDC Manager appliance and outputs only the failures.
36+
This example checks the hard disk space in the SDDC Manager but only reports issues.
3737

3838
## Parameters
3939

docs/documentation/functions/Request-SoSHealthJson.md

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

33
## Synopsis
44

5-
Run SoS and save the JSON output.
5+
Run SOS and save the JSON output.
66

77
## Syntax
88

99
### All-WorkloadDomains
1010

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

1515
### Specific-WorkloadDomain
1616

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

2121
## Description
2222

23-
The `Request-SoSHealthJson` cmdlet connects to SDDC Manager, runs an SoS Health collection to JSON, and saves the JSON file to the local file system.
23+
The `Request-SoSHealthJson` cmdlet connects to SDDC Manager, runs an SOS health collection and saves to a JSON file on the local file system.
2424

2525
## Examples
2626

2727
### Example 1
2828

2929
```powershell
30-
Request-SoSHealthJson -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -reportPath F:\Reporting\HealthReports -allDomains
30+
Request-SoSHealthJson -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -reportPath [report_path] -allDomains
3131
```
3232

33-
This example runs an SoS Health collection for all domains in the SDDC and saves the JSON output to the local file system.
33+
This example runs an SOS health collection for all domains in the SDDC and saves the JSON file on the local file system in the specified report path.
3434

3535
### Example 2
3636

3737
```powershell
38-
Request-SoSHealthJson -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -reportPath F:\Reporting\HealthReports -workloadDomain sfo-w01
38+
Request-SoSHealthJson -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -reportPath [report_path] -workloadDomain [workload_domain_name]
3939
```
4040

41-
This example runs an SoS Health collection for a workload domain in the SDDC and saves the JSON output to the local file system.
41+
This example runs an SOS health collection for a specified workload domain in the SDDC and saves the JSON file on the local file system in the specified report path.
4242

4343
## Parameters
4444

0 commit comments

Comments
 (0)