Request-VcenterAlert¶

Synopsis¶

Returns alarms from a vCenter instance managed by SDDC Manager.

Syntax¶

Request-VcenterAlert [-server] <String> [-user] <String> [-pass] <String> [-domain] <String> [[-filterOut] <String>] [-failureOnly] [<CommonParameters>]

Description¶

The Request-VcenterAlert cmdlet returns all alarms from a vCenter instance 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 instance.
Validates the authentication to vCenter with credentials from SDDC Manager.
Collects the alerts from vCenter.

Examples¶

Example 1¶

Request-VcenterAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name]

This example will return alarms of a vCenter managed by SDDC Manager for a specified workload domain.

Example 2¶

Request-VcenterAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -filterOut hostOnly

This example will return alarms from ESX hosts of a vCenter managed by SDDC Manager for a specified workload domain.

Example 3¶

Request-VcenterAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly

This example will return alarms from vSAN clusters of a vCenter managed by SDDC Manager for a specified workload domain but only reports issues.

Parameters¶

-server¶

The fully qualified domain name of the SDDC Manager.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
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: 2
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: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-domain¶

The name of the workload domain to run against.

Type: String
Parameter Sets: (All)
Aliases:

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

-filterOut¶

Filter out alarms. One of: hostOnly, vsanOnly.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
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.