Get-UMIPGateway
This cmdlet is available only in on-premises Exchange.
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.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Default (Default)
Get-UMIPGateway
[[-Identity] <UMIPGatewayIdParameter>]
[-DomainController <Fqdn>]
[-IncludeSimulator]
[<CommonParameters>]
Description
The Get-UMIPGateway cmdlet displays the properties and values for a specified UM IP gateway, such as the display name, IP address, status and outgoing calls 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 configured on the UM IP gateway. You must use the name of the UM IP gateway. The name specified with the Identity parameter of the Get-UMIPGateway cmdlet can be the same as or different from the host name of the UM IP gateway, for example, Get-UMIPGatewayMyUMIPGateway.
After this task is completed, you can view 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 this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't 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-UMIPGateway | Format-List
This example displays a formatted list of all the UM IP gateways in the Active Directory forest.
Example 2
Get-UMIPGateway -Identity MyUMIPGateway
This example displays the properties for the UM IP gateway MyUMIPGateway.
Example 3
Get-UMIPGateway -IncludeSimulator $true
This example displays all the UM IP gateways including IP gateway simulators in the Active Directory forest.
Parameters
-DomainController
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
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.
Parameter properties
| Type: | Fqdn |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
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.
Parameter properties
| Type: | UMIPGatewayIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-IncludeSimulator
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
The IncludeSimulator switch retrieves the simulator of the UM IP gateway being viewed. You don't need to specify a value with this switch.
A simulator allows a client to connect to the Mailbox server.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.