Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-12-27
Use the Get-UMIPGateway cmdlet to return a list of properties and values for a specified Unified Messaging (UM) IP gateway or a list of UM IP gateways.
Syntax
Get-UMIPGateway [-Identity
<UMIPGatewayIdParameter>] [-DomainController <Fqdn>]
[-IncludeSimulator <SwitchParameter>] [-Organization
<OrganizationIdParameter>]
|
Detailed Description
The Get-UMIPGateway cmdlet displays the properties and values for a specified UM IP gateway, such as the display name, the IP address, status, and outcall settings. If no parameter is specified, all UM IP gateways in the Active Directory forest are returned.
When you’re using the Get-UMIPGateway cmdlet, you can’t enter the IP address that’s configured on the UM IP gateway. You must use the name of the UM IP gateway. The name that’s specified on the Identity parameter with the Get-UMIPGateway cmdlet can be the same as or different from the host name of the UM IP gateway. For example, Get-UMIPGateway MyUMIPGateway.
After this task is completed, you can see the list of properties and values for a specific UM IP gateway. Or, if the Identity parameter isn't used, the cmdlet returns a list of all UM IP gateways in the forest.
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 IP gateways" entry in the Unified Messaging Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
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. |
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter |
The Identity parameter specifies the identifier for the UM IP gateway being viewed. This parameter is the directory object ID for the UM IP gateway. |
|
IncludeSimulator |
Optional |
System.Management.Automation.SwitchParameter |
The IncludeSimulator parameter retrieves the simulator of the UM IP gateway being viewed. A simulator allows a client to connect to the Unified Messaging server. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
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.
Examples
EXAMPLE 1
This example displays a formatted list of all the UM IP gateways in the Active Directory forest.
 Copy Code |
|
|---|---|
Get-UMIPGateway |Format-List |
|
EXAMPLE 2
This example displays the properties for a UM IP gateway named MyUMIPGateway.
| Copy Code |
|
|---|---|
Get-UMIPGateway -Identity MyUMIPGateway |
|
EXAMPLE 3
This example displays all the UM IP gateways including IP gateway simulators in the Active Directory forest.
| Copy Code |
|
|---|---|
Get-UMIPGateway -IncludeSimulator $true |
|