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
18 changes: 9 additions & 9 deletions docs/documentation/functions/Publish-VirtualNetwork.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,41 +9,41 @@ Publish vSphere virtual networking information in HTML format.
### All-WorkloadDomains

```powershell
Publish-VirtualNetwork -server <String> -user <String> -pass <String> [-allDomains] [<CommonParameters>]
Publish-VirtualNetwork [-server] <String> [-user] <String> [-pass] <String> [-allDomains] [<CommonParameters>]
```

### Specific-WorkloadDomain

```powershell
Publish-VirtualNetwork -server <String> -user <String> -pass <String> -workloadDomain <String> [<CommonParameters>]
Publish-VirtualNetwork [-server] <String> [-user] <String> [-pass] <String> [-workloadDomain] <String> [<CommonParameters>]
```

## Description

The `Publish-VirtualNetwork` cmdlet returns vSphere virtual networking 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-VirtualNetwork -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains
Publish-VirtualNetwork -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
```

This example will return vSphere virtual networking details from all clusters in vCenter Server managed by SDDC Manager for a all workload domains.
This example will return vSphere virtual networking details from all clusters in vCenter managed by SDDC Manager for all workload domains.

### Example 2

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

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

## Parameters

Expand Down
20 changes: 10 additions & 10 deletions docs/documentation/functions/Publish-VmConnectedCdrom.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,50 +9,50 @@ Publish the status of virtual machines with connected CD-ROMs in a workload doma
### All-WorkloadDomains

```powershell
Publish-VmConnectedCdrom -server <String> -user <String> -pass <String> [-allDomains] [-outputJson <String>] [<CommonParameters>]
Publish-VmConnectedCdrom [-server] <String> [-user] <String> [-pass] <String> [-allDomains] [-outputJson <String>] [<CommonParameters>]
```

### Specific-WorkloadDomain

```powershell
Publish-VmConnectedCdrom -server <String> -user <String> -pass <String> -workloadDomain <String> [-outputJson <String>] [<CommonParameters>]
Publish-VmConnectedCdrom [-server] <String> [-user] <String> [-pass] <String> [-workloadDomain] <String> [-outputJson <String>] [<CommonParameters>]
```

## Description

The `Publish-VmConnectedCdrom` cmdlet returns the status of virtual machines with connected CD-ROMS in a workload domain 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-VmConnectedCdrom -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains
Publish-VmConnectedCdrom -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
```

This example will returns the status of virtual machines with connected CD-ROMs in all workload domains.

### Example 2

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

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

### Example 3

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

This example will generate a json with the status of virtual machines with connected CD-ROMs in all workload domains
and saves it under F:\Reporting with filename <timestamp>-cdrom-status.json
and saves it under the specified report path with filename `<timestamp>-cdrom-status.json`

## Parameters

Expand Down
22 changes: 11 additions & 11 deletions docs/documentation/functions/Publish-VmOverride.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,48 @@

## Synopsis

Publish VM Override information in HTML format.
Publish VM override information in HTML format.

## Syntax

### All-WorkloadDomains

```powershell
Publish-VmOverride -server <String> -user <String> -pass <String> [-allDomains] [<CommonParameters>]
Publish-VmOverride [-server] <String> [-user] <String> [-pass] <String> [-allDomains] [<CommonParameters>]
```

### Specific-WorkloadDomain

```powershell
Publish-VmOverride -server <String> -user <String> -pass <String> -workloadDomain <String> [<CommonParameters>]
Publish-VmOverride [-server] <String> [-user] <String> [-pass] <String> [-workloadDomain] <String> [<CommonParameters>]
```

## Description

The `Publish-VmOverride` cmdlet returns VM Override information in HTML format.
The `Publish-VmOverride` cmdlet returns VM override 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-VmOverride -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains
Publish-VmOverride -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
```

This example will return VM Override details from all clusters in vCenter Server managed by SDDC Manager for all workload domains.
This example will return VM override details from all clusters in vCenter managed by SDDC Manager for all workload domains.

### Example 2

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

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

## Parameters

Expand Down
26 changes: 13 additions & 13 deletions docs/documentation/functions/Publish-VsanAlert.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,56 +2,56 @@

## Synopsis

RPublish the vSAN Healthcheck alarms from a vCenter Server instance.
Publish the vSAN healthcheck alarms from a vCenter instance.

## Syntax

### All-WorkloadDomains

```powershell
Publish-VsanAlert -server <String> -user <String> -pass <String> [-allDomains] [-failureOnly] [<CommonParameters>]
Publish-VsanAlert [-server] <String> [-user] <String> [-pass] <String> [-allDomains] [-failureOnly] [<CommonParameters>]
```

### Specific-WorkloadDomain

```powershell
Publish-VsanAlert -server <String> -user <String> -pass <String> -workloadDomain <String> [-failureOnly] [<CommonParameters>]
Publish-VsanAlert [-server] <String> [-user] <String> [-pass] <String> [-workloadDomain] <String> [-failureOnly] [<CommonParameters>]
```

## Description

The `Publish-VsanAlert` cmdlet returns vSAN Healthcheck alarms from vCenter Server managed by SDDC Manager.
The `Publish-VsanAlert` cmdlet returns vSAN healthcheck alarms from vCenter managed by SDDC Manager.
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
- Collects the vSAN Healthcheck alarms from vCenter Server
- Validates that network connectivity is available to the vCenter instance.
- Validates the authentication to vCenter with credentials from SDDC Manager.
- Collects the vSAN healthcheck alarms from vCenter.

## Examples

### Example 1

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

This example will return vSAN Healthcheck alarms for all vCenter Server instances managed by SDDC Manager for a workload domain.
This example will return vSAN healthcheck alarms for all vCenter instances managed by SDDC Manager for all workload domains.

### Example 2

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

This example will return vSAN Healthcheck alarms for all vCenter Server instances managed by SDDC Manager for a workload domain but only failed items.
This example will return vSAN healthcheck alarms for all vCenter instances managed by SDDC Manager for all workload domains but only reports issues.

### Example 3

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

This example will return vSAN Healthcheck alarms of a vCenter Server managed by SDDC Manager for a workload domain named sfo-w01.
This example will return vSAN healthcheck alarms of a vCenter managed by SDDC Manager for a workload domain named a specified workload domain.

## Parameters

Expand Down
18 changes: 9 additions & 9 deletions docs/documentation/functions/Publish-VsanHealth.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Synopsis

Formats the vSAN Health data from the SoS JSON output.
Formats the vSAN health data from the SOS JSON output.

## Syntax

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

## Description

The `Publish-VsanHealth` cmdlet formats the vSAN Health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object.
The `Publish-VsanHealth` cmdlet formats the vSAN health data from the SOS JSON output and publishes it as either a standard PowerShell object or an HTML object.

## Examples

### Example 1

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

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

### Example 2

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

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

### Example 3

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

This example extracts and formats the vSAN Health data as a PowerShell object from the JSON file for only the failed items.
This example extracts and formats the vSAN health 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