Mawosoft.PowerShell.WindowsSearchManager.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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"> <command:details> <command:name>Add-SearchRoot</command:name> <command:verb>Add</command:verb> <command:noun>SearchRoot</command:noun> <maml:description> <maml:para>Adds search roots to a search catalog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-SearchRoot` cmdlet adds search roots to a search catalog.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-SearchRoot</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies SearchRootInfo objects containing search roots with advanced properties to be added to a search catalog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SearchRootInfo[]</command:parameterValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SearchRoot</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies a search root to be added to a search catalog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <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> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies SearchRootInfo objects containing search roots with advanced properties to be added to a search catalog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo[]</command:parameterValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies a search root to be added to a search catalog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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.String[]</maml:name> </dev:type> <maml:description> <maml:para>You can pipe paths to this cmdlet.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo[]</maml:name> </dev:type> <maml:description> <maml:para>You can pipe SearchRootInfo objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>To learn more about search roots, see Managing Search Roots (https://learn.microsoft.com/windows/win32/search/-search-3x-wds-extidx-csm-searchroots)in Microsoft's Windows Search documentation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Add a search root -----------------</maml:title> <dev:code>Add-SearchRoot -Path file:///D:\</dev:code> <dev:remarks> <maml:para>This command adds the drive `D:` as a search root to the default Windows Search catalog.</maml:para> <maml:para>For file system search roots, you can omit the `file:///` protocol prefix.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Add-SearchRoot.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchRoot</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SearchRoot</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Add-SearchRule</command:name> <command:verb>Add</command:verb> <command:noun>SearchRule</command:noun> <maml:description> <maml:para>Adds search rules to a search catalog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-SearchRule` cmdlet adds search rules to a search catalog.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-SearchRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies SearchRuleInfo objects containing search rules with their properties to be added to a search catalog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SearchRuleInfo[]</command:parameterValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OverrideChildren</maml:name> <maml:description> <maml:para>Use this parameter to remove any child rules when adding a user search rule.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-SearchRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the URL or path of the search rule to be added to a search catalog. For exclusion rules, the path can contain the wildcard character `*`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RuleType</maml:name> <maml:description> <maml:para>Specifies the type of the rule. The acceptable values for this parameter are:</maml:para> <maml:para>- `Exclude` - The rule specifies an exclusion.</maml:para> <maml:para>- `Include` - The rule specifies an inclusion.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Exclude</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Include</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">SearchRuleInfo+SearchRuleType</command:parameterValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo+SearchRuleType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>Specifies the rule set the rule belongs to. The acceptable values for this parameter are:</maml:para> <maml:para>- `User` - Adds a user rule to the working rule set.</maml:para> <maml:para>- `Default` - Adds a default rule to both the working rule set and the default rule set.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">User</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">SearchRuleInfo+SearchRuleSet</command:parameterValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo+SearchRuleSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>User</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OverrideChildren</maml:name> <maml:description> <maml:para>Use this parameter to remove any child rules when adding a user search rule.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <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> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies SearchRuleInfo objects containing search rules with their properties to be added to a search catalog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo[]</command:parameterValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OverrideChildren</maml:name> <maml:description> <maml:para>Use this parameter to remove any child rules when adding a user search rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the URL or path of the search rule to be added to a search catalog. For exclusion rules, the path can contain the wildcard character `*`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>Specifies the rule set the rule belongs to. The acceptable values for this parameter are:</maml:para> <maml:para>- `User` - Adds a user rule to the working rule set.</maml:para> <maml:para>- `Default` - Adds a default rule to both the working rule set and the default rule set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo+SearchRuleSet</command:parameterValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo+SearchRuleSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>User</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RuleType</maml:name> <maml:description> <maml:para>Specifies the type of the rule. The acceptable values for this parameter are:</maml:para> <maml:para>- `Exclude` - The rule specifies an exclusion.</maml:para> <maml:para>- `Include` - The rule specifies an inclusion.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo+SearchRuleType</command:parameterValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo+SearchRuleType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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.String[]</maml:name> </dev:type> <maml:description> <maml:para>You can pipe paths to this cmdlet.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo[]</maml:name> </dev:type> <maml:description> <maml:para>You can pipe SearchRuleInfo objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>To learn more about search rules, see Managing Scope Rules (https://learn.microsoft.com/windows/win32/search/-search-3x-wds-extidx-csm-scoperules)in Microsoft's Windows Search documentation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Add search rules -----------------</maml:title> <dev:code>Add-SearchRule -Path file:///C:\Users\Bob\Documents\FooData\ -RuleType Exclude -RuleSet User Add-SearchRule -Path file:///C:\Users\Bob\Documents\FooData\Common\ -RuleType Include -RuleSet User</dev:code> <dev:remarks> <maml:para>The first command adds a user exclusion rule to the default Windows Search catalog. The `FooData` directory and all its subdirectories are excluded from the catalog.</maml:para> <maml:para>The second command amends the exclusion by making an exception for one subdirectory. The subdirectory `Common` is included in the catalog, all other subdirectories of `FooData` are still excluded.</maml:para> <maml:para>If the specified path is recognizable as a file system path, you can omit the `file:///` protocol prefix.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------------- Example 2: Override child rules ---------------</maml:title> <dev:code>Add-SearchRule -Path file:///C:\Users\Bob\Documents\FooData\ -RuleType Exclude -RuleSet User -OverrideChildren</dev:code> <dev:remarks> <maml:para>This command adds a user exclusion rule to the default Windows Search catalog. The `FooData` directory and all its subdirectories are excluded from the catalog, any existing child rules are removed.</maml:para> <maml:para>Without the OverrideChildren parameter, child rules, like the one for the subdirectory `Common` in Example 1, would remain active.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------- Example 3: Use wildcards in exclusion rules ---------</maml:title> <dev:code>Add-SearchRule -Path file:///C:\Users\*\Documents\PowerShell\ -RuleType Exclude -RuleSet Default</dev:code> <dev:remarks> <maml:para>This command adds a default exclusion rule to the default Windows Search catalog. The `PowerShell` subdirectory in the `Documents` directory of every user is excluded from the catalog.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Add-SearchRule.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Get-SearchCatalog</command:name> <command:verb>Get</command:verb> <command:noun>SearchCatalog</command:noun> <maml:description> <maml:para>Gets settings and status of all search catalogs or for a specified one.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-SearchCatalog` cmdlet gets settings and status of all search catalogs or for a specified one.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SearchCatalog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog to return information about. If omitted, settings and status of all search catalogs are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog to return information about. If omitted, settings and status of all search catalogs are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>You can't pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchCatalogInfo</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns one or more SearchCatalogInfo objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------- Example 1: Get settings for all search catalogs -------</maml:title> <dev:code>Get-SearchCatalog Catalog : SystemIndex ConnectTimeout : 0 DataTimeout : 0 DiacriticSensitivity : False Status : CATALOG_STATUS_PROCESSING_NOTIFICATIONS PausedReason : CATALOG_PAUSED_REASON_NONE ItemCount : 23930 ItemsToIndexCount : 0 NotificationQueueCount : 47 HighPriorityQueueCount : 0 PathBeingIndexed : file:C:/Users/Bob/Documents/foo.txt</dev:code> <dev:remarks> <maml:para>While it is possible to create, manage, and query multiple catalogs, Windows Search currently uses only one catalog, which is named SystemIndex .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 2: Get settings for a specific catalog --------</maml:title> <dev:code>Get-SearchCatalog -Catalog SystemIndex</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Get-SearchCatalog.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Get-SearchManager</command:name> <command:verb>Get</command:verb> <command:noun>SearchManager</command:noun> <maml:description> <maml:para>Gets global settings and version information for Windows Search.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-SearchManager` cmdlet gets the global settings and version information for Windows Search.</maml:para> <maml:para>NOTE: You must run this cmdlet from an elevated PowerShell session. Start PowerShell by using the Run as administrator option.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SearchManager</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>You can't pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchManagerInfo</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a SearchManagerInfo object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------- Example 1: Get global Windows Search settings --------</maml:title> <dev:code>Get-SearchManager Version : 10.0.19041.3324 MajorVersion : 10 MinorVersion : 0 UserAgent : Mozilla/4.0 (compatible; MSIE 6.0; Windows NT; MS Search 4.0 Robot) ProxyAccess : PROXY_ACCESS_PRECONFIG ProxyName : ProxyPortNumber : 0 ProxyBypassLocal : False ProxyBypassList :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Get-SearchManager.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SearchManager</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Get-SearchRoot</command:name> <command:verb>Get</command:verb> <command:noun>SearchRoot</command:noun> <maml:description> <maml:para>Gets all search roots defined for a search catalog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-SearchRoot` cmdlet gets all search roots defined for a search catalog.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SearchRoot</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PathOnly</maml:name> <maml:description> <maml:para>Use this parameter to return only the paths of the search roots, not the details.</maml:para> </maml:description> <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> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PathOnly</maml:name> <maml:description> <maml:para>Use this parameter to return only the paths of the search roots, not the details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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>None</maml:name> </dev:type> <maml:description> <maml:para>You can't pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRootInfo</maml:name> </dev:type> <maml:description> <maml:para>By default, this cmdlet returns SearchRootInfo objects.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>When you use the PathOnly parameter, the cmdlet returns the root paths.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>To learn more about search roots, see Managing Search Roots (https://learn.microsoft.com/windows/win32/search/-search-3x-wds-extidx-csm-searchroots)in Microsoft's Windows Search documentation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Get all search roots paths ------------</maml:title> <dev:code>Get-SearchRoot -PathOnly csc://{S-1-5-21-3419697060-3810377854-678604692-1001}/ defaultroot://{S-1-5-21-3419697060-3810377854-678604692-1001}/ file:///C:\ iehistory://{S-1-5-21-3419697060-3810377854-678604692-1001}/ winrt://{S-1-5-21-3419697060-3810377854-678604692-1001}/</dev:code> <dev:remarks> <maml:para>This command gets the search root paths for the default Windows Search catalog.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--- Example 2: Get detailed infos for all search roots paths ---</maml:title> <dev:code>Get-SearchRoot Path : csc://{S-1-5-21-3419697060-3810377854-678604692-1001}/ IsHierarchical : True ProvidesNotifications : True UseNotificationsOnly : False EnumerationDepth : 4294967295 HostDepth : 0 FollowDirectories : True AuthenticationType : eAUTH_TYPE_ANONYMOUS Path : defaultroot://{S-1-5-21-3419697060-3810377854-678604692-1001}/ IsHierarchical : True ... output truncated ...</dev:code> <dev:remarks> <maml:para>This command gets the search root details for the default Windows Search catalog.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Get-SearchRoot.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-SearchRoot</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SearchRoot</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Get-SearchRule</command:name> <command:verb>Get</command:verb> <command:noun>SearchRule</command:noun> <maml:description> <maml:para>Gets the search rules in effect for a search catalog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-SearchRule` cmdlet gets the search rules in effect for a search catalog.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SearchRule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>You can't pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns SearchRuleInfo objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>To learn more about search rules, see Managing Scope Rules (https://learn.microsoft.com/windows/win32/search/-search-3x-wds-extidx-csm-scoperules)in Microsoft's Windows Search documentation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Get search rules -----------------</maml:title> <dev:code>Get-SearchRule Path RuleType RuleSet FollowFlags ---- -------- ------- ----------- csc://{S-1-5-21-3419697060-3810377854-678604692-1001}/ Include Default FF_INDEXCOMPLEXURLS file:///*\$RECYCLE.BIN\ Exclude Default FF_INDEXCOMPLEXURLS file:///*\DfsrPrivate\ Exclude Default FF_INDEXCOMPLEXURLS file:///*\System Volume Information\ Exclude Default FF_INDEXCOMPLEXURLS file:///C:\ProgramData\Microsoft\Windows\Start Menu\ Include Default FF_INDEXCOMPLEXURLS file:///C:\Users\ Include Default FF_INDEXCOMPLEXURLS file:///C:\Users\*\AppData\ Exclude Default FF_INDEXCOMPLEXURLS file:///C:\Users\Bob\.*\ Exclude Default FF_INDEXCOMPLEXURLS file:///C:\Users\Bob\Documents\FooData\ Exclude User FF_INDEXCOMPLEXURLS file:///C:\Users\Bob\Documents\FooData\Common\ Include User FF_INDEXCOMPLEXURLS file:///C:\Windows.*\ Exclude Default FF_INDEXCOMPLEXURLS file:///C:\Windows\*\temp\ Exclude Default FF_INDEXCOMPLEXURLS iehistory://{S-1-5-21-3419697060-3810377854-678604692-1001}/ Include Default FF_INDEXCOMPLEXURLS winrt://{S-1-5-21-3419697060-3810377854-678604692-1001}/ Include Default FF_INDEXCOMPLEXURLS</dev:code> <dev:remarks> <maml:para>This command gets the search rules in effect for the default Windows Search catalog.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Get-SearchRule.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>New-SearchCatalog</command:name> <command:verb>New</command:verb> <command:noun>SearchCatalog</command:noun> <maml:description> <maml:para>Creates a new search catalog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-SearchCatalog` cmdlet creates a new search catalog with the specified name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SearchCatalog</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <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> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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>None</maml:name> </dev:type> <maml:description> <maml:para>You can't pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>While it is possible to create, manage, and query multiple catalogs, Windows Search currently uses only one catalog, which is named SystemIndex .</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------- Example 1: Create a new catalog ---------------</maml:title> <dev:code>New-SearchCatalog -Catalog Sample01</dev:code> <dev:remarks> <maml:para>This command creates a new search catalog named `Sample01`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/New-SearchCatalog.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Remove-SearchCatalog</command:name> <command:verb>Remove</command:verb> <command:noun>SearchCatalog</command:noun> <maml:description> <maml:para>Deletes the specified search catalog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-SearchCatalog` cmdlet deletes the catalog with the specified name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-SearchCatalog</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <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> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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>None</maml:name> </dev:type> <maml:description> <maml:para>You can't pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>----------------- Example 1: Delete a catalog -----------------</maml:title> <dev:code>Remove-SearchCatalog -Catalog Sample01 Confirm Are you sure you want to perform this action? Performing the operation "Remove-SearchCatalog" on target "Sample01". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):</dev:code> <dev:remarks> <maml:para>This command deletes the search catalog named `Sample01` after prompting the user for confirmation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------- Example 2: Delete a catalog without confirmation -------</maml:title> <dev:code>Remove-SearchCatalog -Catalog Sample01 -Confirm:$false</dev:code> <dev:remarks> <maml:para>This command deletes the search catalog named `Sample01` without prompting for confirmation.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Remove-SearchCatalog.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Remove-SearchRoot</command:name> <command:verb>Remove</command:verb> <command:noun>SearchRoot</command:noun> <maml:description> <maml:para>Removes the specified search roots from a search catalog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-SearchRoot` cmdlet removes the specified search roots from a search catalog.</maml:para> <maml:para>CAUTION: Removing a search root also removes all search rules associated with it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-SearchRoot</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the search root to be removed from a catalog. The specified path must match an existing search root exactly, including the protocol prefix.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <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> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the search root to be removed from a catalog. The specified path must match an existing search root exactly, including the protocol prefix.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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.String[]</maml:name> </dev:type> <maml:description> <maml:para>You can pipe paths to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>To learn more about search roots, see Managing Search Roots (https://learn.microsoft.com/windows/win32/search/-search-3x-wds-extidx-csm-searchroots)in Microsoft's Windows Search documentation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------- Example 1: Remove a search root ---------------</maml:title> <dev:code>Remove-SearchRoot -Path file:///D:\ Confirm Are you sure you want to perform this action? Performing the operation "Remove-SearchRoot" on target "SystemIndex Path=file:///D:\". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):</dev:code> <dev:remarks> <maml:para>This command removes the search root drive `D:` from the default Windows Search catalog after prompting the user for confirmation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 2: Remove a search root without confirmation -----</maml:title> <dev:code>Remove-SearchRoot -Path file:///D:\ -Confirm:$false</dev:code> <dev:remarks> <maml:para>This command removes the search root drive `D:` from the default Windows Search catalog without prompting for confirmation.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Remove-SearchRoot.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-SearchRoot</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchRoot</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Remove-SearchRule</command:name> <command:verb>Remove</command:verb> <command:noun>SearchRule</command:noun> <maml:description> <maml:para>Removes the specified search rules from a search catalog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-SearchRule` cmdlet removes the specified search rules from a search catalog.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-SearchRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the search rule to be removed from a catalog. The specified path must match an existing search rule exactly, including the protocol prefix.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>Specifies the rule set the rule belongs to. The acceptable values for this parameter are:</maml:para> <maml:para>- `User` - Removes a user rule from the working rule set. If the user rule is a duplicate of or overrides a default rule, the default rule remains in the working rule set.</maml:para> <maml:para>- `Default` - Removes a default rule from both the working rule set and the default rule set.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">User</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">SearchRuleInfo+SearchRuleSet</command:parameterValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo+SearchRuleSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>User</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <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> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the search rule to be removed from a catalog. The specified path must match an existing search rule exactly, including the protocol prefix.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>Specifies the rule set the rule belongs to. The acceptable values for this parameter are:</maml:para> <maml:para>- `User` - Removes a user rule from the working rule set. If the user rule is a duplicate of or overrides a default rule, the default rule remains in the working rule set.</maml:para> <maml:para>- `Default` - Removes a default rule from both the working rule set and the default rule set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo+SearchRuleSet</command:parameterValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.SearchRuleInfo+SearchRuleSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>User</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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.String[]</maml:name> </dev:type> <maml:description> <maml:para>You can pipe paths to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>To learn more about search rules, see Managing Scope Rules (https://learn.microsoft.com/windows/win32/search/-search-3x-wds-extidx-csm-scoperules)in Microsoft's Windows Search documentation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------- Example 1: Remove a search rule ---------------</maml:title> <dev:code>Remove-SearchRule -Path file:///C:\Users\Bob\Documents\FooData\Common\ -RuleSet User</dev:code> <dev:remarks> <maml:para>This command removes the specified user rule from the working rule set of the default Windows Search catalog.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Remove-SearchRule.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Reset-SearchCatalog</command:name> <command:verb>Reset</command:verb> <command:noun>SearchCatalog</command:noun> <maml:description> <maml:para>Resets a search catalog by completely rebuilding its index database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Reset-SearchCatalog` cmdlet resets a search catalog by completely rebuilding its index database.</maml:para> <maml:para>NOTE: You must run this cmdlet from an elevated PowerShell session. Start PowerShell by using the Run as administrator option.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-SearchCatalog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <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> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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>None</maml:name> </dev:type> <maml:description> <maml:para>You can't pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The difference between `Reset-SearchCatalog` and `Update-SearchCatalog -All` is that the former removes any old information from the index before reindexing while the latter doesn't.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Reset the default catalog. ------------</maml:title> <dev:code>Reset-SearchCatalog</dev:code> <dev:remarks> <maml:para>This command resets the default Windows Search catalog, which is named SystemIndex .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------- Example 2: Reset a custom catalog. --------------</maml:title> <dev:code>Reset-SearchCatalog -Catalog Sample01</dev:code> <dev:remarks> <maml:para>This command resets the search catalog named `Sample01`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Reset-SearchCatalog.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Reset-SearchRule</command:name> <command:verb>Reset</command:verb> <command:noun>SearchRule</command:noun> <maml:description> <maml:para>Resets a catalog to the default search rules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Reset-SearchRule` cmdlet removes all `User` rules from a catalog and restores all `Default` rules to the working rule set.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-SearchRule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <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> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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>None</maml:name> </dev:type> <maml:description> <maml:para>You can't pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>To learn more about search rules, see Managing Scope Rules (https://learn.microsoft.com/windows/win32/search/-search-3x-wds-extidx-csm-scoperules)in Microsoft's Windows Search documentation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Reset search rules ----------------</maml:title> <dev:code>Reset-SearchRule Confirm Are you sure you want to perform this action? Performing the operation "Reset-SearchRule" on target "SystemIndex". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):</dev:code> <dev:remarks> <maml:para>This command resets the search rules of the default Windows Search catalog after prompting the user for confirmation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 2: Reset search rules without confirmation ------</maml:title> <dev:code>Reset-SearchRule -Confirm:$false</dev:code> <dev:remarks> <maml:para>This command resets the search rules of the default Windows Search catalog without prompting for confirmation.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Reset-SearchRule.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Set-SearchCatalog</command:name> <command:verb>Set</command:verb> <command:noun>SearchCatalog</command:noun> <maml:description> <maml:para>Changes settings for a search catalog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-SearchCatalog` cmdlet changes settings for a search catalog.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SearchCatalog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectTimeout</maml:name> <maml:description> <maml:para>Specifies the time, in seconds, that the indexer should wait for a connection response from a server or data store.</maml:para> <maml:para>NOTE: This parameter has currently no effect in Windows Search.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DataTimeout</maml:name> <maml:description> <maml:para>Specifies the time, in seconds, that the indexer should wait for a data transaction.</maml:para> <maml:para>NOTE: This parameter has currently no effect in Windows Search.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiacriticSensitivity</maml:name> <maml:description> <maml:para>Enables diacritic sensitivity. When enabled, the catalog treats words like `resume` and `resumé` as different. When disabled, the catalog treats them as if they were the same word.</maml:para> <maml:para>To disable diacritic sensitivity, specify the parameter as follows: `-DiacriticSensitivity:$false`.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <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> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectTimeout</maml:name> <maml:description> <maml:para>Specifies the time, in seconds, that the indexer should wait for a connection response from a server or data store.</maml:para> <maml:para>NOTE: This parameter has currently no effect in Windows Search.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DataTimeout</maml:name> <maml:description> <maml:para>Specifies the time, in seconds, that the indexer should wait for a data transaction.</maml:para> <maml:para>NOTE: This parameter has currently no effect in Windows Search.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiacriticSensitivity</maml:name> <maml:description> <maml:para>Enables diacritic sensitivity. When enabled, the catalog treats words like `resume` and `resumé` as different. When disabled, the catalog treats them as if they were the same word.</maml:para> <maml:para>To disable diacritic sensitivity, specify the parameter as follows: `-DiacriticSensitivity:$false`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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>None</maml:name> </dev:type> <maml:description> <maml:para>You can't pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Changing diacritic sensitivity automatically causes the catalog to be reindexed.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Enable diacritic sensitivity -----------</maml:title> <dev:code>Set-SearchCatalog -DiacriticSensitivity</dev:code> <dev:remarks> <maml:para>This command enables diacritic sensitivity for the default Windows Search catalog.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------- Example 2: Disable diacritic sensitivity -----------</maml:title> <dev:code>Set-SearchCatalog -DiacriticSensitivity:$false</dev:code> <dev:remarks> <maml:para>This command disables diacritic sensitivity for the default Windows Search catalog.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Set-SearchCatalog.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Set-SearchManager</command:name> <command:verb>Set</command:verb> <command:noun>SearchManager</command:noun> <maml:description> <maml:para>Changes global settings for Windows Search.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-SearchManager` cmdlet changes the global settings of Windows Search across all search catalogs.</maml:para> <maml:para>NOTE: You must run this cmdlet from an elevated PowerShell session. Start PowerShell by using the Run as administrator option.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SearchManager</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserAgent</maml:name> <maml:description> <maml:para>Specifies the user agent string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyAccess</maml:name> <maml:description> <maml:para>Specifies if and how a proxy server is used. The acceptable values for this parameter are:</maml:para> <maml:para>- `PROXY_ACCESS_PRECONFIG` - Use the Windows Network & Internet Settings.</maml:para> <maml:para>- `PROXY_ACCESS_DIRECT` - Don't use a proxy.</maml:para> <maml:para>- `PROXY_ACCESS_PROXY` - Use a proxy as specified by the other Proxy... parameters.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">PROXY_ACCESS_PRECONFIG</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PROXY_ACCESS_DIRECT</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PROXY_ACCESS_PROXY</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">_PROXY_ACCESS</command:parameterValue> <dev:type> <maml:name>SearchAPI._PROXY_ACCESS</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyName</maml:name> <maml:description> <maml:para>Specifies the name of the proxy server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyPortNumber</maml:name> <maml:description> <maml:para>Specifies the port number of the proxy server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyBypassLocal</maml:name> <maml:description> <maml:para>Use this parameter to bypass the proxy server for local addresses. Use the ProxyBypassList parameter to specifiy a list of local addresses.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyBypassList</maml:name> <maml:description> <maml:para>Specifies, as a string array, the local addresses for which the proxy server should not be used. Use this parameter in conjunction with the ProxyBypassLocal parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <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> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyAccess</maml:name> <maml:description> <maml:para>Specifies if and how a proxy server is used. The acceptable values for this parameter are:</maml:para> <maml:para>- `PROXY_ACCESS_PRECONFIG` - Use the Windows Network & Internet Settings.</maml:para> <maml:para>- `PROXY_ACCESS_DIRECT` - Don't use a proxy.</maml:para> <maml:para>- `PROXY_ACCESS_PROXY` - Use a proxy as specified by the other Proxy... parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SearchAPI._PROXY_ACCESS</command:parameterValue> <dev:type> <maml:name>SearchAPI._PROXY_ACCESS</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyBypassList</maml:name> <maml:description> <maml:para>Specifies, as a string array, the local addresses for which the proxy server should not be used. Use this parameter in conjunction with the ProxyBypassLocal parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyBypassLocal</maml:name> <maml:description> <maml:para>Use this parameter to bypass the proxy server for local addresses. Use the ProxyBypassList parameter to specifiy a list of local addresses.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyName</maml:name> <maml:description> <maml:para>Specifies the name of the proxy server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyPortNumber</maml:name> <maml:description> <maml:para>Specifies the port number of the proxy server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserAgent</maml:name> <maml:description> <maml:para>Specifies the user agent string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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>None</maml:name> </dev:type> <maml:description> <maml:para>You can't pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Microsoft's Windows Search documentation (https://learn.microsoft.com/windows/win32/search/-search-3x-wds-mngidx-searchmanager)states that the settings described above are implemented, but reserved for future use.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Configure a custom proxy server ----------</maml:title> <dev:code>Set-SearchManager -ProxyAccess PROXY_ACCESS_PROXY -ProxyName proxy.foo.org -ProxyPortNumber 8080</dev:code> <dev:remarks> <maml:para>This command tells Windows Search to use `proxy.foo.org:8080` as the proxy server.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 2: Configure local addresses to bypass the proxy. --</maml:title> <dev:code>Set-SearchManager -ProxyBypassLocal -ProxyBypassList localhost, 127.0.0.1, *.foo.org</dev:code> <dev:remarks> <maml:para>This command tells Windows Search to bypass the proxy for local addresses and provides a list of those local addresses.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------------- Example 3: Use Windows settings ---------------</maml:title> <dev:code>Set-SearchManager -ProxyAccess PROXY_ACCESS_PRECONFIG</dev:code> <dev:remarks> <maml:para>This command tells Windows Search to use the settings as configured in Windows Network & Internet Settings.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Set-SearchManager.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchManager</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Test-SearchRule</command:name> <command:verb>Test</command:verb> <command:noun>SearchRule</command:noun> <maml:description> <maml:para>Tests specified paths against the search rules of a search catalog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Test-SearchRule` cmdlet tests specified paths against the search rules of a search catalog.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-SearchRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the URL or path to be tested.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Use this parameter to return detailed results.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-SearchRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the URL or path to be tested.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HasChildScope</maml:name> <maml:description> <maml:para>Use this parameter to check if the specified path has child search rules.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-SearchRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the URL or path to be tested.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HasParentScope</maml:name> <maml:description> <maml:para>Use this parameter to check if the specified path has parent search rules.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-SearchRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the URL or path to be tested.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsIncluded</maml:name> <maml:description> <maml:para>Use this parameter to check if the specified path is included in the search catalog.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Use this parameter to return detailed results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HasChildScope</maml:name> <maml:description> <maml:para>Use this parameter to check if the specified path has child search rules.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HasParentScope</maml:name> <maml:description> <maml:para>Use this parameter to check if the specified path has parent search rules.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsIncluded</maml:name> <maml:description> <maml:para>Use this parameter to check if the specified path is included in the search catalog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the URL or path to be tested.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para>You can pipe paths to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para>When you use the IsIncluded , HasChildScope , or HasParentScope parameters, the cmdlet returns a Boolean value for each tested path.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Mawosoft.PowerShell.WindowsSearchManager.TestSearchRuleInfo</maml:name> </dev:type> <maml:description> <maml:para>When you use the Detailed parameter, the cmdlet returns an TestSearchRuleInfo object for each tested path.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>To learn more about search rules, see Managing Scope Rules (https://learn.microsoft.com/windows/win32/search/-search-3x-wds-extidx-csm-scoperules)in Microsoft's Windows Search documentation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Test if a path is included ------------</maml:title> <dev:code>Test-SearchRule -Path file:///C:\Users\Bob\Drafts\ True</dev:code> <dev:remarks> <maml:para>This command checks if the specified path is included in the default Windows Search catalog.</maml:para> <maml:para>For file system paths, you can omit the `file:///` protocol prefix.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------- Example 2: Test a path and get detailed results -------</maml:title> <dev:code>Test-SearchRule -Path C:\Users\Bob\Drafts\ -Detailed Path : C:\Users\Bob\Drafts IsIncluded : True Reason : CLUSIONREASON_DEFAULT HasChildScope : True HasParentScope : False ParentScopeVersiondId : 1</dev:code> <dev:remarks> <maml:para>This command gets details about the inclusion or exclusion of the specified path.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Test-SearchRule.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-SearchRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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"> <command:details> <command:name>Update-SearchCatalog</command:name> <command:verb>Update</command:verb> <command:noun>SearchCatalog</command:noun> <maml:description> <maml:para>Reindexes a search catalog either completely or partially.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Update-SearchCatalog` reindexes a search catalog either completely or partially.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-SearchCatalog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Use this parameter to reindex an entire search catalog.</maml:para> <maml:para>NOTE: To use the All parameter, you must run this cmdlet from an elevated PowerShell session. Start PowerShell by using the Run as administrator option.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SearchCatalog</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Use this parameter to specify an URL or path pattern to reindex all matching items.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SearchCatalog</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>RootPath</maml:name> <maml:description> <maml:para>Use this parameter to specify a search root to be reindexed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <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> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Use this parameter to reindex an entire search catalog.</maml:para> <maml:para>NOTE: To use the All parameter, you must run this cmdlet from an elevated PowerShell session. Start PowerShell by using the Run as administrator option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>Specifies the name of the catalog this cmdlet operates on. If omitted, this is the default Windows Search catalog, named SystemIndex .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemIndex</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Use this parameter to specify an URL or path pattern to reindex all matching items.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>RootPath</maml:name> <maml:description> <maml:para>Use this parameter to specify a search root to be reindexed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.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.String[]</maml:name> </dev:type> <maml:description> <maml:para>You can pipe paths to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns no output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The difference between `Reset-SearchCatalog` and `Update-SearchCatalog -All` is that the former removes any old information from the index before reindexing while the latter doesn't.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Reindex an entire catalog -------------</maml:title> <dev:code>Update-SearchCatalog -All</dev:code> <dev:remarks> <maml:para>This command reindexes the entire default Windows Search catalog.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------- Example 2: Reindex a search root. --------------</maml:title> <dev:code>Update-SearchCatalog -RootPath file:///C:\</dev:code> <dev:remarks> <maml:para>This command reindexes the search root drive `C:` in the default Windows Search catalog.</maml:para> <maml:para>For file system search roots, you can omit the `file:///` protocol prefix.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------- Example 3: Reindex matching paths. --------------</maml:title> <dev:code>Update-SearchCatalog -Path file:///C:\Users\*\Documents\*.docx</dev:code> <dev:remarks> <maml:para>This command reindexes all Microsoft Word files in and below the `Documents` folder of all users in the default Windows Search catalog.</maml:para> <maml:para>If the specified path is recognizable as a file system path, you can omit the `file:///` protocol prefix.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://mawosoft.github.io/WindowsSearchManager/reference/Update-SearchCatalog.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SearchCatalog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |