Changeset 531

Show
Ignore:
Timestamp:
02/18/07 19:54:26 (2 years ago)
Author:
hollow
Message:

update vxdb method reference

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/doc/manual/rpcref/commands.tex

    r530 r531  
    2929}{} 
    3030 
    31 \newcommand{\rpccapability}[1]{This method requires the \texttt{#1} capability
     31\newcommand{\rpccapability}[1]{This method requires the \texttt{#1} capability
    3232\newcommand{\rpcnocapability}[0]{This method requires no capabilities } 
    3333\newcommand{\rpcownerchecks}[0]{needs to pass owner checks} 
  • trunk/doc/manual/rpcref/vxdb.tex

    r522 r531  
    11\chapter{Database Manipulation Methods} 
    22 
    3 The vxdb family of functions provide manipulation facilities for the 
     3The \texttt{vxdb} family of functions provide manipulation facilities for the 
    44configuration database. 
    55 
     
    1010This method is used to get information about configured disk limits. 
    1111 
    12 \begin{rpcsynopsis}{vxdb.dx.limit.get}{string name, string path} 
    13 \rpcparam{name}{Unique virtual server name} 
    14 \rpcparam{path}{Absolute path \emph{inside} the virtual server (this value may 
    15         be empty to retrieve information about all configured disk limits)} 
     12\begin{rpcsynopsis}{vxdb.dx.limit.get}{string name} 
     13\rpcparam{name}{Unique virtual server name} 
    1614\end{rpcsynopsis} 
    1715 
     
    2018\end{rpcaccess} 
    2119 
    22 \begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s - one for each 
    23         disk limit - }{string path, uint32 space, uint32~inodes, int reserved} 
    24 \rpcreturnparam{path}{Absolute disk limit path \emph{inside} the virtual 
    25         server} 
     20\begin{rpcreturncomplex}{a \texttt{struct}}{uint32 space, uint32 inodes, 
     21        int reserved} 
    2622\rpcreturnparam{space}{Maximum amount of disk space for this virtual server 
    2723        in KB} 
     
    3935This method is used to remove information about configured disk limits. 
    4036 
    41 \begin{rpcsynopsis}{vxdb.dx.limit.remove}{string name, string path} 
    42 \rpcparam{name}{Unique virtual server name} 
    43 \rpcparam{path}{Absolute disk limit path \emph{inside} the virtual server (this 
    44 value may be empty to remove all configured limits)} 
     37\begin{rpcsynopsis}{vxdb.dx.limit.remove}{string name} 
     38\rpcparam{name}{Unique virtual server name} 
    4539\end{rpcsynopsis} 
    4640 
     
    6054limits. 
    6155 
    62 \begin{rpcsynopsis}{vxdb.dx.limit.set}{string name, string path, uint32 space, 
     56\begin{rpcsynopsis}{vxdb.dx.limit.set}{string name, uint32 space, 
    6357        uint32 inodes, int reserved} 
    6458\rpcparam{name}{Unique virtual server name} 
    65 \rpcparam{path}{Absolute disk limit path \emph{inside} the virtual server} 
    6659\rpcparam{space}{Maximum amount of disk space for this virtual server in KB} 
    6760\rpcparam{inodes}{Maximum number of inodes for this virtual server} 
     
    9386\end{rpcaccess} 
    9487 
    95 \begin{rpcreturncomplex}{\texttt{struct}}{string init, string halt, 
     88\begin{rpcreturncomplex}{a \texttt{struct}}{string init, string halt, 
    9689        string reboot} 
    9790\rpcreturnparam{init}{Absolute path of the init command \emph{inside} the 
     
    140133 
    141134\begin{rpcaccess} 
    142 \rpcnocapability and \rpcownerchecks. The owner checks do not check the 
    143 usual name parameter here, but do a check on all VXDB entries and returns 
    144 the matches. 
    145 \end{rpcaccess} 
    146  
    147  
    148 \rpcreturnsimple{an \texttt{array} of \texttt{string}s - one for each virtual 
    149         server -
     135\rpcnocapability and \rpcownerchecks. The owner checks do not check the usual 
     136\texttt{name} parameter here, instead it returns all virtual servers that would 
     137pass owner checks. 
     138\end{rpcaccess} 
     139 
     140 
     141\rpcreturnsimple{an \texttt{array} of \texttt{string}s -- one for each virtual 
     142        server --
    150143 
    151144\rpcnoerrors 
     
    168161\end{rpcaccess} 
    169162 
    170 \begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s - one for each 
    171         mount point - }{string src, string dst, string type, string opts} 
     163\begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s -- one for each 
     164        mount point --}{string src, string dst, string type, string opts} 
    172165\rpcreturnparam{src}{Absolute source path \emph{inside} the virtual server or 
    173166        arbitrary identifier (defaults to \texttt{none} if empty)} 
    174167\rpcreturnparam{dst}{Absolute destination path for the mount point inside the 
    175         virtual server (this value may be empty to return a list of all configured 
    176         mount points)} 
     168        virtual server} 
    177169\rpcreturnparam{type}{Filesystem type for the specified source path 
    178170        (defaults to \texttt{auto}} if empty) 
     
    237229 
    238230This method is used to lookup the name of a virtual server by its corresponding 
    239 Context ID. 
     231context ID. 
    240232 
    241233\begin{rpcsynopsis}{vxdb.name.get}{int xid} 
    242 \rpcparam{xid}{Context ID to lookup
     234\rpcparam{xid}{Unique context ID
    243235\end{rpcsynopsis} 
    244236 
     
    267259\end{rpcaccess} 
    268260 
    269 \begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s - one for each 
    270         network address -}{string addr, string netmask} 
     261\begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s -- one for each 
     262        network address --}{string addr, string netmask} 
    271263\rpcreturnparam{addr}{Network address in dot-decimal form} 
    272264\rpcreturnparam{netmask}{Network mask in dot-decimal form (defaults to 
     
    285277\rpcparam{name}{Unique virtual server name} 
    286278\rpcparam{addr}{Network address in dot-decimal form (this value may be empty to 
    287 remove all configured network adresses)} 
     279       remove all configured network adresses)} 
    288280\end{rpcsynopsis} 
    289281 
     
    410402\end{rpcaccess} 
    411403 
    412 \rpcreturnsimple{an \texttt{array} of \texttt{string}s - one for each owner - } 
     404\rpcreturnsimple{an \texttt{array} of \texttt{string}s -- one for each 
     405        owner --} 
    413406 
    414407\rpcnoerrors 
     
    436429 
    437430 
    438 % vxdb.user.caps.add 
    439 \section{vxdb.user.caps.add} 
    440  
    441 This method is used to add add capabilities to the internal user database. 
    442  
    443 \begin{rpcsynopsis}{vxdb.user.caps.add}{string username, string cap} 
    444 \rpcparam{username}{Unique username} 
    445 \rpcparam{cap}{Capability to add} 
    446 \end{rpcsynopsis} 
    447  
    448 \begin{rpcaccess} 
    449 \rpccapability{AUTH} and\rpcnoownerchecks. 
    450 \end{rpcaccess} 
    451  
    452 \rpcreturnnil 
    453  
    454 \rpcnoerrors 
    455  
    456  
    457 % vxdb.user.caps.get 
    458 \section{vxdb.user.caps.get} 
    459  
    460 This method is used to get information about configured capabilities in the 
    461 internal user database. 
    462  
    463 \begin{rpcsynopsis}{vxdb.user.caps.get}{string username} 
    464 \rpcparam{username}{Unique username} 
    465 \end{rpcsynopsis} 
    466  
    467 \begin{rpcaccess} 
    468 \rpccapability{AUTH} and \rpcnoownerchecks. 
    469 \end{rpcaccess} 
    470  
    471 \rpcreturnsimple{an \texttt{array} of \texttt{string}s - on for each 
    472         capability - } 
    473  
    474 \rpcnoerrors 
    475  
    476  
    477 % vxdb.user.caps.remove 
    478 \section{vxdb.user.caps.remove} 
    479  
    480 This method is used to remove information about configured capabilities from 
    481 the internal user database. 
    482  
    483 \begin{rpcsynopsis}{vxdb.user.caps.remove}{string username, string cap} 
    484 \rpcparam{username}{Unique username} 
    485 \rpcparam{cap}{Capability to remove} 
    486 \end{rpcsynopsis} 
    487  
    488 \begin{rpcaccess} 
    489 \rpccapability{AUTH} and \rpcnoownerchecks. 
    490 \end{rpcaccess} 
    491  
    492 \rpcreturnnil 
    493  
    494 \rpcnoerrors 
    495  
    496  
    497 % vxdb.user.get 
    498 \section{vxdb.user.get} 
    499  
    500 This method is used to get information about configured users in the internal 
    501 user database. 
    502  
    503 \begin{rpcsynopsis}{vxdb.user.get}{string username} 
    504 \rpcparam{username}{Unique username} 
    505 \end{rpcsynopsis} 
    506  
    507 \begin{rpcaccess} 
    508 \rpccapability{AUTH} and \rpcnoownerchecks. 
    509 \end{rpcaccess} 
    510  
    511 \begin{rpcreturncomplex}{\texttt{struct}}{string password, bool admin} 
    512 \rpcreturnparam{password}{Password hash for the specified user} 
    513 \rpcreturnparam{admin}{Set the administrator flag for the specified user} 
    514 \end{rpcreturncomplex} 
    515  
    516  
    517 % vxdb.user.remove 
    518 \section{vxdb.user.remove} 
    519  
    520 This method is used to remove information about configured users from the 
    521 internal user database. 
    522  
    523 \begin{rpcsynopsis}{vxdb.user.remove}{string username} 
    524 \rpcparam{username}{Unique username} 
    525 \end{rpcsynopsis} 
    526  
    527 \begin{rpcaccess} 
    528 \rpccapability{AUTH} and \rpcnoownerchecks. 
    529 \end{rpcaccess} 
    530  
    531 \rpcreturnnil 
    532  
    533 \rpcnoerrors 
    534  
    535  
    536 % vxdb.user.set 
    537 \section{vxdb.user.set} 
    538  
    539 This method is used to set (add \& change) information about configured users 
    540 in the internal user database. 
    541  
    542 \begin{rpcsynopsis}{vxdb.user.set}{string username, string password, 
    543         bool admin} 
    544 \rpcparam{username}{Unique username} 
    545 \rpcparam{password}{Password for the specified user (if user already exists 
    546         this value may be empty to not change the password)} 
    547 \rpcparam{admin}{Set the administrator flag for the specified user} 
    548 \end{rpcsynopsis} 
    549  
    550 \begin{rpcaccess} 
    551 \rpccapability{AUTH} and \rpcnoownerchecks. 
    552 \end{rpcaccess} 
    553  
    554 \rpcreturnnil 
    555  
    556 \rpcnoerrors 
    557  
    558  
    559431% vxdb.vdir.get 
    560432\section{vxdb.vdir.get} 
     
    609481\end{rpcaccess} 
    610482 
    611 \rpcreturnsimple{an \texttt{array} of \texttt{string}s - one for each system 
    612         capability
     483\rpcreturnsimple{an \texttt{array} of \texttt{string}s -- one for each system 
     484        capability --
    613485 
    614486\rpcnoerrors 
     
    666538\end{rpcaccess} 
    667539 
    668 \rpcreturnsimple{an \texttt{array} of \texttt{string}s - one for each context 
    669         capability
     540\rpcreturnsimple{an \texttt{array} of \texttt{string}s -- one for each context 
     541        capability --
    670542 
    671543\rpcnoerrors 
     
    724596\end{rpcaccess} 
    725597 
    726 \rpcreturnsimple{an \texttt{array} of \texttt{string}s - one for each context 
    727         flag
     598\rpcreturnsimple{an \texttt{array} of \texttt{string}s -- one for each context 
     599        flag --
    728600 
    729601\rpcnoerrors 
     
    764636\end{rpcaccess} 
    765637 
    766 \begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s - one for each 
    767         resource limit -}{string limit, uint64 soft, uint64 max} 
     638\begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s -- one for each 
     639        resource limit --}{string limit, uint64 soft, uint64 max} 
    768640\rpcreturnparam{limit}{Limit type to add or change} 
    769641\rpcreturnparam{soft}{Softl imit for the specified type} 
     
    831703\end{rpcaccess} 
    832704 
    833 \begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s - one for each 
    834         CPU ID}{int cpuid, int interval, int fillrate, int interval2, 
     705\begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s -- one for each 
     706        CPU ID --}{int cpuid, int interval, int fillrate, int interval2, 
    835707        int fillrate2, int tokensmin, int tokensmax} 
    836708\rpcreturnparam{cpuid}{CPU ID as listed in \texttt{/proc/cpuinfo}} 
     
    910782\end{rpcaccess} 
    911783 
    912 \begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s - one for each 
    913         system information type}{string uname, string value} 
     784\begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s -- one for each 
     785        system information type --}{string uname, string value} 
    914786\rpcreturnparam{uname}{System information type} 
    915787\rpcreturnparam{value}{System information value}