File size: 55,105 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections;
using System.Collections.Generic;
using System.ComponentModel; // Win32Exception
using System.Diagnostics; // Eventlog class
using System.Diagnostics.CodeAnalysis;
using System.Management.Automation;
using System.Management.Automation.Internal;
namespace Microsoft.PowerShell.Commands
{
#region GetEventLogCommand
/// <summary>
/// This class implements the Get-EventLog command.
/// </summary>
/// <remarks>
/// The CLR EventLogEntryCollection class has problems with managing
/// rapidly spinning logs (i.e. logs set to "Overwrite" which are
/// rapidly getting new events and discarding old events).
/// In particular, if you enumerate forward
/// EventLogEntryCollection entries = log.Entries;
/// foreach (EventLogEntry entry in entries)
/// it will occasionally skip an entry. Conversely, if you are
/// enumerating backward
/// EventLogEntryCollection entries = log.Entries;
/// int count = entries.Count;
/// for (int i = count-1; i >= 0; i--) {
/// EventLogEntry entry = entries[i];
/// it will occasionally repeat an entry. Accordingly, we enumerate
/// backward and try to leave off the repeated entries.
/// </remarks>
[Cmdlet(VerbsCommon.Get, "EventLog", DefaultParameterSetName = "LogName",
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=113314", RemotingCapability = RemotingCapability.SupportedByCommand)]
[OutputType(typeof(EventLog), typeof(EventLogEntry), typeof(string))]
public sealed class GetEventLogCommand : PSCmdlet
{
#region Parameters
/// <summary>
/// Read eventlog entries from this log.
/// </summary>
[Parameter(Position = 0, Mandatory = true, ParameterSetName = "LogName")]
[Alias("LN")]
public string LogName { get; set; }
/// <summary>
/// Read eventlog entries from this computer.
/// </summary>
[Parameter]
[ValidateNotNullOrEmpty]
[Alias("Cn")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] ComputerName { get; set; } = Array.Empty<string>();
/// <summary>
/// Read only this number of entries.
/// </summary>
[Parameter(ParameterSetName = "LogName")]
[ValidateRange(0, Int32.MaxValue)]
public int Newest { get; set; } = Int32.MaxValue;
/// <summary>
/// Return entries "after " this date.
/// </summary>
[Parameter(ParameterSetName = "LogName")]
[ValidateNotNullOrEmpty]
public DateTime After
{
get { return _after; }
set
{
_after = value;
_isDateSpecified = true;
_isFilterSpecified = true;
}
}
private DateTime _after;
/// <summary>
/// Return entries "Before" this date.
/// </summary>
[Parameter(ParameterSetName = "LogName")]
[ValidateNotNullOrEmpty]
public DateTime Before
{
get { return _before; }
set
{
_before = value;
_isDateSpecified = true;
_isFilterSpecified = true;
}
}
private DateTime _before;
/// <summary>
/// Return entries for this user.Wild characters is supported.
/// </summary>
[Parameter(ParameterSetName = "LogName")]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] UserName
{
get { return _username; }
set
{
_username = value;
_isFilterSpecified = true;
}
}
private string[] _username;
/// <summary>
/// Match eventlog entries by the InstanceIds
/// gets or sets an array of instanceIds.
/// </summary>
[Parameter(Position = 1, ParameterSetName = "LogName")]
[ValidateNotNullOrEmpty]
[ValidateRangeAttribute((long)0, long.MaxValue)]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public long[] InstanceId
{
get { return _instanceIds; }
set
{
_instanceIds = value;
_isFilterSpecified = true;
}
}
private long[] _instanceIds = null;
/// <summary>
/// Match eventlog entries by the Index
/// gets or sets an array of indexes.
/// </summary>
[Parameter(ParameterSetName = "LogName")]
[ValidateNotNullOrEmpty]
[ValidateRangeAttribute((int)1, int.MaxValue)]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public int[] Index
{
get { return _indexes; }
set
{
_indexes = value;
_isFilterSpecified = true;
}
}
private int[] _indexes = null;
/// <summary>
/// Match eventlog entries by the EntryType
/// gets or sets an array of EntryTypes.
/// </summary>
[Parameter(ParameterSetName = "LogName")]
[ValidateNotNullOrEmpty]
[ValidateSetAttribute(new string[] { "Error", "Information", "FailureAudit", "SuccessAudit", "Warning" })]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[Alias("ET")]
public string[] EntryType
{
get { return _entryTypes; }
set
{
_entryTypes = value;
_isFilterSpecified = true;
}
}
private string[] _entryTypes = null;
/// <summary>
/// Get or sets an array of Source.
/// </summary>
[Parameter(ParameterSetName = "LogName")]
[ValidateNotNullOrEmpty]
[Alias("ABO")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] Source
{
get
{ return _sources; }
set
{
_sources = value;
_isFilterSpecified = true;
}
}
private string[] _sources;
/// <summary>
/// Get or Set Message string to searched in EventLog.
/// </summary>
[Parameter(ParameterSetName = "LogName")]
[ValidateNotNullOrEmpty]
[Alias("MSG")]
public string Message
{
get
{
return _message;
}
set
{
_message = value;
_isFilterSpecified = true;
}
}
private string _message;
/// <summary>
/// Returns Log Entry as base object.
/// </summary>
[Parameter(ParameterSetName = "LogName")]
public SwitchParameter AsBaseObject { get; set; }
/// <summary>
/// Return the Eventlog objects rather than the log contents.
/// </summary>
[Parameter(ParameterSetName = "List")]
public SwitchParameter List { get; set; }
/// <summary>
/// Return the log names rather than the EventLog objects.
/// </summary>
[Parameter(ParameterSetName = "List")]
public SwitchParameter AsString
{
get
{
return _asString;
}
set
{
_asString = value;
}
}
private bool _asString /* = false */;
#endregion Parameters
#region Overrides
/// <summary>
/// Sets true when Filter is Specified.
/// </summary>
private bool _isFilterSpecified = false;
private bool _isDateSpecified = false;
private bool _isThrowError = true;
/// <summary>
/// Process the specified logs.
/// </summary>
protected override void BeginProcessing()
{
if (ParameterSetName == "List")
{
if (ComputerName.Length > 0)
{
foreach (string computerName in ComputerName)
{
foreach (EventLog log in EventLog.GetEventLogs(computerName))
{
if (AsString)
WriteObject(log.Log);
else
WriteObject(log);
}
}
}
else
{
foreach (EventLog log in EventLog.GetEventLogs())
{
if (AsString)
WriteObject(log.Log);
else
WriteObject(log);
}
}
}
else
{
Diagnostics.Assert(ParameterSetName == "LogName", "Unexpected parameter set");
if (!WildcardPattern.ContainsWildcardCharacters(LogName))
{
OutputEvents(LogName);
}
else
{
//
// If we were given a wildcard that matches more than one log, output the matching logs. Otherwise output the events in the matching log.
//
List<EventLog> matchingLogs = GetMatchingLogs(LogName);
if (matchingLogs.Count == 1)
{
OutputEvents(matchingLogs[0].Log);
}
else
{
foreach (EventLog log in matchingLogs)
{
WriteObject(log);
}
}
}
}
}
#endregion Overrides
#region Private
private void OutputEvents(string logName)
{
// 2005/04/21-JonN This somewhat odd structure works
// around the FXCOP DisposeObjectsBeforeLosingScope rule.
bool processing = false;
try
{
if (ComputerName.Length == 0)
{
using (EventLog specificLog = new EventLog(logName))
{
processing = true;
Process(specificLog);
}
}
else
{
processing = true;
foreach (string computerName in ComputerName)
{
using (EventLog specificLog = new EventLog(logName, computerName))
{
Process(specificLog);
}
}
}
}
catch (InvalidOperationException e)
{
if (processing)
{
throw;
}
ThrowTerminatingError(new ErrorRecord(
e, // default exception text is OK
"EventLogNotFound",
ErrorCategory.ObjectNotFound,
logName));
}
}
private void Process(EventLog log)
{
bool matchesfound = false;
if (Newest == 0)
{
return;
}
// enumerate backward, skipping repeat entries
EventLogEntryCollection entries = log.Entries;
int count = entries.Count;
int lastindex = Int32.MinValue;
int processed = 0;
for (int i = count - 1; (i >= 0) && (processed < Newest); i--)
{
EventLogEntry entry = null;
try
{
entry = entries[i];
}
catch (ArgumentException e)
{
ErrorRecord er = new ErrorRecord(
e,
"LogReadError",
ErrorCategory.ReadError,
null
);
er.ErrorDetails = new ErrorDetails(
this,
"EventlogResources",
"LogReadError",
log.Log,
e.Message
);
WriteError(er);
// NTRAID#Windows Out Of Band Releases-2005/09/27-JonN
// Break after the first one, rather than repeating this
// over and over
break;
}
catch (Exception e)
{
Diagnostics.Assert(false,
"EventLogEntryCollection error "
+ e.GetType().FullName
+ ": " + e.Message);
throw;
}
if ((entry != null) &&
((lastindex == Int32.MinValue
|| lastindex - entry.Index == 1)))
{
lastindex = entry.Index;
if (_isFilterSpecified)
{
if (!FiltersMatch(entry))
continue;
}
if (!AsBaseObject)
{
// wrapping in PSobject to insert into PStypesnames
PSObject logentry = new PSObject(entry);
// inserting at zero position in reverse order
logentry.TypeNames.Insert(0, logentry.ImmediateBaseObject + "#" + log.Log + "/" + entry.Source);
logentry.TypeNames.Insert(0, logentry.ImmediateBaseObject + "#" + log.Log + "/" + entry.Source + "/" + entry.InstanceId);
WriteObject(logentry);
matchesfound = true;
}
else
{
WriteObject(entry);
matchesfound = true;
}
processed++;
}
}
if (!matchesfound && _isThrowError)
{
Exception Ex = new ArgumentException(StringUtil.Format(EventlogResources.NoEntriesFound, log.Log, string.Empty));
WriteError(new ErrorRecord(Ex, "GetEventLogNoEntriesFound", ErrorCategory.ObjectNotFound, null));
}
}
private bool FiltersMatch(EventLogEntry entry)
{
if (_indexes != null)
{
if (!((IList)_indexes).Contains(entry.Index))
{
return false;
}
}
if (_instanceIds != null)
{
if (!((IList)_instanceIds).Contains(entry.InstanceId))
{
return false;
}
}
if (_entryTypes != null)
{
bool entrymatch = false;
foreach (string type in _entryTypes)
{
if (type.Equals(entry.EntryType.ToString(), StringComparison.OrdinalIgnoreCase))
{
entrymatch = true;
break;
}
}
if (!entrymatch)
{
return entrymatch;
}
}
if (_sources != null)
{
bool sourcematch = false;
foreach (string source in _sources)
{
if (WildcardPattern.ContainsWildcardCharacters(source))
{
_isThrowError = false;
}
WildcardPattern wildcardpattern = WildcardPattern.Get(source, WildcardOptions.IgnoreCase);
if (wildcardpattern.IsMatch(entry.Source))
{
sourcematch = true;
break;
}
}
if (!sourcematch)
{
return sourcematch;
}
}
if (_message != null)
{
if (WildcardPattern.ContainsWildcardCharacters(_message))
{
_isThrowError = false;
}
WildcardPattern wildcardpattern = WildcardPattern.Get(_message, WildcardOptions.IgnoreCase);
if (!wildcardpattern.IsMatch(entry.Message))
{
return false;
}
}
if (_username != null)
{
bool usernamematch = false;
foreach (string user in _username)
{
_isThrowError = false;
if (entry.UserName != null)
{
WildcardPattern wildcardpattern = WildcardPattern.Get(user, WildcardOptions.IgnoreCase);
if (wildcardpattern.IsMatch(entry.UserName))
{
usernamematch = true;
break;
}
}
}
if (!usernamematch)
{
return usernamematch;
}
}
if (_isDateSpecified)
{
_isThrowError = false;
bool datematch = false;
if (!_after.Equals(_initial) && _before.Equals(_initial))
{
if (entry.TimeGenerated > _after)
{
datematch = true;
}
}
else if (!_before.Equals(_initial) && _after.Equals(_initial))
{
if (entry.TimeGenerated < _before)
{
datematch = true;
}
}
else if (!_after.Equals(_initial) && !_before.Equals(_initial))
{
if (_after > _before || _after == _before)
{
if ((entry.TimeGenerated > _after) || (entry.TimeGenerated < _before))
datematch = true;
}
else
{
if ((entry.TimeGenerated > _after) && (entry.TimeGenerated < _before))
{
datematch = true;
}
}
}
if (!datematch)
{
return datematch;
}
}
return true;
}
private List<EventLog> GetMatchingLogs(string pattern)
{
WildcardPattern wildcardPattern = WildcardPattern.Get(pattern, WildcardOptions.IgnoreCase);
List<EventLog> matchingLogs = new List<EventLog>();
if (ComputerName.Length == 0)
{
foreach (EventLog log in EventLog.GetEventLogs())
{
if (wildcardPattern.IsMatch(log.Log))
{
matchingLogs.Add(log);
}
}
}
else
{
foreach (string computerName in ComputerName)
{
foreach (EventLog log in EventLog.GetEventLogs(computerName))
{
if (wildcardPattern.IsMatch(log.Log))
{
matchingLogs.Add(log);
}
}
}
}
return matchingLogs;
}
// private string ErrorBase = "EventlogResources";
private DateTime _initial = new DateTime();
#endregion Private
}
#endregion GetEventLogCommand
#region ClearEventLogCommand
/// <summary>
/// This class implements the Clear-EventLog command.
/// </summary>
[Cmdlet(VerbsCommon.Clear, "EventLog", SupportsShouldProcess = true,
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=135198", RemotingCapability = RemotingCapability.SupportedByCommand)]
public sealed class ClearEventLogCommand : PSCmdlet
{
#region Parameters
/// <summary>
/// Clear these logs.
/// </summary>
[Parameter(Position = 0, Mandatory = true, ValueFromPipelineByPropertyName = true)]
[Alias("LN")]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] LogName { get; set; }
/// <summary>
/// Clear eventlog entries from these Computers.
/// </summary>
[Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[Alias("Cn")]
public string[] ComputerName { get; set; } = { "." };
#endregion Parameters
#region Overrides
/// <summary>
/// Does the processing.
/// </summary>
protected override void BeginProcessing()
{
string computer = string.Empty;
foreach (string compName in ComputerName)
{
if ((compName.Equals("localhost", StringComparison.OrdinalIgnoreCase)) || (compName.Equals(".", StringComparison.OrdinalIgnoreCase)))
{
computer = "localhost";
}
else
{
computer = compName;
}
foreach (string eventString in LogName)
{
try
{
if (!EventLog.Exists(eventString, compName))
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.LogDoesNotExist, eventString, computer)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
continue;
}
if (!ShouldProcess(StringUtil.Format(EventlogResources.ClearEventLogWarning, eventString, computer)))
{
continue;
}
EventLog Log = new EventLog(eventString, compName);
Log.Clear();
}
catch (System.IO.IOException)
{
ErrorRecord er = new ErrorRecord(new System.IO.IOException(StringUtil.Format(EventlogResources.PathDoesNotExist, null, computer)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
continue;
}
catch (Win32Exception)
{
ErrorRecord er = new ErrorRecord(new Win32Exception(StringUtil.Format(EventlogResources.NoAccess, null, computer)), null, ErrorCategory.PermissionDenied, null);
WriteError(er);
continue;
}
catch (InvalidOperationException)
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.OSWritingError)), null, ErrorCategory.ReadError, null);
WriteError(er);
continue;
}
}
}
}
// beginprocessing
#endregion Overrides
}
#endregion ClearEventLogCommand
#region WriteEventLogCommand
/// <summary>
/// This class implements the Write-EventLog command.
/// </summary>
[Cmdlet(VerbsCommunications.Write, "EventLog", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=135281", RemotingCapability = RemotingCapability.SupportedByCommand)]
public sealed class WriteEventLogCommand : PSCmdlet
{
#region Parameters
/// <summary>
/// Write eventlog entries in this log.
/// </summary>
[Parameter(Position = 0, Mandatory = true)]
[Alias("LN")]
[ValidateNotNullOrEmpty]
public string LogName { get; set; }
/// <summary>
/// The source by which the application is registered on the specified computer.
/// </summary>
[Parameter(Position = 1, Mandatory = true)]
[Alias("SRC")]
[ValidateNotNullOrEmpty]
public string Source { get; set; }
/// <summary>
/// String which represents One of the EventLogEntryType values.
/// </summary>
[Parameter(Position = 3)]
[Alias("ET")]
[ValidateNotNullOrEmpty]
[ValidateSetAttribute(new string[] { "Error", "Information", "FailureAudit", "SuccessAudit", "Warning" })]
public EventLogEntryType EntryType { get; set; } = EventLogEntryType.Information;
/// <summary>
/// The application-specific subcategory associated with the message.
/// </summary>
[Parameter]
public Int16 Category { get; set; } = 1;
/// <summary>
/// The application-specific identifier for the event.
/// </summary>
[Parameter(Position = 2, Mandatory = true)]
[Alias("ID", "EID")]
[ValidateNotNullOrEmpty]
[ValidateRange(0, UInt16.MaxValue)]
public Int32 EventId { get; set; }
/// <summary>
/// The message goes here.
/// </summary>
[Parameter(Position = 4, Mandatory = true)]
[Alias("MSG")]
[ValidateNotNullOrEmpty]
[ValidateLength(0, 32766)]
public string Message { get; set; }
/// <summary>
/// Write eventlog entries of this log.
/// </summary>
[Parameter]
[Alias("RD")]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public byte[] RawData { get; set; }
/// <summary>
/// Write eventlog entries of this log.
/// </summary>
[Parameter]
[Alias("CN")]
[ValidateNotNullOrEmpty]
public string ComputerName { get; set; } = ".";
#endregion Parameters
#region private
private void WriteNonTerminatingError(Exception exception, string errorId, string errorMessage,
ErrorCategory category)
{
Exception ex = new Exception(errorMessage, exception);
WriteError(new ErrorRecord(ex, errorId, category, null));
}
#endregion private
#region Overrides
/// <summary>
/// Does the processing.
/// </summary>
protected override void BeginProcessing()
{
string _computerName = string.Empty;
if ((ComputerName.Equals("localhost", StringComparison.OrdinalIgnoreCase)) || (ComputerName.Equals(".", StringComparison.OrdinalIgnoreCase)))
{
_computerName = "localhost";
}
else
{
_computerName = ComputerName;
}
try
{
if (!(EventLog.SourceExists(Source, ComputerName)))
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.SourceDoesNotExist, null, _computerName, Source)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
}
else
{
if (!(EventLog.Exists(LogName, ComputerName)))
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.LogDoesNotExist, LogName, _computerName)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
}
else
{
EventLog _myevent = new EventLog(LogName, ComputerName, Source);
_myevent.WriteEntry(Message, EntryType, EventId, Category, RawData);
}
}
}
catch (ArgumentException ex)
{
WriteNonTerminatingError(ex, ex.Message, ex.Message, ErrorCategory.InvalidOperation);
}
catch (InvalidOperationException ex)
{
WriteNonTerminatingError(ex, "AccessDenied", StringUtil.Format(EventlogResources.AccessDenied, LogName, null, Source), ErrorCategory.PermissionDenied);
}
catch (Win32Exception ex)
{
WriteNonTerminatingError(ex, "OSWritingError", StringUtil.Format(EventlogResources.OSWritingError, null, null, null), ErrorCategory.WriteError);
}
catch (System.IO.IOException ex)
{
WriteNonTerminatingError(ex, "PathDoesNotExist", StringUtil.Format(EventlogResources.PathDoesNotExist, null, ComputerName, null), ErrorCategory.InvalidOperation);
}
}
#endregion Overrides
}
#endregion WriteEventLogCommand
#region LimitEventLogCommand
/// <summary>
/// This class implements the Limit-EventLog command.
/// </summary>
[Cmdlet(VerbsData.Limit, "EventLog", SupportsShouldProcess = true,
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=135227", RemotingCapability = RemotingCapability.SupportedByCommand)]
public sealed class LimitEventLogCommand : PSCmdlet
{
#region Parameters
/// <summary>
/// Limit the properties of this log.
/// </summary>
[Parameter(Position = 0, Mandatory = true)]
[Alias("LN")]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] LogName { get; set; }
/// <summary>
/// Limit eventlog entries of this computer.
/// </summary>
[Parameter]
[Alias("CN")]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] ComputerName { get; set; } = { "." };
/// <summary>
/// Minimum retention days for this log.
/// </summary>
[Parameter]
[Alias("MRD")]
[ValidateNotNullOrEmpty]
[ValidateRange(1, 365)]
public Int32 RetentionDays
{
get { return _retention; }
set
{
_retention = value;
_retentionSpecified = true;
}
}
private Int32 _retention;
private bool _retentionSpecified = false;
/// <summary>
/// Overflow action to be taken.
/// </summary>
[Parameter]
[Alias("OFA")]
[ValidateNotNullOrEmpty]
[ValidateSetAttribute(new string[] { "OverwriteOlder", "OverwriteAsNeeded", "DoNotOverwrite" })]
public System.Diagnostics.OverflowAction OverflowAction
{
get { return _overflowaction; }
set
{
_overflowaction = value;
_overflowSpecified = true;
}
}
private System.Diagnostics.OverflowAction _overflowaction;
private bool _overflowSpecified = false;
/// <summary>
/// Maximum size of this log.
/// </summary>
[Parameter]
[ValidateNotNullOrEmpty]
public Int64 MaximumSize
{
get { return _maximumKilobytes; }
set
{
_maximumKilobytes = value;
_maxkbSpecified = true;
}
}
private Int64 _maximumKilobytes;
private bool _maxkbSpecified = false;
#endregion Parameters
#region private
private void WriteNonTerminatingError(Exception exception, string resourceId, string errorId,
ErrorCategory category, string _logName, string _compName)
{
Exception ex = new Exception(StringUtil.Format(resourceId, _logName, _compName), exception);
WriteError(new ErrorRecord(ex, errorId, category, null));
}
#endregion private
#region Overrides
/// <summary>
/// Does the processing.
/// </summary>
protected override
void
BeginProcessing()
{
string computer = string.Empty;
foreach (string compname in ComputerName)
{
if ((compname.Equals("localhost", StringComparison.OrdinalIgnoreCase)) || (compname.Equals(".", StringComparison.OrdinalIgnoreCase)))
{
computer = "localhost";
}
else
{
computer = compname;
}
foreach (string logname in LogName)
{
try
{
if (!EventLog.Exists(logname, compname))
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.LogDoesNotExist, logname, computer)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
continue;
}
else
{
if (!ShouldProcess(StringUtil.Format(EventlogResources.LimitEventLogWarning, logname, computer)))
{
continue;
}
else
{
EventLog newLog = new EventLog(logname, compname);
int _minRetention = newLog.MinimumRetentionDays;
System.Diagnostics.OverflowAction _newFlowAction = newLog.OverflowAction;
if (_retentionSpecified && _overflowSpecified)
{
if (_overflowaction.CompareTo(System.Diagnostics.OverflowAction.OverwriteOlder) == 0)
{
newLog.ModifyOverflowPolicy(_overflowaction, _retention);
}
else
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.InvalidOverflowAction)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
continue;
}
}
else if (_retentionSpecified && !_overflowSpecified)
{
if (_newFlowAction.CompareTo(System.Diagnostics.OverflowAction.OverwriteOlder) == 0)
{
newLog.ModifyOverflowPolicy(_newFlowAction, _retention);
}
else
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.InvalidOverflowAction)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
continue;
}
}
else if (!_retentionSpecified && _overflowSpecified)
{
newLog.ModifyOverflowPolicy(_overflowaction, _minRetention);
}
if (_maxkbSpecified)
{
int kiloByte = 1024;
_maximumKilobytes = _maximumKilobytes / kiloByte;
newLog.MaximumKilobytes = _maximumKilobytes;
}
}
}
}
catch (InvalidOperationException ex)
{
WriteNonTerminatingError(ex, EventlogResources.PermissionDenied, "PermissionDenied", ErrorCategory.PermissionDenied, logname, computer);
continue;
}
catch (System.IO.IOException ex)
{
WriteNonTerminatingError(ex, EventlogResources.PathDoesNotExist, "PathDoesNotExist", ErrorCategory.InvalidOperation, null, computer);
continue;
}
catch (ArgumentOutOfRangeException ex)
{
if (!_retentionSpecified && !_maxkbSpecified)
{
WriteNonTerminatingError(ex, EventlogResources.InvalidArgument, "InvalidArgument", ErrorCategory.InvalidData, null, null);
}
else
{
WriteNonTerminatingError(ex, EventlogResources.ValueOutofRange, "ValueOutofRange", ErrorCategory.InvalidData, null, null);
}
continue;
}
}
}
}
#endregion override
}
#endregion LimitEventLogCommand
#region ShowEventLogCommand
/// <summary>
/// This class implements the Show-EventLog command.
/// </summary>
[Cmdlet(VerbsCommon.Show, "EventLog", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=135257", RemotingCapability = RemotingCapability.SupportedByCommand)]
public sealed class ShowEventLogCommand : PSCmdlet
{
#region Parameters
/// <summary>
/// Show eventviewer of this computer.
/// </summary>
[Parameter(Position = 0)]
[Alias("CN")]
[ValidateNotNullOrEmpty]
public string ComputerName { get; set; } = ".";
#endregion Parameters
#region Overrides
/// <summary>
/// Does the processing.
/// </summary>
protected override
void
BeginProcessing()
{
try
{
string eventVwrExe = System.IO.Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.System),
"eventvwr.exe");
Process.Start(eventVwrExe, ComputerName);
}
catch (Win32Exception e)
{
if (e.NativeErrorCode.Equals(0x00000002))
{
string message = StringUtil.Format(EventlogResources.NotSupported);
InvalidOperationException ex = new InvalidOperationException(message);
ErrorRecord er = new ErrorRecord(ex, "Win32Exception", ErrorCategory.InvalidOperation, null);
WriteError(er);
}
else
{
ErrorRecord er = new ErrorRecord(e, "Win32Exception", ErrorCategory.InvalidArgument, null);
WriteError(er);
}
}
catch (SystemException ex)
{
ErrorRecord er = new ErrorRecord(ex, "InvalidComputerName", ErrorCategory.InvalidArgument, ComputerName);
WriteError(er);
}
}
#endregion override
}
#endregion ShowEventLogCommand
#region NewEventLogCommand
/// <summary>
/// This cmdlet creates the new event log .This cmdlet can also be used to
/// configure a new source for writing entries to an event log on the local
/// computer or a remote computer.
/// You can create an event source for an existing event log or a new event log.
/// When you create a new source for a new event log, the system registers the
/// source for that log, but the log is not created until the first entry is
/// written to it.
/// The operating system stores event logs as files. The associated file is
/// stored in the %SystemRoot%\System32\Config directory on the specified
/// computer. The file name is set by appending the first 8 characters of the
/// Log property with the ".evt" file name extension.
/// You can register the event source with localized resource file(s) for your
/// event category and message strings. Your application can write event log
/// entries using resource identifiers, rather than specifying the actual
/// string. You can register a separate file for event categories, messages and
/// parameter insertion strings, or you can register the same resource file for
/// all three types of strings.
/// </summary>
[Cmdlet(VerbsCommon.New, "EventLog", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=135235", RemotingCapability = RemotingCapability.SupportedByCommand)]
public class NewEventLogCommand : PSCmdlet
{
#region Parameter
/// <summary>
/// The following is the definition of the input parameter "CategoryResourceFile".
/// Specifies the path of the resource file that contains category strings for
/// the source
/// Resource File is expected to be present in Local/Remote Machines.
/// </summary>
[Parameter]
[ValidateNotNullOrEmpty]
[Alias("CRF")]
public string CategoryResourceFile { get; set; }
/// <summary>
/// The following is the definition of the input parameter "ComputerName".
/// Specify the Computer Name. The default is local computer.
/// </summary>
[Parameter(Position = 2)]
[ValidateNotNullOrEmpty]
[Alias("CN")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] ComputerName { get; set; } = { "." };
/// <summary>
/// The following is the definition of the input parameter "LogName".
/// Specifies the name of the log.
/// </summary>
[Parameter(Mandatory = true,
Position = 0)]
[ValidateNotNullOrEmpty]
[Alias("LN")]
public string LogName { get; set; }
/// <summary>
/// The following is the definition of the input parameter "MessageResourceFile".
/// Specifies the path of the message resource file that contains message
/// formatting strings for the source
/// Resource File is expected to be present in Local/Remote Machines.
/// </summary>
[Parameter]
[ValidateNotNullOrEmpty]
[Alias("MRF")]
public string MessageResourceFile { get; set; }
/// <summary>
/// The following is the definition of the input parameter "ParameterResourceFile".
/// Specifies the path of the resource file that contains message parameter
/// strings for the source
/// Resource File is expected to be present in Local/Remote Machines.
/// </summary>
[Parameter]
[ValidateNotNullOrEmpty]
[Alias("PRF")]
public string ParameterResourceFile { get; set; }
/// <summary>
/// The following is the definition of the input parameter "Source".
/// Specifies the Source of the EventLog.
/// </summary>
[Parameter(Mandatory = true,
Position = 1)]
[ValidateNotNullOrEmpty]
[Alias("SRC")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] Source { get; set; }
#endregion Parameter
#region private
private void WriteNonTerminatingError(Exception exception, string resourceId, string errorId,
ErrorCategory category, string _logName, string _compName, string _source, string _resourceFile)
{
Exception ex = new Exception(StringUtil.Format(resourceId, _logName, _compName, _source, _resourceFile), exception);
WriteError(new ErrorRecord(ex, errorId, category, null));
}
#endregion private
#region override
/// <summary>
/// BeginProcessing method.
/// </summary>
protected override void BeginProcessing()
{
string computer = string.Empty;
foreach (string compname in ComputerName)
{
if ((compname.Equals("localhost", StringComparison.OrdinalIgnoreCase)) || (compname.Equals(".", StringComparison.OrdinalIgnoreCase)))
{
computer = "localhost";
}
else
{
computer = compname;
}
try
{
foreach (string _sourceName in Source)
{
if (!EventLog.SourceExists(_sourceName, compname))
{
EventSourceCreationData newEventSource = new EventSourceCreationData(_sourceName, LogName);
newEventSource.MachineName = compname;
if (!string.IsNullOrEmpty(MessageResourceFile))
newEventSource.MessageResourceFile = MessageResourceFile;
if (!string.IsNullOrEmpty(ParameterResourceFile))
newEventSource.ParameterResourceFile = ParameterResourceFile;
if (!string.IsNullOrEmpty(CategoryResourceFile))
newEventSource.CategoryResourceFile = CategoryResourceFile;
EventLog.CreateEventSource(newEventSource);
}
else
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.SourceExistInComp, null, computer, _sourceName)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
continue;
}
}
}
catch (InvalidOperationException ex)
{
WriteNonTerminatingError(ex, EventlogResources.PermissionDenied, "PermissionDenied", ErrorCategory.PermissionDenied, LogName, computer, null, null);
continue;
}
catch (ArgumentException ex)
{
ErrorRecord er = new ErrorRecord(ex, "NewEventlogException", ErrorCategory.InvalidArgument, null);
WriteError(er);
continue;
}
catch (System.Security.SecurityException ex)
{
WriteNonTerminatingError(ex, EventlogResources.AccessIsDenied, "AccessIsDenied", ErrorCategory.InvalidOperation, null, null, null, null);
continue;
}
}
}
// End BeginProcessing()
#endregion override
}
#endregion NewEventLogCommand
#region RemoveEventLogCommand
/// <summary>
/// This cmdlet is used to delete the specified event log from the specified
/// computer. This can also be used to Clear the entries of the specified event
/// log and also to unregister the Source associated with the eventlog.
/// </summary>
[Cmdlet(VerbsCommon.Remove, "EventLog",
SupportsShouldProcess = true, DefaultParameterSetName = "Default",
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=135248", RemotingCapability = RemotingCapability.SupportedByCommand)]
public class RemoveEventLogCommand : PSCmdlet
{
/// <summary>
/// The following is the definition of the input parameter "ComputerName".
/// Specifies the Computer Name.
/// </summary>
[Parameter(Position = 1)]
[ValidateNotNull]
[ValidateNotNullOrEmpty]
[Alias("CN")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] ComputerName { get; set; } = { "." };
/// <summary>
/// The following is the definition of the input parameter "LogName".
/// Specifies the Event Log Name.
/// </summary>
[Parameter(Mandatory = true,
Position = 0, ParameterSetName = "Default")]
[ValidateNotNull]
[ValidateNotNullOrEmpty]
[Alias("LN")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] LogName { get; set; }
/// <summary>
/// The following is the definition of the input parameter "RemoveSource".
/// Specifies either to remove the event log and associated source or
/// source. alone.
/// When this parameter is not specified, the cmdlet uses Delete Method which
/// clears the eventlog and also the source associated with it.
/// When this parameter value is true, then this cmdlet uses DeleteEventSource
/// Method to delete the Source alone.
/// </summary>
[Parameter(ParameterSetName = "Source")]
[ValidateNotNull]
[ValidateNotNullOrEmpty]
[Alias("SRC")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] Source { get; set; }
/// <summary>
/// BeginProcessing method.
/// </summary>
protected override void BeginProcessing()
{
try
{
string computer = string.Empty;
foreach (string compName in ComputerName)
{
if ((compName.Equals("localhost", StringComparison.OrdinalIgnoreCase)) || (compName.Equals(".", StringComparison.OrdinalIgnoreCase)))
{
computer = "localhost";
}
else
{
computer = compName;
}
if (ParameterSetName.Equals("Default"))
{
foreach (string log in LogName)
{
try
{
if (EventLog.Exists(log, compName))
{
if (!ShouldProcess(StringUtil.Format(EventlogResources.RemoveEventLogWarning, log, computer)))
{
continue;
}
EventLog.Delete(log, compName);
}
else
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.LogDoesNotExist, log, computer)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
continue;
}
}
catch (System.IO.IOException)
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.PathDoesNotExist, null, computer)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
continue;
}
}
}
else
{
foreach (string src in Source)
{
try
{
if (EventLog.SourceExists(src, compName))
{
if (!ShouldProcess(StringUtil.Format(EventlogResources.RemoveSourceWarning, src, computer)))
{
continue;
}
EventLog.DeleteEventSource(src, compName);
}
else
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.SourceDoesNotExist, string.Empty, computer, src)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
continue;
}
}
catch (System.IO.IOException)
{
ErrorRecord er = new ErrorRecord(new InvalidOperationException(StringUtil.Format(EventlogResources.PathDoesNotExist, null, computer)), null, ErrorCategory.InvalidOperation, null);
WriteError(er);
continue;
}
}
}
}
}
catch (System.Security.SecurityException ex)
{
ErrorRecord er = new ErrorRecord(ex, "NewEventlogException", ErrorCategory.SecurityError, null);
WriteError(er);
}
}
}
#endregion RemoveEventLogCommand
}
|