getDeploymentMode

The getDeploymentMode method returns the deployment mode which reflects the licensing model of the product. The deployment mode returned will be either Enterprise, HCS (Hosted Collaboration Service), or HCS-LE (Hosted Collaboration Service - Large Enterprise).
Note:Unified Communications Manager release 14(1)SU1 and 12.5(1)SU7 does not support HCS-LE Deployment mode

Request Parameters
None
Response Parameters (return element children)
result


A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.
deploymentMode


Deployment mode as follows:

    • Enterprise - The server is used as part of a standard enterprise deployment.
    • HCS - The server is hosted by a service provider using the Hosted Collaboration Solution (HCS) end-to-end system.
    • HCS-LE - The server is hosted by a service provider using the Hosted Collaboration Solution (HCS) end-to-end system with centralized management of services and licensing to multiple business units.
Example Request and Response
Request Response 
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
		<wsa:Action>urn:getDeploymentMode</wsa:Action>
		<wsa:ReplyTo>
			<wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
		</wsa:ReplyTo>
		<wsa:MessageID>uuid:26634481-3273-4a70-b537-ab4b874e4d6b</wsa:MessageID>
	</soapenv:Header>
	<soapenv:Body/>
</soapenv:Envelope>
								
								
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
		<wsa:Action>urn:getDeploymentModeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:26634481-3273-4a70-b537-ab4b874e4d6b</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getDeploymentModeResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax274="http://api.platform.vos.cisco.com/xsd" xmlns:ax273="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax273:DeploymentModeResponse">
				<ax273:result>internal.request.complete</ax273:result>
				<ax273:deploymentMode>Enterprise</ax273:deploymentMode>
			</ns:return>
		</ns:getDeploymentModeResponse>
	</soapenv:Body>
</soapenv:Envelope>

setDeploymentMode

The setDeploymentMode method allows you to set the deployment mode which reflects the licensing model of the product. The deployment mode can be set to either Enterprise, HCS (Hosted Collaboration Service), or HCS-LE (Hosted Collaboration Service - Large Enterprise). Once the deployment mode is set, it will be verified against the license that is in use.
Note:Unified Communications Manager release 14(1)SU1 and 12.5(1)SU7 does not support HCS-LE Deployment mode

Request Parameters
args0


    • Enterprise - The server is used as part of a standard enterprise deployment.
    • HCS - The server is hosted by a service provider using the Hosted Collaboration Solution (HCS) end-to-end system.
    • HCS-LE - The server is hosted by a service provider using the Hosted Collaboration Solution (HCS) end-to-end system with centralized management of services and licensing to multiple business units.
Response Parameters (return element children)
result


A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.
deploymentMode


xsi:nil="true" if there are no deployment mode messages
Example Request and Response
Request Response 
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://services.api.platform.vos.cisco.com">
	<soap:Header/>
	<soap:Body>
		<ser:setDeploymentMode>
			<ser:args0>Enterprise</ser:args0>
		</ser:setDeploymentMode>
	</soap:Body>
</soap:Envelope>

								
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
	<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
		<wsa:Action>urn:setDeploymentModeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:d864e7c5-c517-48f2-8957-b26e18806cbd</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:setDeploymentModeResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xsi:type="ax277:DeploymentModeResponse" xmlns:ax277="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax278="http://api.platform.vos.cisco.com/xsd">
				<ax277:result>internal.request.complete</ax277:result>
				<ax277:deploymentMode xsi:nil="true"/>
			</ns:return>
		</ns:setDeploymentModeResponse>
	</soapenv:Body>
</soapenv:Envelope>