CQDPowerShell

1.0

en-US/CQDPowerShell-Help.xml

<?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 begining 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>Specifiy either to output to a CSV file or PowerShell data table. If you specify CSV then use the OutputFilePath to specifiy 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 uery to a specific client type with this paramter. 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 &quot; 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 begining 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>Specifiy 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>Specifiy either to output to a CSV file or PowerShell data table. If you specify CSV then use the OutputFilePath to specifiy 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 uery to a specific client type with this paramter. 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 &quot; 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>