en-US/CQDPowerShell-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
<?xml version="1.0" encoding="utf-8"?><helpItems schema="maml">
<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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<!--Generated by PS Cmdlet Help Editor-->
    <command:details>
        <command:name>Get-CQDData</command:name>
        <maml:description>
            <maml:para />
        </maml:description>
        <maml:copyright>
            <maml:para />
        </maml:copyright>
        <command:verb>Get</command:verb>
        <command:noun>CQDData</command:noun>
        <dev:version />
    </command:details>
    <maml:description>
        <maml:para>This command is used to query the CQD data API. Once you start a query it will prompt you to authenticate. You must have the minimum tenant admin rights to reach cqd.lync.om. Once authenticated you can then build your query. See parameter descriptions on how to form valid queries.</maml:para>
    </maml:description>
    <command:syntax>
        <command:syntaxItem>
            <maml:name>Get-CQDData</maml:name>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">
                <maml:name>Transport</maml:name>
                <maml:description>
                    <maml:para>This allows you to filter your query to a specific transport such as TCP or UDP.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4">
                <maml:name>OutPutFilePath</maml:name>
                <maml:description>
                    <maml:para>This is used to specify the path and file name of the returned data. ex. C:\users\admin\CQD\data.csv. If the file exists it will be appended to the file.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="5">
                <maml:name>StartDate</maml:name>
                <maml:description>
                    <maml:para>Specify the beginning date to query for. ex. 1/1/2018</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="true">Nullable`1[DateTime]</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="6">
                <maml:name>EndDate</maml:name>
                <maml:description>
                    <maml:para>Specify the ending date to query for. ex. 1/1/2018</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="true">Nullable`1[DateTime]</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7">
                <maml:name>MonthYear</maml:name>
                <maml:description>
                    <maml:para>Specifiy a specific month to pull data for. ex 2018-01</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8">
                <maml:name>Weekdays</maml:name>
                <maml:description>
                    <maml:para>Specify which weekdays to pull. This can be used to only pull business days. ex. Monday,Tuesday,Wednesday,Thursday,Friday</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            </command:parameter>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="9">
                <maml:name>OutPutType</maml:name>
                <maml:description>
                    <maml:para>Specify either to output to a CSV file or PowerShell data table. If you specify CSV then use the OutputFilePath to specify the path and file name. CSV files will be appended if the file exists unless the -OverWriteOutput switch is used. If using a Data Table pass the query to a variable such as $CQDQueryResults.</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="10">
                <maml:name>Week</maml:name>
                <maml:description>
                    <maml:para>Allow you to Output with a week time dimension.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="11">
                <maml:name>UACategory</maml:name>
                <maml:description>
                    <maml:para>Limit your query to a specific client type with this parameter. ex. OC</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="12">
                <maml:name>MediaType</maml:name>
                <maml:description>
                    <maml:para>Scope to a specific media Type. ex. Audio,Video,VBSS</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="13">
                <maml:name>IsServerPair</maml:name>
                <maml:description>
                    <maml:para>Allows you to filter to only Conferencing or Peer to Peer streams. &#39;Client : Server&#39; is used for conferencing and &#39;Client : Client&#39; is used for Peer to Peer.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="14">
                <maml:name>ShowQuery</maml:name>
                <maml:description>
                    <maml:para>A verbose option that shows the JSON query in the output screen. This is mainly used for debugging.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="15">
                <maml:name>OverWriteOutput</maml:name>
                <maml:description>
                    <maml:para>Adding this switch will force overwrite of an existing CSV file when CSV outputtype is selected and the file already exists. Otherwise CSV files to be appended to.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
            </command:parameter>
        </command:syntaxItem>
    </command:syntax>
    <command:parameters>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">
            <maml:name>Transport</maml:name>
            <maml:description>
                <maml:para>This allows you to filter your query to a specific transport such as TCP or UDP.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            <dev:type>
                <maml:name>Array</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4">
            <maml:name>OutPutFilePath</maml:name>
            <maml:description>
                <maml:para>This is used to specify the path and file name of the returned data. ex. C:\users\admin\CQD\data.csv. If the file exists it will be appended to the file.</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></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="5">
            <maml:name>StartDate</maml:name>
            <maml:description>
                <maml:para>Specify the beginning date to query for. ex. 1/1/2018</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="true">Nullable`1[DateTime]</command:parameterValue>
            <dev:type>
                <maml:name>Nullable`1[DateTime]</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="6">
            <maml:name>EndDate</maml:name>
            <maml:description>
                <maml:para>Specify the ending date to query for. ex. 1/1/2018</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="true">Nullable`1[DateTime]</command:parameterValue>
            <dev:type>
                <maml:name>Nullable`1[DateTime]</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7">
            <maml:name>MonthYear</maml:name>
            <maml:description>
                <maml:para>Specify a specific month to pull data for. ex 2018-01</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            <dev:type>
                <maml:name>Array</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8">
            <maml:name>Weekdays</maml:name>
            <maml:description>
                <maml:para>Specify which weekdays to pull. This can be used to only pull business days. ex. Monday,Tuesday,Wednesday,Thursday,Friday</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            <dev:type>
                <maml:name>Array</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="9">
            <maml:name>OutPutType</maml:name>
            <maml:description>
                <maml:para>Specify either to output to a CSV file or PowerShell data table. If you specify CSV then use the OutputFilePath to specify the path and file name. CSV files will be appended if the file exists unless the -OverWriteOutput switch is used. If using a Data Table pass the query to a variable such as $CQDQueryResults.</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></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="10">
            <maml:name>Week</maml:name>
            <maml:description>
                <maml:para>Allow you to Output with a week time dimension.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            <dev:type>
                <maml:name>Array</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="11">
            <maml:name>UACategory</maml:name>
            <maml:description>
                <maml:para>Limit your query to a specific client type with this parameter. ex. OC</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            <dev:type>
                <maml:name>Array</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="12">
            <maml:name>MediaType</maml:name>
            <maml:description>
                <maml:para>Scope to a specific media Type. ex. Audio,Video,VBSS</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            <dev:type>
                <maml:name>Array</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="13">
            <maml:name>IsServerPair</maml:name>
            <maml:description>
                <maml:para>Allows you to filter to only Conferencing or Peer to Peer streams. &#39;Client : Server&#39; is used for conferencing and &#39;Client : Client&#39; is used for Peer to Peer.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">Array</command:parameterValue>
            <dev:type>
                <maml:name>Array</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="14">
            <maml:name>ShowQuery</maml:name>
            <maml:description>
                <maml:para>A verbose option that shows the JSON query in the output screen. This is mainly used for debugging.</maml:para>
            </maml:description>
            <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
            <dev:type>
                <maml:name>Boolean</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="15">
            <maml:name>OverWriteOutput</maml:name>
            <maml:description>
                <maml:para>Adding this switch will force overwrite of an existing CSV file when CSV outputtype is selected and the file already exists. Otherwise CSV files to be appended to.</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></dev:defaultValue>
        </command:parameter>
    </command:parameters>
    <command:inputTypes>
        <command:inputType>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:inputType>
    </command:inputTypes>
    <command:returnValues>
        <command:returnValue>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors></command:terminatingErrors>
    <command:nonTerminatingErrors></command:nonTerminatingErrors>
    <maml:alertSet>
        <maml:title></maml:title>
        <maml:alert>
            <maml:para />
        </maml:alert>
    </maml:alertSet>
    <command:examples>
        <command:example>
            <maml:title>--------------------------  Query CQD and store return to Data Table  --------------------------</maml:title>
            <maml:introduction>
                <maml:paragraph>PS C:\&gt;</maml:paragraph>
            </maml:introduction>
            <dev:code>$CQDQueryResults = get-CQDData -Dimensions &apos;AllStreams.Month Year&apos;,&apos;AllStreams.Second Subnet&apos; -Measures &apos;Measures.Total Stream Count&apos; -IsServerPair &apos;Client : Server&apos; -StartDate 12/01/2017 -EndDate 02/28/2018 -OutputType DataTable</dev:code>
            <dev:remarks>
                <maml:para>In this example we are querying for the total number of streams for the last 3 months by Subnet. We are also filtering to just conferencing using IsServerPair with a value of &#39;Client : Server&#39;. After running $CQDQueryResults will contain the data returned by CQD.</maml:para>
                <maml:para />
                <maml:para />
                <maml:para>Month Year Second Subnet Total Stream Count
---------- ------------- ------------------
2018-01    10.121.236.0  26
2018-01    192.168.1.0   7</maml:para>
            </dev:remarks>
            <command:commandLines>
                <command:commandLine>
                    <command:commandText>
                        <maml:para />
                    </command:commandText>
                </command:commandLine>
            </command:commandLines>
        </command:example>
    </command:examples>
    <maml:relatedLinks>
    </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<!--Generated by PS Cmdlet Help Editor-->
    <command:details>
        <command:name>Get-CQDDimensions</command:name>
        <maml:description>
            <maml:para />
        </maml:description>
        <maml:copyright>
            <maml:para />
        </maml:copyright>
        <command:verb>Get</command:verb>
        <command:noun>CQDDimensions</command:noun>
        <dev:version />
    </command:details>
    <maml:description>
        <maml:para>Use this command to see all the available Dimensions in CQD. This is a dynamic list and may change over time. If you receive an error that a dimension is invalid use this command to verify the availability. You can also filter results by piping and adding a where statement: Get-Dimensions | where {$_ -like &#39;*Audio*&#39;}
</maml:para>
    </maml:description>
    <command:syntax>
        <command:syntaxItem>
            <maml:name>Get-CQDDimensions</maml:name>
        </command:syntaxItem>
    </command:syntax>
    <command:parameters>    </command:parameters>
    <command:inputTypes>
        <command:inputType>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:inputType>
    </command:inputTypes>
    <command:returnValues>
        <command:returnValue>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors></command:terminatingErrors>
    <command:nonTerminatingErrors></command:nonTerminatingErrors>
    <maml:alertSet>
        <maml:title></maml:title>
        <maml:alert>
            <maml:para />
        </maml:alert>
    </maml:alertSet>
    <command:examples>
    </command:examples>
    <maml:relatedLinks>
    </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<!--Generated by PS Cmdlet Help Editor-->
    <command:details>
        <command:name>Get-CQDMeasures</command:name>
        <maml:description>
            <maml:para />
        </maml:description>
        <maml:copyright>
            <maml:para />
        </maml:copyright>
        <command:verb>Get</command:verb>
        <command:noun>CQDMeasures</command:noun>
        <dev:version />
    </command:details>
    <maml:description>
        <maml:para>Use this command to see all the available Measures in CQD. This is a dynamic list and may change over time. If you receive an error that a measure is invalid use this command to verify the availability. You can also filter results by piping and adding a where statement: Get-Measures | where {$_ -like ‘*Total*’}</maml:para>
    </maml:description>
    <command:syntax>
        <command:syntaxItem>
            <maml:name>Get-CQDMeasures</maml:name>
        </command:syntaxItem>
    </command:syntax>
    <command:parameters>    </command:parameters>
    <command:inputTypes>
        <command:inputType>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:inputType>
    </command:inputTypes>
    <command:returnValues>
        <command:returnValue>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors></command:terminatingErrors>
    <command:nonTerminatingErrors></command:nonTerminatingErrors>
    <maml:alertSet>
        <maml:title></maml:title>
        <maml:alert>
            <maml:para />
        </maml:alert>
    </maml:alertSet>
    <command:examples>
    </command:examples>
    <maml:relatedLinks>
    </maml:relatedLinks>
</command:command>
</helpItems>