Get-UMIPGateway
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Get-UMIPGateway cmdlet returns a list of properties and values for a specified UM IP gateway or for a list of UM IP gateways.
Syntax
Get-UMIPGateway [-Identity <UMIPGatewayIdParameter>] [-DomainController <Fqdn>] [-IncludeSimulator <SwitchParameter>]
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 will be returned.
To run the Get-UMIPGateway cmdlet, the account you use must be delegated the Exchange View-Only Administrator role.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet. |
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter |
This parameter specifies the identifier for the UM IP gateway that is being viewed. This parameter is the directory object ID for the UM IP gateway. |
IncludeSimulator |
Optional |
System.Management.Automation.SwitchParameter |
This parameter retrieves the simulator of the UM IP gateway that is being viewed. A simulator allows a client to connect to the Unified Messaging server. This connection is typically used with the Exchange UM Test Phone application. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The first example displays a formatted list of all the UM IP gateways in the Active Directory forest.
The second example displays the properties for a UM IP gateway named MyUMIPGateway.
The third example displays all the UM IP gateways including IP gateway simulators in the Active Directory forest.
Get-UMIPGateway |format-list
Get-UMIPGateway -Identity MyUMIPGateway
Get-UMIPGateway -IncludeSimulator $true