summaryrefslogtreecommitdiffstats
path: root/doc/mgr/cli_api.rst
blob: 81a99ae44ac184180a8fb57e018a719c90ceb7ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
CLI API Commands Module
=======================

The CLI API module exposes most ceph-mgr python API via CLI. Furthermore, this API can be
benchmarked for further testing.

Enabling
--------

The *cli api commands* module is enabled with::

  ceph mgr module enable cli_api

To check that it is enabled, run::

  ceph mgr module ls | grep cli_api

Usage
--------

To run a mgr module command, run::

  ceph mgr cli <command> <param>

For example, use the following command to print the list of servers::

  ceph mgr cli list_servers

List all available mgr module commands with::

  ceph mgr cli --help

To benchmark a command, run::

  ceph mgr cli_benchmark <number of calls> <number of threads> <command> <param>

For example, use the following command to benchmark the command to get osd_map::

  ceph mgr cli_benchmark 100 10 get osd_map