Skip to content

Commit c90d0b2

Browse files
committed
Completed Start-MailboxAssistant docs
1 parent 8466bd2 commit c90d0b2

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

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

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.reviewer:
1313
## SYNOPSIS
1414
This cmdlet is available only in Exchange Server 2019 in Cumulative Update 11 (CU11) or later.
1515

16-
Use the Start-MailboxAssistant cmdlet to ???.
16+
Use the Start-MailboxAssistant cmdlet to start processing of a mailbox by the assistant, which was specified using the AssistantName parameter.
1717

1818
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
1919

@@ -36,15 +36,23 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
3636

3737
### Example 1
3838
```powershell
39-
{{ Add example code here }}
39+
Start-MailboxAssistant -Identity "Chris" -AssistantName BigFunnelRetryFeederTimeBasedAssistant
4040
```
4141

42-
{{ Add example description here }}
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]
45+
>
46+
> A [setting override](New-SettingOverride.md) must first be created as described in the [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) article.
4347
4448
## PARAMETERS
4549

4650
### -Identity
47-
{{ Fill Identity Description }}
51+
The Identity parameter specifies the user whose mailboxt should be processed by the Mailbox Assistant. Possible values are:
52+
53+
- Distinguished name (DN)
54+
- SamAccountName
55+
- User ID or user principal name (UPN)
4856

4957
```yaml
5058
Type: UserIdParameter
@@ -60,7 +68,9 @@ Accept wildcard characters: False
6068
```
6169
6270
### -AssistantName
63-
{{ Fill AssistantName Description }}
71+
The AssistantName parameter specifies the assistant, which should process the mailbox. The AssistantName is case-sensitive. Supported values are:
72+
73+
- BigFunnelRetryFeederTimeBasedAssistant
6474
6575
```yaml
6676
Type: String
@@ -111,7 +121,7 @@ Accept wildcard characters: False
111121
```
112122

113123
### -Parameters
114-
{{ Fill Parameters Description }}
124+
This parameter is reserved for internal Microsoft use.
115125

116126
```yaml
117127
Type: String
@@ -127,7 +137,7 @@ Accept wildcard characters: False
127137
```
128138

129139
### -SoftDeletedMailbox
130-
{{ Fill SoftDeletedMailbox Description }}
140+
Use this switch parameter if the mailbox, which should be process by the assistant, is in a soft-deleted state.
131141

132142
```yaml
133143
Type: SwitchParameter

0 commit comments

Comments
 (0)