Skip to content

docs:santize-examples #254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tenthirtyam merged 1 commit into from
May 10, 2025
Merged

docs:santize-examples #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/documentation/functions/Publish-VsanStoragePolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Synopsis

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

## Syntax

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

## Description

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.
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.

## Examples

### Example 1

```powershell
Publish-VsanStoragePolicy -json <file-name>
Publish-VsanStoragePolicy -json [file_name]
```

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

### Example 2

```powershell
Publish-VsanStoragePolicy -json <file-name> -html
Publish-VsanStoragePolicy -json [file_name] -html
```

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

### Example 3

```powershell
Publish-VsanStoragePolicy -json <file-name> -failureOnly
Publish-VsanStoragePolicy -json [file_name] -failureOnly
```

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

## Parameters

### -json

The path to the JSON file containing the SoS Health Summary data.
The path to the JSON file containing the SOS health summary data.

```yaml
Type: String
Expand Down
14 changes: 7 additions & 7 deletions docs/documentation/functions/Request-ClusterConfiguration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Synopsis

Gets cluster configuration from a vCenter Server instance.
Gets cluster configuration from a vCenter instance.

## Syntax

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

## Description

The `Request-ClusterConfiguration` cmdlets gets the cluster configuration for a vCenter Server instance.
The `Request-ClusterConfiguration` cmdlets gets the cluster configuration for a vCenter instance.
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:

- Validates that network connectivity is available to the SDDC Manager instance
- Validates that network connectivity is available to the vCenter Server instance
- Gathers the cluster details from vCenter Server
- Validates that network connectivity is available to the SDDC Manager instance.
- Validates that network connectivity is available to the vCenter instance.
- Gathers the cluster details from vCenter.

## Examples

### Example 1

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

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

## Parameters

Expand Down
14 changes: 7 additions & 7 deletions docs/documentation/functions/Request-ClusterDrsRule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Synopsis

Gets cluster DRS rules from a vCenter Server instance.
Gets cluster DRS rules from a vCenter instance.

## Syntax

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

## Description

The `Request-ClusterDrsRule` cmdlets gets the cluster DRS rules for a vCenter Server instance.
The `Request-ClusterDrsRule` cmdlets gets the cluster DRS rules for a vCenter instance.
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:

- Validates that network connectivity is available to the SDDC Manager instance
- Validates that network connectivity is available to the vCenter Server instance
- Gathers the cluster DRS rules from vCenter Server
- Validates that network connectivity is available to the SDDC Manager instance.
- Validates that network connectivity is available to the vCenter instance.
- Gathers the cluster DRS rules from vCenter.

## Examples

### Example 1

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

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

## Parameters

Expand Down
12 changes: 6 additions & 6 deletions docs/documentation/functions/Request-ClusterOverview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Synopsis

Returns overview of vSphere.
Returns an overview of vSphere.

## Syntax

Expand All @@ -15,24 +15,24 @@ Request-ClusterOverview [-server] <String> [-user] <String> [-pass] <String> [-a
The `Request-ClusterOverview` cmdlet returns an overview of the vSphere environment managed by SDDC Manager.
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:

- Validates that network connectivity and authentication to the SDDC Manager instance
- Validates that network connectivity and authentication to the vCenter Server instances
- Collects the vSphere overview detail
- Validates that network connectivity and authentication to the SDDC Manager instance.
- Validates that network connectivity and authentication to the vCenter instances.
- Collects the vSphere overview detail.

## Examples

### Example 1

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

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

### Example 2

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

This example will return an overview of the vSphere environment managed by the SDDC Manager instance, but will anonymize the output.
Expand Down
18 changes: 9 additions & 9 deletions docs/documentation/functions/Request-DatastoreStorageCapacity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Synopsis

Checks the datastore usage in all vCenter Server instances.
Checks the datastore usage in all vCenter instances.

## Syntax

Expand All @@ -15,28 +15,28 @@ Request-DatastoreStorageCapacity [-server] <String> [-user] <String> [-pass] <St
The `Request-DatastoreStorageCapacity` cmdlet checks the datastore usage in all vCenters.
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:

- Validates that network connectivity is available to the SDDC Manager instance
- Validates that network connectivity is available to the vCenter Server instance
- Gathers the details for each vCenter Server
- Collects information about datastore usage
- Validates that network connectivity is available to the SDDC Manager instance.
- Validates that network connectivity is available to the vCenter instance.
- Gathers the details for each vCenter.
- Collects information about datastore usage.

## Examples

### Example 1

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

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

### Example 2

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

This example will check datastore on a vCenter Servers managed by SDDC Manager for a workload domain.
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.

## Parameters

Expand Down