OSCCPSLogging.Help.xml
|
<?xml version="1.0" encoding="utf-8"?><helpItems schema="maml">
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Close-CMLogging</command:name> <maml:description> <maml:para>This command shuts down the Log4net logmanager and releases any locks on logfiles.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Close</command:verb> <command:noun>CMLogging</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command is a best practice to run at the end of your script when you are done logging. It eliminates situations where the PowerShell host keeps the logfiles locked.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Close-CMLogging</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogObject</maml:name> <maml:description> <maml:para>The logging object as returned by Initialize-CMLogging</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ILog</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogObject</maml:name> <maml:description> <maml:para>The logging object as returned by Initialize-CMLogging</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ILog</command:parameterValue> <dev:type> <maml:name>ILog</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code></dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Close-CMLogging -LogObject $Log</dev:code> <dev:remarks> <maml:para>This example shuts down logging and eliminates any lock the PowerShell host might have on the logfiles.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Initialize-CMLogging</command:name> <maml:description> <maml:para>This CmdLet initializes the module generating a logger object that can be used to create logs based on the Log4Net library. The module allows for the easy creation of logfiles in CMTrace and custom OMS Logging format.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Initialize</command:verb> <command:noun>CMLogging</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Apache log4net library is a tool to help the programmer output log statements to a variety of output targets. log4net is a port of the excellent Apache log4j™ framework to the Microsoft® .NET runtime. We have kept the framework similar in spirit to the original log4j while taking advantage of new features in the .NET runtime. </maml:para> <maml:para>The CMTrace file format is named after a tool (Cmtrace) that cleanly displays these types of logs. The format has support for: •Merge multiple logfiles based on the timestamp of individual log entries •highlight and distinguish info, warning, error and debug log entries This module has some log4net extensions called converters to easily log to the ConfigMgr client log folder or the ConfigMgr admin ui folder, and a converter to correctly set the timezone and logentry importance.</maml:para> <maml:para>For more information on log4net see the features document in the links. •Support for multiple frameworks •Output to multiple logging targets •Hierarchical logging architecture •XML Configuration •Dynamic Configuration •Logging Context •Proven architecture •Modular and extensible design •High performance with flexibility</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-CMLogging</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogFileName</maml:name> <maml:description> <maml:para>Full path including filename to override the Default path (the location of your script with .log appended to the filename) file or the file you specify in your LogConfigFile. This parameter supports the following variables: 1. adminuilog 2. ccmlog Eg: Specifiying the Logfilename as "%adminuilog\myscript.log" wil place the logfile in the adminuilog folder that is created by the installation fo the Configuration Manager adminui. Specifying the Logfilename as "%ccmlog\myscript.log"will place the logfile in the logs folder withing the installation folder of the SCCM Client, typically c:\windows\CCM\Logs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>LogConfigFile</maml:name> <maml:description> <maml:para>Full path including filename to specify your own logging.config file following the log4net syntax.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="2"> <maml:name>FileLogLevel</maml:name> <maml:description> <maml:para>Amount of detail you want in your CMTrace formatted logfile</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="3"> <maml:name>ConsoleLogLevel</maml:name> <maml:description> <maml:para>Amount of detail you want logged to the Console</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="4"> <maml:name>MultiColor</maml:name> <maml:description> <maml:para>Specify whether logging to the console should be done in different colors for the different levels. The Windows PowerShell ISE Host doesn't support multicolor</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="5"> <maml:name>OMSFileLogLevel</maml:name> <maml:description> <maml:para>Amount of detail you want in your CMTrace formatted logfile. Default value is Off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="6"> <maml:name>OMSLogFileName</maml:name> <maml:description> <maml:para>Full path including filename to override the Default path (the location of your script with .OMS %date% .log appended to the filename) file or the file you specify in your LogConfigFile. This parameter supports the following variables: 1. adminuilog 2. ccmlog Eg: Specifiying the Logfilename as "%adminuilog\myscript.log" wil place the logfile in the adminuilog folder that is created by the installation fo the Configuration Manager adminui. Specifying the Logfilename as "%ccmlog\myscript.log"will place the logfile in the logs folder withing the installation folder of the SCCM Client, typically c:\windows\CCM\Logs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogFileName</maml:name> <maml:description> <maml:para>Full path including filename to override the Default path (the location of your script with .log appended to the filename) file or the file you specify in your LogConfigFile. This parameter supports the following variables: 1. adminuilog 2. ccmlog Eg: Specifiying the Logfilename as "%adminuilog\myscript.log" wil place the logfile in the adminuilog folder that is created by the installation fo the Configuration Manager adminui. Specifying the Logfilename as "%ccmlog\myscript.log"will place the logfile in the logs folder withing the installation folder of the SCCM Client, typically c:\windows\CCM\Logs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>ScriptFilePath + ".log"</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>LogConfigFile</maml:name> <maml:description> <maml:para>Full path including filename to specify your own logging.config file following the log4net syntax.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="2"> <maml:name>FileLogLevel</maml:name> <maml:description> <maml:para>Amount of detail you want in your CMTrace formatted logfile</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>Info</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="3"> <maml:name>ConsoleLogLevel</maml:name> <maml:description> <maml:para>Amount of detail you want logged to the Console</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>Info</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="4"> <maml:name>MultiColor</maml:name> <maml:description> <maml:para>Specify whether logging to the console should be done in different colors for the different levels. The Windows PowerShell ISE Host doesn't support multicolor</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>True for ConsoleHost, False for PowerShell ISE host</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="5"> <maml:name>OMSFileLogLevel</maml:name> <maml:description> <maml:para>Amount of detail you want in your CMTrace formatted logfile. Default value is Off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>Off</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="6"> <maml:name>OMSLogFileName</maml:name> <maml:description> <maml:para>Full path including filename to override the Default path (the location of your script with .OMS %date% .log appended to the filename) file or the file you specify in your LogConfigFile. This parameter supports the following variables: 1. adminuilog 2. ccmlog Eg: Specifiying the Logfilename as "%adminuilog\myscript.log" wil place the logfile in the adminuilog folder that is created by the installation fo the Configuration Manager adminui. Specifying the Logfilename as "%ccmlog\myscript.log"will place the logfile in the logs folder withing the installation folder of the SCCM Client, typically c:\windows\CCM\Logs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Please note that the PowerShell ISE host does not support logging in multiple colors depending on the logentry level (info, warn, error debug)</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging Out-LogInfo $log "logging informational message" Out-LogWarn $log "logging warning message" Out-LogError $log "logging error message" Out-LogDebug $log "logging debug message"</dev:code> <dev:remarks> <maml:para>This example uses the most basic initialization. It will log informational messages to both file and console. The log file can be found in $env:temp\osccpslogging.log when executed from either PowerShell consoles. It can be found in your script folder when executed from a PowerShell script.</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-17 22:44:33 220 - INFO - logging informational message 2017-02-17 22:44:33 267 - WARN - logging warning message 2017-02-17 22:44:33 282 - ERROR - logging error message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -ConsoleLogLevel warn Out-LogInfo $log "logging informational message" Out-LogWarn $log "logging warning message" Out-LogError $log "logging error message" Out-LogDebug $log "logging debug message"</dev:code> <dev:remarks> <maml:para>This example initializes the console logging to the warn level. All messages less important than warn will not be logged to the console.</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-17 22:50:08 022 - WARN - logging warning message 2017-02-17 22:50:08 037 - ERROR - logging error message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -ConsoleLogLevel warn -FileLogLevel error Out-LogInfo $log "logging informational message" Out-LogWarn $log "logging warning message" Out-LogError $log "logging error message" Out-LogDebug $log "logging debug message"</dev:code> <dev:remarks> <maml:para>This example initializes the console logging to the warn level. All messages less important than warn will not be logged to the console, messages less important than error will not be logged to the logfile</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-17 22:50:08 022 - WARN - logging warning message 2017-02-17 22:50:08 037 - ERROR - logging error message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -ConsoleLogLevel off -FileLogLevel debug Out-LogInfo $log "logging informational message" Out-LogWarn $log "logging warning message" Out-LogError $log "logging error message" Out-LogDebug $log "logging debug message"</dev:code> <dev:remarks> <maml:para>This example disables logging to the console, and sets debug logging for the log file</maml:para> <maml:para /> <maml:para /> <maml:para>Output -------- None</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -MultiColor $false Out-LogInfo $log "logging informational message" Out-LogWarn $log "logging warning message" Out-LogError $log "logging error message" Out-LogDebug $log "logging debug message"</dev:code> <dev:remarks> <maml:para>This examples disables multi-color logging to the ConsoleHost console.</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-17 22:44:33 220 - INFO - logging informational message 2017-02-17 22:44:33 267 - WARN - logging warning message 2017-02-17 22:44:33 282 - ERROR - logging error message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -LogConfigFile C:\temp\logging.config Out-LogInfo $log "logging informational message" Out-LogWarn $log "logging warning message" Out-LogError $log "logging error message" Out-LogDebug $log "logging debug message"</dev:code> <dev:remarks> <maml:para>This example uses a user specific logging.config file that follows the log4net syntax. Create your own ConversionPattern, alter the colors used in the multi-color format, add new appenders, ....</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging $myVar="trying" $log.InfoFormat("logging informational message and making {0} of {1} substituion.","use","variable") $log.WarnFormat("logging warning message and {0} something new.",$myVar) $log.ErrorFormat("logging error message.") $log.DebugFormat("logging debug message.")</dev:code> <dev:remarks> <maml:para>This examples uses the format methods to use variable subsitution using object methods.</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-17 23:11:34 018 - INFO - logging informational message and making use of variable substituion. 2017-02-17 23:11:34 050 - WARN - logging warning message and trying something new. 2017-02-17 23:11:34 081 - ERROR - logging error message.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 8 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -LogFileName "%ccmlog\myscript.log" Out-LogInfo $log "logging informational message" Out-LogWarn $log "logging warning message" Out-LogError $log "logging error message" Out-LogDebug $log "logging debug message"</dev:code> <dev:remarks> <maml:para>This example logs to console and file. The file myscript.log will be created in the SCCM client installation folder. By default the file would end up in c:\windows\ccm\logs, unless the installation path of the logfile was modified.</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-17 22:44:33 220 - INFO - logging informational message 2017-02-17 22:44:33 267 - WARN - logging warning message 2017-02-17 22:44:33 282 - ERROR - logging error message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 9 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -LogFileName "\\server.domain.local\share\myscript.log" Out-LogInfo $log "logging informational message" Out-LogWarn $log "logging warning message" Out-LogError $log "logging error message" Out-LogDebug $log "logging debug message"</dev:code> <dev:remarks> <maml:para>This example logs to console and file. The file myscript.log will be created in the UNC Path specified</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-17 22:44:33 220 - INFO - logging informational message 2017-02-17 22:44:33 267 - WARN - logging warning message 2017-02-17 22:44:33 282 - ERROR - logging error message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 10 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -OMSLogLevel Out-LogInfo $log "logging informational message" Out-LogWarn $log "logging warning message" Out-LogError $log "logging error message" Out-LogDebug $log "logging debug message"</dev:code> <dev:remarks> <maml:para>This example logs to console and OMS formatted logfile. Logging to the CMtrace formatted log is disabled.</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-17 23:31:25 385 - INFO - logging informational message 2017-02-17 23:31:25 400 - WARN - logging warning message 2017-02-17 23:31:25 400 - ERROR - logging error message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Appache Log4Net Home</maml:linkText> <maml:uri>http://logging.apache.org/log4net/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Log4Net config examples</maml:linkText> <maml:uri>http://logging.apache.org/log4net/release/config-examples.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Log4Net features</maml:linkText> <maml:uri>http://logging.apache.org/log4net/release/features.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Log4Net_Cmtrace(blog)</maml:linkText> <maml:uri>http://www.oscc.be/powershell/Logging-in-PowerShell/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Log4Net_Cmtrace(github)</maml:linkText> <maml:uri>https://github.com/kimoppalfens/Log4NetCMTrace</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText><Link></maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Out-LogDebug</command:name> <maml:description> <maml:para>Creates a log entry with the log entry's importance set to debug</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Out</command:verb> <command:noun>LogDebug</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a log entry with the log entry's importance set to debug, only log outputs that are set to debug level will receive and process these log entries. To process these set ConsoleLevel, FileLogLevel or OMSFileLogLevel to debug</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-LogDebug</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogObject</maml:name> <maml:description> <maml:para>Log4net.Ilog object as generated by $log = Initialize-CMLogging</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ILog</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>LogMessage</maml:name> <maml:description> <maml:para>string text message to write to the log output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogObject</maml:name> <maml:description> <maml:para>Log4net.Ilog object as generated by $log = Initialize-CMLogging</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ILog</command:parameterValue> <dev:type> <maml:name>ILog</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>LogMessage</maml:name> <maml:description> <maml:para>string text message to write to the log output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -consolelevel debug Out-LogDebug -LogObject $log -LogMessage "Logging debug message"</dev:code> <dev:remarks> <maml:para>This example outputs a debug type log entry</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-18 00:14:50 302 - DEBUG - Log debug message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -consolelevel debug Out-LogDebug -LogObject $log -LogMessage "Logging debug message"</dev:code> <dev:remarks> <maml:para>This example outputs a debug type log entry without specifying the parameter names as they are positional</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-18 00:14:50 302 - DEBUG - Log debug message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Out-LogError</command:name> <maml:description> <maml:para>Creates a log entry with the log entry's importance set to error</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Out</command:verb> <command:noun>LogError</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a log entry with the log entry's importance set to error. Only log outputs set to error or debug process error messages</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-LogError</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogObject</maml:name> <maml:description> <maml:para>Log4net.Ilog object as generated by $log = Initialize-CMLogging</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ILog</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>LogMessage</maml:name> <maml:description> <maml:para>string text message to write to the log output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogObject</maml:name> <maml:description> <maml:para>Log4net.Ilog object as generated by $log = Initialize-CMLogging</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ILog</command:parameterValue> <dev:type> <maml:name>ILog</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>LogMessage</maml:name> <maml:description> <maml:para>string text message to write to the log output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -consolelevel error Out-LogError -LogObject $log -LogMessage "Logging error message"</dev:code> <dev:remarks> <maml:para>This example outputs an error type log entry</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-18 00:22:31 330 - ERROR - Logging error message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -consolelevel error Out-LogError $log "Logging error message"</dev:code> <dev:remarks> <maml:para>This example outputs an error type log entry without specifying the parameter names as they are positional</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-18 00:22:31 330 - ERROR - Logging error message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Out-LogInfo</command:name> <maml:description> <maml:para>Creates a log entry with the log entry's importance set to info</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Out</command:verb> <command:noun>LogInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a log entry with the log entry's importance set to info. Log outputs set to info, warn, error or debug process error messages</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-LogInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogObject</maml:name> <maml:description> <maml:para>Log4net.Ilog object as generated by $log = Initialize-CMLogging</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ILog</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>LogMessage</maml:name> <maml:description> <maml:para>string text message to write to the log output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogObject</maml:name> <maml:description> <maml:para>Log4net.Ilog object as generated by $log = Initialize-CMLogging</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ILog</command:parameterValue> <dev:type> <maml:name>ILog</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>LogMessage</maml:name> <maml:description> <maml:para>string text message to write to the log output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -consolelevel info Out-LogInfo -LogObject $log -LogMessage "Logging info message"</dev:code> <dev:remarks> <maml:para>This example outputs an info type log entry</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-18 00:23:12 556 - INFO - Logging info message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -consolelevel info Out-LogInfo $log "Logging info message"</dev:code> <dev:remarks> <maml:para>This example outputs a info type log entry without specifying the parameter names as they are positional</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-18 00:23:12 556 - INFO - Logging info message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Out-LogWarn</command:name> <maml:description> <maml:para>Creates a log entry with the log entry's importance set to warn</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Out</command:verb> <command:noun>LogWarn</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a log entry with the log entry's importance set to warn. Log outputs set to warn, error or debug process error messages</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-LogWarn</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogObject</maml:name> <maml:description> <maml:para>Log4net.Ilog object as generated by $log = Initialize-CMLogging</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ILog</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>LogMessage</maml:name> <maml:description> <maml:para>string text message to write to the log output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>LogObject</maml:name> <maml:description> <maml:para>Log4net.Ilog object as generated by $log = Initialize-CMLogging</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ILog</command:parameterValue> <dev:type> <maml:name>ILog</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>LogMessage</maml:name> <maml:description> <maml:para>string text message to write to the log output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -consolelevel warn Out-LogWarn -LogObject $log -LogMessage "Logging warn message"</dev:code> <dev:remarks> <maml:para>This example outputs a warn type log entry</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-18 00:23:46 994 - WARN - Logging warn message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$log = Initialize-CMLogging -consolelevel warn Out-LogWarn $log "Logging warn message"</dev:code> <dev:remarks> <maml:para>This example outputs a warn type log entry without specifying the parameter names as they are positional</maml:para> <maml:para /> <maml:para /> <maml:para>2017-02-18 00:23:46 994 - WARN - Logging warn message</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> </helpItems> |