Applies to: Exchange Server 2013
Topic Last Modified: 2012-07-02
Use the Get-UMActiveCalls cmdlet to return information about the calls that are active and being processed by the Mailbox server running the Microsoft Exchange Unified Messaging service.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-UMActiveCalls [-Server <ServerIdParameter>]
<COMMON PARAMETERS>
|
Get-UMActiveCalls -InstanceServer <UMServer>
<COMMON PARAMETERS>
|
Get-UMActiveCalls -DialPlan <UMDialPlanIdParameter>
<COMMON PARAMETERS>
|
Get-UMActiveCalls -IPGateway
<UMIPGatewayIdParameter> <COMMON PARAMETERS>
|
COMMON PARAMETERS: [-DomainController
<Fqdn>]
|
Examples
EXAMPLE 1
This example displays the details of all active calls on the local Mailbox server.
 Copy Code |
|
|---|---|
Get-UMActiveCalls |
|
EXAMPLE 2
This example displays the details of all active calls on the Mailbox server MyUMServer.
| Copy Code |
|
|---|---|
Get-UMActiveCalls -Server MyUMServer |
|
EXAMPLE 3
This example displays the details of all active calls being processed by the UM IP gateway MyUMIPGateway.
| Copy Code |
|
|---|---|
Get-UMActiveCalls -IPGateway MyUMIPGateway |
|
EXAMPLE 4
This example displays a list of active calls associated with the UM dial plan MyUMDialPlan.
| Copy Code |
|
|---|---|
Get-UMActiveCalls -DialPlan MyUMDialPlan |
|
Detailed Description
The Get-UMActiveCalls cmdlet returns information about the active calls being processed. If the Get-UMActiveCalls cmdlet specifies either the UM dial plan or UM IP gateway, it looks in Active Directory to determine which Mailbox server running the Microsoft Exchange Unified Messaging service must be contacted. If the Mailbox server is specified at a command prompt, the Get-UMActiveCalls cmdlet returns the active calls being processed by the server specified.
 Note: |
|---|
| When a Mailbox server is process cycling, the Get-UMActiveCalls cmdlet doesn't return a list of all calls for both the discontinued process and the active process. It returns the active calls only for the new process. |
After this task is completed, you can see the list of active calls being processed by a Mailbox server.
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 "Mailbox Server (UM service)" entry in the Unified Messaging Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
DialPlan |
Required |
Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter |
The DialPlan parameter specifies the UM dial plan for which you want to retrieve active calls. |
|
InstanceServer |
Required |
Microsoft.Exchange.Data.Directory.Management.UMServer |
The InstanceServer parameter specifies the Mailbox server running the Microsoft Exchange Unified Messaging service for which you want to retrieve active calls. |
|
IPGateway |
Required |
Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter |
The IPGateway parameter specifies the UM IP gateway for which you want to retrieve active calls. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. |
|
Server |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Server parameter specifies the Mailbox server running the Microsoft Exchange Unified Messaging service for which you want to retrieve active calls. |
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.