Changeset 531
- Timestamp:
- 02/18/07 19:54:26 (2 years ago)
- Files:
-
- trunk/doc/manual/rpcref/commands.tex (modified) (1 diff)
- trunk/doc/manual/rpcref/vxdb.tex (modified) (19 diffs)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
trunk/doc/manual/rpcref/commands.tex
r530 r531 29 29 }{} 30 30 31 \newcommand{\rpccapability}[1]{This method requires the \texttt{#1} capability }31 \newcommand{\rpccapability}[1]{This method requires the \texttt{#1} capability} 32 32 \newcommand{\rpcnocapability}[0]{This method requires no capabilities } 33 33 \newcommand{\rpcownerchecks}[0]{needs to pass owner checks} trunk/doc/manual/rpcref/vxdb.tex
r522 r531 1 1 \chapter{Database Manipulation Methods} 2 2 3 The vxdbfamily of functions provide manipulation facilities for the3 The \texttt{vxdb} family of functions provide manipulation facilities for the 4 4 configuration database. 5 5 … … 10 10 This method is used to get information about configured disk limits. 11 11 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} 16 14 \end{rpcsynopsis} 17 15 … … 20 18 \end{rpcaccess} 21 19 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} 26 22 \rpcreturnparam{space}{Maximum amount of disk space for this virtual server 27 23 in KB} … … 39 35 This method is used to remove information about configured disk limits. 40 36 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} 45 39 \end{rpcsynopsis} 46 40 … … 60 54 limits. 61 55 62 \begin{rpcsynopsis}{vxdb.dx.limit.set}{string name, string path,uint32 space,56 \begin{rpcsynopsis}{vxdb.dx.limit.set}{string name, uint32 space, 63 57 uint32 inodes, int reserved} 64 58 \rpcparam{name}{Unique virtual server name} 65 \rpcparam{path}{Absolute disk limit path \emph{inside} the virtual server}66 59 \rpcparam{space}{Maximum amount of disk space for this virtual server in KB} 67 60 \rpcparam{inodes}{Maximum number of inodes for this virtual server} … … 93 86 \end{rpcaccess} 94 87 95 \begin{rpcreturncomplex}{ \texttt{struct}}{string init, string halt,88 \begin{rpcreturncomplex}{a \texttt{struct}}{string init, string halt, 96 89 string reboot} 97 90 \rpcreturnparam{init}{Absolute path of the init command \emph{inside} the … … 140 133 141 134 \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 virtual149 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 137 pass owner checks. 138 \end{rpcaccess} 139 140 141 \rpcreturnsimple{an \texttt{array} of \texttt{string}s -- one for each virtual 142 server --} 150 143 151 144 \rpcnoerrors … … 168 161 \end{rpcaccess} 169 162 170 \begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s - one for each171 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} 172 165 \rpcreturnparam{src}{Absolute source path \emph{inside} the virtual server or 173 166 arbitrary identifier (defaults to \texttt{none} if empty)} 174 167 \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} 177 169 \rpcreturnparam{type}{Filesystem type for the specified source path 178 170 (defaults to \texttt{auto}} if empty) … … 237 229 238 230 This method is used to lookup the name of a virtual server by its corresponding 239 Context ID.231 context ID. 240 232 241 233 \begin{rpcsynopsis}{vxdb.name.get}{int xid} 242 \rpcparam{xid}{ Context ID to lookup}234 \rpcparam{xid}{Unique context ID} 243 235 \end{rpcsynopsis} 244 236 … … 267 259 \end{rpcaccess} 268 260 269 \begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s - one for each270 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} 271 263 \rpcreturnparam{addr}{Network address in dot-decimal form} 272 264 \rpcreturnparam{netmask}{Network mask in dot-decimal form (defaults to … … 285 277 \rpcparam{name}{Unique virtual server name} 286 278 \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)} 288 280 \end{rpcsynopsis} 289 281 … … 410 402 \end{rpcaccess} 411 403 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 --} 413 406 414 407 \rpcnoerrors … … 436 429 437 430 438 % vxdb.user.caps.add439 \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 \rpcreturnnil453 454 \rpcnoerrors455 456 457 % vxdb.user.caps.get458 \section{vxdb.user.caps.get}459 460 This method is used to get information about configured capabilities in the461 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 each472 capability - }473 474 \rpcnoerrors475 476 477 % vxdb.user.caps.remove478 \section{vxdb.user.caps.remove}479 480 This method is used to remove information about configured capabilities from481 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 \rpcreturnnil493 494 \rpcnoerrors495 496 497 % vxdb.user.get498 \section{vxdb.user.get}499 500 This method is used to get information about configured users in the internal501 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.remove518 \section{vxdb.user.remove}519 520 This method is used to remove information about configured users from the521 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 \rpcreturnnil532 533 \rpcnoerrors534 535 536 % vxdb.user.set537 \section{vxdb.user.set}538 539 This method is used to set (add \& change) information about configured users540 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 exists546 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 \rpcreturnnil555 556 \rpcnoerrors557 558 559 431 % vxdb.vdir.get 560 432 \section{vxdb.vdir.get} … … 609 481 \end{rpcaccess} 610 482 611 \rpcreturnsimple{an \texttt{array} of \texttt{string}s - one for each system612 capability }483 \rpcreturnsimple{an \texttt{array} of \texttt{string}s -- one for each system 484 capability --} 613 485 614 486 \rpcnoerrors … … 666 538 \end{rpcaccess} 667 539 668 \rpcreturnsimple{an \texttt{array} of \texttt{string}s - one for each context669 capability }540 \rpcreturnsimple{an \texttt{array} of \texttt{string}s -- one for each context 541 capability --} 670 542 671 543 \rpcnoerrors … … 724 596 \end{rpcaccess} 725 597 726 \rpcreturnsimple{an \texttt{array} of \texttt{string}s - one for each context727 flag }598 \rpcreturnsimple{an \texttt{array} of \texttt{string}s -- one for each context 599 flag -- } 728 600 729 601 \rpcnoerrors … … 764 636 \end{rpcaccess} 765 637 766 \begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s - one for each767 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} 768 640 \rpcreturnparam{limit}{Limit type to add or change} 769 641 \rpcreturnparam{soft}{Softl imit for the specified type} … … 831 703 \end{rpcaccess} 832 704 833 \begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s - one for each834 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, 835 707 int fillrate2, int tokensmin, int tokensmax} 836 708 \rpcreturnparam{cpuid}{CPU ID as listed in \texttt{/proc/cpuinfo}} … … 910 782 \end{rpcaccess} 911 783 912 \begin{rpcreturncomplex}{an \texttt{array} of \texttt{struct}s - one for each913 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} 914 786 \rpcreturnparam{uname}{System information type} 915 787 \rpcreturnparam{value}{System information value}
