Skip to content

Commit d323af5

Browse files
Merge pull request ceph#63688 from zdover23/wip-doc-2025-06-04-backport-63195-to-tentacle
tentacle: doc/mgr: edit cli_api.rst
2 parents 419f788 + 48827a5 commit d323af5

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

doc/mgr/cli_api.rst

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,55 @@
11
CLI API Commands Module
22
=======================
33

4-
The CLI API module exposes most ceph-mgr python API via CLI. Furthermore, this API can be
5-
benchmarked for further testing.
4+
The CLI API module exposes most of the ceph-mgr Python API via CLI. This API
5+
can be benchmarked for further testing.
66

77
Enabling
88
--------
99

10-
The *cli api commands* module is enabled with::
10+
Enable the ``cli api commands`` module by running the following command:
1111

12-
ceph mgr module enable cli_api
12+
.. prompt:: bash #
1313

14-
To check that it is enabled, run::
14+
ceph mgr module enable cli_api
1515

16-
ceph mgr module ls | grep cli_api
16+
Ensure that the ``cli api commands`` module is enabled by running the following
17+
command:
18+
19+
.. prompt:: bash #
20+
21+
ceph mgr module ls | grep cli_api
1722

1823
Usage
1924
--------
2025

21-
To run a mgr module command, run::
26+
This the the general form of Manager module commands:
27+
28+
.. prompt:: bash #
29+
30+
ceph mgr cli <command> <param>
31+
32+
Print the list of servers by running the following command:
33+
34+
.. prompt:: bash #
35+
36+
ceph mgr cli list_servers
2237

23-
ceph mgr cli <command> <param>
38+
List all available mgr module commands by running the following command:
2439

25-
For example, use the following command to print the list of servers::
40+
.. prompt:: bash #
2641

27-
ceph mgr cli list_servers
42+
ceph mgr cli --help
2843

29-
List all available mgr module commands with::
44+
Benchmark a command, by running a command of the following form:
3045

31-
ceph mgr cli --help
46+
.. prompt:: bash #
3247

33-
To benchmark a command, run::
48+
ceph mgr cli_benchmark <number of calls> <number of threads> <command> <param>
3449

35-
ceph mgr cli_benchmark <number of calls> <number of threads> <command> <param>
50+
For example, run the following command to benchmark the command to get
51+
``osd_map``:
3652

37-
For example, use the following command to benchmark the command to get osd_map::
53+
.. prompt:: bash #
3854

39-
ceph mgr cli_benchmark 100 10 get osd_map
55+
ceph mgr cli_benchmark 100 10 get osd_map

0 commit comments

Comments
 (0)