en-US/LogInsight-Help.xml

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
<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml">
<!--Edited with: SAPIEN PowerShell HelpWriter 2015 v1.0.16-->
<!--Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16-->
<!--
Module:  LogInsight
Version: 1.0
-->
<!--All Commands-->
<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">
<!--Command-->
<command:details>
<command:name>ConvertTo-hLogInsightJsonDateTime</command:name>
<maml:description>
<maml:para/>
</maml:description>
<maml:copyright>
<maml:para/>
</maml:copyright>
<command:verb>ConvertTo</command:verb>
<command:noun>hLogInsightJsonDateTime</command:noun>
<dev:version/>
</command:details>
<maml:description>
<maml:para/>
</maml:description>
<command:syntax>
<!--Parameter Sets-->
<command:syntaxItem>
<maml:name>ConvertTo-hLogInsightJsonDateTime</maml:name>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<!--All Parameters-->
</command:parameters>
</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">
<!--Command-->
<command:details>
<command:name>ConvertFrom-hLogInsightJsonDateTime</command:name>
<maml:description>
<maml:para/>
</maml:description>
<maml:copyright>
<maml:para/>
</maml:copyright>
<command:verb>ConvertFrom</command:verb>
<command:noun>hLogInsightJsonDateTime</command:noun>
<dev:version/>
</command:details>
<maml:description>
<maml:para/>
</maml:description>
<command:syntax>
<!--Parameter Sets-->
<command:syntaxItem>
<maml:name>ConvertFrom-hLogInsightJsonDateTime</maml:name>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<!--All Parameters-->
</command:parameters>
</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">
<!--Command-->
<command:details>
<command:name>Convert-hLogInsightTimeField</command:name>
<maml:description>
<maml:para/>
</maml:description>
<maml:copyright>
<maml:para/>
</maml:copyright>
<command:verb>Convert</command:verb>
<command:noun>hLogInsightTimeField</command:noun>
<dev:version/>
</command:details>
<maml:description>
<maml:para/>
</maml:description>
<command:syntax>
<!--Parameter Sets-->
<command:syntaxItem>
<maml:name>Convert-hLogInsightTimeField</maml:name>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<!--All Parameters-->
</command:parameters>
</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">
<!--Command-->
<command:details>
<command:name>Invoke-hLogInsightRest</command:name>
<maml:description>
<maml:para/>
</maml:description>
<maml:copyright>
<maml:para/>
</maml:copyright>
<command:verb>Invoke</command:verb>
<command:noun>hLogInsightRest</command:noun>
<dev:version/>
</command:details>
<maml:description>
<maml:para/>
</maml:description>
<command:syntax>
<!--Parameter Sets-->
<command:syntaxItem>
<maml:name>Invoke-hLogInsightRest</maml:name>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<!--All Parameters-->
</command:parameters>
</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">
<!--Command-->
<command:details>
<command:name>Connect-LogInsight</command:name>
<maml:description>
<maml:para>Connect to a Log Insight server</maml:para>
</maml:description>
<maml:copyright>
<maml:para/>
</maml:copyright>
<command:verb>Connect</command:verb>
<command:noun>LogInsight</command:noun>
<dev:version/>
</command:details>
<maml:description>
<maml:para>The cmdlet opens a connection to a Log Insight server.
All communication to the Log Insight server will occur over HTTPS.
The Log Insight server information (hostname, session authentication) will be stored in the Script scope.</maml:para>
</maml:description>
<command:syntax>
<!--Parameter Sets-->
<command:syntaxItem>
<maml:name>Connect-LogInsight</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Server</maml:name>
<maml:description>
<maml:para>The Log Insight server.
Can be an IP address or a FQDN</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
<maml:name>Credential</maml:name>
<maml:description>
<maml:para>The credential to access the Log Insight server.
The credential needs at least the &quot;User&quot; role on the Log Insight server</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Proxy</maml:name>
<maml:description>
<maml:para>The proxy, if required, through which communication to the Log Insight server shall run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Fiddler</maml:name>
<maml:description>
<maml:para>Hidden parameter for debugging purposes.
If this switch is set and if Fiddler is running, all communication to the Log Insight server will pass through the
Fiddler proxy. And thus allow inspection of the packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Connect-LogInsight</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Server</maml:name>
<maml:description>
<maml:para>The Log Insight server.
Can be an IP address or a FQDN</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>User</maml:name>
<maml:description>
<maml:para>The username to access the Log Insight server.
The credential needs at least the &quot;User&quot; role on the Log Insight server</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Password</maml:name>
<maml:description>
<maml:para>The password for the user to access the Log Insight server.
The credential needs at least the &quot;User&quot; role on the Log Insight server</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Proxy</maml:name>
<maml:description>
<maml:para>The proxy, if required, through which communication to the Log Insight server shall run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Fiddler</maml:name>
<maml:description>
<maml:para>Hidden parameter for debugging purposes.
If this switch is set and if Fiddler is running, all communication to the Log Insight server will pass through the
Fiddler proxy. And thus allow inspection of the packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<!--All Parameters-->
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Server</maml:name>
<maml:description>
<maml:para>The Log Insight server.
Can be an IP address or a FQDN</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/>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named">
<maml:name>Credential</maml:name>
<maml:description>
<maml:para>The credential to access the Log Insight server.
The credential needs at least the &quot;User&quot; role on the Log Insight server</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>
<dev:type>
<maml:name>PSCredential</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue/>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Proxy</maml:name>
<maml:description>
<maml:para>The proxy, if required, through which communication to the Log Insight server shall run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue/>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Fiddler</maml:name>
<maml:description>
<maml:para>Hidden parameter for debugging purposes.
If this switch is set and if Fiddler is running, all communication to the Log Insight server will pass through the
Fiddler proxy. And thus allow inspection of the packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue/>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>User</maml:name>
<maml:description>
<maml:para>The username to access the Log Insight server.
The credential needs at least the &quot;User&quot; role on the Log Insight server</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/>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Password</maml:name>
<maml:description>
<maml:para>The password for the user to access the Log Insight server.
The credential needs at least the &quot;User&quot; role on the Log Insight server</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/>
</command:parameter>
</command:parameters>
<command:inputTypes>
<!--Inputs-->
<command:inputType>
<dev:type>
<maml:name>System.Management.Automation.PSCredential</maml:name>
<maml:uri/>
</dev:type>
<maml:description>
<maml:para/>
<maml:para/>
<maml:para/>
<maml:para/>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:examples>
<!--Examples-->
<command:example>
<maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
<maml:introduction>
<maml:para>PS C:\&gt;</maml:para>
</maml:introduction>
<dev:code>Connect-LogInsight -Server loginsight.local.lab -Credential $cred</dev:code>
<dev:remarks>
<maml:para>Establish a connection to the Log Insight server with the credentials in the variable $cred.</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
<maml:introduction>
<maml:para>PS C:\&gt;</maml:para>
</maml:introduction>
<dev:code>Connect-LogInsight -Server loginsight.local.lab -Credential $cred -Proxy myproxy.local.lab</dev:code>
<dev:remarks>
<maml:para>Establish a connection to the Log Insight server with the credentials in the variable $cred.
All traffic to the Log Insight server will pass over the proxy server at myproxy.local.lab</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<maml:relatedLinks>
<!--Links-->
<maml:navigationLink>
<maml:linkText>Fiddler</maml:linkText>
<maml:uri>http://www.telerik.com/fiddler</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>vRealize Log Insight</maml:linkText>
<maml:uri>https://www.vmware.com/products/vrealize-log-insight</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">
<!--Command-->
<command:details>
<command:name>Get-LogInsightEvent</command:name>
<maml:description>
<maml:para>Retrieve Events from the Log INsight server</maml:para>
</maml:description>
<maml:copyright>
<maml:para/>
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>LogInsightEvent</command:noun>
<dev:version/>
</command:details>
<maml:description>
<maml:para>The cmdlet uses the Log Insight Query API to retrieve events from the Log Insight server.
The cmdlet can retrieve actual &#39;events&#39; or &#39;aggregated events&#39;, also called &#39;bins&#39;.</maml:para>
</maml:description>
<command:syntax>
<!--Parameter Sets-->
<command:syntaxItem>
<maml:name>Get-LogInsightEvent</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Constraint</maml:name>
<maml:description>
<maml:para>An array with constraints.
A constraint is a condition to which the returned events have to comply.
See Get-LogInsightConstraint</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Event</maml:name>
<maml:description>
<maml:para>A switch that indicates that Events shall be returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Limit</maml:name>
<maml:description>
<maml:para>The maximum number of events or aggregated events that can be returned.
For events (Event) the maximum is 20000.
For aggregated events (Aggregate) the maximum is 2000</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Timeout</maml:name>
<maml:description>
<maml:para>A timeout, in milliseconds, for the query.
If the query didn&#39;t complete within the timeout interval, the returned object&#39;s Complete property will be $false.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Raw</maml:name>
<maml:description>
<maml:para>Hidden switch for debugging purposes.
If this switch is set, all DateTime values in the returned objects will be in the JSON DateTime format (Unix Epoch).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Get-LogInsightEvent</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Constraint</maml:name>
<maml:description>
<maml:para>An array with constraints.
A constraint is a condition to which the returned events have to comply.
See Get-LogInsightConstraint</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Aggregate</maml:name>
<maml:description>
<maml:para>A switch that indicates that aggregated events, also called bins, will be returned.
When aggregated events are selected, additional aggregate related parameters are available.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Limit</maml:name>
<maml:description>
<maml:para>The maximum number of events or aggregated events that can be returned.
For events (Event) the maximum is 20000.
For aggregated events (Aggregate) the maximum is 2000</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Timeout</maml:name>
<maml:description>
<maml:para>A timeout, in milliseconds, for the query.
If the query didn&#39;t complete within the timeout interval, the returned object&#39;s Complete property will be $false.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>BinWidth</maml:name>
<maml:description>
<maml:para>The time interval for a bin.
By default aggregated events are collected in 5 second intervals.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Function</maml:name>
<maml:description>
<maml:para>A function that will be applied to the aggregated events.
The available functions are

COUNT: The count of the events in each bin is returned

SAMPLE: An arbitrary event from each bin is returned

UCOUNT: The count of unique values in the bin

MIN: The minimum value in the bin

MAX: The maximum value in the bin

SUM: The sum of the values in the bin

STDEV: The standard deviation of the values in the bin

VARIANCE: The variance of the values in the bin</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Raw</maml:name>
<maml:description>
<maml:para>Hidden switch for debugging purposes.
If this switch is set, all DateTime values in the returned objects will be in the JSON DateTime format (Unix Epoch).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<!--All Parameters-->
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Constraint</maml:name>
<maml:description>
<maml:para>An array with constraints.
A constraint is a condition to which the returned events have to comply.
See Get-LogInsightConstraint</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue/>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Event</maml:name>
<maml:description>
<maml:para>A switch that indicates that Events shall be returned.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue/>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Limit</maml:name>
<maml:description>
<maml:para>The maximum number of events or aggregated events that can be returned.
For events (Event) the maximum is 20000.
For aggregated events (Aggregate) the maximum is 2000</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue>100 events</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Timeout</maml:name>
<maml:description>
<maml:para>A timeout, in milliseconds, for the query.
If the query didn&#39;t complete within the timeout interval, the returned object&#39;s Complete property will be $false.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue>30 seconds</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Raw</maml:name>
<maml:description>
<maml:para>Hidden switch for debugging purposes.
If this switch is set, all DateTime values in the returned objects will be in the JSON DateTime format (Unix Epoch).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue/>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Aggregate</maml:name>
<maml:description>
<maml:para>A switch that indicates that aggregated events, also called bins, will be returned.
When aggregated events are selected, additional aggregate related parameters are available.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue/>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>BinWidth</maml:name>
<maml:description>
<maml:para>The time interval for a bin.
By default aggregated events are collected in 5 second intervals.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue>5000</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
<maml:name>Function</maml:name>
<maml:description>
<maml:para>A function that will be applied to the aggregated events.
The available functions are

COUNT: The count of the events in each bin is returned

SAMPLE: An arbitrary event from each bin is returned

UCOUNT: The count of unique values in the bin

MIN: The minimum value in the bin

MAX: The maximum value in the bin

SUM: The sum of the values in the bin

STDEV: The standard deviation of the values in the bin

VARIANCE: The variance of the values in the bin</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue>COUNT</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<!--Inputs-->
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri/>
</dev:type>
<maml:description>
<maml:para/>
<maml:para/>
<maml:para/>
<maml:para/>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<!--Outputs-->
<command:returnValue>
<dev:type>
<maml:name>System.Object</maml:name>
<maml:uri/>
</dev:type>
<maml:description>
<maml:para/>
<maml:para/>
<maml:para/>
<maml:para/>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:examples>
<!--Examples-->
<command:example>
<maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
<maml:introduction>
<maml:para>PS C:\&gt;</maml:para>
</maml:introduction>
<dev:code>Get-LogInsightEvent -Event</dev:code>
<dev:remarks>
<maml:para>This will return 100 events from the last minute</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
<maml:introduction>
<maml:para>PS C:\&gt;</maml:para>
</maml:introduction>
<dev:code>Get-LogInsightEvent -Aggregate -Function SAMPLE -BinWidth 60000</dev:code>
<dev:remarks>
<maml:para>Returns aggregated events in bins.
Each bin has a 60 second width, and for each bin there will a random sample event included</maml:para>
</dev:remarks>
</command:example>
</command:examples>
</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">
<!--Command-->
<command:details>
<command:name>Get-LogInsightConstraint</command:name>
<maml:description>
<maml:para>Create a constraint</maml:para>
</maml:description>
<maml:copyright>
<maml:para/>
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>LogInsightConstraint</command:noun>
<dev:version/>
</command:details>
<maml:description>
<maml:para>Create a constraint that can be used on the Constraint parameter of the Get-LogInsightEvent cmdlet.
Constraints are basically filters that allow you to specify which events are returned.

If you specify multiple constraints, they are OR-ed together.
If you specify multiple constraints on the same field, those constraints are AND-ed together.</maml:para>
</maml:description>
<command:syntax>
<!--Parameter Sets-->
<command:syntaxItem>
<maml:name>Get-LogInsightConstraint</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0">
<maml:name>Field</maml:name>
<maml:description>
<maml:para>This defines on which property of the event the constraint will be applied.
These fields can be:
text or timestamp

Any static field
A field defined in a content pack (see also ContentPack)</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">
<maml:name>Operator</maml:name>
<maml:description>
<maml:para>The &#39;operation&#39; that will be applied on the Field.
Operators can be numeric, string or DateTime operators, or a test for the existance of a spcific field.

Numeric operators can be applied to fields that contain numbers
The &#39;numeric&#39; operators are
=  the &#39;equals&#39; operator
!= the &#39;not-equals&#39; operator
&lt;  the &#39;less-than&#39; operator
&lt;= the &#39;less-than-or-equals&#39; operator
&gt;  the &#39;larger-than&#39; operator
&gt;= the &#39;larger-than-or-equals&#39; operator

String operators are case-insensitive filters that can be applied
 to text fields
The &#39;string&#39; operators are
CONTAINS          checks if a text field contains a value
NOT_CONTAINS      checks if a text field does not contain a value
HAS               checks if a field contains every white-space delimited
 token in the value
NOT_HAS           checks if a text field does not contain all of the tokens in the value
MATCHES_REGEX     checks if a text field matches a regular expression
NOT_MATCHES_REGEX checks if a text field does not match a regular expression

For a DateTime field the LAST operator selects a time range in milliseconds relative to the current time.

The test for the existance of a field uses the EXISTS operator. For this constraint there is no Value parameter.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">
<maml:name>Value</maml:name>
<maml:description>
<maml:para>The Value that is used to select the events.
This combines with the Field and Operator parameters.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<!--All Parameters-->
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0">
<maml:name>Field</maml:name>
<maml:description>
<maml:para>This defines on which property of the event the constraint will be applied.
These fields can be:
text or timestamp

Any static field
A field defined in a content pack (see also ContentPack)</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue/>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">
<maml:name>Operator</maml:name>
<maml:description>
<maml:para>The &#39;operation&#39; that will be applied on the Field.
Operators can be numeric, string or DateTime operators, or a test for the existance of a spcific field.

Numeric operators can be applied to fields that contain numbers
The &#39;numeric&#39; operators are
=  the &#39;equals&#39; operator
!= the &#39;not-equals&#39; operator
&lt;  the &#39;less-than&#39; operator
&lt;= the &#39;less-than-or-equals&#39; operator
&gt;  the &#39;larger-than&#39; operator
&gt;= the &#39;larger-than-or-equals&#39; operator

String operators are case-insensitive filters that can be applied
 to text fields
The &#39;string&#39; operators are
CONTAINS          checks if a text field contains a value
NOT_CONTAINS      checks if a text field does not contain a value
HAS               checks if a field contains every white-space delimited
 token in the value
NOT_HAS           checks if a text field does not contain all of the tokens in the value
MATCHES_REGEX     checks if a text field matches a regular expression
NOT_MATCHES_REGEX checks if a text field does not match a regular expression

For a DateTime field the LAST operator selects a time range in milliseconds relative to the current time.

The test for the existance of a field uses the EXISTS operator. For this constraint there is no Value parameter.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue/>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">
<maml:name>Value</maml:name>
<maml:description>
<maml:para>The Value that is used to select the events.
This combines with the Field and Operator parameters.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue>
<dev:type>
<maml:name>PSObject</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue/>
</command:parameter>
</command:parameters>
<command:inputTypes>
<!--Inputs-->
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri/>
</dev:type>
<maml:description>
<maml:para/>
<maml:para/>
<maml:para/>
<maml:para/>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<!--Outputs-->
<command:returnValue>
<dev:type>
<maml:name>System.Object</maml:name>
<maml:uri/>
</dev:type>
<maml:description>
<maml:para/>
<maml:para/>
<maml:para/>
<maml:para/>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:examples>
<!--Examples-->
<command:example>
<maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
<maml:introduction>
<maml:para>PS C:\&gt;</maml:para>
</maml:introduction>
<dev:code>Get-LogInsightConstraint -Field &#39;text&#39; -Operator CONTAINS -Value &#39;error&#39;</dev:code>
<dev:remarks>
<maml:para>All events where the text field contains the text &apos;error&apos;</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
<maml:introduction>
<maml:para>PS C:\&gt;</maml:para>
</maml:introduction>
<dev:code>Get-LogInsightConstraint -Field &apos;timestamp&apos; -Operator GE -Value (Get-Date).AddHours(-1)</dev:code>
<dev:remarks>
<maml:para>Creates a constraint the says all events with a timestamp in the last hour</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>
<maml:introduction>
<maml:para>PS C:\&gt;</maml:para>
</maml:introduction>
<dev:code>$constraint = (Get-LogInsightConstraint -Field &apos;timestamp&apos; -Operator GE -Value $start),
    (Get-LogInsightConstraint -Field &apos;timestamp&apos; -Operator LT -Value $start.AddMinutes(10))</dev:code>
<dev:remarks>
<maml:para>These constraints are for the same field, the constraints will be AND-ed together.
The combination of both will create a constraint that will collect events from the point in time in $start, and that for an interval of 10 minutes.</maml:para>
</dev:remarks>
</command:example>
</command:examples>
</command:command>
<!--Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16-->
</helpItems>