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