[This topic is in progress.]

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2011-08-30

Use the Export-UMCallDataRecord cmdlet to export Unified Messaging (UM) call data records for UM dial plans and UM IP gateways for a date that you've specified.

Syntax

Export-UMCallDataRecord -ClientStream <Stream> -Date <ExDateTime> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-UMDialPlan <UMDialPlanIdParameter>] [-UMIPGateway <UMIPGatewayIdParameter>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Export-UMCallDataRecord cmdlet exports Unified Messaging call data records for a specified date to a comma separated value (.csv) file. You can filter call data records for specific UM dial plans and/or UM IP gateways; however, if you don't specify a UM IP gateway, all call data records will be returned.

Note:
The Export-UMCallDataRecord cmdlet is available when you’re using the Exchange Control Panel. You can’t use the cmdlet from the Exchange Management Shell.

After this task is completed, a report is generated that contains Unified Messaging call data records.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "UM call data and summary reports" entry in the Unified Messaging Permissions topic.

Parameters

Parameter Required Type Description

ClientStream

Required

System.IO.Stream

The ClientStream parameter specifies the .NET stream to use to output for the Unified Messaging call data records.

Date

Required

Microsoft.Exchange.ExchangeSystem.ExDateTime

The Date parameter specifies the date of Unified Messaging call data records to retrieve, in the last 90 days. If there are no call records for the date specified, the report will be empty.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

UMDialPlan

Optional

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

The UMDialPlan parameter specifies the UM dial plan to export statistics for. If you don't specify a UM dial plan, statistics include all UM dial plans in the organization

UMIPGateway

Optional

Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter

The UMIPGateway parameter specifies the UM IP gateway to export statistics for. If you don't specify a gateway, statistics include all UM IP gateways in the selected UM dial plan, or if a UM dial plan isn't selected, statistics include all UM IP gateways in the organization.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Errors

Error Description

"Organizations of UMDialPlan {0} and UMIPGateway {1} do not match."

This error message appears when the organization identity of the UMIPGateway and UMDialPlan parameters don't match.

Examples

EXAMPLE 1

This example returns all Unified Messaging call data records and exports them to a CSV file.

Copy Code
Export-UMCallDataRecord -Date 02/01/10

EXAMPLE 2

This example exports all Unified Messaging call data records for February 1, 2010 for the UM dial plan MyUMDialPlan.

Copy Code
Export-UMCallDataRecord -Date 02/01/10 -UMDialPlan MyUMDialPlan