Get-CTXAPI_FailureReport
SYNOPSIS
Reports on failures in the last x hours.
SYNTAX
Fetch odata (Default)
Get-CTXAPI_FailureReport -APIHeader <Object> [-region <String>] [-hours <Int32>] -FailureType <String>
[-Export <String>] [-ReportPath <String>] [<CommonParameters>]
Got odata
Get-CTXAPI_FailureReport [-APIHeader <Object>] [-MonitorData <Object>] -FailureType <String> [-Export <String>]
[-ReportPath <String>] [<CommonParameters>]
DESCRIPTION
Reports on machine or connection failures in the last x hours.
EXAMPLES
EXAMPLE 1
Get-CTXAPI_FailureReport -MonitorData $MonitorData -FailureType Connection
PARAMETERS
-APIHeader
Use Connect-CTXAPI to create headers.
Type: Object
Parameter Sets: Fetch odata
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Object
Parameter Sets: Got odata
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MonitorData
Use Get-CTXAPI_MonitorData to create OData.
Type: Object
Parameter Sets: Got odata
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-region
Your Cloud instance hosted region.
Type: String
Parameter Sets: Fetch odata
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-hours
Amount of time to report on.
Type: Int32
Parameter Sets: Fetch odata
Aliases:
Required: False
Position: Named
Default value: 24
Accept pipeline input: False
Accept wildcard characters: False
-FailureType
Type of failure to report on
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Export
In what format to export the reports.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Host
Accept pipeline input: False
Accept wildcard characters: False
-ReportPath
Destination folder for the exported report.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $env:temp
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.