ApplyExtensionConfiguration (v2)
Nov 30, 2015
Overview
Applies the extension configuration.
The function is available as a Web Service request.
Request
Parameters of the API request:
Parameter | Type | Description | Requirements |
|---|
Parameter | Type | Description | Requirements |
|---|---|---|---|
token | String | API authentication token | Mandatory |
theseServersOnly | List<Location> | The list of server you would like to send the extension configuration to. If left out then the extension configuration will be sent to all available servers in the Verba System. |
|
returnSuccessfulStatuses | boolean | If true we show all success and failure response states. If false we show only failure responses. |
|
forceEvenIfNotRegistered | boolean | If true we send to all servers regardless of their current extension configuration. If false we only send the extension configuration to those servers that have different extension configuration than in the central database. |
|
Response
Parameters of the API response:
Parameter | Type | Description |
|---|---|---|
statuses | Contains the success or error message from each requested server. | |
return | Possible return values:
|
Examples
Example ApplyExtensionConfiguration to all servers. Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v2:applyExtensionConfiguration>
<token>piyyOvWeg64IXskLzVMutqxikakzLV5D</token>
<!--Zero or more repetitions:-->
<!--
<theseServersOnly>
<eid>0000</eid>
<location>server-name</location>
</theseServersOnly>
-->
<returnSuccessfulStatuses>1</returnSuccessfulStatuses>
<forceEvenIfNotRegistered>1</forceEvenIfNotRegistered>
</v2:applyExtensionConfiguration>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:applyExtensionConfigurationResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
<return>
<status>
<statusCode>OK</statusCode>
</status>
<statuses>
<server>
<eid>0000</eid>
<location>DEV-MR</location>
</server>
<status>
<statusCode>OK</statusCode>
</status>
</statuses>
<statuses>
<server>
<eid>0000</eid>
<location>FE1SFB</location>
</server>
<status>
<statusCode>OK</statusCode>
</status>
</statuses>
<statuses>
<server>
<eid>0000</eid>
<location>FE2SFB</location>
</server>
<status>
<statusCode>OK</statusCode>
</status>
</statuses>
<statuses>
<server>
<eid>0000</eid>
<location>DEV-PROXY1</location>
</server>
<status>
<statusCode>OK</statusCode>
</status>
</statuses>
<statuses>
<server>
<eid>0000</eid>
<location>DEV-PROXY2</location>
</server>
<status>
<statusCode>OK</statusCode>
</status>
</statuses>
<statuses>
<server>
<eid>0000</eid>
<location>DEV-RS2</location>
</server>
<status>
<statusCode>OK</statusCode>
</status>
</statuses>
<statuses>
<server>
<eid>0000</eid>
<location>DEV-RS1</location>
</server>
<status>
<statusCode>OK</statusCode>
</status>
</statuses>
</return>
</ns2:applyExtensionConfigurationResponse>
</S:Body>
</S:Envelope>
Example ApplyExtensionConfiguration to specific servers. Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v2:applyExtensionConfiguration>
<token>piyyOvWeg64IXskLzVMutqxikakzLV5D</token>
<!--Zero or more repetitions:-->
<theseServersOnly>
<eid>0000</eid>
<location>DEV-RS1</location>
</theseServersOnly>
<theseServersOnly>
<eid>0000</eid>
<location>DEV-RS2</location>
</theseServersOnly>
<returnSuccessfulStatuses>1</returnSuccessfulStatuses>
<forceEvenIfNotRegistered>1</forceEvenIfNotRegistered>
</v2:applyExtensionConfiguration>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:applyExtensionConfigurationResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
<return>
<status>
<statusCode>OK</statusCode>
</status>
<statuses>
<server>
<eid>0000</eid>
<location>DEV-RS1</location>
</server>
<status>
<statusCode>OK</statusCode>
</status>
</statuses>
<statuses>
<server>
<eid>0000</eid>
<location>DEV-RS2</location>
</server>
<status>
<statusCode>OK</statusCode>
</status>
</statuses>
</return>
</ns2:applyExtensionConfigurationResponse>
</S:Body>
</S:Envelope>
Example ApplyExtensionConfiguration to unavailable servers. Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v2:applyExtensionConfiguration>
<token>piyyOvWeg64IXskLzVMutqxikakzLV5D</token>
<!--Zero or more repetitions:-->
<theseServersOnly>
<eid>0000</eid>
<location>DEV-RS1</location>
</theseServersOnly>
<theseServersOnly>
<eid>0000</eid>
<location>DEV-RS2</location>
</theseServersOnly>
<returnSuccessfulStatuses>1</returnSuccessfulStatuses>
<forceEvenIfNotRegistered>1</forceEvenIfNotRegistered>
</v2:applyExtensionConfiguration>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:applyExtensionConfigurationResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
<return>
<status>
<message>2 server(s) failed</message>
<statusCode>ERROR_GENERAL</statusCode>
</status>
<statuses>
<server>
<eid>0000</eid>
<location>DEV-RS1</location>
</server>
<status>
<message>Could not apply extension configuration on 0000:DEV-RS1: java.lang.Exception: Could not connect to Verba Node Manager Agent at host DEV-RS1.
Please check if the service is in running state.</message>
<statusCode>ERROR_GENERAL</statusCode>
</status>
</statuses>
<statuses>
<server>
<eid>0000</eid>
<location>DEV-RS2</location>
</server>
<status>
<message>Could not apply extension configuration on 0000:DEV-RS2: java.lang.Exception: Could not connect to Verba Node Manager Agent at host DEV-RS2.
Please check if the service is in running state.</message>
<statusCode>ERROR_GENERAL</statusCode>
</status>
</statuses>
</return>
</ns2:applyExtensionConfigurationResponse>
</S:Body>
</S:Envelope>