Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Invoke-NcEmsAutosupportLog


NAME
Invoke-NcEmsAutosupportLog

SYNOPSIS
This cmdlet is used by applications to log specific events occurring on a ho
st system.

SYNTAX
Invoke-NcEmsAutosupportLog [-ComputerName] <String> [-EventId] <Int64> [-Eve
ntSource] <String> [-AppVersion] <String> [-Category] <String> [-EventDescri
ption] <String> [-LogLevel] <Int32> [-Node <String>] [-Controller <NcControl
ler[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
This cmdlet is used by applications to log specific events occurring on a ho
st system.


PARAMETERS
-ComputerName <String>
Host name invoking the API.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-EventId <Int64>
ID of event.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-EventSource <String>
Name of the application invoking the API.

Required? true
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-AppVersion <String>
Version of application invoking the API.

Required? true
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Category <String>
Application defined category of the event.

Required? true
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-EventDescription <String>
Description of event to log. An application defined message to log.

Required? true
Position? 6
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-LogLevel <Int32>
Log level. Accepted values are 0 for 'emergency', 1 for 'alert', 2 for
'critical', 3 for 'error', 4 for 'warning', 5 for 'notice', 6 for 'info'
, and 7 for 'debug'.

Required? true
Position? 7
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Node <String>
Node to log the EMS message.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NcController[]>
A Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-WhatIf


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS



NOTES


Category: ems
API: ems-autosupport-log
Family: cluster

-------------- Example 1 --------------

C:\PS>Invoke-NcEmsAutosupportLog -ComputerName "host1" -EventId 100 -EventSo
urce "powershell" -AppVersion "2.0" -Category "test" -EventDescription "this
is a test message." -LogLevel 6 -Node fas3070cluster01-01


Log a test EMS log message.






RELATED LINKS







 Data ONTAP® PowerShell Toolkit