code.grnet.gr Git - ganeti-local/blob - man/ganeti-rapi.rst

   1 ganeti-rapi(8) Ganeti | Version @GANETI_VERSION@
   2 ================================================
   3
   4 Name
   5 ----
   6
   7 ganeti-rapi - Ganeti remote API daemon
   8
   9 Synopsis
  10 --------
  11
  12 | **ganeti-rapi** [-d] [-f] [\--no-ssl] [-K *SSL_KEY_FILE*]
  13 | [-C *SSL_CERT_FILE*] [\--require-authentication]
  14
  15 DESCRIPTION
  16 -----------
  17
  18 **ganeti-rapi** is the daemon providing a remote API for Ganeti
  19 clusters.
  20
  21 It is automatically started on the master node, and by default it
  22 uses SSL encryption. This can be disabled by passing the
  23 ``--no-ssl`` option, or alternatively the certificate used can be
  24 changed via the ``-C`` option and the key via the ``-K`` option.
  25
  26 The daemon will listen to the "ganeti-rapi" TCP port, as listed in the
  27 system services database, or if not defined, to port 5080 by default.
  28
  29 See the *Ganeti remote API* documentation for further information.
  30
  31 Requests are logged to ``@LOCALSTATEDIR@/log/ganeti/rapi-daemon.log``,
  32 in the same format as for the node and master daemon.
  33
  34 ACCESS CONTROLS
  35 ---------------
  36
  37 Most query operations are allowed without authentication. Only the
  38 modification operations require authentication, in the form of basic
  39 authentication. Specify the ``--require-authentication`` command line
  40 flag to always require authentication.
  41
  42 The users and their rights are defined in the
  43 ``@LOCALSTATEDIR@/lib/ganeti/rapi/users`` file. The format of this file
  44 is described in the Ganeti documentation (``rapi.html``).
  45
  46 .. vim: set textwidth=72 :
  47 .. Local Variables:
  48 .. mode: rst
  49 .. fill-column: 72
  50 .. End: