DDVCmdlets.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-DiagnosticData --> <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:details> <command:name>Get-DiagnosticData</command:name> <command:verb>Get</command:verb> <command:noun>DiagnosticData</command:noun> <maml:description> <maml:para>Fetches historical Windows Diagnostic Data uploaded by this machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet fetches historical Windows Diagnostic Data uploaded by this machine. The total available historical data is limited by the diagnostic data store’s configurations. See 'Set-DiagnosticStoreCapacity' for changes.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-DiagnosticData</maml:name> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="st,start"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies start time of the window for the oldest event in the fetched set.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="et,end"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies end time of the window for the newest event in the fetched set.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM</dev:defaultValue> </command:parameter> <!-- Parameter: RecordCount --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2" aliases="rc,recCount,c,count"> <maml:name>RecordCount</maml:name> <maml:description> <maml:para>Specifies maximum number of events to fetch.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DiagnosticDataCategory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="ddc,dc"> <maml:name>DiagnosticDataCategory</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data category. See Get-DiagnosticDataCategories for data category IDs.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-2147483648</dev:defaultValue> </command:parameter> <!-- Parameter: DiagnosticDataOtherFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="ddof,dof"> <maml:name>DiagnosticDataOtherFilter</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data other filter. See Get-DiagnosticDataOtherFilters for data other filter IDs.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-2147483648</dev:defaultValue> </command:parameter> <!-- Parameter: DiagnosticDataSource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="dds,ds"> <maml:name>DiagnosticDataSource</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data source. See Get-DiagnosticDataSources for data source names.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventNameFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="name"> <maml:name>EventNameFilter</maml:name> <maml:description> <maml:para>Event name filter parameter. Specifies if resultset should only include events with this name (case insensitive.).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredTelemetryOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="required,requiredOnly"> <maml:name>RequiredTelemetryOnly</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include Required diagnostic data events.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="st,start"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies start time of the window for the oldest event in the fetched set.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="st,start"> <maml:name>st</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies start time of the window for the oldest event in the fetched set.</maml:para> <maml:para>This is an alias of the StartTime parameter.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="st,start"> <maml:name>start</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies start time of the window for the oldest event in the fetched set.</maml:para> <maml:para>This is an alias of the StartTime parameter.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="et,end"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies end time of the window for the newest event in the fetched set.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="et,end"> <maml:name>et</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies end time of the window for the newest event in the fetched set.</maml:para> <maml:para>This is an alias of the EndTime parameter.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="et,end"> <maml:name>end</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies end time of the window for the newest event in the fetched set.</maml:para> <maml:para>This is an alias of the EndTime parameter.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM</dev:defaultValue> </command:parameter> <!-- Parameter: RecordCount --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2" aliases="rc,recCount,c,count"> <maml:name>RecordCount</maml:name> <maml:description> <maml:para>Specifies maximum number of events to fetch.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2" aliases="rc,recCount,c,count"> <maml:name>rc</maml:name> <maml:description> <maml:para>Specifies maximum number of events to fetch.</maml:para> <maml:para>This is an alias of the RecordCount parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2" aliases="rc,recCount,c,count"> <maml:name>recCount</maml:name> <maml:description> <maml:para>Specifies maximum number of events to fetch.</maml:para> <maml:para>This is an alias of the RecordCount parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2" aliases="rc,recCount,c,count"> <maml:name>c</maml:name> <maml:description> <maml:para>Specifies maximum number of events to fetch.</maml:para> <maml:para>This is an alias of the RecordCount parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2" aliases="rc,recCount,c,count"> <maml:name>count</maml:name> <maml:description> <maml:para>Specifies maximum number of events to fetch.</maml:para> <maml:para>This is an alias of the RecordCount parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DiagnosticDataCategory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="ddc,dc"> <maml:name>DiagnosticDataCategory</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data category. See Get-DiagnosticDataCategories for data category IDs.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-2147483648</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="ddc,dc"> <maml:name>ddc</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data category. See Get-DiagnosticDataCategories for data category IDs.</maml:para> <maml:para>This is an alias of the DiagnosticDataCategory parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-2147483648</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="ddc,dc"> <maml:name>dc</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data category. See Get-DiagnosticDataCategories for data category IDs.</maml:para> <maml:para>This is an alias of the DiagnosticDataCategory parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-2147483648</dev:defaultValue> </command:parameter> <!-- Parameter: DiagnosticDataSource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="dds,ds"> <maml:name>DiagnosticDataSource</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data source. See Get-DiagnosticDataSources for data source names.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="dds,ds"> <maml:name>dds</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data source. See Get-DiagnosticDataSources for data source names.</maml:para> <maml:para>This is an alias of the DiagnosticDataSource parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="dds,ds"> <maml:name>ds</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data source. See Get-DiagnosticDataSources for data source names.</maml:para> <maml:para>This is an alias of the DiagnosticDataSource parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiagnosticDataOtherFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="ddof,dof"> <maml:name>DiagnosticDataOtherFilter</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data other filter. See Get-DiagnosticDataOtherFilters for data other filter IDs.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-2147483648</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="ddof,dof"> <maml:name>ddof</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data other filter. See Get-DiagnosticDataOtherFilters for data other filter IDs.</maml:para> <maml:para>This is an alias of the DiagnosticDataOtherFilter parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-2147483648</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="ddof,dof"> <maml:name>dof</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include events having this diagnostic data other filter. See Get-DiagnosticDataOtherFilters for data other filter IDs.</maml:para> <maml:para>This is an alias of the DiagnosticDataOtherFilter parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-2147483648</dev:defaultValue> </command:parameter> <!-- Parameter: RequiredTelemetryOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="required,requiredOnly"> <maml:name>RequiredTelemetryOnly</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include Required diagnostic data events.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="required,requiredOnly"> <maml:name>required</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include Required diagnostic data events.</maml:para> <maml:para>This is an alias of the RequiredTelemetryOnly parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="required,requiredOnly"> <maml:name>requiredOnly</maml:name> <maml:description> <maml:para>Query filter parameter. Specifies if resultset should only include Required diagnostic data events.</maml:para> <maml:para>This is an alias of the RequiredTelemetryOnly parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EventNameFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="name"> <maml:name>EventNameFilter</maml:name> <maml:description> <maml:para>Event name filter parameter. Specifies if resultset should only include events with this name (case insensitive.).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="name"> <maml:name>name</maml:name> <maml:description> <maml:para>Event name filter parameter. Specifies if resultset should only include events with this name (case insensitive.).</maml:para> <maml:para>This is an alias of the EventNameFilter parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Query filter parameter. Specifies start time of the window for the oldest event in the fetched set.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Query filter parameter. Specifies end time of the window for the newest event in the fetched set.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies maximum number of events to fetch.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: EventRecord --> <command:returnValue> <dev:type> <maml:name>DDVCmdlets.Containers.EventRecord</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Persisted event record.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-DiagnosticData -StartTime (Get-Date).AddDays(-1) -RecordCount 1</dev:code> <dev:remarks> <maml:para>Returns first (oldest) diagnostic event since yesterday. Sample output below.</maml:para> <maml:para>Name : Microsoft.Windows.Kernel.PnP.DeviceConfig</maml:para> <maml:para>Timestamp : 11/8/2018 4:52:53 PM</maml:para> <maml:para>Payload : JSON PAYLOAD</maml:para> <maml:para>IsRequired : False</maml:para> <maml:para>DiagnosticDataCategories : {11}</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-DiagnosticData -StartTime (Get-Date).AddHours(-12) -EndTime (Get-Date).AddHours(-6) -RequiredTelemetryOnly</dev:code> <dev:remarks> <maml:para>Returns all required diagnostic events sent between 12 and 6 hours before now.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Get-DiagnosticData -EventNameFilter EventName</dev:code> <dev:remarks> <maml:para>Returns diagnostic events with name EventName (case insensitive).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>Get-DiagnosticData -DiagnosticDataCategory 11</dev:code> <dev:remarks> <maml:para>Returns diagnostic events tagged with diagnostic data category ID 11. See Get-DiagnosticDataCategories for the list of diagnostic data categories.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DiagnosticDataCategories --> <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:details> <command:name>Get-DiagnosticDataCategories</command:name> <command:verb>Get</command:verb> <command:noun>DiagnosticDataCategories</command:noun> <maml:description> <maml:para>Fetches the mapping of diagnostic data category identifiers to their corresponding descriptions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet shows the mapping between diagnostic data category identifiers to their official descriptions. Each diagnostic data event is grouped into a Data Category based on how Microsoft uses the data. It may take some time for descriptions to be loaded.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-DiagnosticDataCategories</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: DiagnosticDataCategory --> <command:returnValue> <dev:type> <maml:name>DDVCmdlets.Containers.DiagnosticDataCategory</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Diagnostic data category information.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-DiagnosticDataCategories</dev:code> <dev:remarks> <maml:para>Fetches Windows Diagnostic Data diagnostic data categories.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>https://docs.microsoft.com/en-us/windows/privacy/windows-diagnostic-data</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-DiagnosticDataOtherFilters --> <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:details> <command:name>Get-DiagnosticDataOtherFilters</command:name> <command:verb>Get</command:verb> <command:noun>DiagnosticDataOtherFilters</command:noun> <maml:description> <maml:para>Fetches the mapping of diagnostic data other filter identifiers to their corresponding descriptions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet shows the mapping between diagnostic data other filter identifiers to their official descriptions. Some diagnostic data event are assigned to a Data Other Filter based on how Microsoft uses the data. It may take some time for descriptions to be loaded.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-DiagnosticDataOtherFilters</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: DiagnosticDataOtherFilter --> <command:returnValue> <dev:type> <maml:name>DDVCmdlets.Containers.DiagnosticDataOtherFilter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Diagnostic data other filter information.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-DiagnosticDataOtherFilters</dev:code> <dev:remarks> <maml:para>Fetches Windows Diagnostic Data diagnostic data other filters.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>https://docs.microsoft.com/en-us/windows/privacy/windows-diagnostic-data</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-DiagnosticDataSources --> <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:details> <command:name>Get-DiagnosticDataSources</command:name> <command:verb>Get</command:verb> <command:noun>DiagnosticDataSources</command:noun> <maml:description> <maml:para>Fetches the mapping of diagnostic data source identifiers to their corresponding descriptions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet shows the mapping between diagnostic data source identifiers to their official descriptions. Each diagnostic data event is grouped into a Data Source based on how Microsoft uses the data. It may take some time for descriptions to be loaded.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-DiagnosticDataSources</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: DiagnosticDataSource --> <command:returnValue> <dev:type> <maml:name>DDVCmdlets.Containers.DiagnosticDataSource</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Diagnostic data source information.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-DiagnosticDataSources</dev:code> <dev:remarks> <maml:para>Fetches Windows Diagnostic Data diagnostic data sources.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>https://docs.microsoft.com/en-us/windows/privacy/windows-diagnostic-data</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-DiagnosticDataViewing --> <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:details> <command:name>Disable-DiagnosticDataViewing</command:name> <command:verb>Disable</command:verb> <command:noun>DiagnosticDataViewing</command:noun> <maml:description> <maml:para>Disables diagnostic data viewing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet disables diagnostic data viewing. Once diagnostic data viewing is disabled, this tool will throw an error. Note that disabling diagnostic data viewing will also delete the available history of diagnostic data on the device.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-DiagnosticDataViewing</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Disable-DiagnosticDataViewing</dev:code> <dev:remarks> <maml:para>Disable Diagnostic Data Viewing.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Enable-DiagnosticDataViewing --> <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:details> <command:name>Enable-DiagnosticDataViewing</command:name> <command:verb>Enable</command:verb> <command:noun>DiagnosticDataViewing</command:noun> <maml:description> <maml:para>Enables diagnostic data viewing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet enables diagnostic data viewing. Once enabled, the device henceforth will start recording each diagnostic data event uploaded to Microsoft, where the total history is limited by the diagnostic store capacity. It may take some time for events to be shown.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-DiagnosticDataViewing</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Enable-DiagnosticDataViewing</dev:code> <dev:remarks> <maml:para>Enable Diagnostic Data Viewing.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DiagnosticDataViewingSetting --> <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:details> <command:name>Get-DiagnosticDataViewingSetting</command:name> <command:verb>Get</command:verb> <command:noun>DiagnosticDataViewingSetting</command:noun> <maml:description> <maml:para>Fetches whether diagnostic data viewing is currently enabled or disabled.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns the current state of diagnostic data viewing. This state indicates whether diagnostic data viewing is enabled for this device. If disabled, this tool will throw an error.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-DiagnosticDataViewingSetting</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-DiagnosticDataViewingSetting</dev:code> <dev:remarks> <maml:para>Checks if Diagnostic Data Viewing is enabled.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DiagnosticStoreCapacity --> <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:details> <command:name>Get-DiagnosticStoreCapacity</command:name> <command:verb>Get</command:verb> <command:noun>DiagnosticStoreCapacity</command:noun> <maml:description> <maml:para>Fetches the current diagnostic store capacity. Parameter [-Size] returns the diagnostic store size capacity in megabytes. Parameter [-Time] returns the diagnostic store capacity in days. The default diagnostic data store size capacity is 1024 MB. The default time capacity is 30 days.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The amount of Diagnostic Data history that can be shown through this tool is capped based on time in days and size in megabytes. Once either cap is reached (whichever comes first), diagnostic data is removed based on a first in first out order. For example, if the size cap is 1GB and the time cap is 30 days, then once the diagnostic data store has reached 1GB of history or the oldest record is 30 days old (whichever comes first), the oldest seen event is dropped.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-DiagnosticStoreCapacity</maml:name> <!-- Parameter: Size --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="s"> <maml:name>Size</maml:name> <maml:description> <maml:para>Get configured size capacity (megabytes) of the Diagnostic store.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Time --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="t"> <maml:name>Time</maml:name> <maml:description> <maml:para>Get configured time capacity (hours) of the Diagnostic store.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Size --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="s"> <maml:name>Size</maml:name> <maml:description> <maml:para>Get configured size capacity (megabytes) of the Diagnostic store.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="s"> <maml:name>s</maml:name> <maml:description> <maml:para>Get configured size capacity (megabytes) of the Diagnostic store.</maml:para> <maml:para>This is an alias of the Size parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Time --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="t"> <maml:name>Time</maml:name> <maml:description> <maml:para>Get configured time capacity (hours) of the Diagnostic store.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="t"> <maml:name>t</maml:name> <maml:description> <maml:para>Get configured time capacity (hours) of the Diagnostic store.</maml:para> <maml:para>This is an alias of the Time parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Get configured size capacity (megabytes) of the Diagnostic store.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Get configured time capacity (hours) of the Diagnostic store.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-DiagnosticStoreCapacity -Size</dev:code> <dev:remarks> <maml:para>Get configured size capacity (megabytes) of the Diagnostic store.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-DiagnosticStoreCapacity -Time</dev:code> <dev:remarks> <maml:para>Get configured time capacity (hours) of the Diagnostic store.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DiagnosticStoreCapacity --> <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:details> <command:name>Set-DiagnosticStoreCapacity</command:name> <command:verb>Set</command:verb> <command:noun>DiagnosticStoreCapacity</command:noun> <maml:description> <maml:para>Sets the diagnostic store time and size capacity.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet sets the maximum amount of Diagnostic Data history (by time and by size) that can be shown through this tool. The size cap is measured in megabytes, and the time cap is measured in days. Once the either cap is reached (whichever comes first), diagnostic data history is removed based on a first in first out order.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-DiagnosticStoreCapacity</maml:name> <!-- Parameter: Size --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="s"> <maml:name>Size</maml:name> <maml:description> <maml:para>Set size capacity of the diagnostic store.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Time --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="t"> <maml:name>Time</maml:name> <maml:description> <maml:para>Set time capacity of the diagnostic store.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Size --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="s"> <maml:name>Size</maml:name> <maml:description> <maml:para>Set size capacity of the diagnostic store.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="s"> <maml:name>s</maml:name> <maml:description> <maml:para>Set size capacity of the diagnostic store.</maml:para> <maml:para>This is an alias of the Size parameter.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Time --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="t"> <maml:name>Time</maml:name> <maml:description> <maml:para>Set time capacity of the diagnostic store.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="t"> <maml:name>t</maml:name> <maml:description> <maml:para>Set time capacity of the diagnostic store.</maml:para> <maml:para>This is an alias of the Time parameter.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Set size capacity of the diagnostic store.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Set time capacity of the diagnostic store.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set-DiagnosticStoreCapacity -Size 1024</dev:code> <dev:remarks> <maml:para>Set store capacity (megabytes) of the diagnostic store.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Set-DiagnosticStoreCapacity -Time 24</dev:code> <dev:remarks> <maml:para>Set time capacity (hours) of the diagnostic store.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Set-DiagnosticStoreCapacity -Size 1024 -Time 24</dev:code> <dev:remarks> <maml:para>Set store capacity (megabytes) and time capacity (hours) of the diagnostic store at the same time.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |