4.16.12 Create event for Event log
Function
This plug-in creates an event log event on the Windows execution target server.
This plug-in requires the following server:
- An execution target server
This plug-in will be executed on this server.
The script in this plug-in executes the following processing:
- The following command is executed:
eventcreate
/l event-log-name(value for the Windows.eventLogName property)
/so event-source(value for the Windows.eventSource property)
/t event-type(value for the Windows.eventType property)
/id event-ID(value for the Windows.eventID property)
/d description-of-the-event(value for the Windows.eventDescription property)
For details about the eventcreate command, see the description in the Microsoft library.
Use situation
Used to create a Windows event log event that reports the execution result in another plug-in, for example.
Prerequisites
For the latest support information about [Prerequisite product in the system]/[Prerequisite OS running on the execution target server], see the release notes.
[Prerequisite product in the system]
JP1/Automatic Operation 11-00 or later
[Prerequisite OS running on the execution target server]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
Cautions
(1) For a plug-in property, do not specify a character string that contains a double quotation mark (") or a single quotation mark (').
Execution privilege
(1) The user who connects to the execution server must have the necessary permissions to create an event log event.
Version
02.01.00
Plug-in tags
Configure OS,Windows
Plug-in name displayed in the task log
osEventLogCreateEvent
Return code
0: Normal
21: Error (invalid environment): No command was found. (An error was detected in the plug-in script.)
27: Error (Check the error details from a task log.)
41: Error (error detected in plug-in): Missing property (error detected in plug-in script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
Windows.eventLogName |
Event log name |
Specify the name of an event log. |
-- |
Input |
R |
|
Windows.eventSource |
Event source |
Specify an event source. |
-- |
Input |
R |
|
Windows.eventType |
Event type |
Specify an event type. The valid values are SUCCESS, ERROR, WARNING, and INFORMATION. |
-- |
Input |
R |
|
Windows.eventID |
Event ID |
Specify an event ID between 1 and 1,000. |
-- |
Input |
R |
|
Windows.eventDescription |
Event description |
Specify a description for the event. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |