Unified Messaging 2007 Provider::GetUMIPGateway

  • Article

This procedure gets the properties for an IP Gateway.

Arguments

Input Arguments Required Description

<preferredDomainController>

Yes

The domain controller to use for Active Directory actions.

<identity>

No

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>

No

This parameter retrieves the simulator of the Unified Messaging (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.

Remarks

Security

The caller must be at least a member of role: UserCreators.

Sample Code

Example XML Request

<request> 
        <data/> 
        <procedure> 
                <execute namespace='Unified Messaging 2007 Provider' procedure='GetUMIPGateway'> 
                        <executeData> 
                                <identity>Fabrikam\Gateway1</indentity> 
                                <preferredDomainController>dc01.fabrikam.local</preferredDomainController> 
                                <includeSimulator>true</includeSimulator> 
                        </executeData> 
                </execute> 
        </procedure> 
</request>

Example XML Response

<data> 
        <ipGateways> 
        <ipGateway name="gatewayname"> 
        <properties> 
                <property name="propertyName"> 
                        <value>return value</value> 
                        . 
                </property> 
                . 
        </ properties> 
        </ipGateway> 
        </ipGateways> 
</data>

Applies To

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0