Get-UMActiveCalls
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Get-UMActiveCalls cmdlet returns information about the calls that are active and being processed by the Unified Messaging server.
Syntax
Get-UMActiveCalls [-DomainController <Fqdn>] [-Server <ServerIdParameter>]
Get-UMActiveCalls -InstanceServer <UMServer> [-DomainController <Fqdn>]
Get-UMActiveCalls -DialPlan <UMDialPlanIdParameter> [-DomainController <Fqdn>]
Get-UMActiveCalls -IPGateway <UMIPGatewayIdParameter> [-DomainController <Fqdn>]
Detailed Description
The Get-UMActiveCalls cmdlet returns information about the active calls that are being processed. If the Get-UMActiveCalls cmdlet specifies either the UM dial plan or UM IP gateway, it will look in the Active Directory directory service to determine which Unified Messaging servers must be contacted. If the Unified Messaging server is specified in the command line, the Get-UMActiveCalls cmdlet returns the active calls that are being processed by the server that is specified.
Note
When a Unified Messaging server is process cycling, the Get-UMActiveCalls cmdlet will not return a list of all calls for both the discontinued process and the active process. It will return the active calls only for the new process.
To run the Get-UMActiveCalls cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.
For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
DialPlan |
Required |
Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter |
This parameter specifies the UM dial plan for which you want to retrieve active calls. |
InstanceServer |
Required |
Microsoft.Exchange.Data.Directory.Management.UMServer |
This parameter specifies the Unified Messaging server for which you want to retrieve active calls. |
IPGateway |
Required |
Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter |
This parameter specifies the UM IP gateway for which you want to retrieve active calls. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory, include the DomainController parameter in the command. |
Server |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
This parameter specifies the Unified Messaging server for which you want to retrieve active calls. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The first code example displays the details of all active calls on the local Unified Messaging server.
The second code example displays the details of all active calls on a Unified Messaging server named MyUMServer.
The third code example displays details of all active calls that are being processed by a UM IP gateway named MyUMIPGateway.
The fourth code example displays a list of active calls that are associated with the UM dial plan named MyUMDialPlan.
Get-UMActiveCalls
Get-UMActiveCalls -Server MyUMServer
Get-UMActiveCalls -IPGateway MyUMIPGateway
Get-UMActiveCalls -DialPlan MyUMDialPlan