LogoutALL

Metreos.Native.CiscoExtensionMobility.LogoutALL

Summary

Logs out a user from a device.

Usage

The LogoutALL action will log all users out of a device, if the user's device profile is currently logged into a device.

Remarks

This action will invoke the LogoutALL Extension Mobility API method by communicating to the specified Cisco Unified Communications Manager node.

Action Parameters
Parameter Name.NET TypeDefaultDescription
AppId *System.StringThe name of a user configured in Cisco Unified Communications Manager that has the necessary permissions to invoke methods on the Extension Mobility service.
AppCertificate *System.StringThe password of the user specified by AppId.
UrlSystem.StringThe URL for the Extension Mobility Service. This field should only be specified if the Extension Mobility Service is in a non-default location. This field is also completely ignored if any non-null value is specified as the CallManagerHost.
CallManagerHostSystem.StringThe IP address and port of the publisher CallManager IP, in the form '[IP]:[Port]'. Note that the Extension Mobility service is on port 80 by default in 3.x/4.x, and on port 8080 by default in 5.x/6.x.
VersionMetreos.Native.CiscoExtensionMobility.CcmVersionUndefinedThe version of Cisco Unified Communications Manager. This version is used in conjuction with CallManagerHost to build the URL of the Extension Mobility Service. The possible values are described below:
other

Specifiy other if the Cisco Unified Communications Manager version is anything above 3.3.

v333

Specify v333 if the Cisco Unified Communications Manager version is 3.3.3, 3.3.4, or 3.3.5.

Undefined

This is the default value to when nothing is specified for the Version field. It is strongly recommended that this value not be used because the behavior is undefined as well.

Result Data
Parameter Name.NET TypeDescription
ErrorCodeSystem.Int32This error code maps almost exactly to the standard Cisco Unified Communications Manager Extension Mobility API error codes. The one exception is if the service returns 0, which is returned by this action if the Extension Mobility service did not respond back to the Cisco Unified Application Server with response XML or if the action was unable to communication with the service.
ErrorMessageSystem.StringThis error message maps almost exactly to the standard Cisco Unified Communications Manager Extension Mobility API error messages. The one exception is if the service returns null, which is returned by this action if the Extension Mobility service did not respond back to the Cisco Unified Application Server with response XML or if the action was unable to communication with the service.

Branch Conditions 

Success

No description.

Failure

No description.