Write-KFLogOutput

Syntax

Write-KFLogOutput
  [-InputObject] <object> 
  [-LogOutputFormat <log-output-format>] 
  [-LogLevel <log-level>] 
  [-ThrowErrors:[$true]]  

Support

>= kenaflow 1.0.0

Return

Nothing.

Description

This Cmdlet writes the given <object> in serialized form to the log of kenaflow.

By default, the format 'JSON' is used for serialization. Alternatively, 'CliXML' is possible for serialization as PowerShell compatible object serialization XML.

Parameters

-InputObject <object>

The <object> to be logged in serialized form

-LogOutputFormat <log-output-format>

The serialization format for the given <object>

Possible values are:

  • JSON
  • CliXML

Default (if not specified) is "JSON"

-LogLevel <log-level>

Specifies the severity of the log entry.

Possible values are:

  • Debug
  • Verbose
  • Normal
  • Warning
  • Error
  • Critical

Critical will cause an error message and e-mail to the administrators.

[-ThrowErrors[:$true]]

This is a default parameter for all kenaflow cmdlets. If set to $true (default!) the engine will pass exception within the cmdlet to the script for further handling.

Example

Write-KFLogOutput @{Hello="kenaflow"}

Discussion