lib/core/logging/Write-IcingaConsoleError.psm1
|
<# .SYNOPSIS Default Cmdlet for printing error messages to console .DESCRIPTION Default Cmdlet for printing error messages to console .FUNCTIONALITY Default Cmdlet for printing error messages to console .EXAMPLE PS>Write-IcingaConsoleError -Message 'Test message: {0}' -Objects 'Hello World'; .PARAMETER Message The message to print with {x} placeholder replaced by content inside the Objects array. Replace x with the number of the index from the objects array .PARAMETER Objects An array of objects being added to a provided message. The index of the array position has to refer to the message locations. .PARAMETER DropMessage Allows to programmatically drop a message in case it is not required without dealing with If-Blocks .INPUTS System.String .LINK https://github.com/Icinga/icinga-powershell-framework #> function Write-IcingaConsoleError() { param ( [string]$Message, [array]$Objects, [switch]$DropMessage = $FALSE ); Write-IcingaConsoleOutput ` -Message $Message ` -Objects $Objects ` -ForeColor 'Red' ` -Severity 'Error' ` -DropMessage:$DropMessage; } |