1 dl.meetei 1.1.2.1 //%LICENSE////////////////////////////////////////////////////////////////
 2                   //
 3                   // Licensed to The Open Group (TOG) under one or more contributor license
 4                   // agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
 5                   // this work for additional information regarding copyright ownership.
 6                   // Each contributor licenses this file to you under the OpenPegasus Open
 7                   // Source License; you may not use this file except in compliance with the
 8                   // License.
 9                   //
10                   // Permission is hereby granted, free of charge, to any person obtaining a
11                   // copy of this software and associated documentation files (the "Software"),
12                   // to deal in the Software without restriction, including without limitation
13                   // the rights to use, copy, modify, merge, publish, distribute, sublicense,
14                   // and/or sell copies of the Software, and to permit persons to whom the
15                   // Software is furnished to do so, subject to the following conditions:
16                   //
17                   // The above copyright notice and this permission notice shall be included
18                   // in all copies or substantial portions of the Software.
19                   //
20                   // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21                   // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 dl.meetei 1.1.2.1 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23                   // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
24                   // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
25                   // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
26                   // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27                   //
28                   //////////////////////////////////////////////////////////////////////////
29                   
30                   
31                   Wed Oct 23 2013
32                   
33                   What is webadmin?
34                   =================
35                   Pegasus webadmin interface provides a limited edition of administering the
36                   cimserver through web. Currently, modification of cimserver config options
37                   viewing the Providers registered and subscriptions view are supported. In
38                   future management of subscriptions and provider management will be added.
39                   
40                   How to build pegasus for using webadmin?
41                   ========================================
42                   If you are building from sources, No need to set any build environ variable. It

43 dl.meetei 1.1.2.2 is enabled by default.
44                   webadmin interface's backbone is CIM-RS details at [1] and webserver facility
45                   built on pegasus. CIM-RS accepts payload represented as JSON[2]. The response
46                   in JSON can be consumed webserver and can be shown as a webpage.
47                   CIM-RS is built as a integral part of cimserver, not controlled by any env and
48                   webserver facility is controlled by PEGASUS_ENABLE_PROTOCOL_WEB, which is
49                   enabled by default. To disable it set PEGASUS_ENABLE_PROTOCOL_WEB=false.
50                   
51                   How do I bring up the webadmin?
52                   ===============================
53                   Enter the your local host name along with port number in the address bar of a
54                   browser. For example, if your hostname is localhost.localdomain. Just type in
55                   localhost.localdomain:5988. 
56                   
57                   where does my webRoot points to?

58 lawrence.luo 1.1.2.3 ===============================
59                      webRoot is the path that webadmin pages locate. Following are the value of 
60                      webRoot for part of the platforms.
61                      
62                      Linux           /opt/tog-pegasus/www
63                      i5/PASE         /QOpenSys/QIBM/UserData/UME/Pegasus/www
64                      Windows         <PEGASUS_HOME>/www
65                      zOS             /var/wbem/www
66                      
67                      Where do I put my custom webpages? 
68                      ===============================
69                      The custom webpages can be put in to webRoot and the types are limited to the 
70                      ones in mimeTypes.txt. 
71                       

72 dl.meetei    1.1.2.2 What are the security concern for using webadmin?

73 lawrence.luo 1.1.2.3 ===============================
74                      The security is enabled by default in the release version.To disable it,set 
75                      enableAuthentication=true when start cimserver. When PAM is enabled, webadmin is
76                      able to access by the system users, otherwise the cim users needs to be added by 
77                      the tool cimuser. 

78 dl.meetei    1.1.2.2 
79                      
80                      References:
81                      ===========
82                      1 http://www.dmtf.org/sites/default/files/standards/documents/DSP0210_1.0.0.pdf
83                      2 http://www.dmtf.org/sites/default/files/standards/documents/DSP0211_1.0.0.pdf