Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion docs/documentation/functions/Invoke-VcfHealthReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

Perform health checks for a VMware Cloud Foundation instance or workload domain.


## Syntax

### All-WorkloadDomains
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The `Invoke-VcfUpgradePrecheck` runs an upgrade precheck for a workload domain
### Example 1

```powershell
Invoke-VcfUpgradePrecheck -sddcManagerFqdn sfo-vcf01.sfo.rainpole.io -sddcManagerUser admin@local -sddcManagerPass VMw@re1!VMw@re1! -reportPath F:\Reporting -workloadDomain sfo-w01
Invoke-VcfUpgradePrecheck -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -reportPath [report_path] -workloadDomain [workload_domain_name]
```

This example runs a health check for a specific workload domain within an SDDC Manager instance.
Expand Down
22 changes: 11 additions & 11 deletions docs/documentation/functions/Publish-BackupStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Publish-BackupStatus -server <String> -user <String> -pass <String> -workloadDom

## Description

The `Publish-BackupStatus` cmdlet checks the backup status for SDDC Manager, vCenter Server instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance and prepares the data to be published to an HTML report.
The `Publish-BackupStatus` cmdlet checks the backup status for SDDC Manager, vCenter instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance and prepares the data to be published to an HTML report.
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
- Performs checks on the backup status and outputs the results
- Validates that network connectivity is available to the SDDC Manager instance.
- Performs checks on the backup status and outputs the results.
- outputJson parameter takes in name of the folder to save the json.
Filename is autogenerated.

Expand All @@ -33,34 +33,34 @@ Filename is autogenerated.
### Example 1

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

This example will publish the backup status for the SDDC Manager, vCenter Server instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance.
This example will publish the backup status for the SDDC Manager, vCenter instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance.

### Example 2

```powershell
Publish-BackupStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -failureOnly
Publish-BackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly
```

This example will publish the backup status for the SDDC Manager, vCenter Server instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance but only reports issues.
This example will publish the backup status for the SDDC Manager, vCenter instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance but only reports issues.

### Example 3

```powershell
Publish-BackupStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01
Publish-BackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
```

This example will publish the backup status for the vCenter Server instances, and NSX Local Manager clusters in workload domain sfo-w01.
This example will publish the backup status for the vCenter instances, and NSX Local Manager clusters in the specified workload domain.

### Example 4

```powershell
Publish-BackupStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -outputJson F:\Reporting
Publish-BackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -outputJson [report_path]
```

This example will generate a json for the backup status for the vCenter Server instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance and saves it under F:\Reporting with filename <timestamp>-backup-status.json
This example will generate a json for the backup status for the vCenter instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance and saves it under the specified report path with filename `<timestamp>-backup-status.json`.

## Parameters

Expand Down
7 changes: 4 additions & 3 deletions docs/documentation/functions/Publish-CertificateHealth.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,24 @@ The `Publish-CertificateHealth` cmdlet formats the Certificate Health data from
### Example 1

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

```

This example extracts and formats the Certificate Health data as a PowerShell object from the JSON file.

### Example 2

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

This example extracts and formats the Certificate Health data as an HTML object from the JSON file.

### Example 3

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

This example extracts and formats the Certificate Health data as a PowerShell object from the JSON file for only the failed items.
Expand Down
12 changes: 6 additions & 6 deletions docs/documentation/functions/Publish-ClusterConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,27 +23,27 @@ Publish-ClusterConfiguration -server <String> -user <String> -pass <String> -wor
The `Publish-ClusterConfiguration` cmdlet returns cluster configuration information in HTML format.
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:

- Validates that network connectivity is available to the vCenter Server instance
- Validates the authentication to vCenter Server with credentials from SDDC Manager
- Publishes information
- Validates that network connectivity is available to the vCenter instance.
- Validates the authentication to vCenter with credentials from SDDC Manager.
- Publishes information.

## Examples

### Example 1

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

This example will return cluster configuration from all clusters in vCenter Server managed by SDDC Manager for a all workload domains.

### Example 2

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

This example will return cluster configuration from all clusters in vCenter Server managed by SDDC Manager for a workload domain named sfo-w01.
This example will return cluster configuration from all clusters in vCenter managed by SDDC Manager for a specified workload domain.

## Parameters

Expand Down
14 changes: 7 additions & 7 deletions docs/documentation/functions/Publish-ClusterDrsRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,27 +23,27 @@ Publish-ClusterDrsRule -server <String> -user <String> -pass <String> -workloadD
The `Publish-ClusterDrsRule` cmdlet returns cluster DRS rule information in HTML format.
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:

- Validates that network connectivity is available to the vCenter Server instance
- Validates the authentication to vCenter Server with credentials from SDDC Manager
- Publishes information
- Validates that network connectivity is available to the vCenter instance.
- Validates the authentication to vCenter with credentials from SDDC Manager.
- Publishes information.

## Examples

### Example 1

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

This example will return cluster DRS rules from all clusters in vCenter Server managed by SDDC Manager for a all workload domains.
This example will return cluster DRS rules from all clusters in vCenter managed by SDDC Manager for all workload domains.

### Example 2

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

This example will return cluster DRS rules from all clusters in vCenter Server managed by SDDC Manager for a workload domain named sfo-w01.
This example will return cluster DRS rules from all clusters in vCenter managed by SDDC Manager for a specified workload domain named.

## Parameters

Expand Down