Skip to content

Commit c6bb502

Browse files
authored
docs: sanitize examples (#254)
- Updated Publish-VsanStoragePolicy.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-ClusterConfiguration.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-ClusterDrsRule.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-ClusterOverview.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-DatastoreStorageCapacity.md doc to sanitize all the example variables, add brackets and punctuation. Signed-off-by: Andy Beltz <andy.beltz@broadcom.com>
1 parent e754cd2 commit c6bb502

5 files changed

Lines changed: 38 additions & 38 deletions

File tree

docs/documentation/functions/Publish-VsanStoragePolicy.md

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

33
## Synopsis
44

5-
Formats the vSAN Storage Policy for virtual machines from the SoS JSON output.
5+
Formats the vSAN storage policy for virtual machines from the SOS JSON output.
66

77
## Syntax
88

@@ -12,39 +12,39 @@ Publish-VsanStoragePolicy [-json] <String> [-html] [-failureOnly] [<CommonParame
1212

1313
## Description
1414

15-
The `Publish-VsanStoragePolicy` cmdlet formats the vSAN Storage Policy data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object.
15+
The `Publish-VsanStoragePolicy` cmdlet formats the vSAN storage policy data from the SOS JSON output and publishes it as either a standard PowerShell object or an HTML object.
1616

1717
## Examples
1818

1919
### Example 1
2020

2121
```powershell
22-
Publish-VsanStoragePolicy -json <file-name>
22+
Publish-VsanStoragePolicy -json [file_name]
2323
```
2424

25-
This example extracts and formats the vSAN Storage Policy data as a PowerShell object from the JSON file.
25+
This example extracts and formats the vSAN storage policy data as a PowerShell object from the JSON file.
2626

2727
### Example 2
2828

2929
```powershell
30-
Publish-VsanStoragePolicy -json <file-name> -html
30+
Publish-VsanStoragePolicy -json [file_name] -html
3131
```
3232

33-
This example extracts and formats the vSAN Storage Policy data as an HTML object from the JSON file.
33+
This example extracts and formats the vSAN storage policy data as an HTML object from the JSON file.
3434

3535
### Example 3
3636

3737
```powershell
38-
Publish-VsanStoragePolicy -json <file-name> -failureOnly
38+
Publish-VsanStoragePolicy -json [file_name] -failureOnly
3939
```
4040

41-
This example extracts and formats the vSAN Storage Policy data as a PowerShell object from the JSON file for only the failed items.
41+
This example extracts and formats the vSAN storage policy data as a PowerShell object from the JSON file for only the failed items.
4242

4343
## Parameters
4444

4545
### -json
4646

47-
The path to the JSON file containing the SoS Health Summary data.
47+
The path to the JSON file containing the SOS health summary data.
4848

4949
```yaml
5050
Type: String

docs/documentation/functions/Request-ClusterConfiguration.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 cluster configuration from a vCenter Server instance.
5+
Gets cluster configuration from a vCenter instance.
66

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-ClusterConfiguration` cmdlets gets the cluster configuration for a vCenter Server instance.
15+
The `Request-ClusterConfiguration` cmdlets gets the cluster configuration 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 cluster details 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 cluster details from vCenter.
2121

2222
## Examples
2323

2424
### Example 1
2525

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

30-
This example gets the cluster configuration for a vCenter Server instance based on the workload domain provided.
30+
This example gets the cluster configuration for a vCenter instance based on a specified workload domain.
3131

3232
## Parameters
3333

docs/documentation/functions/Request-ClusterDrsRule.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 cluster DRS rules from a vCenter Server instance.
5+
Gets cluster DRS rules from a vCenter instance.
66

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-ClusterDrsRule` cmdlets gets the cluster DRS rules for a vCenter Server instance.
15+
The `Request-ClusterDrsRule` cmdlets gets the cluster DRS rules 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 cluster DRS rules 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 cluster DRS rules from vCenter.
2121

2222
## Examples
2323

2424
### Example 1
2525

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

30-
This example gets the cluster DRS rules for a vCenter Server instance based on the workload domain provided.
30+
This example gets the cluster DRS rules for a vCenter Server instance based on a specified workload domain.
3131

3232
## Parameters
3333

docs/documentation/functions/Request-ClusterOverview.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 overview of vSphere.
5+
Returns an overview of vSphere.
66

77
## Syntax
88

@@ -15,24 +15,24 @@ Request-ClusterOverview [-server] <String> [-user] <String> [-pass] <String> [-a
1515
The `Request-ClusterOverview` 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 to the SDDC Manager instance.
19+
- Validates that network connectivity and authentication to the vCenter instances.
20+
- Collects the vSphere overview detail.
2121

2222
## Examples
2323

2424
### Example 1
2525

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

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

3232
### Example 2
3333

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

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

docs/documentation/functions/Request-DatastoreStorageCapacity.md

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

33
## Synopsis
44

5-
Checks the datastore usage in all vCenter Server instances.
5+
Checks the datastore usage in all vCenter instances.
66

77
## Syntax
88

@@ -15,28 +15,28 @@ Request-DatastoreStorageCapacity [-server] <String> [-user] <String> [-pass] <St
1515
The `Request-DatastoreStorageCapacity` cmdlet checks the datastore usage in all vCenters.
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 details for each vCenter Server
21-
- Collects information about datastore usage
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 details for each vCenter.
21+
- Collects information about datastore usage.
2222

2323
## Examples
2424

2525
### Example 1
2626

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

31-
This example will check datastores on all vCenter Servers managed by SDDC Manager in a VMware Cloud Foundation instance but only failed items.
31+
This example will check datastores on a vCenter managed by SDDC Manager in a specified workload domain.
3232

3333
### Example 2
3434

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

39-
This example will check datastore on a vCenter Servers managed by SDDC Manager for a workload domain.
39+
This example will check datastores on a vCenter managed by SDDC Manager in a VMware Cloud Foundation instance in a specified workload domain and will only report issues.
4040

4141
## Parameters
4242

0 commit comments

Comments
 (0)