Skip to content

Commit ec25bac

Browse files
chrisdachrisda
authored
Merge pull request MicrosoftDocs#11488 from lusassl-msft/lusassl-SMA
Start-MailboxAssistant documentation completed
2 parents a52e769 + 9533306 commit ec25bac

File tree

3 files changed

+185
-0
lines changed

3 files changed

+185
-0
lines changed

‎exchange/exchange-ps/exchange/Start-MailboxAssistant.md

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
---
2+
external help file: Microsoft.Exchange.RolesAndAccess-Help.xml
3+
online version: https://learn.microsoft.com/powershell/module/exchange/start-mailboxassistant
4+
applicable: Exchange Server 2019
5+
title: Start-MailboxAssistant
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
# Start-MailboxAssistant
12+
13+
## SYNOPSIS
14+
This cmdlet is available only in Exchange Server 2019 in Cumulative Update 11 (CU11) or later.
15+
16+
Use the Start-MailboxAssistant cmdlet to start processing of a mailbox by the specified assistant.
17+
18+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
19+
20+
## SYNTAX
21+
22+
```
23+
Start-MailboxAssistant [-Identity] <UserIdParameter> -AssistantName <String>
24+
[-Confirm]
25+
[-DomainController <Fqdn>]
26+
[-Parameters <String>]
27+
[-SoftDeletedMailbox]
28+
[-WhatIf]
29+
[<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
34+
35+
## EXAMPLES
36+
37+
### Example 1
38+
```powershell
39+
Start-MailboxAssistant -Identity "Chris" -AssistantName BigFunnelRetryFeederTimeBasedAssistant
40+
```
41+
42+
This example starts the `BigFunnelRetryFeederTimeBasedAssistant` assistant and lets it process the mailbox of the user "Chris". The assistant indexes the mailbox items that were not indexed previously.
43+
44+
**Note**: You first need to create a setting override as described in [Incomplete search results after installing an Exchange Server 2019 update](https://support.microsoft.com/topic/incomplete-search-results-after-installing-an-exchange-server-2019-update-96ae2ef0-4569-4327-8d0c-8a3c1abdc1f6).
45+
46+
## PARAMETERS
47+
48+
### -Identity
49+
The Identity parameter specifies the user whose mailbox should be processed by the Mailbox Assistant. Valid values are:
50+
51+
- Distinguished name (DN)
52+
- SamAccountName
53+
- User ID or user principal name (UPN)
54+
55+
```yaml
56+
Type: UserIdParameter
57+
Parameter Sets: (All)
58+
Aliases:
59+
Applicable: Exchange Server 2019
60+
61+
Required: True
62+
Position: 0
63+
Default value: None
64+
Accept pipeline input: True (ByPropertyName, ByValue)
65+
Accept wildcard characters: False
66+
```
67+
68+
### -AssistantName
69+
The AssistantName parameter specifies the assistant that should process the mailbox. Valid values are:
70+
71+
- BigFunnelRetryFeederTimeBasedAssistant
72+
73+
Values are case sensitive.
74+
75+
```yaml
76+
Type: String
77+
Parameter Sets: (All)
78+
Aliases:
79+
Applicable: Exchange Server 2019
80+
81+
Required: True
82+
Position: Named
83+
Default value: None
84+
Accept pipeline input: False
85+
Accept wildcard characters: False
86+
```
87+
88+
### -Confirm
89+
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
90+
91+
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
92+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
93+
94+
```yaml
95+
Type: SwitchParameter
96+
Parameter Sets: (All)
97+
Aliases: cf
98+
Applicable: Exchange Server 2019
99+
100+
Required: False
101+
Position: Named
102+
Default value: None
103+
Accept pipeline input: False
104+
Accept wildcard characters: False
105+
```
106+
107+
### -DomainController
108+
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
109+
110+
```yaml
111+
Type: Fqdn
112+
Parameter Sets: (All)
113+
Aliases:
114+
Applicable: Exchange Server 2019
115+
116+
Required: False
117+
Position: Named
118+
Default value: None
119+
Accept pipeline input: False
120+
Accept wildcard characters: False
121+
```
122+
123+
### -Parameters
124+
This parameter is reserved for internal Microsoft use.
125+
126+
```yaml
127+
Type: String
128+
Parameter Sets: (All)
129+
Aliases:
130+
Applicable: Exchange Server 2019
131+
132+
Required: False
133+
Position: Named
134+
Default value: None
135+
Accept pipeline input: False
136+
Accept wildcard characters: False
137+
```
138+
139+
### -SoftDeletedMailbox
140+
The SoftDeletedMailbox switch specifies that the mailbox to be processed by the assistant is a soft-delted mailbox.
141+
142+
Soft-deleted mailboxes are deleted mailboxes that are still recoverable.
143+
144+
```yaml
145+
Type: SwitchParameter
146+
Parameter Sets: (All)
147+
Aliases:
148+
Applicable: Exchange Server 2019
149+
150+
Required: False
151+
Position: Named
152+
Default value: None
153+
Accept pipeline input: False
154+
Accept wildcard characters: False
155+
```
156+
157+
### -WhatIf
158+
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
159+
160+
```yaml
161+
Type: SwitchParameter
162+
Parameter Sets: (All)
163+
Aliases: wi
164+
Applicable: Exchange Server 2019
165+
166+
Required: False
167+
Position: Named
168+
Default value: None
169+
Accept pipeline input: False
170+
Accept wildcard characters: False
171+
```
172+
173+
### CommonParameters
174+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
175+
176+
## INPUTS
177+
178+
## OUTPUTS
179+
180+
## NOTES
181+
182+
## RELATED LINKS

‎exchange/exchange-ps/exchange/exchange.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1064,6 +1064,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow
10641064

10651065
### [Set-SearchDocumentFormat](Set-SearchDocumentFormat.md)
10661066

1067+
### [Start-MailboxAssistant](Start-MailboxAssistant.md)
1068+
10671069
### [Test-AssistantHealth](Test-AssistantHealth.md)
10681070

10691071
### [Test-ExchangeSearch](Test-ExchangeSearch.md)

‎exchange/mapping/serviceMapping.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -517,6 +517,7 @@
517517
"Set-MailboxDatabase": "mailbox-databases-and-servers",
518518
"Set-MailboxServer": "mailbox-databases-and-servers",
519519
"Set-SearchDocumentFormat": "mailbox-databases-and-servers",
520+
"Start-MailboxAssistant": "mailbox-databases-and-servers",
520521
"Test-AssistantHealth": "mailbox-databases-and-servers",
521522
"Test-ExchangeSearch": "mailbox-databases-and-servers",
522523
"Test-MRSHealth": "mailbox-databases-and-servers",

0 commit comments

Comments
 (0)