Skip to content

Commit 6f3a7a1

Browse files
authored
docs: sanitize examples (#257)
- Updated `Request-NsxtTier0BgpStatus` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Request-NsxtTransportNodeStatus` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Request-NsxtTransportNodeTunnelStatus` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Request-NsxtVidmStatus` doc to sanitize all the example variables, add brackets and punctuation. - Updated `Request-ResourcePool` doc to sanitize all the example variables, add brackets and punctuation. Signed-off-by: Andy Beltz <andy.beltz@broadcom.com>
1 parent ed364e2 commit 6f3a7a1

5 files changed

Lines changed: 47 additions & 47 deletions

File tree

docs/documentation/functions/Request-NsxtTier0BgpStatus.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 the BGP status for all Tier-0 gateways managed by the NSX Local Manager cluster.
5+
Returns the BGP status for all Tier-0 gateways managed by NSX.
66

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-NsxtTier0BgpStatus` cmdlet returns the BGP status for all Tier-0 gateways managed by the NSX Manager cluster.
16-
The cmdlet connects to the NSX Local Manager using the `-server`, `-user`, and `-pass` values:
15+
The `Request-NsxtTier0BgpStatus` cmdlet returns the BGP status for all Tier-0 gateways managed by NSX.
16+
The cmdlet connects to NSX 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 NSX Local Manager cluster
20-
- Gathers the details for the NSX Local Manager cluster
21-
- Collects the BGP status for all Tier-0s managed by the NSX Local Manager cluster
18+
- Validates that network connectivity is available to the SDDC Manager instance.
19+
- Validates that network connectivity is available to NSX.
20+
- Gathers the details for NSX.
21+
- Collects the BGP status for all Tier-0 gateways managed by NSX.
2222

2323
## Examples
2424

2525
### Example 1
2626

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

31-
This example will return the BGP status for all Tier-0 gateways managed by the NSX Local Manager cluster that is managed by SDDC Manager for a workload domain.
31+
This example will return the BGP status for all Tier-0 gateways managed by NSX which is managed by SDDC Manager for a specified workload domain.
3232

3333
### Example 2
3434

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

39-
This example will return the BGP status for all Tier-0 gateways managed by the NSX Local Manager cluster that is managed by SDDC Manager for a workload domain but only reports issues.
39+
This example will return the BGP status for all Tier-0 gateways managed by NSX which is managed by SDDC Manager for a specified workload domain but only reports issues.
4040

4141
## Parameters
4242

docs/documentation/functions/Request-NsxtTransportNodeStatus.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 NSX transport nodes managed by an NSX Manager cluster.
5+
Returns the status of NSX transport nodes managed by NSX.
66

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-NsxtTransportNodeStatus` cmdlet returns the status NSX transport nodes managed by an NSX Manager cluster.
15+
The `Request-NsxtTransportNodeStatus` cmdlet returns the status NSX transport nodes managed by NSX.
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 NSX Manager cluster from the SDDC Manager
20-
- Validates network connectivity and authentication to the NSX Local Manager cluster
21-
- Collects the status of the transport nodes
18+
- Validates network connectivity and authentication to the SDDC Manager instance.
19+
- Gathers the details for NSX from the SDDC Manager.
20+
- Validates network connectivity and authentication to NSX.
21+
- Collects the status of the transport nodes.
2222

2323
## Examples
2424

2525
### Example 1
2626

2727
```powershell
28-
Request-NsxtTransportNodeStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01
28+
Request-NsxtTransportNodeStatus -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 NSX transport nodes managed by an NSX Manager cluster which is managed by SDDC Manager for a workload domain.
31+
This example will return the status of the NSX transport nodes managed by NSX which is managed by SDDC Manager for a specified workload domain.
3232

3333
### Example 2
3434

3535
```powershell
36-
Request-NsxtTransportNodeStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01 -failureOnly
36+
Request-NsxtTransportNodeStatus -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 NSX transport nodes managed by an NSX Manager cluster which is managed by SDDC Manager for a workload domain but only reports issues.
39+
This example will return the status of the NSX transport nodes managed by NSX which is managed by SDDC Manager for a specified workload domain but only reports issues.
4040

4141
## Parameters
4242

docs/documentation/functions/Request-NsxtTransportNodeTunnelStatus.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,31 @@ Request-NsxtTransportNodeTunnelStatus [-server] <String> [-user] <String> [-pass
1212

1313
## Description
1414

15-
The `Request-NsxtTransportNodeTunnelStatus` cmdlet returns the status NSX transport nodes tunnels.
15+
The `Request-NsxtTransportNodeTunnelStatus` cmdlet returns the status of NSX transport nodes tunnels.
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 NSX Manager cluster from the SDDC Manager
20-
- Validates network connectivity and authentication to the NSX Local Manager cluster
21-
- Collects the status of the transport node tunnels
18+
- Validates network connectivity and authentication to the SDDC Manager instance.
19+
- Gathers the details for NSX from the SDDC Manager.
20+
- Validates network connectivity and authentication to NSX.
21+
- Collects the status of the transport node tunnels.
2222

2323
## Examples
2424

2525
### Example 1
2626

2727
```powershell
28-
Request-NsxtTransportNodeTunnelStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01
28+
Request-NsxtTransportNodeTunnelStatus -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 NSX transport node tunnels for a workload domain.
31+
This example will return the status of the NSX transport node tunnels for a specified workload domain.
3232

3333
### Example 2
3434

3535
```powershell
36-
Request-NsxtTransportNodeTunnelStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01 -failureOnly
36+
Request-NsxtTransportNodeTunnelStatus -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 NSX transport node tunnels for a workload domain but only reports issues.
39+
This example will return the status of the NSX transport node tunnels for a specified workload domain but only reports issues.
4040

4141
## Parameters
4242

docs/documentation/functions/Request-NsxtVidmStatus.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 Identity Manager integration for an NSX Manager cluster.
5+
Returns the status of the identity manager integration for NSX.
66

77
## Syntax
88

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

1313
## Description
1414

15-
The `Request-NsxtVidmStatus` cmdlet returns the status of the Identity Manager integration for an NSX Manager cluster.
15+
The `Request-NsxtVidmStatus` cmdlet returns the status of the identity manager integration for NSX.
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 instanc
19-
- Gathers the details for the NSX Manager cluster from the SDDC Manager
20-
- Validates network connectivity and authentication to the NSX Local Manager cluster
21-
- Collects the Identity Manager integration status details
18+
- Validates network connectivity and authentication to the SDDC Manager instance.
19+
- Gathers the details for NSX from the SDDC Manager.
20+
- Validates network connectivity and authentication to NSX.
21+
- Collects the identity manager integration status details.
2222

2323
## Examples
2424

2525
### Example 1
2626

2727
```powershell
28-
Request-NsxtVidmStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01
28+
Request-NsxtVidmStatus -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 Identity Manager integration for an NSX Manager cluster managed by SDDC Manager for a workload domain.
31+
This example will return the status of the identity manager integration for NSX managed by SDDC Manager for a specified workload domain.
3232

3333
### Example 2
3434

3535
```powershell
36-
Request-NsxtVidmStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -domain sfo-w01 -failureOnly
36+
Request-NsxtVidmStatus -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 Identity Manager integration for an NSX Manager cluster managed by SDDC Manager for a workload domain but only reports issues.
39+
This example will return the status of the identity manager integration for NSX managed by SDDC Manager for a specified workload domain but only reports issues.
4040

4141
## Parameters
4242

docs/documentation/functions/Request-ResourcePool.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 resource pool details from a vCenter Server instance.
5+
Gets resource pool details from a vCenter instance.
66

77
## Syntax
88

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

1313
## Description
1414

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

2222
## Examples
2323

2424
### Example 1
2525

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

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

3232
## Parameters
3333

0 commit comments

Comments
 (0)