gosa-plugins/opsi/admin/opsi/class_opsi.inc

   1 <?php
   2 /*
   3    This code is part of GOsa (https://gosa.gonicus.de)
   4    Copyright (C) 2008  Fabian Hickert
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation, either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20
  21
  22 /*! \brief  This is the opsi base class, it handles
  23   .          gosa daemon requests and prepares data for opsi plugins.
  24  */
  25 class opsi
  26 {
  27
  28
  29   /*! \brief            Returns a list of netboot products.
  30     @param
  31     @return
  32    */
  33   public static function opsi_get_netboot_products()
  34   {
  35     /*  <xml>
  36         <header>gosa_opsi_get_netboot_products</header>
  37         <source>GOSA</source>
  38         <target>00:01:6c:9d:b9:fa</target>
  39         </xml>
  40         <xml>
  41         <header>gosa_opsi_get_netboot_products</header>
  42         <source>GOSA</source>
  43         <target>GOSA</target>
  44         <hostId>limux-cl-2.intranet.gonicus.de</hostId>
  45         </xml> */
  46
  47   }
  48
  49
  50   /*! \brief            Returns a list of all local products.
  51     @param
  52     @return
  53    */
  54   public static function gosa_opsi_get_local_products()
  55   {
  56     /*  <xml>
  57         <header>gosa_opsi_get_local_products</header>
  58         <source>GOSA</source>
  59         <target>GOSA</target>
  60         </xml>
  61         <xml>
  62         <header>gosa_opsi_get_local_products</header>
  63         <source>GOSA</source>
  64         <target>GOSA</target>
  65         <hostId>limux-cl-2.intranet.gonicus.de</hostId>
  66         </xml> */
  67
  68   }
  69
  70
  71   /*! \brief            Returns a list of all product properties. \
  72     .           Additionally you can specify the host parameter to \
  73     .           get host specific product properties
  74     @param
  75     @return
  76    */
  77   public static function gosa_opsi_get_product_properties()
  78   {
  79     /*  <xml>
  80         <header>gosa_opsi_get_product_properties</header>
  81         <source>GOSA</source>
  82         <target>GOSA</target>
  83         <productId>firefox</productId>
  84         </xml>
  85         <xml>
  86         <header>gosa_opsi_get_product_properties</header>
  87         <source>GOSA</source>
  88         <target>GOSA</target>
  89         <productId>firefox</productId>
  90         <hostId>limux-cl-2.intranet.gonicus.de</hostId>
  91         </xml>
  92      */
  93   }
  94
  95
  96   /*! \brief            Set product properties, globally or per host.
  97     @param
  98     @return
  99    */
 100   public static function gosa_opsi_set_product_properties()
 101   {
 102     /*  <xml>
 103         <header>gosa_opsi_set_product_properties</header>
 104         <source>GOSA</source>
 105         <target>00:01:6c:9d:b9:fa</target>
 106         <productId>firefox</productId>
 107         <item>
 108         <name>askbeforeinst</name>
 109         <value>false</value>
 110         </item>
 111         </xml>
 112         <xml>
 113         <header>gosa_opsi_set_product_properties</header>
 114         <source>GOSA</source>
 115         <target>00:01:6c:9d:b9:fa</target>
 116         <hostId>limux-cl-2.intranet.gonicus.de</hostId>
 117         <productId>firefox</productId>
 118         <item>
 119         <name>askbeforeinst</name>
 120         <value>false</value>
 121         </item>
 122         </xml>
 123      */
 124   }
 125
 126
 127   /*! \brief            Returns the clients hardware setup.
 128     @param
 129     @return
 130    */
 131   public static function gosa_opsi_get_client_hardware()
 132   {
 133     /*  <xml>
 134         <header>gosa_opsi_get_client_hardware</header>
 135         <source>GOSA</source>
 136         <target>GOSA</target>
 137         <hostId>limux-cl-2.intranet.gonicus.de</hostId>
 138         </xml>
 139      */
 140   }
 141
 142
 143   /*! \brief            Returns the clients software setup.
 144     @param
 145     @return
 146    */
 147   public static function gosa_opsi_get_client_software()
 148   {
 149     /*  <xml>
 150         <header>gosa_opsi_get_client_software</header>
 151         <source>GOSA</source>
 152         <target>GOSA</target>
 153         <hostId>limux-cl-2.intranet.gonicus.de</hostId>
 154         </xml> i
 155      */
 156   }
 157
 158
 159   /*! \brief            Returns a list of all opsi clients.
 160     @param
 161     @return
 162    */
 163   public static function gosa_opsi_list_clients()
 164   {
 165     /*  <xml>
 166         <header>gosa_opsi_list_clients</header>
 167         <source>GOSA</source>
 168         <target>00:01:6c:9d:b9:fa</target>
 169         </xml>
 170      */
 171   }
 172
 173
 174   /*! \brief            Deletes the given opsi client.
 175     @param
 176     @return
 177    */
 178   public static function gosa_opsi_del_client()
 179   {
 180     /*  <xml>
 181         <header>gosa_opsi_del_client</header>
 182         <source>GOSA</source>
 183         <target>00:01:6c:9d:b9:fa</target>
 184         <hostId>limux-cl-2.intranet.gonicus.de</hostId>
 185         </xml>
 186      */
 187   }
 188
 189
 190   /*! \brief            Triggers install/reinstall of an opsi client.
 191     @param
 192     @return
 193    */
 194   public static function job_opsi_install_client()
 195   {
 196     /*  <xml>
 197         <header>job_opsi_install_client</header>
 198         <source>GOSA</source>
 199         <target>00:01:6c:9d:b9:fa</target>
 200         <hostId>limux-cl-2.intranet.gonicus.de</hostId>
 201         <macaddress>00:11:25:4b:8c:e5</macaddress>
 202         </xml>
 203      */
 204   }
 205
 206
 207   /*! \brief            Adds a new opsi client.
 208     @param
 209     @return
 210    */
 211   public static function gosa_opsi_add_client()
 212   {
 213     /*  <xml>
 214         <header>gosa_opsi_add_client</header>
 215         <source>GOSA</source>
 216         <target>00:01:6c:9d:b9:fa</target>
 217         <hostId>limux-cl-2.intranet.gonicus.de</hostId>
 218         <macaddress>00:11:25:4b:8c:e5</macaddress>
 219         <description>Test halt</description>
 220         <ip>1.2.3.4</ip>
 221         <notes>Im a note</notes>
 222         </xml>
 223      */
 224   }
 225
 226
 227   /*! \brief            Adds a given product to a client.
 228     @param
 229     @return
 230    */
 231   public static function gosa_opsi_add_product_to_client()
 232   {
 233     /*  <xml>
 234         <header>gosa_opsi_add_product_to_client</header>
 235         <source>GOSA</source>
 236         <target>00:01:6c:9d:b9:fa</target>
 237         <macaddress>00:11:25:4b:8c:e5</macaddress>
 238         <hostId>limux-cl-2.intranet.gonicus.de</hostId>
 239         <productId>winxppro</productId>
 240         </xml>
 241      */
 242   }
 243
 244
 245   /*! \brief      Removes a given product from a client.
 246     @param
 247     @return
 248    */
 249   public static function gosa_opsi_del_product_from_client()
 250   {
 251     /* <xml>
 252        <header>gosa_opsi_del_product_from_client</header>
 253        <source>GOSA</source>
 254        <target>00:01:6c:9d:b9:fa</target>
 255        <hostId>limux-cl-1.intranet.gonicus.de</hostId>
 256        <macaddress>00:11:25:4b:8c:e5</macaddress>
 257        <productId>softprod</productId>
 258        </xml>
 259      */
 260   }
 261 }
 262
 263 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 264 ?>