Skip to content

Commit 2dfffe6

Browse files
chrisdachrisda
committed
Update Get-CalendarDiagnosticLog.md
Cleanup based on recent platyPS run
1 parent 610ce37 commit 2dfffe6

File tree

1 file changed

+78
-35
lines changed

1 file changed

+78
-35
lines changed

‎exchange/exchange-ps/exchange/mailboxes/Get-CalendarDiagnosticLog.md

Lines changed: 78 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For information about the parameter sets in the Syntax section below, see Exchan
2222

2323
### MeetingId
2424
```
25-
Get-CalendarDiagnosticLog [-Identity] <MailboxIdParameter> -MeetingID <String> [-EndDate <ExDateTime>] [-Latest] [-StartDate <ExDateTime>] [-Subject <String>] [-EntryId <String>] [-ExactMatch <$true | $false>] [-ItemClass <String[]>] [-ItemIds <String[]>]
25+
Get-CalendarDiagnosticLog [-Identity] <MailboxIdParameter> -MeetingID <String>
2626
[-Credential <PSCredential>]
2727
[-DomainController <Fqdn>]
2828
[-LogLocation <String>]
@@ -42,6 +42,25 @@ Get-CalendarDiagnosticLog [-Identity] <MailboxIdParameter> -Subject <String>
4242
[<CommonParameters>]
4343
```
4444

45+
### ExportToMsg
46+
```
47+
Get-CalendarDiagnosticLog [-Identity] <MailboxIdParameter> -LogLocation <String>
48+
[-Credential <PSCredential>]
49+
[-DomainController <Fqdn>]
50+
[-EndDate <ExDateTime>]
51+
[-EntryId <String>]
52+
[-ExactMatch <Boolean>]
53+
[-ItemClass <String[]>]
54+
[-ItemIds <String[]>]
55+
[-Latest]
56+
[-MeetingID <String>]
57+
[-ReadFromDomainController]
58+
[-ResultSize <Unlimited>]
59+
[-StartDate <ExDateTime>]
60+
[-Subject <String>]
61+
[<CommonParameters>]
62+
```
63+
4564
## DESCRIPTION
4665
The output of this cmdlet contains the following information:
4766

@@ -128,7 +147,40 @@ Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Ex
128147
Required: True
129148
Position: 1
130149
Default value: None
131-
Accept pipeline input: True
150+
Accept pipeline input: True (ByPropertyName)
151+
Accept wildcard characters: False
152+
```
153+
154+
### -LogLocation
155+
The LogLocation parameter specifies the location to export the calendar items to .msg files. You can specify a local path, or a UNC path (\\\\\<Server\>\\\<Share\>). If the value contains spaces, enclose the value in quotation marks (").
156+
157+
In the location you specify, a subfolder is automatically created for the specified mailbox that holds the exported calendar items. For example, if you specify the value "C:\\My Documents\\Calendar Export" to export calendar items from the mailbox of Shannon Steele, the .msg files are actually stored in C:\\My Documents\\Calendar Export\\[email protected].
158+
159+
In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet with the LogLocation parameter to analyze the exported .msg files.
160+
161+
Note: Commands that use this parameter might fail if the calendar item doesn't have a title. If you receive errors when you use this parameter, run the command again and replace this parameter with redirection to a file (| Set-Content -Path "C:\\My Documents\\Calendar Export") or substitute the output to a PowerShell variable.
162+
163+
```yaml
164+
Type: String
165+
Parameter Sets: ExportToMsg
166+
Aliases:
167+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
168+
Required: True
169+
Position: Named
170+
Default value: None
171+
Accept pipeline input: False
172+
Accept wildcard characters: False
173+
```
174+
175+
```yaml
176+
Type: String
177+
Parameter Sets: MeetingId, MeetingSubject
178+
Aliases:
179+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
180+
Required: False
181+
Position: Named
182+
Default value: None
183+
Accept pipeline input: False
132184
Accept wildcard characters: False
133185
```
134186
@@ -147,7 +199,19 @@ Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Ex
147199
Required: True
148200
Position: Named
149201
Default value: None
150-
Accept pipeline input: True
202+
Accept pipeline input: True (ByPropertyName)
203+
Accept wildcard characters: False
204+
```
205+
206+
```yaml
207+
Type: String
208+
Parameter Sets: ExportToMsg
209+
Aliases:
210+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
211+
Required: False
212+
Position: Named
213+
Default value: None
214+
Accept pipeline input: True (ByPropertyName)
151215
Accept wildcard characters: False
152216
```
153217
@@ -158,10 +222,10 @@ Don't use this parameter with the MeetingID parameter, because the value of the
158222
159223
```yaml
160224
Type: String
161-
Parameter Sets: MeetingId
225+
Parameter Sets: MeetingSubject
162226
Aliases:
163227
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
164-
Required: False
228+
Required: True
165229
Position: Named
166230
Default value: None
167231
Accept pipeline input: False
@@ -170,10 +234,10 @@ Accept wildcard characters: False
170234
171235
```yaml
172236
Type: String
173-
Parameter Sets: MeetingSubject
237+
Parameter Sets: ExportToMsg
174238
Aliases:
175239
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
176-
Required: True
240+
Required: False
177241
Position: Named
178242
Default value: None
179243
Accept pipeline input: False
@@ -223,7 +287,7 @@ Use the short date format that's defined in the Regional Options settings on the
223287

224288
```yaml
225289
Type: ExDateTime
226-
Parameter Sets: MeetingId
290+
Parameter Sets: ExportToMsg
227291
Aliases:
228292
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
229293
Required: False
@@ -238,7 +302,7 @@ The EntryId parameter filters the results by entry ID. You can specify multiple
238302

239303
```yaml
240304
Type: String
241-
Parameter Sets: MeetingId
305+
Parameter Sets: ExportToMsg
242306
Aliases:
243307
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
244308
Required: False
@@ -263,7 +327,7 @@ The value of this parameter is ignored when you use the MeetingId parameter.
263327

264328
```yaml
265329
Type: $true | $false
266-
Parameter Sets: MeetingId
330+
Parameter Sets: ExportToMsg
267331
Aliases:
268332
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
269333
Required: False
@@ -280,7 +344,7 @@ You can only use this parameter with the MeetingID parameter.
280344

281345
```yaml
282346
Type: String[]
283-
Parameter Sets: MeetingId
347+
Parameter Sets: ExportToMsg
284348
Aliases:
285349
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
286350
Required: False
@@ -295,7 +359,7 @@ The ItemIds parameter filters the results by item ID. You can specify multiple v
295359

296360
```yaml
297361
Type: String[]
298-
Parameter Sets: MeetingId
362+
Parameter Sets: ExportToMsg
299363
Aliases:
300364
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
301365
Required: False
@@ -310,7 +374,7 @@ The Latest switch specifies whether to return calendar log data for only the mos
310374

311375
```yaml
312376
Type: SwitchParameter
313-
Parameter Sets: MeetingId
377+
Parameter Sets: ExportToMsg
314378
Aliases:
315379
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
316380
Required: False
@@ -320,27 +384,6 @@ Accept pipeline input: False
320384
Accept wildcard characters: False
321385
```
322386

323-
### -LogLocation
324-
The LogLocation parameter specifies the location to export the calendar items to .msg files. You can specify a local path, or a UNC path (\\\\\<Server\>\\\<Share\>). If the value contains spaces, enclose the value in quotation marks (").
325-
326-
In the location you specify, a subfolder is automatically created for the specified mailbox that holds the exported calendar items. For example, if you specify the value "C:\\My Documents\\Calendar Export" to export calendar items from the mailbox of Shannon Steele, the .msg files are actually stored in C:\\My Documents\\Calendar Export\\[email protected].
327-
328-
In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet with the LogLocation parameter to analyze the exported .msg files.
329-
330-
Note: Commands that use this parameter might fail if the calendar item doesn't have a title. If you receive errors when you use this parameter, run the command again and replace this parameter with redirection to a file (| Set-Content -Path "C:\\My Documents\\Calendar Export") or substitute the output to a PowerShell variable.
331-
332-
```yaml
333-
Type: String
334-
Parameter Sets: (All)
335-
Aliases:
336-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
337-
Required: False
338-
Position: Named
339-
Default value: None
340-
Accept pipeline input: False
341-
Accept wildcard characters: False
342-
```
343-
344387
### -ReadFromDomainController
345388
This parameter is available only in on-premises Exchange.
346389

@@ -382,7 +425,7 @@ Use the short date format that's defined in the Regional Options settings on the
382425

383426
```yaml
384427
Type: ExDateTime
385-
Parameter Sets: MeetingId
428+
Parameter Sets: ExportToMsg
386429
Aliases:
387430
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
388431
Required: False

0 commit comments

Comments
 (0)