Skip to content

Commit 01103ca

Browse files
authored
docs: sanitize examples (#255)
- Updated Request-EsxiAlert.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-EsxiConnectionHealth.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-EsxiOverview.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-EsxiSecurityConfiguration.md doc to sanitize all the example variables, add brackets and punctuation. - Updated Request-EsxiStorageCapacity.md doc to sanitize all the example variables, add brackets and punctuation. Signed-off-by: Andy Beltz <andy.beltz@broadcom.com>
1 parent c6bb502 commit 01103ca

5 files changed

Lines changed: 48 additions & 49 deletions

File tree

docs/documentation/functions/Request-EsxiAlert.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 Alarms from all ESXi hosts in vCenter Server instance.
5+
Returns alarms from all ESX hosts in a vCenter instance.
66

77
## Syntax
88

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

1313
## Description
1414

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

2222
## Examples
2323

2424
### Example 1
2525

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

30-
This example will return alarms from all ESXi hosts in vCenter Server managed by SDDC Manager for a workload domain sfo-w01.
30+
This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for a specified workload domain.
3131

3232
### Example 2
3333

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

38-
This example will return alarms from all ESXi hosts in vCenter Server managed by SDDC Manager for a workload domain sfo-w01 but only for the failed items.
38+
This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for a specified workload domain but only reports issues.
3939

4040
## Parameters
4141

docs/documentation/functions/Request-EsxiConnectionHealth.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 the connection status of ESXi hosts in a workload domain.
5+
Returns the connection status of ESX hosts in a workload domain.
66

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-EsxiConnectionHealth` cmdlet returns the connection status of ESXi hosts in a workload domain.
15+
The `Request-EsxiConnectionHealth` cmdlet returns the connection status of ESX hosts in a workload domain.
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 connection status of ESXi hosts in a workload domain.
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 connection status of ESX hosts in a workload domain.
2121

2222
## Examples
2323

2424
### Example 1
2525

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

30-
This example returns the connection status of ESXi hosts in a workload domain.
30+
This example returns the connection status of ESX hosts in a specified workload domain.
3131

3232
### Example 2
3333

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

38-
This example returns the connection status of ESXi hosts in a workload domain but only reports issues.
38+
This example returns the connection status of ESX hosts in a specified workload domain but only reports issues.
3939

4040
## Parameters
4141

docs/documentation/functions/Request-EsxiOverview.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,57 +2,56 @@
22

33
## Synopsis
44

5-
Returns overview of ESXi hosts.
5+
Returns an overview of ESX hosts.
66

77
## Syntax
88

99
```powershell
10-
Request-EsxiOverview [-server] <String> [-user] <String> [-pass] <String> [-anonymized] [-subscription]
11-
[[-outputCsv] <String>] [<CommonParameters>]
10+
Request-EsxiOverview [-server] <String> [-user] <String> [-pass] <String> [-anonymized] [-subscription] [[-outputCsv] <String>] [<CommonParameters>]
1211
```
1312

1413
## Description
1514

16-
The `Request-EsxiOverview` cmdlet returns an overview of the ESXi host managed by SDDC Manager.
15+
The `Request-EsxiOverview` cmdlet returns an overview of the ESX hosts managed by SDDC Manager.
1716
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:
1817

19-
- Validates that network connectivity and authentication to the SDDC Manager instance
20-
- Validates that network connectivity and authentication to the vCenter Server instances
21-
- Collects the ESXi host 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 ESX host overview detail.
2221

2322
## Examples
2423

2524
### Example 1
2625

2726
```powershell
28-
Request-EsxiOverview -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1!
27+
Request-EsxiOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password]
2928
```
3029

31-
This example will return an overview of the ESXi hosts managed by the SDDC Manager instance.
30+
This example will return an overview of the ESX hosts managed by the SDDC Manager instance.
3231

3332
### Example 2
3433

3534
```powershell
36-
Request-EsxiOverview -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -subscription
35+
Request-EsxiOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -subscription
3736
```
3837

39-
This example will return an overview of the ESXi hosts managed by the SDDC Manager instance with the number of cores for VCF+ subscription.
38+
This example will return an overview of the ESX hosts managed by the SDDC Manager instance with the number of cores for VCF+ subscription.
4039

4140
### Example 3
4241

4342
```powershell
44-
Request-EsxiOverview -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -subscription -outputCsv F:\Reporting
43+
Request-EsxiOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -subscription -outputCsv [report_path]
4544
```
4645

47-
This example will return an overview of the ESXi hosts managed by the SDDC Manager instance with the number of cores for VCF+ subscription and save as a CSV file to F:\Reporting.
46+
This example will return an overview of the ESX hosts managed by the SDDC Manager instance with the number of cores for VCF+ subscription and save as a CSV file to the specified report path.
4847

4948
### Example 4
5049

5150
```powershell
52-
Request-EsxiOverview -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -anonymized
51+
Request-EsxiOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -anonymized
5352
```
5453

55-
This example will return an overview of the ESXi hosts managed by the SDDC Manager instance, but will anonymize the output.
54+
This example will return an overview of the ESX hosts managed by the SDDC Manager instance, but will anonymize the output.
5655

5756
## Parameters
5857

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

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-EsxiSecurityConfiguration` cmdlets gets ESXi security configuration for a vCenter Server instance.
15+
The `Request-EsxiSecurityConfiguration` cmdlets gets ESX security 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 ESXi security configuration 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 ESX security configuration from vCenter.
2121

2222
## Examples
2323

2424
### Example 1
2525

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

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

3232
## Parameters
3333

docs/documentation/functions/Request-EsxiStorageCapacity.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 disk usage for ESXi hosts.
5+
Checks the disk usage for ESX hosts.
66

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-EsxiStorageCapacity` cmdlets checks the disk space usage on ESXi hosts.
15+
The `Request-EsxiStorageCapacity` cmdlets checks the disk space usage on ESX hosts.
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 disk usage information for each ESXi host in the workload domain
20-
- Checks disk usage against thresholds and outputs the results
18+
- Validates network connectivity and authentication to the SDDC Manager instance.
19+
- Collects disk usage information for each ESX host in the workload domain.
20+
- Checks disk usage against thresholds and outputs the results.
2121

2222
## Examples
2323

2424
### Example 1
2525

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

30-
This example will check disk usage for ESXi hosts managed by SDDC Manager for a single workload domain.
30+
This example will check disk usage for ESX hosts managed by SDDC Manager for a specified workload domain.
3131

3232
### Example 2
3333

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

38-
This example will check disk usage for ESXi hosts managed by SDDC Manager for a single workload domain but only reports issues.
38+
This example will check disk usage for ESX hosts managed by SDDC Manager for a specified workload domain but only reports issues.
3939

4040
## Parameters
4141

0 commit comments

Comments
 (0)