Skip to content

Commit c277d48

Browse files
authored
docs: sanitize examples (#260)
- Updated `Request-VcenterSnapshotStatus.md` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Request-VcenterStorageHealth.md` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Request-VcfOverview.md` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Request-VirtualNetwork.md` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Request-VmConnectedCdrom.md` doc to sanitize all the example variables, add brackets and punctuation. Signed-off-by: Andy Beltz <andy.beltz@broadcom.com>
1 parent 69dca26 commit c277d48

5 files changed

Lines changed: 39 additions & 39 deletions

File tree

docs/documentation/functions/Request-VcenterSnapshotStatus.md

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

33
## Synopsis
44

5-
Request the snapshot status for the vCenter Server instance.
5+
Request the snapshot status for the vCenter instance.
66

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-VcenterSnapshotStatus` cmdlet checks the snapshot status for vCenter Server instance.
15+
The `Request-VcenterSnapshotStatus` cmdlet checks the snapshot status for 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 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 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+
- Performs checks on the snapshot status and outputs the results.
2222

2323
## Examples
2424

2525
### Example 1
2626

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

31-
This example will publish the snapshot status for a vCenter Server instance for a specific workload domain.
31+
This example will publish the snapshot status for a vCenter instance managed by SDDC Manager for a specified workload domain.
3232

3333
### Example 2
3434

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

39-
This example will publish the snapshot status for a vCenter Server instance for a specific workload domain, but only failed items.
39+
This example will publish the snapshot status for a vCenter instance managed by SDDC Manager for a specified workload domain but only reports issues.
4040

4141
## Parameters
4242

docs/documentation/functions/Request-VcenterStorageHealth.md

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

33
## Synopsis
44

5-
Checks the disk usage on a vCenter Server instance.
5+
Checks the disk usage on a vCenter instance.
66

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-VcenterStorageHealth` cmdlets checks the disk space usage on a vCenter Server.
15+
The `Request-VcenterStorageHealth` cmdlets checks the disk space usage on 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-
- Validates network connectivity and authentication to the vCenter Server instance
20-
- Collects information for the disk usage
21-
- Checks disk usage against thresholds and outputs the results
18+
- Validates network connectivity and authentication to the SDDC Manager instance.
19+
- Validates network connectivity and authentication to the vCenter instance.
20+
- Collects information for the disk usage.
21+
- Checks disk usage against thresholds and outputs the results.
2222

2323
## Examples
2424

2525
### Example 1
2626

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

31-
This example will check disk usage for a single workload domain
31+
This example will check disk usage for a vCenter instance managed by SDDC Manager for a specified workload domain.
3232

3333
### Example 2
3434

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

39-
This example will check the disk usage for all vCenter Server instances but only reports issues.
39+
This example will check the disk usage for all vCenter instances managed by SDDC Manager but only reports issues.
4040

4141
## Parameters
4242

docs/documentation/functions/Request-VcfOverview.md

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

33
## Synopsis
44

5-
Returns System Overview.
5+
Returns returns an overview of the SDDC Manager instance.
66

77
## Syntax
88

@@ -15,23 +15,23 @@ Request-VcfOverview [-server] <String> [-user] <String> [-pass] <String> [-anony
1515
The `Request-VcfOverview` cmdlet returns an overview of the SDDC Manager 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-
- Collects the overview detail
18+
- Validates that network connectivity is available to the SDDC Manager instance.
19+
- Collects the overview detail.
2020

2121
## Examples
2222

2323
### Example 1
2424

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

2929
This example will return an overview of the SDDC Manager instance.
3030

3131
### Example 2
3232

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

3737
This example will return an overview of the SDDC Manager instance, but will anonymize the output.

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

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-VirtualNetwork` cmdlets gets vSphere virtual networking configuration for a vCenter Server instance.
15+
The `Request-VirtualNetwork` cmdlets gets vSphere virtual networking 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 vSphere virtual networking 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 vSphere virtual networking configuration from vCenter.
2121

2222
## Examples
2323

2424
### Example 1
2525

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

30-
This example gets the vSphere virtual networking configurationfor a vCenter Server instance based on the workload domain provided.
30+
This example gets the vSphere virtual networking configuration for a vCenter instance managed by SDDC Manager a specified workload domain.
3131

3232
## Parameters
3333

docs/documentation/functions/Request-VmConnectedCdrom.md

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

33
## Synopsis
44

5-
Returns the status of virtual machines with connected CD-ROMs in a workload domain.
5+
Returns the status of virtual machines with connected CD-ROMs in a specified workload domain.
66

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-VmConnectedCdrom` cmdlet returns the status of virtual machines with connected CD-ROMs in a workload domain.
15+
The `Request-VmConnectedCdrom` cmdlet returns the status of virtual machines with connected CD-ROMs in a specified 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 status of virtual machines with connected CD-ROMs 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 status of virtual machines with connected CD-ROMs in a specified workload domain.
2121

2222
## Examples
2323

2424
### Example 1
2525

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

30-
This example returns the status of virtual machines with connected CD-ROMs in a workload domain.
30+
This example returns the status of virtual machines with connected CD-ROMs in a specified workload domain.
3131

3232
## Parameters
3333

0 commit comments

Comments
 (0)