Set-PRTGResultMessage

NAME Set-PRTGResultMessage



SYNOPSIS

Output the PRTG Result Set Object in JSON Format. Typically this is the last step in your EXEXML script to report

to PRTG





SYNTAX

Set-PRTGResultMessage [[-Message] <String>] [-AsError] [-AsWarning] [[-PRTGResultSet] <Object>]

[<CommonParameters>]





DESCRIPTION





PARAMETERS

-Message <String>

The content of the message. Default is "OK"



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AsError [<SwitchParameter>]

Specify if the message is an error. WARNING: This type of error does not save the channel data, only use for

script errors or if historical info is not required. A sensor in this error status cannot return any data in

its channels; if used, all channel values in the <result> section will be removed.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-AsWarning [<SwitchParameter>]

Specify if the message is a warning



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-PRTGResultSet <Object>

The PRTG Result Set to set the message for



Required? false

Position? 2

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS