Publish-NsxtCombinedHealth¶

Synopsis¶

Request and publish NSX health.

Syntax¶

All-WorkloadDomains¶

Publish-NsxtCombinedHealth [-server] <String> [-user] <String> [-pass] <String> [-json] <String> [-allDomains] [-failureOnly] [<CommonParameters>]

Specific-WorkloadDomain¶

Publish-NsxtCombinedHealth [-server] <String> [-user] <String> [-pass] <String> [-json] <String> [-workloadDomain] <String> [-failureOnly] [<CommonParameters>]

Description¶

The Publish-NsxtCombinedHealth cmdlet checks the health of NSX in the 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 and authentication is available to SDDC Manager.
Validates that network connectivity and authentication is available to NSX.
Performs health checks and outputs the results.

Examples¶

Example 1¶

Publish-NsxtCombinedHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains

This example checks NSX health for all workload domains across the VMware Cloud Foundation instance.

Example 2¶

Publish-NsxtCombinedHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]

This example checks NSX health for a specified workload domain in a VMware Cloud Foundation instance.

### Example 3

```powershell
Publish-NsxtCombinedHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly

This example checks NSX health for all workload domains across the VMware Cloud Foundation instance but only reports issues.

Parameters¶

-server¶

The fully qualified domain name of the SDDC Manager.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-user¶

The username to authenticate to the SDDC Manager.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-pass¶

The password to authenticate to the SDDC Manager.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-json¶

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

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-allDomains¶

Switch to run health checks across all workload domains.

Type: SwitchParameter
Parameter Sets: All-WorkloadDomains
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-workloadDomain¶

The name of the workload domain to run against.

Type: String
Parameter Sets: Specific-WorkloadDomain
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-failureOnly¶

Switch to only output issues to the report.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Common Parameters¶

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.