This operation returns the configuration for the web server.
Request
Syntax
GET <webservice>/CommServ/WebServerConfiguration HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
commcellReportsUrl |
The URL used to view CommCell Console reports. |
App_GetWebServerConfigResp |
|
IISServerName |
The URL for the online help. Use the following format: http://hostname:port/release_version/article |
App_GetWebServerConfigResp |
|
IISServerAlternateUrl |
The URL for downloading updates for the Outlook Add-In and Lotus Notes Client Add-In. |
App_GetWebServerConfigResp |
|
reportIISServerInstallDir |
If you are using an alternate Web Server for reports, the location where the CommCell Console software is installed on the Web Server computer. |
App_GetWebServerConfigResp |
|
CVAccountsSsoUrl |
The URL for the Web Console to use as the identity provider (IdP). |
App_GetWebServerConfigResp |
|
IISServerSelected |
The option to use an alternate URL for the online help. Valid values are True and False. |
App_GetWebServerConfigResp |
|
reportIISServerSSLPort |
The HTTPS (secure) port number; the default is port 443. |
App_GetWebServerConfigResp |
|
reportIISServerSelected |
The option to use an alternate Web Server for reports. Valid values are True and False. |
App_GetWebServerConfigResp |
|
EnableIISServerAlternateUrl |
The option to use an alternate Web URL for downloading updates for the Outlook Add-In and Lotus Notes Client Add-In. Valid values are True and False. |
App_GetWebServerConfigResp |
|
enableCVAccountsSsoUrl |
If Multi-Web Console Single Sign-On is enabled, the option to define a Web Console as the identity provider (IdP). |
App_GetWebServerConfigResp |
|
reportIISServerHTTPProtocol |
App_GetWebServerConfigResp |
|
|
reportIISServerName |
If you are using an alternate Web Server for reports, the name of a computer that has the Internet Information Service (IIS) installed. |
App_GetWebServerConfigResp |
|
reportIISServerPort |
The HTTP port number; the default is port 80. |
App_GetWebServerConfigResp |
|
userName |
If you are using an alternate Web Server for reports, the user name used to access the software installation path on the Web Server. |
userPassword |
Examples
Sample Request
GET <webservice>/CommServ/WebServerConfiguration HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
{ "commcellReportsUrl": "http://mycompany:81/reports", "IISServerName": "http://documentation.commvault.com/commvault/v11/article", "IISServerAlternateUrl": "http://resource001:8089/alt_web_server_ADDIN", "reportIISServerInstallDir": "c:/Reports", "CVAccountsSsoUrl": "http://mycompany:80/webconsole", "IISServerSelected": true, "reportIISServerSSLPort": 443, "reportIISServerSelected": false, "EnableIISServerAlternateUrl": true, "enableCVAccountsSsoUrl": true, "reportIISServerHTTPProtocol": 1, "reportIISServerName": "mycompanyMA", "reportIISServerPort": 80, "userPassword": {"userName": ""}
}