mirror of
https://github.com/Icinga/icinga-powershell-framework.git
synced 2025-12-21 15:19:58 -05:00
35 lines
983 B
PowerShell
35 lines
983 B
PowerShell
|
|
<#
|
||
|
|
.SYNOPSIS
|
||
|
|
Default Cmdlet for printing notice messages to console
|
||
|
|
.DESCRIPTION
|
||
|
|
Default Cmdlet for printing notice messages to console
|
||
|
|
.FUNCTIONALITY
|
||
|
|
Default Cmdlet for printing notice messages to console
|
||
|
|
.EXAMPLE
|
||
|
|
PS>Write-IcingaConsoleNotice -Message 'Test message: {0}' -Objects 'Hello World';
|
||
|
|
.PARAMETER Message
|
||
|
|
The message to print with {x} placeholdes 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.
|
||
|
|
.INPUTS
|
||
|
|
System.String
|
||
|
|
.LINK
|
||
|
|
https://github.com/Icinga/icinga-powershell-framework
|
||
|
|
#>
|
||
|
|
|
||
|
|
function Write-IcingaConsoleNotice()
|
||
|
|
{
|
||
|
|
param (
|
||
|
|
[string]$Message,
|
||
|
|
[array]$Objects
|
||
|
|
);
|
||
|
|
|
||
|
|
Write-IcingaConsoleOutput `
|
||
|
|
-Message $Message `
|
||
|
|
-Objects $Objects `
|
||
|
|
-ForeColor 'Green' `
|
||
|
|
-Severity 'Notice';
|
||
|
|
}
|