root / man / ganeti-rapi.rst @ 194775f5
History | View | Annotate | Download (1.7 kB)
| 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*] |
| 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``). |
| 32 |
|
| 33 |
See the *Ganeti remote API* documentation for further information. |
| 34 |
|
| 35 |
Requests are logged to ``@LOCALSTATEDIR@/log/ganeti/rapi-daemon.log``, |
| 36 |
in the same format as for the node and master daemon. |
| 37 |
|
| 38 |
ACCESS CONTROLS |
| 39 |
--------------- |
| 40 |
|
| 41 |
Most query operations are allowed without authentication. Only the |
| 42 |
modification operations require authentication, in the form of basic |
| 43 |
authentication. Specify the ``--require-authentication`` command line |
| 44 |
flag to always require authentication. |
| 45 |
|
| 46 |
The users and their rights are defined in the |
| 47 |
``@LOCALSTATEDIR@/lib/ganeti/rapi/users`` file. The format of this file |
| 48 |
is described in the Ganeti documentation (``rapi.html``). |
| 49 |
|
| 50 |
.. vim: set textwidth=72 : |
| 51 |
.. Local Variables: |
| 52 |
.. mode: rst |
| 53 |
.. fill-column: 72 |
| 54 |
.. End: |