< Back

Out-Message

Sun Jan 12, 2020 4:12 pm

NAME Out-Message



SYNOPSIS

Logs a message to default message log target.





SYNTAX

Out-Message [[-Severity] <Int32>] [[-FunctionName] <String>] [[-Message] <String>] [[-Facility] <Int32>]

[<CommonParameters>]





DESCRIPTION

Logs a message to default message log target.



Logs a message in SYSLOG style to a defined autoselected log target in a synchronous way.





PARAMETERS

-Severity <Int32>



Required? false

Position? 1

Default value $(throw("You must specify a severity level."))

Accept pipeline input? false

Accept wildcard characters? false



-FunctionName <String>



Required? false

Position? 2

Default value $((Get-PSCallStack)[0].Command)

Accept pipeline input? false

Accept wildcard characters? false



-Message <String>



Required? false

Position? 3

Default value $((Get-PSCallStack)[0].InvocationInfo.PositionMessage)

Accept pipeline input? false

Accept wildcard characters? false



-Facility <Int32>

A SYSLOG facility. Default LOCAL0 (16).



Required? false

Position? 4

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

This Cmdlet does not return a parameter.





NOTES





This is a wrapper around the Apache 2.0 LOG4NET library.



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Out-Message 16 6 "function-name" "Message string"



Logs a message to with facility := LOCAL0 and severity := Info









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Out-Message 16 6 "function-name" "Message string"



Logs a message to with facility := LOCAL0 and severity := Info









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Out-Message -Facility 16 -Severity 6 -FunctionName "function-name" -Message "Message string"



Logs a message to with facility := LOCAL0 and severity := Informational. Full parameter names are specified.











RELATED LINKS

http://dfch.biz/biz/dfch/PS/System/Logging/Out-Message/





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Out-MessageAlert; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

relatedLinks : @{navigationLink=System.Management.Automation.PSObject[]}

returnValues : @{returnValue=}

aliases : Log-Alert



remarks : Get-Help cannot find the Help files for this cmdlet on this computer. It is displaying only

partial help.

-- To download and install Help files for the module that includes this cmdlet, use

Update-Help.

-- To view the Help topic for this cmdlet online, type: "Get-Help Out-MessageAlert

-Online" or

go to http://dfch.biz/biz/dfch/PS/System/Logg ... sageAlert/.

alertSet :

description :

examples :

Synopsis :

Out-MessageAlert [[-FunctionName] <string>] [[-Message] <string>] [[-Facility] <int>]

[<CommonParameters>]



ModuleName : biz.dfch.PS.System.Logging

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Out-MessageAlert

Category : Function

Component :

Role :

Functionality :





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Out-MessageCritical; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

relatedLinks : @{navigationLink=System.Management.Automation.PSObject[]}

returnValues : @{returnValue=}

aliases : Log-Critical



remarks : Get-Help cannot find the Help files for this cmdlet on this computer. It is displaying only

partial help.

-- To download and install Help files for the module that includes this cmdlet, use

Update-Help.

-- To view the Help topic for this cmdlet online, type: "Get-Help Out-MessageCritical

-Online" or

go to http://dfch.biz/biz/dfch/PS/System/Logg ... eCritical/.

alertSet :

description :

examples :

Synopsis :

Out-MessageCritical [[-FunctionName] <string>] [[-Message] <string>] [[-Facility] <int>]

[<CommonParameters>]



ModuleName : biz.dfch.PS.System.Logging

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Out-MessageCritical

Category : Function

Component :

Role :

Functionality :