lib/core/logging/Write-IcingaConsoleDebug.psm1

<#
.SYNOPSIS
   Default Cmdlet for printing debug messages to console
.DESCRIPTION
   Default Cmdlet for printing debug messages to console
.FUNCTIONALITY
   Default Cmdlet for printing debug messages to console
.EXAMPLE
   PS>Write-IcingaConsoleDebug -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-IcingaConsoleDebug()
{
   param (
       [string]$Message,
       [array]$Objects
   );

   if ((Get-IcingaFrameworkDebugMode) -eq $FALSE) {
      return;
   }

   Write-IcingaConsoleOutput `
      -Message $Message `
      -Objects $Objects `
      -ForeColor 'Blue' `
      -Severity 'Debug';
}