Get-UMActiveCalls

Module:

ExchangePowerShell

Applies to:

Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

This cmdlet is available only in on-premises Exchange.

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 Exchange cmdlet syntax.

Syntax

Get-UMActiveCalls
   -DialPlan <UMDialPlanIdParameter>
   [-DomainController <Fqdn>]
   [<CommonParameters>]

Get-UMActiveCalls
   -InstanceServer <UMServer>
   [-DomainController <Fqdn>]
   [<CommonParameters>]

Get-UMActiveCalls
   -IPGateway <UMIPGatewayIdParameter>
   [-DomainController <Fqdn>]
   [<CommonParameters>]

Get-UMActiveCalls
   [-Server <ServerIdParameter>]
   [-DomainController <Fqdn>]
   [<CommonParameters>]

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.

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 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.

Examples

Example 1

Get-UMActiveCalls

This example displays the details of all active calls on the local Mailbox server.

Example 2

Get-UMActiveCalls -Server MyUMServer

This example displays the details of all active calls on the Mailbox server MyUMServer.

Example 3

Get-UMActiveCalls -IPGateway MyUMIPGateway

This example displays the details of all active calls being processed by the UM IP gateway MyUMIPGateway.

Example 4

Get-UMActiveCalls -DialPlan MyUMDialPlan

This example displays a list of active calls associated with the UM dial plan MyUMDialPlan.

Parameters

-DialPlan

The DialPlan parameter specifies the UM dial plan for which you want to retrieve active calls.

You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command.

Type:	UMDialPlanIdParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

-DomainController

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.

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

-InstanceServer

The InstanceServer parameter specifies the Mailbox server running the Microsoft Exchange Unified Messaging service for which you want to retrieve active calls.

You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command.

Type:	UMServer
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

-IPGateway

The IPGateway parameter specifies the UM IP gateway for which you want to retrieve active calls.

You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command.

Type:	UMIPGatewayIdParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

-Server

The Server parameter filters the results by the specified Unified Messaging server. You can use any value that uniquely identifies the server. For example:

• Name
• FQDN
• Distinguished name (DN)
• Exchange Legacy DN

You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command.

Type:	ServerIdParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

Inputs

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.

Outputs

Output 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.