Applies to: Exchange Server 2013
Topic Last Modified: 2012-06-29
Use the Disable-UMIPGateway cmdlet to disable a Unified Messaging (UM) IP gateway.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Disable-UMIPGateway -Identity
<UMIPGatewayIdParameter> [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-Immediate <$true |
$false>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example disables the UM IP gateway MyUMIPGateway and stops it from accepting incoming calls from the IP gateway.
 Copy Code |
|
|---|---|
Disable-UMIPGateway -Identity MyUMIPGateway |
|
EXAMPLE 2
This example disables the UM IP gateway MyUMIPGateway and disconnects all current calls immediately.
| Copy Code |
|
|---|---|
Disable-UMIPGateway -Identity MyUMIPGateway -Immediate $true |
|
Detailed Description
The status variable for a UM IP gateway can be used to enable or disable call answering destined for the IP gateway. The Disable-UMIPGateway cmdlet disables a UM IP gateway in Active Directory by modifying its status variable. After this task is completed, the UM IP gateway no longer answers incoming calls or makes outgoing calls.
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 |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter |
The Identity parameter specifies the identifier for the UM IP gateway being disabled. This is the directory object ID for the UM IP gateway. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
Immediate |
Optional |
System.Boolean |
The Immediate parameter specifies whether the Mailbox server running the Microsoft Exchange Unified Messaging service drops incoming calls associated with this UM IP gateway immediately or waits for the current calls to finish processing. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
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.