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] [-p *PORT] [-b *ADDRESS*] [-i *INTERFACE*]
  13 | [\--no-ssl] [-K *SSL_KEY_FILE*] [-C *SSL_CERT_FILE*]
  14 | [\--require-authentication]
  15
  16 DESCRIPTION
  17 -----------
  18
  19 **ganeti-rapi** is the daemon providing a remote API for Ganeti
  20 clusters.
  21
  22 It is automatically started on the master node, and by default it
  23 uses SSL encryption. This can be disabled by passing the
  24 ``--no-ssl`` option, or alternatively the certificate used can be
  25 changed via the ``-C`` option and the key via the ``-K`` option.
  26
  27 The daemon will listen to the "ganeti-rapi" TCP port, as listed in the
  28 system services database, or if not defined, to port 5080 by default.
  29 The port can be overridded by passing the ``-p`` option. The ``-b``
  30 option can be used to specify the address to bind to (defaults to
  31 ``0.0.0.0``); alternatively, the ``-i`` option can be used to specify
  32 the interface to bind do.
  33
  34 See the *Ganeti remote API* documentation for further information.
  35
  36 Requests are logged to ``@LOCALSTATEDIR@/log/ganeti/rapi-daemon.log``,
  37 in the same format as for the node and master daemon.
  38
  39 ACCESS CONTROLS
  40 ---------------
  41
  42 Most query operations are allowed without authentication. Only the
  43 modification operations require authentication, in the form of basic
  44 authentication. Specify the ``--require-authentication`` command line
  45 flag to always require authentication.
  46
  47 The users and their rights are defined in the
  48 ``@LOCALSTATEDIR@/lib/ganeti/rapi/users`` file. The format of this file
  49 is described in the Ganeti documentation (``rapi.html``).
  50
  51 .. vim: set textwidth=72 :
  52 .. Local Variables:
  53 .. mode: rst
  54 .. fill-column: 72
  55 .. End: