Google Git
Sign in
apache / vcl-site / 451b1805a6eaed9587e3d526c731c8eb2118c984 / . / static / docs / xmlrpcWrappers_8php.html
blob: 340bb0e0a3c287dd323e4a8d6b5f3f8c047d5730 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>VCL XML RPC: xmlrpcWrappers.php File Reference</title>
<link href="xmlrpcdocs.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">VCL XML RPC
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">xmlrpcWrappers.php File Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af3cdb4a0c6d2fa4ca9409f2bda3c3dae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#af3cdb4a0c6d2fa4ca9409f2bda3c3dae">XMLRPCaffiliations</a> ()</td></tr>
<tr class="memdesc:af3cdb4a0c6d2fa4ca9409f2bda3c3dae"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets all of the affilations for which users can log in to VCL<br/>
<b>NOTE:</b> This is the only function available for which the X-User and X-Pass HTTP headers do not need to be passed <a href="#af3cdb4a0c6d2fa4ca9409f2bda3c3dae">More...</a><br/></td></tr>
<tr class="separator:af3cdb4a0c6d2fa4ca9409f2bda3c3dae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a905bda05c77ad0d7b1af805607a69ecd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a905bda05c77ad0d7b1af805607a69ecd">XMLRPCtest</a> ($string)</td></tr>
<tr class="memdesc:a905bda05c77ad0d7b1af805607a69ecd"><td class="mdescLeft">&#160;</td><td class="mdescRight">this is a test function that call be called when getting XML RPC calls to this site to work <a href="#a905bda05c77ad0d7b1af805607a69ecd">More...</a><br/></td></tr>
<tr class="separator:a905bda05c77ad0d7b1af805607a69ecd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bacea01de3773fb69f1cb141204b58c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a5bacea01de3773fb69f1cb141204b58c">XMLRPCgetImages</a> ()</td></tr>
<tr class="memdesc:a5bacea01de3773fb69f1cb141204b58c"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets the images to which the user has access <a href="#a5bacea01de3773fb69f1cb141204b58c">More...</a><br/></td></tr>
<tr class="separator:a5bacea01de3773fb69f1cb141204b58c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ee76978294a2a1e45fc4f4ef446f9a2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a8ee76978294a2a1e45fc4f4ef446f9a2">XMLRPCaddRequest</a> ($imageid, $start, $length, $foruser='', $nousercheck=0)</td></tr>
<tr class="memdesc:a8ee76978294a2a1e45fc4f4ef446f9a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">tries to make a request <a href="#a8ee76978294a2a1e45fc4f4ef446f9a2">More...</a><br/></td></tr>
<tr class="separator:a8ee76978294a2a1e45fc4f4ef446f9a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09dbfe443001dc76965449ef7a6260d1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a09dbfe443001dc76965449ef7a6260d1">XMLRPCaddRequestWithEnding</a> ($imageid, $start, $end, $foruser='', $nousercheck=0)</td></tr>
<tr class="memdesc:a09dbfe443001dc76965449ef7a6260d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">tries to make a request with the specified ending time <a href="#a09dbfe443001dc76965449ef7a6260d1">More...</a><br/></td></tr>
<tr class="separator:a09dbfe443001dc76965449ef7a6260d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeca4a12a3df632e152b4ecafa1b3e174"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#aeca4a12a3df632e152b4ecafa1b3e174">XMLRPCdeployServer</a> ($imageid, $start, $end, $admingroup='', $logingroup='', $ipaddr='', $macaddr='', $monitored=0, $foruser='', $name='', $userdata='')</td></tr>
<tr class="memdesc:aeca4a12a3df632e152b4ecafa1b3e174"><td class="mdescLeft">&#160;</td><td class="mdescRight">tries to make a server request <a href="#aeca4a12a3df632e152b4ecafa1b3e174">More...</a><br/></td></tr>
<tr class="separator:aeca4a12a3df632e152b4ecafa1b3e174"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92ebf10589864453db3940767bc63376"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a92ebf10589864453db3940767bc63376">XMLRPCgetRequestIds</a> ()</td></tr>
<tr class="memdesc:a92ebf10589864453db3940767bc63376"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets information about all of user's requests <a href="#a92ebf10589864453db3940767bc63376">More...</a><br/></td></tr>
<tr class="separator:a92ebf10589864453db3940767bc63376"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a032dc164f41a976c5d757eb7f9e984f9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a032dc164f41a976c5d757eb7f9e984f9">XMLRPCgetRequestStatus</a> ($requestid)</td></tr>
<tr class="memdesc:a032dc164f41a976c5d757eb7f9e984f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">determines and returns the status of the request <a href="#a032dc164f41a976c5d757eb7f9e984f9">More...</a><br/></td></tr>
<tr class="separator:a032dc164f41a976c5d757eb7f9e984f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1d25d949e2beee11bb73248ef5890d9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#ae1d25d949e2beee11bb73248ef5890d9">XMLRPCgetRequestConnectData</a> ($requestid, $remoteIP)</td></tr>
<tr class="memdesc:ae1d25d949e2beee11bb73248ef5890d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">if request is ready, adds the connecting user's computer to the request and returns info about how to connect to the computer <a href="#ae1d25d949e2beee11bb73248ef5890d9">More...</a><br/></td></tr>
<tr class="separator:ae1d25d949e2beee11bb73248ef5890d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af31dfd65379b8d3d9203bb343ce4adea"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#af31dfd65379b8d3d9203bb343ce4adea">XMLRPCextendRequest</a> ($requestid, $extendtime)</td></tr>
<tr class="memdesc:af31dfd65379b8d3d9203bb343ce4adea"><td class="mdescLeft">&#160;</td><td class="mdescRight">extends the length of an active request; if a request that has not started needs to be extended, delete the request and submit a new one <a href="#af31dfd65379b8d3d9203bb343ce4adea">More...</a><br/></td></tr>
<tr class="separator:af31dfd65379b8d3d9203bb343ce4adea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ffaf38c049a59237adcdd103122b1ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a2ffaf38c049a59237adcdd103122b1ed">XMLRPCsetRequestEnding</a> ($requestid, $end)</td></tr>
<tr class="memdesc:a2ffaf38c049a59237adcdd103122b1ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">modifies the end time of an active request; if a request that has not started needs to be modifed, delete the request and submit a new one <a href="#a2ffaf38c049a59237adcdd103122b1ed">More...</a><br/></td></tr>
<tr class="separator:a2ffaf38c049a59237adcdd103122b1ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2303425584288df956142b63607d15b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#ac2303425584288df956142b63607d15b">XMLRPCendRequest</a> ($requestid)</td></tr>
<tr class="memdesc:ac2303425584288df956142b63607d15b"><td class="mdescLeft">&#160;</td><td class="mdescRight">ends/deletes a request <a href="#ac2303425584288df956142b63607d15b">More...</a><br/></td></tr>
<tr class="separator:ac2303425584288df956142b63607d15b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d0ad65897ca8d5ce3e7f5dfb099bb1d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a8d0ad65897ca8d5ce3e7f5dfb099bb1d">XMLRPCautoCapture</a> ($requestid)</td></tr>
<tr class="memdesc:a8d0ad65897ca8d5ce3e7f5dfb099bb1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates entries in appropriate tables to capture an image and sets the request state to image <a href="#a8d0ad65897ca8d5ce3e7f5dfb099bb1d">More...</a><br/></td></tr>
<tr class="separator:a8d0ad65897ca8d5ce3e7f5dfb099bb1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6da19270827056754d8e7782ddc6faaa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a6da19270827056754d8e7782ddc6faaa">XMLRPCgetGroupImages</a> ($name)</td></tr>
<tr class="memdesc:a6da19270827056754d8e7782ddc6faaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets a list of all images in a particular group <a href="#a6da19270827056754d8e7782ddc6faaa">More...</a><br/></td></tr>
<tr class="separator:a6da19270827056754d8e7782ddc6faaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2637fdb90d52331d228ed7f20120ffbe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a2637fdb90d52331d228ed7f20120ffbe">XMLRPCaddImageToGroup</a> ($name, $imageid)</td></tr>
<tr class="memdesc:a2637fdb90d52331d228ed7f20120ffbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds an image to a resource group <a href="#a2637fdb90d52331d228ed7f20120ffbe">More...</a><br/></td></tr>
<tr class="separator:a2637fdb90d52331d228ed7f20120ffbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4da8c99adf62b1182b40ffc8d980394f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a4da8c99adf62b1182b40ffc8d980394f">XMLRPCremoveImageFromGroup</a> ($name, $imageid)</td></tr>
<tr class="memdesc:a4da8c99adf62b1182b40ffc8d980394f"><td class="mdescLeft">&#160;</td><td class="mdescRight">removes an image from a resource group <a href="#a4da8c99adf62b1182b40ffc8d980394f">More...</a><br/></td></tr>
<tr class="separator:a4da8c99adf62b1182b40ffc8d980394f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4775e2f79c46e64e168e213d8ed38477"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a4775e2f79c46e64e168e213d8ed38477">XMLRPCaddImageGroupToComputerGroup</a> ($imageGroup, $computerGroup)</td></tr>
<tr class="memdesc:a4775e2f79c46e64e168e213d8ed38477"><td class="mdescLeft">&#160;</td><td class="mdescRight">map an image group to a computer group <a href="#a4775e2f79c46e64e168e213d8ed38477">More...</a><br/></td></tr>
<tr class="separator:a4775e2f79c46e64e168e213d8ed38477"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9be10d4b225b80d377781f1095ce477c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a9be10d4b225b80d377781f1095ce477c">XMLRPCremoveImageGroupFromComputerGroup</a> ($imageGroup, $computerGroup)</td></tr>
<tr class="memdesc:a9be10d4b225b80d377781f1095ce477c"><td class="mdescLeft">&#160;</td><td class="mdescRight">remove the mapping of an image group to a computer group <a href="#a9be10d4b225b80d377781f1095ce477c">More...</a><br/></td></tr>
<tr class="separator:a9be10d4b225b80d377781f1095ce477c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac779aaea31c0836d4fd85cb837b8c870"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#ac779aaea31c0836d4fd85cb837b8c870">XMLRPCgetNodes</a> ($root=NULL)</td></tr>
<tr class="memdesc:ac779aaea31c0836d4fd85cb837b8c870"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets a list of all nodes in the privilege tree <a href="#ac779aaea31c0836d4fd85cb837b8c870">More...</a><br/></td></tr>
<tr class="separator:ac779aaea31c0836d4fd85cb837b8c870"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac420460fdb4c40a550ad95d3efbb6a26"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#ac420460fdb4c40a550ad95d3efbb6a26">XMLRPCnodeExists</a> ($nodeName, $parentNode)</td></tr>
<tr class="memdesc:ac420460fdb4c40a550ad95d3efbb6a26"><td class="mdescLeft">&#160;</td><td class="mdescRight">indicates whether a node with that name already exists at this location in the privilege tree <a href="#ac420460fdb4c40a550ad95d3efbb6a26">More...</a><br/></td></tr>
<tr class="separator:ac420460fdb4c40a550ad95d3efbb6a26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3223a46e4ec40200fd9f8417490b18e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#af3223a46e4ec40200fd9f8417490b18e">XMLRPCaddNode</a> ($nodeName, $parentNode)</td></tr>
<tr class="memdesc:af3223a46e4ec40200fd9f8417490b18e"><td class="mdescLeft">&#160;</td><td class="mdescRight">add a node to the privilege tree as a child of the specified parent node <a href="#af3223a46e4ec40200fd9f8417490b18e">More...</a><br/></td></tr>
<tr class="separator:af3223a46e4ec40200fd9f8417490b18e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a510d59605fc4044c4092a7248f391b60"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a510d59605fc4044c4092a7248f391b60">XMLRPCremoveNode</a> ($nodeID)</td></tr>
<tr class="memdesc:a510d59605fc4044c4092a7248f391b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">delete a node from the privilege tree <a href="#a510d59605fc4044c4092a7248f391b60">More...</a><br/></td></tr>
<tr class="separator:a510d59605fc4044c4092a7248f391b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3758464d83cab9c47819d13ca79ab96"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#ac3758464d83cab9c47819d13ca79ab96">XMLRPCgetUserGroupPrivs</a> ($name, $affiliation, $nodeid)</td></tr>
<tr class="memdesc:ac3758464d83cab9c47819d13ca79ab96"><td class="mdescLeft">&#160;</td><td class="mdescRight">get a list of privileges for a user group at a particular node in the privilege tree <a href="#ac3758464d83cab9c47819d13ca79ab96">More...</a><br/></td></tr>
<tr class="separator:ac3758464d83cab9c47819d13ca79ab96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07f67dc653cccb327b3dce8db07da558"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a07f67dc653cccb327b3dce8db07da558">XMLRPCaddUserGroupPriv</a> ($name, $affiliation, $nodeid, $permissions)</td></tr>
<tr class="memdesc:a07f67dc653cccb327b3dce8db07da558"><td class="mdescLeft">&#160;</td><td class="mdescRight">add privileges for a user group at a particular node in the privilege tree <a href="#a07f67dc653cccb327b3dce8db07da558">More...</a><br/></td></tr>
<tr class="separator:a07f67dc653cccb327b3dce8db07da558"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c2576b692238ebf50ce3a642926d133"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a2c2576b692238ebf50ce3a642926d133">XMLRPCremoveUserGroupPriv</a> ($name, $affiliation, $nodeid, $permissions)</td></tr>
<tr class="memdesc:a2c2576b692238ebf50ce3a642926d133"><td class="mdescLeft">&#160;</td><td class="mdescRight">remove privileges for a resource group at a particular node in the privilege tree <a href="#a2c2576b692238ebf50ce3a642926d133">More...</a><br/></td></tr>
<tr class="separator:a2c2576b692238ebf50ce3a642926d133"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b03beb7300fbe2bee1f3a238c87ad95"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a7b03beb7300fbe2bee1f3a238c87ad95">XMLRPCgetResourceGroupPrivs</a> ($name, $type, $nodeid)</td></tr>
<tr class="memdesc:a7b03beb7300fbe2bee1f3a238c87ad95"><td class="mdescLeft">&#160;</td><td class="mdescRight">get a list of privileges for a resource group at a particular node in the privilege tree <a href="#a7b03beb7300fbe2bee1f3a238c87ad95">More...</a><br/></td></tr>
<tr class="separator:a7b03beb7300fbe2bee1f3a238c87ad95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa18cc4de5d271ccae63849a359d54f65"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#aa18cc4de5d271ccae63849a359d54f65">XMLRPCaddResourceGroupPriv</a> ($name, $type, $nodeid, $permissions)</td></tr>
<tr class="memdesc:aa18cc4de5d271ccae63849a359d54f65"><td class="mdescLeft">&#160;</td><td class="mdescRight">add privileges for a resource group at a particular node in the privilege tree <a href="#aa18cc4de5d271ccae63849a359d54f65">More...</a><br/></td></tr>
<tr class="separator:aa18cc4de5d271ccae63849a359d54f65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af850ce9dc616c6cf763006711e062de4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#af850ce9dc616c6cf763006711e062de4">XMLRPCremoveResourceGroupPriv</a> ($name, $type, $nodeid, $permissions)</td></tr>
<tr class="memdesc:af850ce9dc616c6cf763006711e062de4"><td class="mdescLeft">&#160;</td><td class="mdescRight">remove privileges for a resource group from a node in the privilege tree <a href="#af850ce9dc616c6cf763006711e062de4">More...</a><br/></td></tr>
<tr class="separator:af850ce9dc616c6cf763006711e062de4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada4c0b4bbf44b5c82b484d8113bce6df"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#ada4c0b4bbf44b5c82b484d8113bce6df">XMLRPCgetUserGroups</a> ($groupType=0, $affiliationid=0)</td></tr>
<tr class="memdesc:ada4c0b4bbf44b5c82b484d8113bce6df"><td class="mdescLeft">&#160;</td><td class="mdescRight">builds a list of user groups <a href="#ada4c0b4bbf44b5c82b484d8113bce6df">More...</a><br/></td></tr>
<tr class="separator:ada4c0b4bbf44b5c82b484d8113bce6df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6199166923822a70e546fb5330e3c72c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a6199166923822a70e546fb5330e3c72c">XMLRPCgetUserGroupAttributes</a> ($name, $affiliation)</td></tr>
<tr class="memdesc:a6199166923822a70e546fb5330e3c72c"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets information about a user group <a href="#a6199166923822a70e546fb5330e3c72c">More...</a><br/></td></tr>
<tr class="separator:a6199166923822a70e546fb5330e3c72c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a916ec0d977122e91649fcfff137f07a4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a916ec0d977122e91649fcfff137f07a4">XMLRPCaddUserGroup</a> ($name, $affiliation, $owner, $managingGroup, $initialMaxTime, $totalMaxTime, $maxExtendTime, $custom=1)</td></tr>
<tr class="memdesc:a916ec0d977122e91649fcfff137f07a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates a new user group with the specified parameters <a href="#a916ec0d977122e91649fcfff137f07a4">More...</a><br/></td></tr>
<tr class="separator:a916ec0d977122e91649fcfff137f07a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8c71512a96fa5cd7890e8fa1f0ac66a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#af8c71512a96fa5cd7890e8fa1f0ac66a">XMLRPCeditUserGroup</a> ($name, $affiliation, $newName, $newAffiliation, $newOwner='', $newManagingGroup='', $newInitialMaxTime='', $newTotalMaxTime='', $newMaxExtendTime='')</td></tr>
<tr class="memdesc:af8c71512a96fa5cd7890e8fa1f0ac66a"><td class="mdescLeft">&#160;</td><td class="mdescRight">modifies attributes of a user group<br/>
<b>NOTE:</b> an empty string may be passed for any of the new* fields to leave that item unchanged <a href="#af8c71512a96fa5cd7890e8fa1f0ac66a">More...</a><br/></td></tr>
<tr class="separator:af8c71512a96fa5cd7890e8fa1f0ac66a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a55396e98856ffa4e2b3f33e55a4031"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a0a55396e98856ffa4e2b3f33e55a4031">XMLRPCremoveUserGroup</a> ($name, $affiliation)</td></tr>
<tr class="memdesc:a0a55396e98856ffa4e2b3f33e55a4031"><td class="mdescLeft">&#160;</td><td class="mdescRight">removes a user group along with all of its privileges <a href="#a0a55396e98856ffa4e2b3f33e55a4031">More...</a><br/></td></tr>
<tr class="separator:a0a55396e98856ffa4e2b3f33e55a4031"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6109cc77232e01c3d50772c191e43aee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a6109cc77232e01c3d50772c191e43aee">XMLRPCdeleteUserGroup</a> ($name, $affiliation)</td></tr>
<tr class="memdesc:a6109cc77232e01c3d50772c191e43aee"><td class="mdescLeft">&#160;</td><td class="mdescRight">alias for XMLRPCremoveUserGroup <a href="#a6109cc77232e01c3d50772c191e43aee">More...</a><br/></td></tr>
<tr class="separator:a6109cc77232e01c3d50772c191e43aee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa75ba57e059c75e9638b1a95bd12d6cf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#aa75ba57e059c75e9638b1a95bd12d6cf">XMLRPCgetUserGroupMembers</a> ($name, $affiliation)</td></tr>
<tr class="memdesc:aa75ba57e059c75e9638b1a95bd12d6cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets members of a user group<br/>
<b>NOTE:</b> it is possible to have a group with no members in which case success will be returned with an empty array for members <a href="#aa75ba57e059c75e9638b1a95bd12d6cf">More...</a><br/></td></tr>
<tr class="separator:aa75ba57e059c75e9638b1a95bd12d6cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc9a41feddb3be4edafe1ad0d519e2e5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#afc9a41feddb3be4edafe1ad0d519e2e5">XMLRPCaddUsersToGroup</a> ($name, $affiliation, $users)</td></tr>
<tr class="memdesc:afc9a41feddb3be4edafe1ad0d519e2e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds users to a group <a href="#afc9a41feddb3be4edafe1ad0d519e2e5">More...</a><br/></td></tr>
<tr class="separator:afc9a41feddb3be4edafe1ad0d519e2e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a293e447aaf99c561c4247a62fff4c13f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a293e447aaf99c561c4247a62fff4c13f">XMLRPCremoveUsersFromGroup</a> ($name, $affiliation, $users)</td></tr>
<tr class="memdesc:a293e447aaf99c561c4247a62fff4c13f"><td class="mdescLeft">&#160;</td><td class="mdescRight">removes users from a group <a href="#a293e447aaf99c561c4247a62fff4c13f">More...</a><br/></td></tr>
<tr class="separator:a293e447aaf99c561c4247a62fff4c13f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeef7932684f15af6bcbd01e546939eb8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#aeef7932684f15af6bcbd01e546939eb8">XMLRPCgetResourceGroups</a> ($type)</td></tr>
<tr class="memdesc:aeef7932684f15af6bcbd01e546939eb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">get a list of resource groups of a particular type <a href="#aeef7932684f15af6bcbd01e546939eb8">More...</a><br/></td></tr>
<tr class="separator:aeef7932684f15af6bcbd01e546939eb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1da3175b525b6abfba0666102d6d0e62"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a1da3175b525b6abfba0666102d6d0e62">XMLRPCaddResourceGroup</a> ($name, $managingGroup, $type)</td></tr>
<tr class="memdesc:a1da3175b525b6abfba0666102d6d0e62"><td class="mdescLeft">&#160;</td><td class="mdescRight">add a resource group <a href="#a1da3175b525b6abfba0666102d6d0e62">More...</a><br/></td></tr>
<tr class="separator:a1da3175b525b6abfba0666102d6d0e62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bf0cfa485b1c13efc21c6cb07924c6c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a4bf0cfa485b1c13efc21c6cb07924c6c">XMLRPCremoveResourceGroup</a> ($name, $type)</td></tr>
<tr class="memdesc:a4bf0cfa485b1c13efc21c6cb07924c6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">remove a resource group <a href="#a4bf0cfa485b1c13efc21c6cb07924c6c">More...</a><br/></td></tr>
<tr class="separator:a4bf0cfa485b1c13efc21c6cb07924c6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d59515e70006076eff93787c65f0fc8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a3d59515e70006076eff93787c65f0fc8">XMLRPCblockAllocation</a> ($imageid, $start, $end, $numMachines, $usergroupid, $ignoreprivileges=0)</td></tr>
<tr class="memdesc:a3d59515e70006076eff93787c65f0fc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates and processes a block allocation according to the passed in criteria <a href="#a3d59515e70006076eff93787c65f0fc8">More...</a><br/></td></tr>
<tr class="separator:a3d59515e70006076eff93787c65f0fc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a428ab5529037c8e2d7e035c5b972aec9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#a428ab5529037c8e2d7e035c5b972aec9">XMLRPCprocessBlockTime</a> ($blockTimesid, $ignoreprivileges=0)</td></tr>
<tr class="memdesc:a428ab5529037c8e2d7e035c5b972aec9"><td class="mdescLeft">&#160;</td><td class="mdescRight">processes a block allocation for the blockTimes entry associated with blockTimesid <a href="#a428ab5529037c8e2d7e035c5b972aec9">More...</a><br/></td></tr>
<tr class="separator:a428ab5529037c8e2d7e035c5b972aec9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac83a2eb35aa274b5167c8848d16e9b67"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmlrpcWrappers_8php.html#ac83a2eb35aa274b5167c8848d16e9b67">XMLRPCfinishBaseImageCapture</a> ($ownerid, $resourceid, $virtual =1)</td></tr>
<tr class="memdesc:ac83a2eb35aa274b5167c8848d16e9b67"><td class="mdescLeft">&#160;</td><td class="mdescRight">calls addImagePermissions to create and set up permissions, groupings, and mappings so that the owner of a new base image will be able to make a reservation for it after capturing it using 'vcld -setup'; specifically designed to be called by vcld as part of the process of capturing a new base image <a href="#ac83a2eb35aa274b5167c8848d16e9b67">More...</a><br/></td></tr>
<tr class="separator:ac83a2eb35aa274b5167c8848d16e9b67"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The functions listed here are for making VCL requests from other applications. They are implemented according to the XML RPC spec defined at <a href="http://www.xmlrpc.com/">http://www.xmlrpc.com/</a> <br/>
There is one function called <b><a class="el" href="xmlrpcWrappers_8php.html#a905bda05c77ad0d7b1af805607a69ecd" title="this is a test function that call be called when getting XML RPC calls to this site to work ...">XMLRPCtest()</a></b> that can be used during initial development to get started without actually making a request.<br/>
<br/>
The URL you will use to submit RPC calls is the URL for your VCL site followed by<br/>
<br/>
index.php?mode=xmlrpccall<br/>
<br/>
for example if the URL for your VCL site is<br/>
<br/>
<a href="https://vcl.mysite.org/vcl/">https://vcl.mysite.org/vcl/</a><br/>
<br/>
the RPC URL would be<br/>
<br/>
<a href="https://vcl.mysite.org/vcl/index.php?mode=xmlrpccall">https://vcl.mysite.org/vcl/index.php?mode=xmlrpccall</a><br/>
<br/>
There is one exception - when calling the XMLRPCaffiliations function, the mode is xmlrpcaffiliations, for example:<br/>
<br/>
<a href="https://vcl.mysite.org/vcl/index.php?mode=xmlrpcaffiliations">https://vcl.mysite.org/vcl/index.php?mode=xmlrpcaffiliations</a><br/>
<br/>
Your application must connect using HTTPS.<br/>
<br/>
Internal to the VCL code, "Reservations" are called "Requests"; therefore, "request" is used instead of "reservation" in this documentation and in the RPC functions. <br/>
</p>
<h2>API Version 2</h2>
<p>This is the current version of the API. It should be used for any new code development. Any older code needs to be migrated to this version.<br/>
<br/>
Authentication is handled by 2 additional HTTP headers you will need to send:<br/>
<b>X-User</b> - the userid you would use to log in to the VCL site, followed by the at sign (@), followed by your affiliation<br/>
example: myuserid@NCSU<br/>
You can obtain a list of the affiliations by using the <a class="el" href="xmlrpcWrappers_8php.html#af3cdb4a0c6d2fa4ca9409f2bda3c3dae" title="gets all of the affilations for which users can log in to VCL NOTE: This is the only function availab...">XMLRPCaffiliations()</a> call<br/>
<br/>
<b>X-Pass</b> - the password you would use to log in to the VCL site<br/>
<br/>
There is one other additional HTTP header you must send:<br/>
<b>X-APIVERSION</b> - set this to 2<br/>
<br/>
The X-User and X-Pass HTTP headers do not need to be passed to call the <a class="el" href="xmlrpcWrappers_8php.html#af3cdb4a0c6d2fa4ca9409f2bda3c3dae" title="gets all of the affilations for which users can log in to VCL NOTE: This is the only function availab...">XMLRPCaffiliations()</a> function. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a4775e2f79c46e64e168e213d8ed38477"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCaddImageGroupToComputerGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$imageGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$computerGroup</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>map an image group to a computer group </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$imageGroup</td><td>- the name of an imageGroup </td></tr>
<tr><td class="paramname">$computerGroup</td><td>- the name of a computerGroup</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - successfully mapped an image group to a computer group<br/>
</li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a2637fdb90d52331d228ed7f20120ffbe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCaddImageToGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$imageid</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>adds an image to a resource group </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- the name of an imageGroup </td></tr>
<tr><td class="paramname">$imageid</td><td>- the id of an image</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - image was added to the group<br/>
</li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="af3223a46e4ec40200fd9f8417490b18e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCaddNode </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$nodeName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$parentNode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>add a node to the privilege tree as a child of the specified parent node </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$nodeName</td><td>- the name of the new node </td></tr>
<tr><td class="paramname">$parentNode</td><td>- the ID of the node parent</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - node was successfully added </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a8ee76978294a2a1e45fc4f4ef446f9a2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCaddRequest </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$imageid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$foruser</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$nousercheck</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>tries to make a request </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$imageid</td><td>- id of an image </td></tr>
<tr><td class="paramname">$start</td><td>- "now" or unix timestamp for start of reservation; will use a floor function to round down to the nearest 15 minute increment for actual reservation </td></tr>
<tr><td class="paramname">$length</td><td>- length of reservation in minutes (must be in 15 minute increments) </td></tr>
<tr><td class="paramname">$foruser</td><td>- (optional) login to be used when setting up the account on the reserved machine - CURRENTLY, THIS IS UNSUPPORTED </td></tr>
<tr><td class="paramname">$nousercheck</td><td>- (optional, default=0) set to 1 to disable timeout when user is disconnected for too long</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named '<b>status'</b> which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>notavailable</b> - no computers were available for the request<br/>
<b>success</b> - there will be an additional element in the array: </li>
<li><b>requestid</b> - identifier that should be passed to later calls when acting on the request </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a09dbfe443001dc76965449ef7a6260d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCaddRequestWithEnding </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$imageid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$foruser</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$nousercheck</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>tries to make a request with the specified ending time </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$imageid</td><td>- id of an image </td></tr>
<tr><td class="paramname">$start</td><td>- "now" or unix timestamp for start of reservation; will use a floor function to round down to the nearest 15 minute increment for actual reservation </td></tr>
<tr><td class="paramname">$end</td><td>- unix timestamp for end of reservation; will be rounded up to the nearest 15 minute increment </td></tr>
<tr><td class="paramname">$foruser</td><td>- (optional) login to be used when setting up the account on the reserved machine - CURRENTLY, THIS IS UNSUPPORTED </td></tr>
<tr><td class="paramname">$nousercheck</td><td>- (optional, default=0) set to 1 to disable timeout when user is disconnected for too long</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named '<b>status'</b> which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>notavailable</b> - no computers were available for the request<br/>
<b>success</b> - there will be an additional element in the array: </li>
<li><b>requestid</b> - identifier that should be passed to later calls when acting on the request </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a1da3175b525b6abfba0666102d6d0e62"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCaddResourceGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$managingGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>add a resource group </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- the name of the resource group </td></tr>
<tr><td class="paramname">$managingGroup</td><td>- the name of the managing group </td></tr>
<tr><td class="paramname">$type</td><td>- the type of resource group</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - the resource group was added </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="aa18cc4de5d271ccae63849a359d54f65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCaddResourceGroupPriv </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$nodeid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$permissions</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>add privileges for a resource group at a particular node in the privilege tree </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- the name of the resource group </td></tr>
<tr><td class="paramname">$type</td><td>- the resource group type </td></tr>
<tr><td class="paramname">$nodeid</td><td>- the ID of the node in the privilege tree </td></tr>
<tr><td class="paramname">$permissions</td><td>- a colon (:) delimited list of privileges to add</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - privileges were successfully added </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a916ec0d977122e91649fcfff137f07a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCaddUserGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$owner</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$managingGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$initialMaxTime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$totalMaxTime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$maxExtendTime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$custom</em> = <code>1</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>creates a new user group with the specified parameters </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- name of user group </td></tr>
<tr><td class="paramname">$affiliation</td><td>- affiliation of user group </td></tr>
<tr><td class="paramname">$owner</td><td>- user that will be the owner of the group in username@affiliation form </td></tr>
<tr><td class="paramname">$managingGroup</td><td>- user group that can manage membership of this one </td></tr>
<tr><td class="paramname">$initialMaxTime</td><td>- (minutes) max initial time users in this group can select for length of reservations </td></tr>
<tr><td class="paramname">$totalMaxTime</td><td>- (minutes) total length users in the group can have for a reservation (including all extensions) </td></tr>
<tr><td class="paramname">$maxExtendTime</td><td>- (minutes) max length of time users can request as an extension to a reservation at a time </td></tr>
<tr><td class="paramname">$custom</td><td>- (optional, default=1) set custom flag for user group; if set to 0, $owner and $managingGroup will be ignored and group membership will be managed via authentication protocol</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string</li>
</ul>
<b>success</b> - user group was successfully created </dd></dl>
</div>
</div>
<a class="anchor" id="a07f67dc653cccb327b3dce8db07da558"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCaddUserGroupPriv </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$nodeid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$permissions</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>add privileges for a user group at a particular node in the privilege tree </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- the name of the user group </td></tr>
<tr><td class="paramname">$affiliation</td><td>- the affiliation of the user group </td></tr>
<tr><td class="paramname">$nodeid</td><td>- the ID of the node in the privilege tree </td></tr>
<tr><td class="paramname">$permissions</td><td>- a colon (:) delimited list of privileges to add</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - privileges were successfully added </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="afc9a41feddb3be4edafe1ad0d519e2e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCaddUsersToGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$users</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>adds users to a group </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- name of user group </td></tr>
<tr><td class="paramname">$affiliation</td><td>- affiliation of user group </td></tr>
<tr><td class="paramname">$users</td><td>- array of users in username@affiliation form to be added to the group</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number </li>
<li><b>errormsg</b> - error string</li>
</ul>
<b>success</b> - users successfully added to the group<br/>
<b>warning</b> - there was a non-fatal issue that occurred while processing the call; there will be three additional elements in this case: <ul>
<li><b>warningcode</b> - warning number </li>
<li><b>warningmsg</b> - warning string </li>
<li><b>failedusers</b> - array of users in username@affiliation form that could not be added </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="af3cdb4a0c6d2fa4ca9409f2bda3c3dae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCaffiliations </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets all of the affilations for which users can log in to VCL<br/>
<b>NOTE:</b> This is the only function available for which the X-User and X-Pass HTTP headers do not need to be passed </p>
<dl class="section return"><dt>Returns</dt><dd>an array of affiliation arrays, each with 2 indices:<br/>
<b>id</b> - id of the affiliation<br/>
<b>name</b> - name of the affiliation </dd></dl>
</div>
</div>
<a class="anchor" id="a8d0ad65897ca8d5ce3e7f5dfb099bb1d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCautoCapture </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$requestid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>creates entries in appropriate tables to capture an image and sets the request state to image </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$requestid</td><td>- id of request to be captured</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number </li>
<li><b>errormsg</b> - error string</li>
</ul>
<b>success</b> - image was successfully set to be captured </dd></dl>
</div>
</div>
<a class="anchor" id="a3d59515e70006076eff93787c65f0fc8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCblockAllocation </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$imageid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$numMachines</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$usergroupid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$ignoreprivileges</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>creates and processes a block allocation according to the passed in criteria </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$imageid</td><td>- id of the image to be used </td></tr>
<tr><td class="paramname">$start</td><td>- mysql datetime for the start time (i.e. machines should be prep'd and ready by this time) </td></tr>
<tr><td class="paramname">$end</td><td>- mysql datetime for the end time </td></tr>
<tr><td class="paramname">$numMachines</td><td>- number of computers to allocate </td></tr>
<tr><td class="paramname">$usergroupid</td><td>- id of user group for checking user access to machines </td></tr>
<tr><td class="paramname">$ignoreprivileges</td><td>- (optional, default=0) 0 (false) or 1 (true) - set to 1 to select computers from any that are mapped to be able to run the image; set to 0 to only select computers from ones that are both mapped and that users in the usergroup assigned to this block allocation have been granted access to through the privilege tree</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with blockTimesid as an index with the value of the newly created block time and at least one other index named 'status' which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array:<br/>
<ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - blockTimesid was processed; there will be two additional elements in this case:<br/>
</li>
<li><b>allocated</b> - total number of desired allocations that have been processed<br/>
</li>
<li><b>unallocated</b> - total number of desired allocations that have not been processed<br/>
<b>warning</b> - there was a non-fatal issue that occurred while processing the call; there will be four additional elements in this case:<br/>
</li>
<li><b>warningcode</b> - warning number<br/>
</li>
<li><b>warningmsg</b> - warning string<br/>
</li>
<li><b>allocated</b> - total number of desired allocations that have been processed<br/>
</li>
<li><b>unallocated</b> - total number of desired allocations that have not been processed<br/>
<br/>
<b>NOTE:</b> status may be warning, but allocated may be 0 indicating there were no errors that occurred, but there simply were not any machines available </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a6109cc77232e01c3d50772c191e43aee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCdeleteUserGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliation</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>alias for XMLRPCremoveUserGroup </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- name of user group </td></tr>
<tr><td class="paramname">$affiliation</td><td>- affiliation of user group</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number </li>
<li><b>errormsg</b> - error string</li>
</ul>
<b>success</b> - user group was successfully removed </dd></dl>
</div>
</div>
<a class="anchor" id="aeca4a12a3df632e152b4ecafa1b3e174"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCdeployServer </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$imageid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$admingroup</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$logingroup</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$ipaddr</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$macaddr</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$monitored</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$foruser</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$userdata</em> = <code>''</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>tries to make a server request </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$imageid</td><td>- id of an image </td></tr>
<tr><td class="paramname">$start</td><td>- "now" or unix timestamp for start of reservation; will use a floor function to round down to the nearest 15 minute increment for actual reservation </td></tr>
<tr><td class="paramname">$end</td><td>- "indefinite" or unix timestamp for end of reservation; will use a floor function to round up to the nearest 15 minute increment for actual reservation </td></tr>
<tr><td class="paramname">$admingroup</td><td>- (optional, default='') admin user group for reservation </td></tr>
<tr><td class="paramname">$logingroup</td><td>- (optional, default='') login user group for reservation </td></tr>
<tr><td class="paramname">$ipaddr</td><td>- (optional, default='') IP address to use for public IP of server </td></tr>
<tr><td class="paramname">$macaddr</td><td>- (optional, default='') MAC address to use for public NIC of server </td></tr>
<tr><td class="paramname">$monitored</td><td>- (optional, default=0) whether or not the server should be monitored - CURRENTLY, THIS IS UNSUPPORTED </td></tr>
<tr><td class="paramname">$foruser</td><td>- (optional) login to be used when setting up the account on the reserved machine - CURRENTLY, THIS IS UNSUPPORTED </td></tr>
<tr><td class="paramname">$name</td><td>- (optional) name for reservation </td></tr>
<tr><td class="paramname">$userdata</td><td>- (optional) text that will be placed in /root/.vclcontrol/post_reserve_userdata on the reserved node</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named '<b>status'</b> which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>notavailable</b> - no computers were available for the request<br/>
<b>success</b> - there will be an additional element in the array: </li>
<li><b>requestid</b> - identifier that should be passed to later calls when acting on the request </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="af8c71512a96fa5cd7890e8fa1f0ac66a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCeditUserGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$newName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$newAffiliation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$newOwner</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$newManagingGroup</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$newInitialMaxTime</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$newTotalMaxTime</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$newMaxExtendTime</em> = <code>''</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>modifies attributes of a user group<br/>
<b>NOTE:</b> an empty string may be passed for any of the new* fields to leave that item unchanged </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- name of user group </td></tr>
<tr><td class="paramname">$affiliation</td><td>- affiliation of user group </td></tr>
<tr><td class="paramname">$newName</td><td>- new name for user group </td></tr>
<tr><td class="paramname">$newAffiliation</td><td>- new affiliation for user group </td></tr>
<tr><td class="paramname">$newOwner</td><td>- (optional, default='') user that will be the owner of the group in username@affiliation form </td></tr>
<tr><td class="paramname">$newManagingGroup</td><td>- (optional, default='') user group that can manage membership of this one </td></tr>
<tr><td class="paramname">$newInitialMaxTime</td><td>- (optional, default='') (minutes) max initial time users in this group can select for length of reservations </td></tr>
<tr><td class="paramname">$newTotalMaxTime</td><td>- (optional, default='') (minutes) total length users in the group can have for a reservation (including all extensions) </td></tr>
<tr><td class="paramname">$newMaxExtendTime</td><td>- (optional, default='') (minutes) max length of time users can request as an extension to a reservation at a time</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number </li>
<li><b>errormsg</b> - error string</li>
</ul>
<b>success</b> - user group was successfully updated </dd></dl>
</div>
</div>
<a class="anchor" id="ac2303425584288df956142b63607d15b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCendRequest </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$requestid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>ends/deletes a request </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$requestid</td><td>- id of a request</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - request was successfully ended<br/>
</li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="af31dfd65379b8d3d9203bb343ce4adea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCextendRequest </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$requestid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$extendtime</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>extends the length of an active request; if a request that has not started needs to be extended, delete the request and submit a new one </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$requestid</td><td>- id of a request </td></tr>
<tr><td class="paramname">$extendtime</td><td>- time in minutes to extend reservation</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - request was successfully extended<br/>
</li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ac83a2eb35aa274b5167c8848d16e9b67"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCfinishBaseImageCapture </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$ownerid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$resourceid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$virtual</em> = <code>1</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>calls addImagePermissions to create and set up permissions, groupings, and mappings so that the owner of a new base image will be able to make a reservation for it after capturing it using 'vcld -setup'; specifically designed to be called by vcld as part of the process of capturing a new base image </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$ownerid</td><td>- id of owner of image </td></tr>
<tr><td class="paramname">$resourceid</td><td>- id from resource table for the image </td></tr>
<tr><td class="paramname">$virtual</td><td>- (bool) 0 if bare metal image, 1 if virtual</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - the permissions, groupings, and mappings were set up successfully </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a6da19270827056754d8e7782ddc6faaa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetGroupImages </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets a list of all images in a particular group </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- the name of an imageGroup</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - returns an array of images; there will be an additional element in the array with an index of 'images' that is an array of images with each element having the following two keys:<br/>
</li>
<li><b>id</b> - id of the image<br/>
</li>
<li><b>name</b> - name of the image </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a5bacea01de3773fb69f1cb141204b58c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetImages </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets the images to which the user has access </p>
<dl class="section return"><dt>Returns</dt><dd>an array of image arrays, each with these indices:<br/>
<b>id</b> - id of the image<br/>
<b>name</b> - name of the image<br/>
<b>description</b> - description of image<br/>
<b>usage</b> - usage instructions for image </dd></dl>
</div>
</div>
<a class="anchor" id="ac779aaea31c0836d4fd85cb837b8c870"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetNodes </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$root</em> = <code>NULL</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets a list of all nodes in the privilege tree </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$root</td><td>- (optional, default=top of tree) the ID of the node forming the root of the hierarchy</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - returns an array of nodes; there will be an additional element in the array with an index of 'nodes' that is an array of nodes with each element having the following three keys:<br/>
</li>
<li><b>id</b> - id of the node<br/>
</li>
<li><b>name</b> - name of the node<br/>
</li>
<li><b>parent</b> - id of the parent node </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ae1d25d949e2beee11bb73248ef5890d9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetRequestConnectData </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$requestid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$remoteIP</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>if request is ready, adds the connecting user's computer to the request and returns info about how to connect to the computer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$requestid</td><td>- id of a request </td></tr>
<tr><td class="paramname">$remoteIP</td><td>- ip address of connecting user's computer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named '<b>status'</b> which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>ready</b> - request is ready; there will be 3 additional elements in the array:<br/>
</li>
<li><b>serverIP</b> - address of the reserved machine </li>
<li><b>user</b> - user to use when connecting to the machine </li>
<li><b>password</b> - password to use when connecting to the machine</li>
</ul>
<b>notready</b> - request is not ready for connection </dd></dl>
</div>
</div>
<a class="anchor" id="a92ebf10589864453db3940767bc63376"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetRequestIds </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets information about all of user's requests </p>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - request was successfully found; there will be an additional element whose index is 'requests' which is an array of arrays, each having these elements (or empty if no existing requests):<br/>
</li>
<li><b>requestid</b> - id of the request<br/>
</li>
<li><b>imageid</b> - id of the image<br/>
</li>
<li><b>imagename</b> - name of the image<br/>
</li>
<li><b>start</b> - unix timestamp of start time<br/>
</li>
<li><b>end</b> - unix timestamp of end time<br/>
</li>
<li><b>OS</b> - name of OS used in image<br/>
</li>
<li><b>isserver</b> - 0 or 1 - whether or not this is a server reservation<br/>
</li>
<li><b>state</b> - current state of reservation<br/>
</li>
<li><b>servername</b> - only included if isserver == 1 - name of the reservation </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a032dc164f41a976c5d757eb7f9e984f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetRequestStatus </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$requestid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>determines and returns the status of the request </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$requestid</td><td>- id of a request</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named '<b>status'</b> which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>ready</b> - request is ready<br/>
<b>failed</b> - request failed to load properly<br/>
<b>timedout</b> - request timed out (user didn't connect before timeout expired)<br/>
<b>loading</b> - request is still loading; there will be an additional element in the array: </li>
<li><b>time</b> - the estimated wait time (in minutes) for loading to complete<br/>
<b>future</b> - start time of request is in the future<br/>
</li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a7b03beb7300fbe2bee1f3a238c87ad95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetResourceGroupPrivs </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$nodeid</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get a list of privileges for a resource group at a particular node in the privilege tree </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- the name of the resource group </td></tr>
<tr><td class="paramname">$type</td><td>- the resource group type </td></tr>
<tr><td class="paramname">$nodeid</td><td>- the ID of the node in the privilege tree</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - an additional element is returned:<br/>
</li>
<li><b>privileges</b> - array of privileges assigned at the node </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="aeef7932684f15af6bcbd01e546939eb8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetResourceGroups </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get a list of resource groups of a particular type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$type</td><td>- the resource group type</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - a 'groups' element will contain an array of groups of the given type<br/>
</li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a6199166923822a70e546fb5330e3c72c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetUserGroupAttributes </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliation</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets information about a user group </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- name of user group </td></tr>
<tr><td class="paramname">$affiliation</td><td>- affiliation of user group</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number </li>
<li><b>errormsg</b> - error string</li>
</ul>
<b>success</b> - there will be six additional elements in this case: <ul>
<li><b>owner</b> - user that will be the owner of the group in username@affiliation form </li>
<li><b>managingGroup</b> - user group that can manage membership of this one in groupname@affiliation form </li>
<li><b>initialMaxTime</b> - (minutes) max initial time users in this group can select for length of reservations </li>
<li><b>totalMaxTime</b> - (minutes) total length users in the group can have for a reservation (including all extensions) </li>
<li><b>maxExtendTime</b> - (minutes) max length of time users can request as an extension to a reservation at a time </li>
<li><b>overlapResCount</b> - maximum allowed number of overlapping reservations allowed for users in this group </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="aa75ba57e059c75e9638b1a95bd12d6cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetUserGroupMembers </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliation</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets members of a user group<br/>
<b>NOTE:</b> it is possible to have a group with no members in which case success will be returned with an empty array for members </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- name of user group </td></tr>
<tr><td class="paramname">$affiliation</td><td>- affiliation of user group</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number </li>
<li><b>errormsg</b> - error string</li>
</ul>
<b>success</b> - there will be one additional element in this case: <ul>
<li><b>members</b> - array of members of the group in username@affiliation form </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ac3758464d83cab9c47819d13ca79ab96"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetUserGroupPrivs </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$nodeid</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get a list of privileges for a user group at a particular node in the privilege tree </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- the name of the user group </td></tr>
<tr><td class="paramname">$affiliation</td><td>- the affiliation of the group </td></tr>
<tr><td class="paramname">$nodeid</td><td>- the ID of the node in the privilege tree</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - an additional element is returned:<br/>
</li>
<li><b>privileges</b> - array of privileges assigned at the node </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ada4c0b4bbf44b5c82b484d8113bce6df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCgetUserGroups </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$groupType</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliationid</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>builds a list of user groups </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$groupType</td><td>- (optional, default=0) specify 0 for all groups, 1 for only custom groups, 2 for only courseroll groups </td></tr>
<tr><td class="paramname">$affiliationid</td><td>- (optional, default=0) specifiy an affiliationid to limit returned groups to only those matching the affiliation; pass 0 for all affiliations</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with two indices, one named 'status' which will have a value of 'success', the other named 'groups' which will be an array of arrays, each one having the following keys:<br/>
<ul>
<li>id<br/>
</li>
<li>name<br/>
</li>
<li>groupaffiliation<br/>
</li>
<li>groupaffiliationid<br/>
</li>
<li>ownerid<br/>
</li>
<li>owner<br/>
</li>
<li>affiliation<br/>
</li>
<li>editgroupid<br/>
</li>
<li>editgroup<br/>
</li>
<li>editgroupaffiliationid<br/>
</li>
<li>editgroupaffiliation<br/>
</li>
<li>custom<br/>
</li>
<li>courseroll<br/>
</li>
<li>initialmaxtime<br/>
</li>
<li>maxextendtime<br/>
</li>
<li>overlapResCount </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ac420460fdb4c40a550ad95d3efbb6a26"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCnodeExists </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$nodeName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$parentNode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>indicates whether a node with that name already exists at this location in the privilege tree </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$nodeName</td><td>- the name of a node </td></tr>
<tr><td class="paramname">$parentNode</td><td>- the ID of the parent node</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - returns an 'exists' element set to either 1 or 0<br/>
</li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a428ab5529037c8e2d7e035c5b972aec9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCprocessBlockTime </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$blockTimesid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$ignoreprivileges</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>processes a block allocation for the blockTimes entry associated with blockTimesid </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$blockTimesid</td><td>- id from the blockTimes table </td></tr>
<tr><td class="paramname">$ignoreprivileges</td><td>- (optional, default=0) 0 (false) or 1 (true) - set to 1 to select computers from any that are mapped to be able to run the image; set to 0 to only select computers from ones that are both mapped and that users in the usergroup assigned to this block allocation have been granted access to through the privilege tree</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number </li>
<li><b>errormsg</b> - error string</li>
</ul>
<b>completed</b> - blockTimesid was previously successfully processed<br/>
<b>success</b> - blockTimesid was processed; there will be two additional elements in this case:<br/>
<ul>
<li><b>allocated</b> - total number of desired allocations that have been processed<br/>
</li>
<li><b>unallocated</b> - total number of desired allocations that have not been processed<br/>
<b>warning</b> - there was a non-fatal issue that occurred while processing the call; there will be four additional elements in this case:<br/>
</li>
<li><b>warningcode</b> - warning number<br/>
</li>
<li><b>warningmsg</b> - warning string<br/>
</li>
<li><b>allocated</b> - total number of desired allocations that have been processed<br/>
</li>
<li><b>unallocated</b> - total number of desired allocations that have not been processed<br/>
<br/>
<b>NOTE:</b> status may be warning, but allocated may be 0 indicating there were no errors that occurred, but there simply were not any machines available </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a4da8c99adf62b1182b40ffc8d980394f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCremoveImageFromGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$imageid</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>removes an image from a resource group </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- the name of an imageGroup </td></tr>
<tr><td class="paramname">$imageid</td><td>- the id of an image</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - image was removed from the group<br/>
</li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a9be10d4b225b80d377781f1095ce477c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCremoveImageGroupFromComputerGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$imageGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$computerGroup</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>remove the mapping of an image group to a computer group </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$imageGroup</td><td>- the name of an imageGroup </td></tr>
<tr><td class="paramname">$computerGroup</td><td>- the name of a computerGroup</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - successfully removed the mapping from an image group to a computer group<br/>
</li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a510d59605fc4044c4092a7248f391b60"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCremoveNode </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$nodeID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>delete a node from the privilege tree </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$nodeID</td><td>- the ID of a node</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - node was successfully deleted </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a4bf0cfa485b1c13efc21c6cb07924c6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCremoveResourceGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>remove a resource group </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- the name of the resource group </td></tr>
<tr><td class="paramname">$type</td><td>- the resource group type</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - the resource group was removed<br/>
</li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="af850ce9dc616c6cf763006711e062de4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCremoveResourceGroupPriv </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$nodeid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$permissions</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>remove privileges for a resource group from a node in the privilege tree </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- the name of the resource group </td></tr>
<tr><td class="paramname">$type</td><td>- the resource type </td></tr>
<tr><td class="paramname">$nodeid</td><td>- the ID of the node in the privilege tree </td></tr>
<tr><td class="paramname">$permissions</td><td>- a colon (:) delimited list of privileges to remove</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - privileges were successfully removed </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a0a55396e98856ffa4e2b3f33e55a4031"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCremoveUserGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliation</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>removes a user group along with all of its privileges </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- name of user group </td></tr>
<tr><td class="paramname">$affiliation</td><td>- affiliation of user group</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number </li>
<li><b>errormsg</b> - error string</li>
</ul>
<b>success</b> - user group was successfully removed </dd></dl>
</div>
</div>
<a class="anchor" id="a2c2576b692238ebf50ce3a642926d133"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCremoveUserGroupPriv </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$nodeid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$permissions</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>remove privileges for a resource group at a particular node in the privilege tree </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- the name of the user group </td></tr>
<tr><td class="paramname">$affiliation</td><td>- the affiliation of the user group </td></tr>
<tr><td class="paramname">$nodeid</td><td>- the ID of the node in the privilege tree </td></tr>
<tr><td class="paramname">$permissions</td><td>- a colon (:) delimited list of privileges to remove</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - privileges were successfully removed </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a293e447aaf99c561c4247a62fff4c13f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCremoveUsersFromGroup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$affiliation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$users</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>removes users from a group </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$name</td><td>- name of user group </td></tr>
<tr><td class="paramname">$affiliation</td><td>- affiliation of user group </td></tr>
<tr><td class="paramname">$users</td><td>- array of users in username@affiliation form to be removed from the group</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values:<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number </li>
<li><b>errormsg</b> - error string</li>
</ul>
<b>success</b> - users successfully removed from the group<br/>
<b>warning</b> - there was a non-fatal issue that occurred while processing the call; there will be three additional elements in this case: <ul>
<li><b>warningcode</b> - warning number </li>
<li><b>warningmsg</b> - warning string </li>
<li><b>failedusers</b> - array of users in username@affiliation form that could not be removed </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a2ffaf38c049a59237adcdd103122b1ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCsetRequestEnding </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$requestid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$end</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>modifies the end time of an active request; if a request that has not started needs to be modifed, delete the request and submit a new one </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$requestid</td><td>- id of a request </td></tr>
<tr><td class="paramname">$end</td><td>- unix timestamp for end of reservation; will be rounded up to the nearest 15 minute increment</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with at least one index named 'status' which will have one of these values<br/>
<b>error</b> - error occurred; there will be 2 additional elements in the array: <ul>
<li><b>errorcode</b> - error number<br/>
</li>
<li><b>errormsg</b> - error string<br/>
<b>success</b> - request was successfully extended<br/>
</li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a905bda05c77ad0d7b1af805607a69ecd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLRPCtest </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$string</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>this is a test function that call be called when getting XML RPC calls to this site to work </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$string</td><td>- a string</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array with 3 indices:<br/>
<b>status</b> - will be 'success'<br/>
<b>message</b> - will be 'RPC call worked successfully'<br/>
<b>string</b> - contents of $string (after being sanatized) </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Feb 12 2015 16:49:38 for VCL XML RPC by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>