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/Request-EsxiAlert.md
Comment thread
andybeltz marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Synopsis

Returns Alarms from all ESXi hosts in vCenter Server instance.
Returns alarms from all ESX hosts in a vCenter instance.

## Syntax

Expand All @@ -12,30 +12,30 @@ Request-EsxiAlert [-server] <String> [-user] <String> [-pass] <String> [[-domain

## Description

The `Request-EsxiAlert` cmdlet returns all alarms from all ESXi hosts in vCenter Server managed by SDDC Manager.
The `Request-EsxiAlert` cmdlet returns all alarms from all ESX hosts in 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 alerts from all ESXi hosts in vCenter Server instance
- Validates that network connectivity is available to the vCenter instance.
- Validates the authentication to vCenter with credentials from SDDC Manager.
- Collects the alerts from all ESX hosts in vCenter instance.

## Examples

### Example 1

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

This example will return alarms from all ESXi hosts in vCenter Server managed by SDDC Manager for a workload domain sfo-w01.
This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for a specified workload domain.

### Example 2

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

This example will return alarms from all ESXi hosts in vCenter Server managed by SDDC Manager for a workload domain sfo-w01 but only for the failed items.
This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for a specified workload domain but only reports issues.

## Parameters

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

## Synopsis

Returns the connection status of ESXi hosts in a workload domain.
Returns the connection status of ESX hosts in a workload domain.

## Syntax

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

## Description

The `Request-EsxiConnectionHealth` cmdlet returns the connection status of ESXi hosts in a workload domain.
The `Request-EsxiConnectionHealth` cmdlet returns the connection status of ESX hosts in a workload domain.
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 connection status of ESXi hosts in a workload domain.
- Validates that network connectivity is available to the SDDC Manager instance.
- Validates that network connectivity is available to the vCenter instance.
- Gathers the connection status of ESX hosts in a workload domain.

## Examples

### Example 1

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

This example returns the connection status of ESXi hosts in a workload domain.
This example returns the connection status of ESX hosts in a specified workload domain.

### Example 2

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

This example returns the connection status of ESXi hosts in a workload domain but only reports issues.
This example returns the connection status of ESX hosts in a specified workload domain but only reports issues.

## Parameters

Expand Down
29 changes: 14 additions & 15 deletions docs/documentation/functions/Request-EsxiOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,56 @@

## Synopsis

Returns overview of ESXi hosts.
Returns an overview of ESX hosts.

## Syntax

```powershell
Request-EsxiOverview [-server] <String> [-user] <String> [-pass] <String> [-anonymized] [-subscription]
[[-outputCsv] <String>] [<CommonParameters>]
Request-EsxiOverview [-server] <String> [-user] <String> [-pass] <String> [-anonymized] [-subscription] [[-outputCsv] <String>] [<CommonParameters>]
```

## Description

The `Request-EsxiOverview` cmdlet returns an overview of the ESXi host managed by SDDC Manager.
The `Request-EsxiOverview` cmdlet returns an overview of the ESX hosts 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 ESXi host 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 ESX host overview detail.

## Examples

### Example 1

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

This example will return an overview of the ESXi hosts managed by the SDDC Manager instance.
This example will return an overview of the ESX hosts managed by the SDDC Manager instance.

### Example 2

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

This example will return an overview of the ESXi hosts managed by the SDDC Manager instance with the number of cores for VCF+ subscription.
This example will return an overview of the ESX hosts managed by the SDDC Manager instance with the number of cores for VCF+ subscription.

### Example 3

```powershell
Request-EsxiOverview -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -subscription -outputCsv F:\Reporting
Request-EsxiOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -subscription -outputCsv [report_path]
```

This example will return an overview of the ESXi hosts managed by the SDDC Manager instance with the number of cores for VCF+ subscription and save as a CSV file to F:\Reporting.
This example will return an overview of the ESX hosts managed by the SDDC Manager instance with the number of cores for VCF+ subscription and save as a CSV file to the specified report path.

### Example 4

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

This example will return an overview of the ESXi hosts managed by the SDDC Manager instance, but will anonymize the output.
This example will return an overview of the ESX hosts managed by the SDDC Manager instance, but will anonymize the output.

## Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Synopsis

Gets ESXi security configuration from a vCenter Server instance.
Gets ESX security configuration from a vCenter instance.

## Syntax

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

## Description

The `Request-EsxiSecurityConfiguration` cmdlets gets ESXi security configuration for a vCenter Server instance.
The `Request-EsxiSecurityConfiguration` cmdlets gets ESX security 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 ESXi security configuration 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 ESX security configuration from vCenter.

## Examples

### Example 1

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

This example gets the ESXi security configurationfor a vCenter Server instance based on the workload domain provided.
This example gets the ESX security configuration for a vCenter instance based on a specified workload domain.

## Parameters

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

## Synopsis

Checks the disk usage for ESXi hosts.
Checks the disk usage for ESX hosts.

## Syntax

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

## Description

The `Request-EsxiStorageCapacity` cmdlets checks the disk space usage on ESXi hosts.
The `Request-EsxiStorageCapacity` cmdlets checks the disk space usage on ESX hosts.
The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values:

- Validates network connectivity and authentication to the SDDC Manager instance
- Collects disk usage information for each ESXi host in the workload domain
- Checks disk usage against thresholds and outputs the results
- Validates network connectivity and authentication to the SDDC Manager instance.
- Collects disk usage information for each ESX host in the workload domain.
- Checks disk usage against thresholds and outputs the results.

## Examples

### Example 1

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

This example will check disk usage for ESXi hosts managed by SDDC Manager for a single workload domain.
This example will check disk usage for ESX hosts managed by SDDC Manager for a specified workload domain.

### Example 2

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

This example will check disk usage for ESXi hosts managed by SDDC Manager for a single workload domain but only reports issues.
This example will check disk usage for ESX hosts managed by SDDC Manager for a specified workload domain but only reports issues.

## Parameters

Expand Down