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.
+The CLI API module exposes most of the ceph-mgr Python API via CLI. This API
+can be benchmarked for further testing.
Enabling
--------
-The *cli api commands* module is enabled with::
+Enable the ``cli api commands`` module by running the following command:
- ceph mgr module enable cli_api
+.. prompt:: bash #
-To check that it is enabled, run::
+ ceph mgr module enable cli_api
- ceph mgr module ls | grep cli_api
+Ensure that the ``cli api commands`` module is enabled by running the following
+command:
+
+.. prompt:: bash #
+
+ ceph mgr module ls | grep cli_api
Usage
--------
-To run a mgr module command, run::
+This the the general form of Manager module commands:
+
+.. prompt:: bash #
+
+ ceph mgr cli <command> <param>
+
+Print the list of servers by running the following command:
+
+.. prompt:: bash #
+
+ ceph mgr cli list_servers
- ceph mgr cli <command> <param>
+List all available mgr module commands by running the following command:
-For example, use the following command to print the list of servers::
+.. prompt:: bash #
- ceph mgr cli list_servers
+ ceph mgr cli --help
-List all available mgr module commands with::
+Benchmark a command, by running a command of the following form:
- ceph mgr cli --help
+.. prompt:: bash #
-To benchmark a command, run::
+ ceph mgr cli_benchmark <number of calls> <number of threads> <command> <param>
- ceph mgr cli_benchmark <number of calls> <number of threads> <command> <param>
+For example, run the following command to benchmark the command to get
+``osd_map``:
-For example, use the following command to benchmark the command to get osd_map::
+.. prompt:: bash #
- ceph mgr cli_benchmark 100 10 get osd_map
+ ceph mgr cli_benchmark 100 10 get osd_map