10 description: This is the official Ceph REST API
34 application/vnd.ceph.api.v1.0+json:
36 description: Resource created.
39 application/vnd.ceph.api.v1.0+json:
41 description: Operation is still executing. Please check the task queue.
43 description: Operation exception. Please check the response body for details.
45 description: Unauthenticated access. Please login first.
47 description: Unauthorized access. Please check your permissions.
49 description: Unexpected error. Please check the response body for the stack
56 - description: Authentication Token
68 description: Authentication Token
76 application/vnd.ceph.api.v1.0+json:
80 description: List of permissions acquired
91 description: Is password update required?
94 description: Uses single sign on?
105 description: Resource created.
108 application/vnd.ceph.api.v1.0+json:
110 description: Operation is still executing. Please check the task queue.
112 description: Operation exception. Please check the response body for details.
114 description: Unauthenticated access. Please login first.
116 description: Unauthorized access. Please check your permissions.
118 description: Unexpected error. Please check the response body for the stack
120 summary: Check token Authentication
129 application/vnd.ceph.api.v1.0+json:
131 description: Resource created.
134 application/vnd.ceph.api.v1.0+json:
136 description: Operation is still executing. Please check the task queue.
138 description: Operation exception. Please check the response body for details.
140 description: Unauthenticated access. Please login first.
142 description: Unauthorized access. Please check your permissions.
144 description: Unexpected error. Please check the response body for the stack
151 - allowEmptyValue: true
152 description: Pool Name
182 application/vnd.ceph.api.v2.0+json:
187 description: pool name
201 description: Operation exception. Please check the response body for details.
203 description: Unauthenticated access. Please login first.
205 description: Unauthorized access. Please check your permissions.
207 description: Unexpected error. Please check the response body for the stack
211 summary: Display Rbd Images
256 application/vnd.ceph.api.v1.0+json:
258 description: Resource created.
261 application/vnd.ceph.api.v1.0+json:
263 description: Operation is still executing. Please check the task queue.
265 description: Operation exception. Please check the response body for details.
267 description: Unauthenticated access. Please login first.
269 description: Unauthorized access. Please check your permissions.
271 description: Unexpected error. Please check the response body for the stack
277 /api/block/image/clone_format_version:
279 description: "Return the RBD clone format version.\n "
284 application/vnd.ceph.api.v1.0+json:
288 description: Operation exception. Please check the response body for details.
290 description: Unauthenticated access. Please login first.
292 description: Unauthorized access. Please check your permissions.
294 description: Unexpected error. Please check the response body for the stack
300 /api/block/image/default_features:
306 application/vnd.ceph.api.v1.0+json:
310 description: Operation exception. Please check the response body for details.
312 description: Unauthenticated access. Please login first.
314 description: Unauthorized access. Please check your permissions.
316 description: Unexpected error. Please check the response body for the stack
322 /api/block/image/trash:
324 description: List all entries from trash.
326 - allowEmptyValue: true
327 description: Name of the pool
335 application/vnd.ceph.api.v1.0+json:
340 description: pool name
358 description: Operation exception. Please check the response body for details.
360 description: Unauthenticated access. Please login first.
362 description: Unauthorized access. Please check your permissions.
364 description: Unexpected error. Please check the response body for the stack
368 summary: Get RBD Trash Details by pool name
371 /api/block/image/trash/purge:
373 description: Remove all expired images from trash.
375 - allowEmptyValue: true
391 application/vnd.ceph.api.v1.0+json:
393 description: Resource created.
396 application/vnd.ceph.api.v1.0+json:
398 description: Operation is still executing. Please check the task queue.
400 description: Operation exception. Please check the response body for details.
402 description: Unauthenticated access. Please login first.
404 description: Unauthorized access. Please check your permissions.
406 description: Unexpected error. Please check the response body for the stack
412 /api/block/image/trash/{image_id_spec}:
414 description: "Delete an image from trash.\n If image deferment time has\
415 \ not expired you can not removed it unless use force.\n But an actively\
416 \ in-use by clones or has snapshots can not be removed.\n "
431 application/vnd.ceph.api.v1.0+json:
433 description: Operation is still executing. Please check the task queue.
436 application/vnd.ceph.api.v1.0+json:
438 description: Resource deleted.
440 description: Operation exception. Please check the response body for details.
442 description: Unauthenticated access. Please login first.
444 description: Unauthorized access. Please check your permissions.
446 description: Unexpected error. Please check the response body for the stack
452 /api/block/image/trash/{image_id_spec}/restore:
454 description: Restore an image from trash.
474 application/vnd.ceph.api.v1.0+json:
476 description: Resource created.
479 application/vnd.ceph.api.v1.0+json:
481 description: Operation is still executing. Please check the task queue.
483 description: Operation exception. Please check the response body for details.
485 description: Unauthenticated access. Please login first.
487 description: Unauthorized access. Please check your permissions.
489 description: Unexpected error. Please check the response body for the stack
495 /api/block/image/{image_spec}:
506 application/vnd.ceph.api.v1.0+json:
508 description: Operation is still executing. Please check the task queue.
511 application/vnd.ceph.api.v1.0+json:
513 description: Resource deleted.
515 description: Operation exception. Please check the response body for details.
517 description: Unauthenticated access. Please login first.
519 description: Unauthorized access. Please check your permissions.
521 description: Unexpected error. Please check the response body for the stack
537 application/vnd.ceph.api.v1.0+json:
541 description: Operation exception. Please check the response body for details.
543 description: Unauthenticated access. Please login first.
545 description: Unauthorized access. Please check your permissions.
547 description: Unexpected error. Please check the response body for the stack
597 application/vnd.ceph.api.v1.0+json:
599 description: Resource updated.
602 application/vnd.ceph.api.v1.0+json:
604 description: Operation is still executing. Please check the task queue.
606 description: Operation exception. Please check the response body for details.
608 description: Unauthenticated access. Please login first.
610 description: Unauthorized access. Please check your permissions.
612 description: Unexpected error. Please check the response body for the stack
618 /api/block/image/{image_spec}/copy:
661 application/vnd.ceph.api.v1.0+json:
663 description: Resource created.
666 application/vnd.ceph.api.v1.0+json:
668 description: Operation is still executing. Please check the task queue.
670 description: Operation exception. Please check the response body for details.
672 description: Unauthenticated access. Please login first.
674 description: Unauthorized access. Please check your permissions.
676 description: Unexpected error. Please check the response body for the stack
682 /api/block/image/{image_spec}/flatten:
693 application/vnd.ceph.api.v1.0+json:
695 description: Resource created.
698 application/vnd.ceph.api.v1.0+json:
700 description: Operation is still executing. Please check the task queue.
702 description: Operation exception. Please check the response body for details.
704 description: Unauthenticated access. Please login first.
706 description: Unauthorized access. Please check your permissions.
708 description: Unexpected error. Please check the response body for the stack
714 /api/block/image/{image_spec}/move_trash:
716 description: "Move an image to the trash.\n Images, even ones actively\
717 \ in-use by clones,\n can be moved to the trash and deleted at a later\
737 application/vnd.ceph.api.v1.0+json:
739 description: Resource created.
742 application/vnd.ceph.api.v1.0+json:
744 description: Operation is still executing. Please check the task queue.
746 description: Operation exception. Please check the response body for details.
748 description: Unauthenticated access. Please login first.
750 description: Unauthorized access. Please check your permissions.
752 description: Unexpected error. Please check the response body for the stack
758 /api/block/image/{image_spec}/snap:
777 - mirrorImageSnapshot
782 application/vnd.ceph.api.v1.0+json:
784 description: Resource created.
787 application/vnd.ceph.api.v1.0+json:
789 description: Operation is still executing. Please check the task queue.
791 description: Operation exception. Please check the response body for details.
793 description: Unauthenticated access. Please login first.
795 description: Unauthorized access. Please check your permissions.
797 description: Unexpected error. Please check the response body for the stack
803 /api/block/image/{image_spec}/snap/{snapshot_name}:
819 application/vnd.ceph.api.v1.0+json:
821 description: Operation is still executing. Please check the task queue.
824 application/vnd.ceph.api.v1.0+json:
826 description: Resource deleted.
828 description: Operation exception. Please check the response body for details.
830 description: Unauthenticated access. Please login first.
832 description: Unauthorized access. Please check your permissions.
834 description: Unexpected error. Please check the response body for the stack
865 application/vnd.ceph.api.v1.0+json:
867 description: Resource updated.
870 application/vnd.ceph.api.v1.0+json:
872 description: Operation is still executing. Please check the task queue.
874 description: Operation exception. Please check the response body for details.
876 description: Unauthenticated access. Please login first.
878 description: Unauthorized access. Please check your permissions.
880 description: Unexpected error. Please check the response body for the stack
886 /api/block/image/{image_spec}/snap/{snapshot_name}/clone:
888 description: "\n Clones a snapshot to an image\n "
932 application/vnd.ceph.api.v1.0+json:
934 description: Resource created.
937 application/vnd.ceph.api.v1.0+json:
939 description: Operation is still executing. Please check the task queue.
941 description: Operation exception. Please check the response body for details.
943 description: Unauthenticated access. Please login first.
945 description: Unauthorized access. Please check your permissions.
947 description: Unexpected error. Please check the response body for the stack
953 /api/block/image/{image_spec}/snap/{snapshot_name}/rollback:
969 application/vnd.ceph.api.v1.0+json:
971 description: Resource created.
974 application/vnd.ceph.api.v1.0+json:
976 description: Operation is still executing. Please check the task queue.
978 description: Operation exception. Please check the response body for details.
980 description: Unauthenticated access. Please login first.
982 description: Unauthorized access. Please check your permissions.
984 description: Unexpected error. Please check the response body for the stack
990 /api/block/mirroring/pool/{pool_name}:
993 - description: Pool Name
1002 application/vnd.ceph.api.v1.0+json:
1006 description: Mirror Mode
1013 description: Operation exception. Please check the response body for details.
1015 description: Unauthenticated access. Please login first.
1017 description: Unauthorized access. Please check your permissions.
1019 description: Unexpected error. Please check the response body for the stack
1023 summary: Display Rbd Mirroring Summary
1025 - RbdMirroringPoolMode
1044 application/vnd.ceph.api.v1.0+json:
1046 description: Resource updated.
1049 application/vnd.ceph.api.v1.0+json:
1051 description: Operation is still executing. Please check the task queue.
1053 description: Operation exception. Please check the response body for details.
1055 description: Unauthenticated access. Please login first.
1057 description: Unauthorized access. Please check your permissions.
1059 description: Unexpected error. Please check the response body for the stack
1064 - RbdMirroringPoolMode
1065 /api/block/mirroring/pool/{pool_name}/bootstrap/peer:
1089 application/vnd.ceph.api.v1.0+json:
1091 description: Resource created.
1094 application/vnd.ceph.api.v1.0+json:
1096 description: Operation is still executing. Please check the task queue.
1098 description: Operation exception. Please check the response body for details.
1100 description: Unauthenticated access. Please login first.
1102 description: Unauthorized access. Please check your permissions.
1104 description: Unexpected error. Please check the response body for the stack
1109 - RbdMirroringPoolBootstrap
1110 /api/block/mirroring/pool/{pool_name}/bootstrap/token:
1121 application/vnd.ceph.api.v1.0+json:
1123 description: Resource created.
1126 application/vnd.ceph.api.v1.0+json:
1128 description: Operation is still executing. Please check the task queue.
1130 description: Operation exception. Please check the response body for details.
1132 description: Unauthenticated access. Please login first.
1134 description: Unauthorized access. Please check your permissions.
1136 description: Unexpected error. Please check the response body for the stack
1141 - RbdMirroringPoolBootstrap
1142 /api/block/mirroring/pool/{pool_name}/peer:
1153 application/vnd.ceph.api.v1.0+json:
1157 description: Operation exception. Please check the response body for details.
1159 description: Unauthenticated access. Please login first.
1161 description: Unauthorized access. Please check your permissions.
1163 description: Unexpected error. Please check the response body for the stack
1168 - RbdMirroringPoolPeer
1196 application/vnd.ceph.api.v1.0+json:
1198 description: Resource created.
1201 application/vnd.ceph.api.v1.0+json:
1203 description: Operation is still executing. Please check the task queue.
1205 description: Operation exception. Please check the response body for details.
1207 description: Unauthenticated access. Please login first.
1209 description: Unauthorized access. Please check your permissions.
1211 description: Unexpected error. Please check the response body for the stack
1216 - RbdMirroringPoolPeer
1217 /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}:
1233 application/vnd.ceph.api.v1.0+json:
1235 description: Operation is still executing. Please check the task queue.
1238 application/vnd.ceph.api.v1.0+json:
1240 description: Resource deleted.
1242 description: Operation exception. Please check the response body for details.
1244 description: Unauthenticated access. Please login first.
1246 description: Unauthorized access. Please check your permissions.
1248 description: Unexpected error. Please check the response body for the stack
1253 - RbdMirroringPoolPeer
1269 application/vnd.ceph.api.v1.0+json:
1273 description: Operation exception. Please check the response body for details.
1275 description: Unauthenticated access. Please login first.
1277 description: Unauthorized access. Please check your permissions.
1279 description: Unexpected error. Please check the response body for the stack
1284 - RbdMirroringPoolPeer
1314 application/vnd.ceph.api.v1.0+json:
1316 description: Resource updated.
1319 application/vnd.ceph.api.v1.0+json:
1321 description: Operation is still executing. Please check the task queue.
1323 description: Operation exception. Please check the response body for details.
1325 description: Unauthenticated access. Please login first.
1327 description: Unauthorized access. Please check your permissions.
1329 description: Unexpected error. Please check the response body for the stack
1334 - RbdMirroringPoolPeer
1335 /api/block/mirroring/site_name:
1341 application/vnd.ceph.api.v1.0+json:
1345 description: Site Name
1352 description: Operation exception. Please check the response body for details.
1354 description: Unauthenticated access. Please login first.
1356 description: Unauthorized access. Please check your permissions.
1358 description: Unexpected error. Please check the response body for the stack
1362 summary: Display Rbd Mirroring sitename
1380 application/vnd.ceph.api.v1.0+json:
1382 description: Resource updated.
1385 application/vnd.ceph.api.v1.0+json:
1387 description: Operation is still executing. Please check the task queue.
1389 description: Operation exception. Please check the response body for details.
1391 description: Unauthenticated access. Please login first.
1393 description: Unauthorized access. Please check your permissions.
1395 description: Unexpected error. Please check the response body for the stack
1401 /api/block/mirroring/summary:
1407 application/vnd.ceph.api.v1.0+json:
1438 description: pool health
1447 description: Pool name
1470 description: site name
1482 description: Operation exception. Please check the response body for details.
1484 description: Unauthenticated access. Please login first.
1486 description: Unauthorized access. Please check your permissions.
1488 description: Unexpected error. Please check the response body for the stack
1492 summary: Display Rbd Mirroring Summary
1494 - RbdMirroringSummary
1495 /api/block/pool/{pool_name}/namespace:
1506 application/vnd.ceph.api.v1.0+json:
1510 description: Operation exception. Please check the response body for details.
1512 description: Unauthenticated access. Please login first.
1514 description: Unauthorized access. Please check your permissions.
1516 description: Unexpected error. Please check the response body for the stack
1542 application/vnd.ceph.api.v1.0+json:
1544 description: Resource created.
1547 application/vnd.ceph.api.v1.0+json:
1549 description: Operation is still executing. Please check the task queue.
1551 description: Operation exception. Please check the response body for details.
1553 description: Unauthenticated access. Please login first.
1555 description: Unauthorized access. Please check your permissions.
1557 description: Unexpected error. Please check the response body for the stack
1563 /api/block/pool/{pool_name}/namespace/{namespace}:
1579 application/vnd.ceph.api.v1.0+json:
1581 description: Operation is still executing. Please check the task queue.
1584 application/vnd.ceph.api.v1.0+json:
1586 description: Resource deleted.
1588 description: Operation exception. Please check the response body for details.
1590 description: Unauthenticated access. Please login first.
1592 description: Unauthorized access. Please check your permissions.
1594 description: Unexpected error. Please check the response body for the stack
1606 application/vnd.ceph.api.v1.0+json:
1610 description: Operation exception. Please check the response body for details.
1612 description: Unauthenticated access. Please login first.
1614 description: Unauthorized access. Please check your permissions.
1616 description: Unexpected error. Please check the response body for the stack
1622 /api/cephfs/{fs_id}:
1633 application/vnd.ceph.api.v1.0+json:
1637 description: Operation exception. Please check the response body for details.
1639 description: Unauthenticated access. Please login first.
1641 description: Unauthorized access. Please check your permissions.
1643 description: Unexpected error. Please check the response body for the stack
1649 /api/cephfs/{fs_id}/client/{client_id}:
1665 application/vnd.ceph.api.v1.0+json:
1667 description: Operation is still executing. Please check the task queue.
1670 application/vnd.ceph.api.v1.0+json:
1672 description: Resource deleted.
1674 description: Operation exception. Please check the response body for details.
1676 description: Unauthenticated access. Please login first.
1678 description: Unauthorized access. Please check your permissions.
1680 description: Unexpected error. Please check the response body for the stack
1686 /api/cephfs/{fs_id}/clients:
1697 application/vnd.ceph.api.v1.0+json:
1701 description: Operation exception. Please check the response body for details.
1703 description: Unauthenticated access. Please login first.
1705 description: Unauthorized access. Please check your permissions.
1707 description: Unexpected error. Please check the response body for the stack
1713 /api/cephfs/{fs_id}/get_root_directory:
1715 description: "\n The root directory that can't be fetched using ls_dir\
1716 \ (api).\n :param fs_id: The filesystem identifier.\n :return:\
1717 \ The root directory\n :rtype: dict\n "
1727 application/vnd.ceph.api.v1.0+json:
1731 description: Operation exception. Please check the response body for details.
1733 description: Unauthenticated access. Please login first.
1735 description: Unauthorized access. Please check your permissions.
1737 description: Unexpected error. Please check the response body for the stack
1743 /api/cephfs/{fs_id}/ls_dir:
1745 description: "\n List directories of specified path.\n :param\
1746 \ fs_id: The filesystem identifier.\n :param path: The path where to\
1747 \ start listing the directory content.\n Defaults to '/' if not set.\n\
1748 \ :type path: str | bytes\n :param depth: The number of steps\
1749 \ to go down the directory tree.\n :type depth: int | str\n \
1750 \ :return: The names of the directories below the specified path.\n \
1758 - allowEmptyValue: true
1771 application/vnd.ceph.api.v1.0+json:
1775 description: Operation exception. Please check the response body for details.
1777 description: Unauthenticated access. Please login first.
1779 description: Unauthorized access. Please check your permissions.
1781 description: Unexpected error. Please check the response body for the stack
1787 /api/cephfs/{fs_id}/mds_counters:
1795 - allowEmptyValue: true
1803 application/vnd.ceph.api.v1.0+json:
1807 description: Operation exception. Please check the response body for details.
1809 description: Unauthenticated access. Please login first.
1811 description: Unauthorized access. Please check your permissions.
1813 description: Unexpected error. Please check the response body for the stack
1819 /api/cephfs/{fs_id}/quota:
1821 description: "\n Get the quotas of the specified path.\n :param\
1822 \ fs_id: The filesystem identifier.\n :param path: The path of the\
1823 \ directory/file.\n :return: Returns a dictionary containing 'max_bytes'\n\
1824 \ and 'max_files'.\n :rtype: dict\n "
1826 - description: File System Identifier
1832 - description: File System Path
1841 application/vnd.ceph.api.v1.0+json:
1856 description: Operation exception. Please check the response body for details.
1858 description: Unauthenticated access. Please login first.
1860 description: Unauthorized access. Please check your permissions.
1862 description: Unexpected error. Please check the response body for the stack
1866 summary: Get Cephfs Quotas of the specified path
1870 description: "\n Set the quotas of the specified path.\n :param\
1871 \ fs_id: The filesystem identifier.\n :param path: The path of the\
1872 \ directory/file.\n :param max_bytes: The byte limit.\n :param\
1873 \ max_files: The file limit.\n "
1897 application/vnd.ceph.api.v1.0+json:
1899 description: Resource updated.
1902 application/vnd.ceph.api.v1.0+json:
1904 description: Operation is still executing. Please check the task queue.
1906 description: Operation exception. Please check the response body for details.
1908 description: Unauthenticated access. Please login first.
1910 description: Unauthorized access. Please check your permissions.
1912 description: Unexpected error. Please check the response body for the stack
1918 /api/cephfs/{fs_id}/snapshot:
1920 description: "\n Remove a snapshot.\n :param fs_id: The filesystem\
1921 \ identifier.\n :param path: The path of the directory.\n :param\
1922 \ name: The name of the snapshot.\n "
1942 application/vnd.ceph.api.v1.0+json:
1944 description: Operation is still executing. Please check the task queue.
1947 application/vnd.ceph.api.v1.0+json:
1949 description: Resource deleted.
1951 description: Operation exception. Please check the response body for details.
1953 description: Unauthenticated access. Please login first.
1955 description: Unauthorized access. Please check your permissions.
1957 description: Unexpected error. Please check the response body for the stack
1964 description: "\n Create a snapshot.\n :param fs_id: The filesystem\
1965 \ identifier.\n :param path: The path of the directory.\n :param\
1966 \ name: The name of the snapshot. If not specified, a name using the\n \
1967 \ current time in RFC3339 UTC format will be generated.\n :return:\
1968 \ The name of the snapshot.\n :rtype: str\n "
1990 application/vnd.ceph.api.v1.0+json:
1992 description: Resource created.
1995 application/vnd.ceph.api.v1.0+json:
1997 description: Operation is still executing. Please check the task queue.
1999 description: Operation exception. Please check the response body for details.
2001 description: Unauthenticated access. Please login first.
2003 description: Unauthorized access. Please check your permissions.
2005 description: Unexpected error. Please check the response body for the stack
2011 /api/cephfs/{fs_id}/tree:
2013 description: "\n Remove a directory.\n :param fs_id: The filesystem\
2014 \ identifier.\n :param path: The path of the directory.\n "
2029 application/vnd.ceph.api.v1.0+json:
2031 description: Operation is still executing. Please check the task queue.
2034 application/vnd.ceph.api.v1.0+json:
2036 description: Resource deleted.
2038 description: Operation exception. Please check the response body for details.
2040 description: Unauthenticated access. Please login first.
2042 description: Unauthorized access. Please check your permissions.
2044 description: Unexpected error. Please check the response body for the stack
2051 description: "\n Create a directory.\n :param fs_id: The filesystem\
2052 \ identifier.\n :param path: The path of the directory.\n "
2072 application/vnd.ceph.api.v1.0+json:
2074 description: Resource created.
2077 application/vnd.ceph.api.v1.0+json:
2079 description: Operation is still executing. Please check the task queue.
2081 description: Operation exception. Please check the response body for details.
2083 description: Unauthenticated access. Please login first.
2085 description: Unauthorized access. Please check your permissions.
2087 description: Unexpected error. Please check the response body for the stack
2099 application/vnd.ceph.api.v0.1+json:
2103 description: Operation exception. Please check the response body for details.
2105 description: Unauthenticated access. Please login first.
2107 description: Unauthorized access. Please check your permissions.
2109 description: Unexpected error. Please check the response body for the stack
2113 summary: Get the cluster status
2124 description: Cluster Status
2132 application/vnd.ceph.api.v0.1+json:
2134 description: Resource updated.
2137 application/vnd.ceph.api.v0.1+json:
2139 description: Operation is still executing. Please check the task queue.
2141 description: Operation exception. Please check the response body for details.
2143 description: Unauthenticated access. Please login first.
2145 description: Unauthorized access. Please check your permissions.
2147 description: Unexpected error. Please check the response body for the stack
2151 summary: Update the cluster status
2156 description: "\n Get list of ceph users and its respective data\n \
2162 application/vnd.ceph.api.v1.0+json:
2166 description: Operation exception. Please check the response body for details.
2168 description: Unauthenticated access. Please login first.
2170 description: Unauthorized access. Please check your permissions.
2172 description: Unexpected error. Please check the response body for the stack
2176 summary: Get Ceph Users
2180 description: "\n Add a ceph user with its defined capabilities.\n \
2181 \ :param user_entity: Entity to change\n :param capabilities: List\
2182 \ of capabilities to add to user_entity\n "
2201 application/vnd.ceph.api.v1.0+json:
2203 description: Resource created.
2206 application/vnd.ceph.api.v1.0+json:
2208 description: Operation is still executing. Please check the task queue.
2210 description: Operation exception. Please check the response body for details.
2212 description: Unauthenticated access. Please login first.
2214 description: Unauthorized access. Please check your permissions.
2216 description: Unexpected error. Please check the response body for the stack
2220 summary: Create Ceph User
2224 description: "\n Change the ceph user capabilities.\n Setting\
2225 \ new capabilities will overwrite current ones.\n :param user_entity:\
2226 \ Entity to change\n :param capabilities: List of updated capabilities\
2227 \ to user_entity\n "
2243 application/vnd.ceph.api.v1.0+json:
2245 description: Resource updated.
2248 application/vnd.ceph.api.v1.0+json:
2250 description: Operation is still executing. Please check the task queue.
2252 description: Operation exception. Please check the response body for details.
2254 description: Unauthenticated access. Please login first.
2256 description: Unauthorized access. Please check your permissions.
2258 description: Unexpected error. Please check the response body for the stack
2262 summary: Edit Ceph User
2265 /api/cluster/user/export:
2281 application/vnd.ceph.api.v1.0+json:
2283 description: Resource created.
2286 application/vnd.ceph.api.v1.0+json:
2288 description: Operation is still executing. Please check the task queue.
2290 description: Operation exception. Please check the response body for details.
2292 description: Unauthenticated access. Please login first.
2294 description: Unauthorized access. Please check your permissions.
2296 description: Unexpected error. Please check the response body for the stack
2300 summary: Export Ceph Users
2303 /api/cluster/user/{user_entity}:
2305 description: "\n Delete a ceph user and it's defined capabilities.\n\
2306 \ :param user_entity: Entity to delete\n "
2316 application/vnd.ceph.api.v1.0+json:
2318 description: Operation is still executing. Please check the task queue.
2321 application/vnd.ceph.api.v1.0+json:
2323 description: Resource deleted.
2325 description: Operation exception. Please check the response body for details.
2327 description: Unauthenticated access. Please login first.
2329 description: Unauthorized access. Please check your permissions.
2331 description: Unexpected error. Please check the response body for the stack
2335 summary: Delete Ceph User
2344 application/vnd.ceph.api.v1.0+json:
2348 description: Operation exception. Please check the response body for details.
2350 description: Unauthenticated access. Please login first.
2352 description: Unauthorized access. Please check your permissions.
2354 description: Unexpected error. Please check the response body for the stack
2359 - ClusterConfiguration
2378 application/vnd.ceph.api.v1.0+json:
2380 description: Resource created.
2383 application/vnd.ceph.api.v1.0+json:
2385 description: Operation is still executing. Please check the task queue.
2387 description: Operation exception. Please check the response body for details.
2389 description: Unauthenticated access. Please login first.
2391 description: Unauthorized access. Please check your permissions.
2393 description: Unexpected error. Please check the response body for the stack
2398 - ClusterConfiguration
2414 application/vnd.ceph.api.v1.0+json:
2416 description: Resource updated.
2419 application/vnd.ceph.api.v1.0+json:
2421 description: Operation is still executing. Please check the task queue.
2423 description: Operation exception. Please check the response body for details.
2425 description: Unauthenticated access. Please login first.
2427 description: Unauthorized access. Please check your permissions.
2429 description: Unexpected error. Please check the response body for the stack
2434 - ClusterConfiguration
2435 /api/cluster_conf/filter:
2438 - allowEmptyValue: true
2439 description: Config option names
2447 application/vnd.ceph.api.v1.0+json:
2451 can_update_at_runtime:
2452 description: Check if can update at runtime
2455 description: Daemon specific default value
2458 description: Default value for the config option
2461 description: Description of the configuration
2464 description: List of enums allowed
2469 description: List of flags associated
2474 description: Config option level
2477 description: Elaborated description
2480 description: Maximum value
2483 description: Minimum value
2486 description: Name of the config option
2489 description: Related config options
2494 description: Services associated with the config option
2499 description: Tags associated with the cluster
2504 description: Config option type
2521 - can_update_at_runtime
2526 description: Operation exception. Please check the response body for details.
2528 description: Unauthenticated access. Please login first.
2530 description: Unauthorized access. Please check your permissions.
2532 description: Unexpected error. Please check the response body for the stack
2536 summary: Get Cluster Configuration by name
2538 - ClusterConfiguration
2539 /api/cluster_conf/{name}:
2555 application/vnd.ceph.api.v1.0+json:
2557 description: Operation is still executing. Please check the task queue.
2560 application/vnd.ceph.api.v1.0+json:
2562 description: Resource deleted.
2564 description: Operation exception. Please check the response body for details.
2566 description: Unauthenticated access. Please login first.
2568 description: Unauthorized access. Please check your permissions.
2570 description: Unexpected error. Please check the response body for the stack
2575 - ClusterConfiguration
2586 application/vnd.ceph.api.v1.0+json:
2590 description: Operation exception. Please check the response body for details.
2592 description: Unauthenticated access. Please login first.
2594 description: Unauthorized access. Please check your permissions.
2596 description: Unexpected error. Please check the response body for the stack
2601 - ClusterConfiguration
2608 application/vnd.ceph.api.v2.0+json:
2612 description: Maximum size of Rule
2615 description: Minimum size of Rule
2618 description: Rule ID
2621 description: Rule Name
2624 description: RuleSet related to the rule
2627 description: Steps included in the rule
2632 description: Type of Rule
2645 description: Operation exception. Please check the response body for details.
2647 description: Unauthenticated access. Please login first.
2649 description: Unauthorized access. Please check your permissions.
2651 description: Unexpected error. Please check the response body for the stack
2655 summary: List Crush Rule Configuration
2681 application/vnd.ceph.api.v1.0+json:
2683 description: Resource created.
2686 application/vnd.ceph.api.v1.0+json:
2688 description: Operation is still executing. Please check the task queue.
2690 description: Operation exception. Please check the response body for details.
2692 description: Unauthenticated access. Please login first.
2694 description: Unauthorized access. Please check your permissions.
2696 description: Unexpected error. Please check the response body for the stack
2702 /api/crush_rule/{name}:
2713 application/vnd.ceph.api.v1.0+json:
2715 description: Operation is still executing. Please check the task queue.
2718 application/vnd.ceph.api.v1.0+json:
2720 description: Resource deleted.
2722 description: Operation exception. Please check the response body for details.
2724 description: Unauthenticated access. Please login first.
2726 description: Unauthorized access. Please check your permissions.
2728 description: Unexpected error. Please check the response body for the stack
2744 application/vnd.ceph.api.v2.0+json:
2748 description: Operation exception. Please check the response body for details.
2750 description: Unauthenticated access. Please login first.
2752 description: Unauthorized access. Please check your permissions.
2754 description: Unexpected error. Please check the response body for the stack
2760 /api/daemon/{daemon_name}:
2782 application/vnd.ceph.api.v0.1+json:
2784 description: Resource updated.
2787 application/vnd.ceph.api.v0.1+json:
2789 description: Operation is still executing. Please check the task queue.
2791 description: Operation exception. Please check the response body for details.
2793 description: Unauthenticated access. Please login first.
2795 description: Unauthorized access. Please check your permissions.
2797 description: Unexpected error. Please check the response body for the stack
2803 /api/erasure_code_profile:
2809 application/vnd.ceph.api.v1.0+json:
2813 crush-failure-domain:
2817 description: Number of data chunks
2820 description: Number of coding chunks
2823 description: Name of the profile
2826 description: Plugin Info
2833 - crush-failure-domain
2842 description: Operation exception. Please check the response body for details.
2844 description: Unauthenticated access. Please login first.
2846 description: Unauthorized access. Please check your permissions.
2848 description: Unexpected error. Please check the response body for the stack
2852 summary: List Erasure Code Profile Information
2854 - ErasureCodeProfile
2870 application/vnd.ceph.api.v1.0+json:
2872 description: Resource created.
2875 application/vnd.ceph.api.v1.0+json:
2877 description: Operation is still executing. Please check the task queue.
2879 description: Operation exception. Please check the response body for details.
2881 description: Unauthenticated access. Please login first.
2883 description: Unauthorized access. Please check your permissions.
2885 description: Unexpected error. Please check the response body for the stack
2890 - ErasureCodeProfile
2891 /api/erasure_code_profile/{name}:
2902 application/vnd.ceph.api.v1.0+json:
2904 description: Operation is still executing. Please check the task queue.
2907 application/vnd.ceph.api.v1.0+json:
2909 description: Resource deleted.
2911 description: Operation exception. Please check the response body for details.
2913 description: Unauthenticated access. Please login first.
2915 description: Unauthorized access. Please check your permissions.
2917 description: Unexpected error. Please check the response body for the stack
2922 - ErasureCodeProfile
2933 application/vnd.ceph.api.v1.0+json:
2937 description: Operation exception. Please check the response body for details.
2939 description: Unauthenticated access. Please login first.
2941 description: Unauthorized access. Please check your permissions.
2943 description: Unexpected error. Please check the response body for the stack
2948 - ErasureCodeProfile
2949 /api/feature_toggles:
2955 application/vnd.ceph.api.v1.0+json:
2990 description: Operation exception. Please check the response body for details.
2992 description: Unauthenticated access. Please login first.
2994 description: Unauthorized access. Please check your permissions.
2996 description: Unexpected error. Please check the response body for the stack
3000 summary: Get List Of Features
3002 - FeatureTogglesEndpoint
3005 description: "\n List all issues details.\n "
3010 application/vnd.ceph.api.v0.1+json:
3014 description: Operation exception. Please check the response body for details.
3016 description: Unauthenticated access. Please login first.
3018 description: Unauthorized access. Please check your permissions.
3020 description: Unexpected error. Please check the response body for the stack
3027 description: "\n Create an issue.\n :param project: The affected\
3028 \ ceph component.\n :param tracker: The tracker type.\n :param\
3029 \ subject: The title of the issue.\n :param description: The description\
3030 \ of the issue.\n :param api_key: Ceph tracker api key.\n "
3056 application/vnd.ceph.api.v0.1+json:
3058 description: Resource created.
3061 application/vnd.ceph.api.v0.1+json:
3063 description: Operation is still executing. Please check the task queue.
3065 description: Operation exception. Please check the response body for details.
3067 description: Unauthenticated access. Please login first.
3069 description: Unauthorized access. Please check your permissions.
3071 description: Unexpected error. Please check the response body for the stack
3077 /api/feedback/api_key:
3079 description: "\n Deletes Ceph tracker API key.\n "
3084 application/vnd.ceph.api.v0.1+json:
3086 description: Operation is still executing. Please check the task queue.
3089 application/vnd.ceph.api.v0.1+json:
3091 description: Resource deleted.
3093 description: Operation exception. Please check the response body for details.
3095 description: Unauthenticated access. Please login first.
3097 description: Unauthorized access. Please check your permissions.
3099 description: Unexpected error. Please check the response body for the stack
3106 description: "\n Returns Ceph tracker API key.\n "
3111 application/vnd.ceph.api.v0.1+json:
3115 description: Operation exception. Please check the response body for details.
3117 description: Unauthenticated access. Please login first.
3119 description: Unauthorized access. Please check your permissions.
3121 description: Unexpected error. Please check the response body for the stack
3128 description: "\n Sets Ceph tracker API key.\n :param api_key:\
3129 \ The Ceph tracker API key.\n "
3144 application/vnd.ceph.api.v0.1+json:
3146 description: Resource created.
3149 application/vnd.ceph.api.v0.1+json:
3151 description: Operation is still executing. Please check the task queue.
3153 description: Operation exception. Please check the response body for details.
3155 description: Unauthenticated access. Please login first.
3157 description: Unauthorized access. Please check your permissions.
3159 description: Unexpected error. Please check the response body for the stack
3165 /api/grafana/dashboards:
3171 application/vnd.ceph.api.v1.0+json:
3173 description: Resource created.
3176 application/vnd.ceph.api.v1.0+json:
3178 description: Operation is still executing. Please check the task queue.
3180 description: Operation exception. Please check the response body for details.
3182 description: Unauthenticated access. Please login first.
3184 description: Unauthorized access. Please check your permissions.
3186 description: Unexpected error. Please check the response body for the stack
3198 application/vnd.ceph.api.v1.0+json:
3202 description: grafana instance
3209 description: Operation exception. Please check the response body for details.
3211 description: Unauthenticated access. Please login first.
3213 description: Unauthorized access. Please check your permissions.
3215 description: Unexpected error. Please check the response body for the stack
3219 summary: List Grafana URL Instance
3222 /api/grafana/validation/{params}:
3233 application/vnd.ceph.api.v1.0+json:
3237 description: Operation exception. Please check the response body for details.
3239 description: Unauthenticated access. Please login first.
3241 description: Unauthorized access. Please check your permissions.
3243 description: Unexpected error. Please check the response body for the stack
3255 application/vnd.ceph.api.v1.0+json:
3259 description: Operation exception. Please check the response body for details.
3261 description: Unauthenticated access. Please login first.
3263 description: Unauthorized access. Please check your permissions.
3265 description: Unexpected error. Please check the response body for the stack
3271 /api/health/get_cluster_capacity:
3277 application/vnd.ceph.api.v1.0+json:
3281 description: Operation exception. Please check the response body for details.
3283 description: Unauthenticated access. Please login first.
3285 description: Unauthorized access. Please check your permissions.
3287 description: Unexpected error. Please check the response body for the stack
3293 /api/health/get_cluster_fsid:
3299 application/vnd.ceph.api.v1.0+json:
3303 description: Operation exception. Please check the response body for details.
3305 description: Unauthenticated access. Please login first.
3307 description: Unauthorized access. Please check your permissions.
3309 description: Unexpected error. Please check the response body for the stack
3315 /api/health/minimal:
3321 application/vnd.ceph.api.v1.0+json:
3333 recovering_bytes_per_sec:
3345 - recovering_bytes_per_sec
3361 total_used_raw_bytes:
3367 - total_used_raw_bytes
3421 ever_allowed_features:
3424 explicitly_allowed_features:
3449 last_failure_osd_epoch:
3464 required_client_features:
3476 standby_count_wanted:
3494 - last_failure_osd_epoch
3498 - explicitly_allowed_features
3507 - required_client_features
3512 - standby_count_wanted
3517 - ever_allowed_features
3631 num_objects_degraded:
3634 num_objects_misplaced:
3637 num_objects_unfound:
3643 - num_objects_degraded
3644 - num_objects_misplaced
3645 - num_objects_unfound
3684 description: Operation exception. Please check the response body for details.
3686 description: Unauthenticated access. Please login first.
3688 description: Unauthorized access. Please check your permissions.
3690 description: Unexpected error. Please check the response body for the stack
3694 summary: Get Cluster's minimal health report
3700 - allowEmptyValue: true
3701 description: Host Sources
3707 description: Host Facts
3715 application/vnd.ceph.api.v1.2+json:
3719 description: Host address
3722 description: Ceph version
3725 description: Hostname
3728 description: Labels related to the host
3733 description: Service instances related to the host
3737 description: Number of instances of the service
3740 description: type of service
3751 description: Services related to the host
3755 description: Service Id
3758 description: type of service
3766 description: Host Sources
3794 description: Operation exception. Please check the response body for details.
3796 description: Unauthenticated access. Please login first.
3798 description: Unauthorized access. Please check your permissions.
3800 description: Unexpected error. Please check the response body for the stack
3804 summary: List Host Specifications
3815 description: Network Address
3818 description: Hostname
3821 description: Host Labels
3826 description: Host Status
3834 application/vnd.ceph.api.v0.1+json:
3836 description: Resource created.
3839 application/vnd.ceph.api.v0.1+json:
3841 description: Operation is still executing. Please check the task queue.
3843 description: Operation exception. Please check the response body for details.
3845 description: Unauthenticated access. Please login first.
3847 description: Unauthorized access. Please check your permissions.
3849 description: Unexpected error. Please check the response body for the stack
3855 /api/host/{hostname}:
3866 application/vnd.ceph.api.v1.0+json:
3868 description: Operation is still executing. Please check the task queue.
3871 application/vnd.ceph.api.v1.0+json:
3873 description: Resource deleted.
3875 description: Operation exception. Please check the response body for details.
3877 description: Unauthenticated access. Please login first.
3879 description: Unauthorized access. Please check your permissions.
3881 description: Unexpected error. Please check the response body for the stack
3888 description: "\n Get the specified host.\n :raises: cherrypy.HTTPError:\
3889 \ If host not found.\n "
3899 application/vnd.ceph.api.v1.0+json:
3903 description: Operation exception. Please check the response body for details.
3905 description: Unauthenticated access. Please login first.
3907 description: Unauthorized access. Please check your permissions.
3909 description: Unexpected error. Please check the response body for the stack
3916 description: "\n Update the specified host.\n Note, this is only\
3917 \ supported when Ceph Orchestrator is enabled.\n :param hostname: The\
3918 \ name of the host to be processed.\n :param update_labels: To update\
3919 \ the labels.\n :param labels: List of labels.\n :param maintenance:\
3920 \ Enter/Exit maintenance mode.\n :param force: Force enter maintenance\
3921 \ mode.\n :param drain: Drain host\n "
3923 - description: Hostname
3936 description: Drain Host
3940 description: Force Enter Maintenance
3943 description: Host Labels
3949 description: Enter/Exit Maintenance
3953 description: Update Labels
3959 application/vnd.ceph.api.v0.1+json:
3963 description: Resource updated.
3966 application/vnd.ceph.api.v0.1+json:
3968 description: Operation is still executing. Please check the task queue.
3970 description: Operation exception. Please check the response body for details.
3972 description: Unauthenticated access. Please login first.
3974 description: Unauthorized access. Please check your permissions.
3976 description: Unexpected error. Please check the response body for the stack
3982 /api/host/{hostname}/daemons:
3993 application/vnd.ceph.api.v1.0+json:
3997 description: Operation exception. Please check the response body for details.
3999 description: Unauthenticated access. Please login first.
4001 description: Unauthorized access. Please check your permissions.
4003 description: Unexpected error. Please check the response body for the stack
4009 /api/host/{hostname}/devices:
4020 application/vnd.ceph.api.v1.0+json:
4024 description: Operation exception. Please check the response body for details.
4026 description: Unauthenticated access. Please login first.
4028 description: Unauthorized access. Please check your permissions.
4030 description: Unexpected error. Please check the response body for the stack
4036 /api/host/{hostname}/identify_device:
4038 description: "\n Identify a device by switching on the device light for\
4039 \ N seconds.\n :param hostname: The hostname of the device to process.\n\
4040 \ :param device: The device identifier to process, e.g. ``/dev/dm-0``\
4041 \ or\n ``ABC1234DEF567-1R1234_ABC8DE0Q``.\n :param duration:\
4042 \ The duration in seconds how long the LED should flash.\n "
4065 application/vnd.ceph.api.v1.0+json:
4067 description: Resource created.
4070 application/vnd.ceph.api.v1.0+json:
4072 description: Operation is still executing. Please check the task queue.
4074 description: Operation exception. Please check the response body for details.
4076 description: Unauthenticated access. Please login first.
4078 description: Unauthorized access. Please check your permissions.
4080 description: Unexpected error. Please check the response body for the stack
4086 /api/host/{hostname}/inventory:
4089 - description: Hostname
4095 - allowEmptyValue: true
4096 description: Trigger asynchronous refresh
4104 application/vnd.ceph.api.v1.0+json:
4108 description: Host address
4111 description: Host devices
4115 description: If the device can be provisioned to an OSD
4118 description: Device's udev ID
4120 human_readable_type:
4121 description: Device type. ssd or hdd
4220 description: Device OSD IDs
4225 description: Device path
4235 human_readable_size:
4258 human_readable_size:
4278 - human_readable_size
4339 - human_readable_size
4349 - human_readable_type
4356 description: Host labels
4361 description: Hostname
4371 description: Operation exception. Please check the response body for details.
4373 description: Unauthenticated access. Please login first.
4375 description: Unauthorized access. Please check your permissions.
4377 description: Unexpected error. Please check the response body for the stack
4381 summary: Get inventory of a host
4384 /api/host/{hostname}/smart:
4395 application/vnd.ceph.api.v1.0+json:
4399 description: Operation exception. Please check the response body for details.
4401 description: Unauthenticated access. Please login first.
4403 description: Unauthorized access. Please check your permissions.
4405 description: Unexpected error. Please check the response body for the stack
4411 /api/iscsi/discoveryauth:
4417 application/vnd.ceph.api.v1.0+json:
4428 description: password
4431 description: username
4442 description: Operation exception. Please check the response body for details.
4444 description: Unauthenticated access. Please login first.
4446 description: Unauthorized access. Please check your permissions.
4448 description: Unexpected error. Please check the response body for the stack
4452 summary: Get Iscsi discoveryauth Details
4457 - description: Username
4463 - description: Password
4469 - description: Mutual UserName
4475 - description: Mutual Password
4477 name: mutual_password
4487 description: Mutual Password
4490 description: Mutual UserName
4493 description: Password
4496 description: Username
4507 application/vnd.ceph.api.v1.0+json:
4509 description: Resource updated.
4512 application/vnd.ceph.api.v1.0+json:
4514 description: Operation is still executing. Please check the task queue.
4516 description: Operation exception. Please check the response body for details.
4518 description: Unauthenticated access. Please login first.
4520 description: Unauthorized access. Please check your permissions.
4522 description: Unexpected error. Please check the response body for the stack
4526 summary: Set Iscsi discoveryauth
4535 application/vnd.ceph.api.v1.0+json:
4539 description: Operation exception. Please check the response body for details.
4541 description: Unauthenticated access. Please login first.
4543 description: Unauthorized access. Please check your permissions.
4545 description: Unexpected error. Please check the response body for the stack
4578 application/vnd.ceph.api.v1.0+json:
4580 description: Resource created.
4583 application/vnd.ceph.api.v1.0+json:
4585 description: Operation is still executing. Please check the task queue.
4587 description: Operation exception. Please check the response body for details.
4589 description: Unauthenticated access. Please login first.
4591 description: Unauthorized access. Please check your permissions.
4593 description: Unexpected error. Please check the response body for the stack
4599 /api/iscsi/target/{target_iqn}:
4610 application/vnd.ceph.api.v1.0+json:
4612 description: Operation is still executing. Please check the task queue.
4615 application/vnd.ceph.api.v1.0+json:
4617 description: Resource deleted.
4619 description: Operation exception. Please check the response body for details.
4621 description: Unauthenticated access. Please login first.
4623 description: Unauthorized access. Please check your permissions.
4625 description: Unexpected error. Please check the response body for the stack
4641 application/vnd.ceph.api.v1.0+json:
4645 description: Operation exception. Please check the response body for details.
4647 description: Unauthenticated access. Please login first.
4649 description: Unauthorized access. Please check your permissions.
4651 description: Unexpected error. Please check the response body for the stack
4689 application/vnd.ceph.api.v1.0+json:
4691 description: Resource updated.
4694 application/vnd.ceph.api.v1.0+json:
4696 description: Operation is still executing. Please check the task queue.
4698 description: Operation exception. Please check the response body for details.
4700 description: Unauthenticated access. Please login first.
4702 description: Unauthorized access. Please check your permissions.
4704 description: Unexpected error. Please check the response body for the stack
4716 application/vnd.ceph.api.v1.0+json:
4720 description: Audit log
4731 description: IP Address
4791 description: Operation exception. Please check the response body for details.
4793 description: Unauthenticated access. Please login first.
4795 description: Unauthorized access. Please check your permissions.
4797 description: Unexpected error. Please check the response body for the stack
4801 summary: Display Logs Configuration
4806 description: "\n Get the list of managed modules.\n :return: A\
4807 \ list of objects with the fields 'enabled', 'name' and 'options'.\n \
4813 application/vnd.ceph.api.v1.0+json:
4818 description: Is it an always on module?
4821 description: Is Module Enabled
4824 description: Module Name
4827 description: Module Options
4830 description: Options
4833 description: Default value for the option
4836 description: Description of the option
4844 description: List of flags associated
4847 description: Option level
4850 description: Elaborated description
4853 description: Maximum value
4856 description: Minimum value
4859 description: Name of the option
4862 description: Related options
4867 description: Tags associated with the option
4872 description: Type of the option
4900 description: Operation exception. Please check the response body for details.
4902 description: Unauthenticated access. Please login first.
4904 description: Unauthorized access. Please check your permissions.
4906 description: Unexpected error. Please check the response body for the stack
4910 summary: List Mgr modules
4913 /api/mgr/module/{module_name}:
4915 description: "\n Retrieve the values of the persistent configuration\
4916 \ settings.\n :param module_name: The name of the Ceph Mgr module.\n\
4917 \ :type module_name: str\n :return: The values of the module\
4918 \ options.\n :rtype: dict\n "
4928 application/vnd.ceph.api.v1.0+json:
4932 description: Operation exception. Please check the response body for details.
4934 description: Unauthenticated access. Please login first.
4936 description: Unauthorized access. Please check your permissions.
4938 description: Unexpected error. Please check the response body for the stack
4945 description: "\n Set the values of the persistent configuration settings.\n\
4946 \ :param module_name: The name of the Ceph Mgr module.\n :type\
4947 \ module_name: str\n :param config: The values of the module options\
4948 \ to be stored.\n :type config: dict\n "
4968 application/vnd.ceph.api.v1.0+json:
4970 description: Resource updated.
4973 application/vnd.ceph.api.v1.0+json:
4975 description: Operation is still executing. Please check the task queue.
4977 description: Operation exception. Please check the response body for details.
4979 description: Unauthenticated access. Please login first.
4981 description: Unauthorized access. Please check your permissions.
4983 description: Unexpected error. Please check the response body for the stack
4989 /api/mgr/module/{module_name}/disable:
4991 description: "\n Disable the specified Ceph Mgr module.\n :param\
4992 \ module_name: The name of the Ceph Mgr module.\n :type module_name:\
5003 application/vnd.ceph.api.v1.0+json:
5005 description: Resource created.
5008 application/vnd.ceph.api.v1.0+json:
5010 description: Operation is still executing. Please check the task queue.
5012 description: Operation exception. Please check the response body for details.
5014 description: Unauthenticated access. Please login first.
5016 description: Unauthorized access. Please check your permissions.
5018 description: Unexpected error. Please check the response body for the stack
5024 /api/mgr/module/{module_name}/enable:
5026 description: "\n Enable the specified Ceph Mgr module.\n :param\
5027 \ module_name: The name of the Ceph Mgr module.\n :type module_name:\
5038 application/vnd.ceph.api.v1.0+json:
5040 description: Resource created.
5043 application/vnd.ceph.api.v1.0+json:
5045 description: Operation is still executing. Please check the task queue.
5047 description: Operation exception. Please check the response body for details.
5049 description: Unauthenticated access. Please login first.
5051 description: Unauthorized access. Please check your permissions.
5053 description: Unexpected error. Please check the response body for the stack
5059 /api/mgr/module/{module_name}/options:
5061 description: "\n Get the module options of the specified Ceph Mgr module.\n\
5062 \ :param module_name: The name of the Ceph Mgr module.\n :type\
5063 \ module_name: str\n :return: The module options as list of dicts.\n\
5074 application/vnd.ceph.api.v1.0+json:
5078 description: Operation exception. Please check the response body for details.
5080 description: Unauthenticated access. Please login first.
5082 description: Unauthorized access. Please check your permissions.
5084 description: Unexpected error. Please check the response body for the stack
5096 application/vnd.ceph.api.v1.0+json:
5321 min_mon_release_name:
5402 - min_mon_release_name
5459 description: Operation exception. Please check the response body for details.
5461 description: Unauthenticated access. Please login first.
5463 description: Unauthorized access. Please check your permissions.
5465 description: Unexpected error. Please check the response body for the stack
5469 summary: Get Monitor Details
5472 /api/nfs-ganesha/cluster:
5478 application/vnd.ceph.api.v0.1+json:
5482 description: Operation exception. Please check the response body for details.
5484 description: Unauthenticated access. Please login first.
5486 description: Unauthorized access. Please check your permissions.
5488 description: Unexpected error. Please check the response body for the stack
5494 /api/nfs-ganesha/export:
5500 application/vnd.ceph.api.v1.0+json:
5505 description: Export access type
5508 description: List of client configurations
5512 description: Client access type
5515 description: list of IP addresses
5520 description: Client squash policy
5529 description: Cluster identifier
5532 description: Export ID
5535 description: FSAL configuration
5538 description: CephFS filesystem name
5541 description: name of FSAL
5544 description: Name of xattr for security label
5547 description: User id
5553 description: Export path
5556 description: List of protocol types
5561 description: Pseudo FS path
5564 description: Security label
5567 description: Export squash policy
5570 description: List of transport types
5590 description: Operation exception. Please check the response body for details.
5592 description: Unauthenticated access. Please login first.
5594 description: Unauthorized access. Please check your permissions.
5596 description: Unexpected error. Please check the response body for the stack
5600 summary: List all NFS-Ganesha exports
5611 description: Export access type
5614 description: List of client configurations
5618 description: Client access type
5621 description: list of IP addresses
5626 description: Client squash policy
5635 description: Cluster identifier
5638 description: FSAL configuration
5641 description: CephFS filesystem name
5644 description: name of FSAL
5647 description: Name of xattr for security label
5653 description: Export path
5656 description: List of protocol types
5661 description: Pseudo FS path
5664 description: Security label
5667 description: Export squash policy
5670 description: List of transport types
5689 application/vnd.ceph.api.v2.0+json:
5693 description: Export access type
5696 description: List of client configurations
5700 description: Client access type
5703 description: list of IP addresses
5708 description: Client squash policy
5717 description: Cluster identifier
5720 description: Export ID
5723 description: FSAL configuration
5726 description: CephFS filesystem name
5729 description: name of FSAL
5732 description: Name of xattr for security label
5735 description: User id
5741 description: Export path
5744 description: List of protocol types
5749 description: Pseudo FS path
5752 description: Security label
5755 description: Export squash policy
5758 description: List of transport types
5775 description: Resource created.
5778 application/vnd.ceph.api.v2.0+json:
5780 description: Operation is still executing. Please check the task queue.
5782 description: Operation exception. Please check the response body for details.
5784 description: Unauthenticated access. Please login first.
5786 description: Unauthorized access. Please check your permissions.
5788 description: Unexpected error. Please check the response body for the stack
5792 summary: Creates a new NFS-Ganesha export
5795 /api/nfs-ganesha/export/{cluster_id}/{export_id}:
5798 - description: Cluster identifier
5804 - description: Export ID
5813 application/vnd.ceph.api.v2.0+json:
5815 description: Operation is still executing. Please check the task queue.
5818 application/vnd.ceph.api.v2.0+json:
5820 description: Resource deleted.
5822 description: Operation exception. Please check the response body for details.
5824 description: Unauthenticated access. Please login first.
5826 description: Unauthorized access. Please check your permissions.
5828 description: Unexpected error. Please check the response body for the stack
5832 summary: Deletes an NFS-Ganesha export
5837 - description: Cluster identifier
5843 - description: Export ID
5852 application/vnd.ceph.api.v1.0+json:
5856 description: Export access type
5859 description: List of client configurations
5863 description: Client access type
5866 description: list of IP addresses
5871 description: Client squash policy
5880 description: Cluster identifier
5883 description: Export ID
5886 description: FSAL configuration
5889 description: CephFS filesystem name
5892 description: name of FSAL
5895 description: Name of xattr for security label
5898 description: User id
5904 description: Export path
5907 description: List of protocol types
5912 description: Pseudo FS path
5915 description: Security label
5918 description: Export squash policy
5921 description: List of transport types
5940 description: Operation exception. Please check the response body for details.
5942 description: Unauthenticated access. Please login first.
5944 description: Unauthorized access. Please check your permissions.
5946 description: Unexpected error. Please check the response body for the stack
5950 summary: Get an NFS-Ganesha export
5955 - description: Cluster identifier
5961 - description: Export ID
5973 description: Export access type
5976 description: List of client configurations
5980 description: Client access type
5983 description: list of IP addresses
5988 description: Client squash policy
5997 description: FSAL configuration
6000 description: CephFS filesystem name
6003 description: name of FSAL
6006 description: Name of xattr for security label
6012 description: Export path
6015 description: List of protocol types
6020 description: Pseudo FS path
6023 description: Security label
6026 description: Export squash policy
6029 description: List of transport types
6047 application/vnd.ceph.api.v2.0+json:
6051 description: Export access type
6054 description: List of client configurations
6058 description: Client access type
6061 description: list of IP addresses
6066 description: Client squash policy
6075 description: Cluster identifier
6078 description: Export ID
6081 description: FSAL configuration
6084 description: CephFS filesystem name
6087 description: name of FSAL
6090 description: Name of xattr for security label
6093 description: User id
6099 description: Export path
6102 description: List of protocol types
6107 description: Pseudo FS path
6110 description: Security label
6113 description: Export squash policy
6116 description: List of transport types
6133 description: Resource updated.
6136 application/vnd.ceph.api.v2.0+json:
6138 description: Operation is still executing. Please check the task queue.
6140 description: Operation exception. Please check the response body for details.
6142 description: Unauthenticated access. Please login first.
6144 description: Unauthorized access. Please check your permissions.
6146 description: Unexpected error. Please check the response body for the stack
6150 summary: Updates an NFS-Ganesha export
6159 application/vnd.ceph.api.v1.0+json:
6163 description: Operation exception. Please check the response body for details.
6165 description: Unauthenticated access. Please login first.
6167 description: Unauthorized access. Please check your permissions.
6169 description: Unexpected error. Please check the response body for the stack
6196 application/vnd.ceph.api.v1.0+json:
6198 description: Resource created.
6201 application/vnd.ceph.api.v1.0+json:
6203 description: Operation is still executing. Please check the task queue.
6205 description: Operation exception. Please check the response body for details.
6207 description: Unauthenticated access. Please login first.
6209 description: Unauthorized access. Please check your permissions.
6211 description: Unexpected error. Please check the response body for the stack
6223 application/vnd.ceph.api.v1.0+json:
6236 description: Operation exception. Please check the response body for details.
6238 description: Unauthenticated access. Please login first.
6240 description: Unauthorized access. Please check your permissions.
6242 description: Unexpected error. Please check the response body for the stack
6246 summary: Display OSD Flags
6250 description: "\n The `recovery_deletes`, `sortbitwise` and `pglog_hardlimit`\
6251 \ flags cannot be unset.\n `purged_snapshots` cannot even be set. It\
6252 \ is therefore required to at\n least include those four flags for\
6253 \ a successful operation.\n "
6261 description: List of flags to set. The flags `recovery_deletes`,
6262 `sortbitwise` and `pglog_hardlimit` cannot be unset. Additionally
6263 `purged_snapshots` cannot even be set.
6273 application/vnd.ceph.api.v1.0+json:
6284 description: Resource updated.
6287 application/vnd.ceph.api.v1.0+json:
6289 description: Operation is still executing. Please check the task queue.
6291 description: Operation exception. Please check the response body for details.
6293 description: Unauthenticated access. Please login first.
6295 description: Unauthorized access. Please check your permissions.
6297 description: Unexpected error. Please check the response body for the stack
6301 summary: Sets OSD flags for the entire cluster.
6304 /api/osd/flags/individual:
6310 application/vnd.ceph.api.v1.0+json:
6314 description: List of active flags
6327 description: Operation exception. Please check the response body for details.
6329 description: Unauthenticated access. Please login first.
6331 description: Unauthorized access. Please check your permissions.
6333 description: Unexpected error. Please check the response body for the stack
6337 summary: Displays individual OSD flags
6341 description: "\n Updates flags (`noout`, `noin`, `nodown`, `noup`) for\
6342 \ an individual\n subset of OSDs.\n "
6350 description: Directory of flags to set or unset. The flags `noin`,
6351 `noout`, `noup` and `nodown` are going to be considered only.
6354 description: Sets/unsets `nodown`
6357 description: Sets/unsets `noin`
6360 description: Sets/unsets `noout`
6363 description: Sets/unsets `noup`
6367 description: List of OSD ids the flags should be applied to.
6378 application/vnd.ceph.api.v1.0+json:
6382 description: List of added flags
6387 description: List of updated OSDs
6392 description: List of removed flags
6401 description: Resource updated.
6404 application/vnd.ceph.api.v1.0+json:
6406 description: Operation is still executing. Please check the task queue.
6408 description: Operation exception. Please check the response body for details.
6410 description: Unauthenticated access. Please login first.
6412 description: Unauthorized access. Please check your permissions.
6414 description: Unexpected error. Please check the response body for the stack
6418 summary: Sets OSD flags for a subset of individual OSDs.
6421 /api/osd/safe_to_delete:
6423 description: "\n :type ids: int|[int]\n "
6433 application/vnd.ceph.api.v1.0+json:
6437 description: Operation exception. Please check the response body for details.
6439 description: Unauthenticated access. Please login first.
6441 description: Unauthorized access. Please check your permissions.
6443 description: Unexpected error. Please check the response body for the stack
6449 /api/osd/safe_to_destroy:
6451 description: "\n :type ids: int|[int]\n "
6453 - description: OSD Service Identifier
6462 application/vnd.ceph.api.v1.0+json:
6471 description: Is OSD safe to destroy?
6479 description: Is OSD safe to destroy?
6484 description: Stored Pool groups in Osd
6493 - is_safe_to_destroy
6497 description: Operation exception. Please check the response body for details.
6499 description: Unauthenticated access. Please login first.
6501 description: Unauthorized access. Please check your permissions.
6503 description: Unexpected error. Please check the response body for the stack
6507 summary: Check If OSD is Safe to Destroy
6516 application/vnd.ceph.api.v0.1+json:
6520 description: Operation exception. Please check the response body for details.
6522 description: Unauthenticated access. Please login first.
6524 description: Unauthorized access. Please check your permissions.
6526 description: Unexpected error. Please check the response body for the stack
6540 - allowEmptyValue: true
6545 - allowEmptyValue: true
6553 application/vnd.ceph.api.v1.0+json:
6555 description: Operation is still executing. Please check the task queue.
6558 application/vnd.ceph.api.v1.0+json:
6560 description: Resource deleted.
6562 description: Operation exception. Please check the response body for details.
6564 description: Unauthenticated access. Please login first.
6566 description: Unauthorized access. Please check your permissions.
6568 description: Unexpected error. Please check the response body for the stack
6575 description: "\n Returns collected data about an OSD.\n\n :return:\
6576 \ Returns the requested data.\n "
6586 application/vnd.ceph.api.v1.0+json:
6590 description: Operation exception. Please check the response body for details.
6592 description: Unauthenticated access. Please login first.
6594 description: Unauthorized access. Please check your permissions.
6596 description: Unexpected error. Please check the response body for the stack
6622 application/vnd.ceph.api.v1.0+json:
6624 description: Resource updated.
6627 application/vnd.ceph.api.v1.0+json:
6629 description: Operation is still executing. Please check the task queue.
6631 description: Operation exception. Please check the response body for details.
6633 description: Unauthenticated access. Please login first.
6635 description: Unauthorized access. Please check your permissions.
6637 description: Unexpected error. Please check the response body for the stack
6643 /api/osd/{svc_id}/destroy:
6645 description: "\n Mark osd as being destroyed. Keeps the ID intact (allowing\
6646 \ reuse), but\n removes cephx keys, config-key data and lockbox keys,\
6647 \ rendering data\n permanently unreadable.\n\n The osd must\
6648 \ be marked down before being destroyed.\n "
6658 application/vnd.ceph.api.v1.0+json:
6660 description: Resource created.
6663 application/vnd.ceph.api.v1.0+json:
6665 description: Operation is still executing. Please check the task queue.
6667 description: Operation exception. Please check the response body for details.
6669 description: Unauthenticated access. Please login first.
6671 description: Unauthorized access. Please check your permissions.
6673 description: Unexpected error. Please check the response body for the stack
6679 /api/osd/{svc_id}/devices:
6690 application/vnd.ceph.api.v1.0+json:
6694 description: Operation exception. Please check the response body for details.
6696 description: Unauthenticated access. Please login first.
6698 description: Unauthorized access. Please check your permissions.
6700 description: Unexpected error. Please check the response body for the stack
6706 /api/osd/{svc_id}/histogram:
6708 description: "\n :return: Returns the histogram data.\n "
6718 application/vnd.ceph.api.v1.0+json:
6722 description: Operation exception. Please check the response body for details.
6724 description: Unauthenticated access. Please login first.
6726 description: Unauthorized access. Please check your permissions.
6728 description: Unexpected error. Please check the response body for the stack
6734 /api/osd/{svc_id}/mark:
6736 description: "\n Note: osd must be marked `down` before marking lost.\n\
6739 - description: SVC ID
6758 application/vnd.ceph.api.v1.0+json:
6760 description: Resource updated.
6763 application/vnd.ceph.api.v1.0+json:
6765 description: Operation is still executing. Please check the task queue.
6767 description: Operation exception. Please check the response body for details.
6769 description: Unauthenticated access. Please login first.
6771 description: Unauthorized access. Please check your permissions.
6773 description: Unexpected error. Please check the response body for the stack
6777 summary: Mark OSD flags (out, in, down, lost, ...)
6780 /api/osd/{svc_id}/purge:
6782 description: "\n Note: osd must be marked `down` before removal.\n \
6793 application/vnd.ceph.api.v1.0+json:
6795 description: Resource created.
6798 application/vnd.ceph.api.v1.0+json:
6800 description: Operation is still executing. Please check the task queue.
6802 description: Operation exception. Please check the response body for details.
6804 description: Unauthenticated access. Please login first.
6806 description: Unauthorized access. Please check your permissions.
6808 description: Unexpected error. Please check the response body for the stack
6814 /api/osd/{svc_id}/reweight:
6816 description: "\n Reweights the OSD temporarily.\n\n Note that\
6817 \ \u2018ceph osd reweight\u2019 is not a persistent setting. When an OSD\n\
6818 \ gets marked out, the osd weight will be set to 0. When it gets marked\n\
6819 \ in again, the weight will be changed to 1.\n\n Because of\
6820 \ this \u2018ceph osd reweight\u2019 is a temporary solution. You should\n\
6821 \ only use it to keep your cluster running while you\u2019re ordering\
6822 \ more\n hardware.\n\n - Craig Lewis (http://lists.ceph.com/pipermail/ceph-users-ceph.com/2014-June/040967.html)\n\
6843 application/vnd.ceph.api.v1.0+json:
6845 description: Resource created.
6848 application/vnd.ceph.api.v1.0+json:
6850 description: Operation is still executing. Please check the task queue.
6852 description: Operation exception. Please check the response body for details.
6854 description: Unauthenticated access. Please login first.
6856 description: Unauthorized access. Please check your permissions.
6858 description: Unexpected error. Please check the response body for the stack
6864 /api/osd/{svc_id}/scrub:
6889 application/vnd.ceph.api.v1.0+json:
6891 description: Resource created.
6894 application/vnd.ceph.api.v1.0+json:
6896 description: Operation is still executing. Please check the task queue.
6898 description: Operation exception. Please check the response body for details.
6900 description: Unauthenticated access. Please login first.
6902 description: Unauthorized access. Please check your permissions.
6904 description: Unexpected error. Please check the response body for the stack
6910 /api/osd/{svc_id}/smart:
6921 application/vnd.ceph.api.v1.0+json:
6925 description: Operation exception. Please check the response body for details.
6927 description: Unauthenticated access. Please login first.
6929 description: Unauthorized access. Please check your permissions.
6931 description: Unexpected error. Please check the response body for the stack
6943 application/vnd.ceph.api.v1.0+json:
6947 description: Service ID
6986 description: Operation exception. Please check the response body for details.
6988 description: Unauthenticated access. Please login first.
6990 description: Unauthorized access. Please check your permissions.
6992 description: Unexpected error. Please check the response body for the stack
6996 summary: Display Perf Counters
6999 /api/perf_counters/mds/{service_id}:
7010 application/vnd.ceph.api.v1.0+json:
7014 description: Operation exception. Please check the response body for details.
7016 description: Unauthenticated access. Please login first.
7018 description: Unauthorized access. Please check your permissions.
7020 description: Unexpected error. Please check the response body for the stack
7026 /api/perf_counters/mgr/{service_id}:
7037 application/vnd.ceph.api.v1.0+json:
7041 description: Operation exception. Please check the response body for details.
7043 description: Unauthenticated access. Please login first.
7045 description: Unauthorized access. Please check your permissions.
7047 description: Unexpected error. Please check the response body for the stack
7053 /api/perf_counters/mon/{service_id}:
7064 application/vnd.ceph.api.v1.0+json:
7068 description: Operation exception. Please check the response body for details.
7070 description: Unauthenticated access. Please login first.
7072 description: Unauthorized access. Please check your permissions.
7074 description: Unexpected error. Please check the response body for the stack
7080 /api/perf_counters/osd/{service_id}:
7091 application/vnd.ceph.api.v1.0+json:
7095 description: Operation exception. Please check the response body for details.
7097 description: Unauthenticated access. Please login first.
7099 description: Unauthorized access. Please check your permissions.
7101 description: Unexpected error. Please check the response body for the stack
7107 /api/perf_counters/rbd-mirror/{service_id}:
7118 application/vnd.ceph.api.v1.0+json:
7122 description: Operation exception. Please check the response body for details.
7124 description: Unauthenticated access. Please login first.
7126 description: Unauthorized access. Please check your permissions.
7128 description: Unexpected error. Please check the response body for the stack
7133 - RgwMirrorPerfCounter
7134 /api/perf_counters/rgw/{service_id}:
7145 application/vnd.ceph.api.v1.0+json:
7149 description: Operation exception. Please check the response body for details.
7151 description: Unauthenticated access. Please login first.
7153 description: Unauthorized access. Please check your permissions.
7155 description: Unexpected error. Please check the response body for the stack
7161 /api/perf_counters/tcmu-runner/{service_id}:
7172 application/vnd.ceph.api.v1.0+json:
7176 description: Operation exception. Please check the response body for details.
7178 description: Unauthenticated access. Please login first.
7180 description: Unauthorized access. Please check your permissions.
7182 description: Unexpected error. Please check the response body for the stack
7187 - TcmuRunnerPerfCounter
7191 - allowEmptyValue: true
7192 description: Pool Attributes
7198 description: Pool Stats
7206 application/vnd.ceph.api.v1.0+json:
7210 application_metadata:
7218 cache_min_evict_age:
7221 cache_min_flush_age:
7227 cache_target_dirty_high_ratio_micro:
7230 cache_target_dirty_ratio_micro:
7233 cache_target_full_ratio_micro:
7242 erasure_code_profile:
7245 expected_num_objects:
7255 description: flags name
7265 hit_set_grade_decay_rate:
7280 hit_set_search_last_n:
7286 last_force_op_resend:
7289 last_force_op_resend_preluminous:
7292 last_force_op_resend_prenautilus:
7318 - last_epoch_started
7324 min_read_recency_for_promote:
7330 min_write_recency_for_promote:
7364 pg_placement_num_target:
7368 description: pool id
7371 description: pool name
7393 description: pool size
7422 description: type of pool
7444 - pg_placement_num_target
7447 - last_pg_merge_meta
7461 - target_max_objects
7462 - cache_target_dirty_ratio_micro
7463 - cache_target_dirty_high_ratio_micro
7464 - cache_target_full_ratio_micro
7465 - cache_min_flush_age
7466 - cache_min_evict_age
7467 - erasure_code_profile
7472 - min_read_recency_for_promote
7473 - min_write_recency_for_promote
7474 - hit_set_grade_decay_rate
7475 - hit_set_search_last_n
7478 - expected_num_objects
7481 - application_metadata
7484 - last_force_op_resend
7485 - last_force_op_resend_prenautilus
7486 - last_force_op_resend_preluminous
7491 description: Operation exception. Please check the response body for details.
7493 description: Unauthenticated access. Please login first.
7495 description: Unauthorized access. Please check your permissions.
7497 description: Unexpected error. Please check the response body for the stack
7501 summary: Display Pool List
7518 application/vnd.ceph.api.v1.0+json:
7520 description: Resource created.
7523 application/vnd.ceph.api.v1.0+json:
7525 description: Operation is still executing. Please check the task queue.
7527 description: Operation exception. Please check the response body for details.
7529 description: Unauthenticated access. Please login first.
7531 description: Unauthorized access. Please check your permissions.
7533 description: Unexpected error. Please check the response body for the stack
7539 /api/pool/{pool_name}:
7550 application/vnd.ceph.api.v1.0+json:
7552 description: Operation is still executing. Please check the task queue.
7555 application/vnd.ceph.api.v1.0+json:
7557 description: Resource deleted.
7559 description: Operation exception. Please check the response body for details.
7561 description: Unauthenticated access. Please login first.
7563 description: Unauthorized access. Please check your permissions.
7565 description: Unexpected error. Please check the response body for the stack
7578 - allowEmptyValue: true
7591 application/vnd.ceph.api.v1.0+json:
7595 description: Operation exception. Please check the response body for details.
7597 description: Unauthenticated access. Please login first.
7599 description: Unauthorized access. Please check your permissions.
7601 description: Unexpected error. Please check the response body for the stack
7619 application_metadata:
7629 application/vnd.ceph.api.v1.0+json:
7631 description: Resource updated.
7634 application/vnd.ceph.api.v1.0+json:
7636 description: Operation is still executing. Please check the task queue.
7638 description: Operation exception. Please check the response body for details.
7640 description: Unauthenticated access. Please login first.
7642 description: Unauthorized access. Please check your permissions.
7644 description: Unexpected error. Please check the response body for the stack
7650 /api/pool/{pool_name}/configuration:
7661 application/vnd.ceph.api.v1.0+json:
7665 description: Operation exception. Please check the response body for details.
7667 description: Unauthenticated access. Please login first.
7669 description: Unauthorized access. Please check your permissions.
7671 description: Unexpected error. Please check the response body for the stack
7683 application/vnd.ceph.api.v1.0+json:
7687 description: Operation exception. Please check the response body for details.
7689 description: Unauthenticated access. Please login first.
7691 description: Unauthorized access. Please check your permissions.
7693 description: Unexpected error. Please check the response body for the stack
7699 /api/prometheus/data:
7705 application/vnd.ceph.api.v1.0+json:
7709 description: Operation exception. Please check the response body for details.
7711 description: Unauthenticated access. Please login first.
7713 description: Unauthorized access. Please check your permissions.
7715 description: Unexpected error. Please check the response body for the stack
7721 /api/prometheus/notifications:
7727 application/vnd.ceph.api.v1.0+json:
7731 description: Operation exception. Please check the response body for details.
7733 description: Unauthenticated access. Please login first.
7735 description: Unauthorized access. Please check your permissions.
7737 description: Unexpected error. Please check the response body for the stack
7742 - PrometheusNotifications
7743 /api/prometheus/rules:
7749 application/vnd.ceph.api.v1.0+json:
7753 description: Operation exception. Please check the response body for details.
7755 description: Unauthenticated access. Please login first.
7757 description: Unauthorized access. Please check your permissions.
7759 description: Unexpected error. Please check the response body for the stack
7765 /api/prometheus/silence:
7771 application/vnd.ceph.api.v1.0+json:
7773 description: Resource created.
7776 application/vnd.ceph.api.v1.0+json:
7778 description: Operation is still executing. Please check the task queue.
7780 description: Operation exception. Please check the response body for details.
7782 description: Unauthenticated access. Please login first.
7784 description: Unauthorized access. Please check your permissions.
7786 description: Unexpected error. Please check the response body for the stack
7792 /api/prometheus/silence/{s_id}:
7803 application/vnd.ceph.api.v1.0+json:
7805 description: Operation is still executing. Please check the task queue.
7808 application/vnd.ceph.api.v1.0+json:
7810 description: Resource deleted.
7812 description: Operation exception. Please check the response body for details.
7814 description: Unauthenticated access. Please login first.
7816 description: Unauthorized access. Please check your permissions.
7818 description: Unexpected error. Please check the response body for the stack
7824 /api/prometheus/silences:
7830 application/vnd.ceph.api.v1.0+json:
7834 description: Operation exception. Please check the response body for details.
7836 description: Unauthenticated access. Please login first.
7838 description: Unauthorized access. Please check your permissions.
7840 description: Unexpected error. Please check the response body for the stack
7854 - allowEmptyValue: true
7859 - allowEmptyValue: true
7867 application/vnd.ceph.api.v1.1+json:
7871 description: Operation exception. Please check the response body for details.
7873 description: Unauthenticated access. Please login first.
7875 description: Unauthorized access. Please check your permissions.
7877 description: Unexpected error. Please check the response body for the stack
7906 lock_retention_period_days:
7908 lock_retention_period_years:
7923 application/vnd.ceph.api.v1.0+json:
7925 description: Resource created.
7928 application/vnd.ceph.api.v1.0+json:
7930 description: Operation is still executing. Please check the task queue.
7932 description: Operation exception. Please check the response body for details.
7934 description: Unauthenticated access. Please login first.
7936 description: Unauthorized access. Please check your permissions.
7938 description: Unexpected error. Please check the response body for the stack
7944 /api/rgw/bucket/deleteEncryption:
7952 - allowEmptyValue: true
7957 - allowEmptyValue: true
7965 application/vnd.ceph.api.v1.0+json:
7967 description: Operation is still executing. Please check the task queue.
7970 application/vnd.ceph.api.v1.0+json:
7972 description: Resource deleted.
7974 description: Operation exception. Please check the response body for details.
7976 description: Unauthenticated access. Please login first.
7978 description: Unauthorized access. Please check your permissions.
7980 description: Unexpected error. Please check the response body for the stack
7986 /api/rgw/bucket/getEncryption:
7994 - allowEmptyValue: true
7999 - allowEmptyValue: true
8007 application/vnd.ceph.api.v1.0+json:
8011 description: Operation exception. Please check the response body for details.
8013 description: Unauthenticated access. Please login first.
8015 description: Unauthorized access. Please check your permissions.
8017 description: Unexpected error. Please check the response body for the stack
8023 /api/rgw/bucket/getEncryptionConfig:
8026 - allowEmptyValue: true
8031 - allowEmptyValue: true
8039 application/vnd.ceph.api.v1.0+json:
8043 description: Operation exception. Please check the response body for details.
8045 description: Unauthenticated access. Please login first.
8047 description: Unauthorized access. Please check your permissions.
8049 description: Unexpected error. Please check the response body for the stack
8055 /api/rgw/bucket/setEncryptionConfig:
8095 application/vnd.ceph.api.v1.0+json:
8097 description: Resource updated.
8100 application/vnd.ceph.api.v1.0+json:
8102 description: Operation is still executing. Please check the task queue.
8104 description: Operation exception. Please check the response body for details.
8106 description: Unauthenticated access. Please login first.
8108 description: Unauthorized access. Please check your permissions.
8110 description: Unexpected error. Please check the response body for the stack
8116 /api/rgw/bucket/{bucket}:
8129 - allowEmptyValue: true
8137 application/vnd.ceph.api.v1.0+json:
8139 description: Operation is still executing. Please check the task queue.
8142 application/vnd.ceph.api.v1.0+json:
8144 description: Resource deleted.
8146 description: Operation exception. Please check the response body for details.
8148 description: Unauthenticated access. Please login first.
8150 description: Unauthorized access. Please check your permissions.
8152 description: Unexpected error. Please check the response body for the stack
8165 - allowEmptyValue: true
8173 application/vnd.ceph.api.v1.0+json:
8177 description: Operation exception. Please check the response body for details.
8179 description: Unauthenticated access. Please login first.
8181 description: Unauthorized access. Please check your permissions.
8183 description: Unexpected error. Please check the response body for the stack
8214 lock_retention_period_days:
8216 lock_retention_period_years:
8235 application/vnd.ceph.api.v1.0+json:
8237 description: Resource updated.
8240 application/vnd.ceph.api.v1.0+json:
8242 description: Operation is still executing. Please check the task queue.
8244 description: Operation exception. Please check the response body for details.
8246 description: Unauthenticated access. Please login first.
8248 description: Unauthorized access. Please check your permissions.
8250 description: Unexpected error. Please check the response body for the stack
8262 application/vnd.ceph.api.v1.0+json:
8267 description: Daemon ID
8276 description: Ceph Version
8282 description: Zone Group
8295 description: Operation exception. Please check the response body for details.
8297 description: Unauthenticated access. Please login first.
8299 description: Unauthorized access. Please check your permissions.
8301 description: Unexpected error. Please check the response body for the stack
8305 summary: Display RGW Daemons
8308 /api/rgw/daemon/{svc_id}:
8319 application/vnd.ceph.api.v1.0+json:
8323 description: Operation exception. Please check the response body for details.
8325 description: Unauthenticated access. Please login first.
8327 description: Unauthorized access. Please check your permissions.
8329 description: Unexpected error. Please check the response body for the stack
8341 application/vnd.ceph.api.v1.0+json:
8345 description: Operation exception. Please check the response body for details.
8347 description: Unauthenticated access. Please login first.
8349 description: Unauthorized access. Please check your permissions.
8351 description: Unexpected error. Please check the response body for the stack
8355 summary: List RGW roles
8365 role_assume_policy_doc:
8378 application/vnd.ceph.api.v1.0+json:
8380 description: Resource created.
8383 application/vnd.ceph.api.v1.0+json:
8385 description: Operation is still executing. Please check the task queue.
8387 description: Operation exception. Please check the response body for details.
8389 description: Unauthenticated access. Please login first.
8391 description: Unauthorized access. Please check your permissions.
8393 description: Unexpected error. Please check the response body for the stack
8397 summary: Create Ceph User
8403 - allowEmptyValue: true
8408 - allowEmptyValue: true
8416 application/vnd.ceph.api.v1.0+json:
8420 description: Operation exception. Please check the response body for details.
8422 description: Unauthenticated access. Please login first.
8424 description: Unauthorized access. Please check your permissions.
8426 description: Unexpected error. Please check the response body for the stack
8435 - allowEmptyValue: true
8443 application/vnd.ceph.api.v1.0+json:
8447 description: list of rgw users
8456 description: Operation exception. Please check the response body for details.
8458 description: Unauthenticated access. Please login first.
8460 description: Unauthorized access. Please check your permissions.
8462 description: Unexpected error. Please check the response body for the stack
8466 summary: Display RGW Users
8501 application/vnd.ceph.api.v1.0+json:
8503 description: Resource created.
8506 application/vnd.ceph.api.v1.0+json:
8508 description: Operation is still executing. Please check the task queue.
8510 description: Operation exception. Please check the response body for details.
8512 description: Unauthenticated access. Please login first.
8514 description: Unauthorized access. Please check your permissions.
8516 description: Unexpected error. Please check the response body for the stack
8522 /api/rgw/user/get_emails:
8525 - allowEmptyValue: true
8533 application/vnd.ceph.api.v1.0+json:
8537 description: Operation exception. Please check the response body for details.
8539 description: Unauthenticated access. Please login first.
8541 description: Unauthorized access. Please check your permissions.
8543 description: Unexpected error. Please check the response body for the stack
8549 /api/rgw/user/{uid}:
8557 - allowEmptyValue: true
8565 application/vnd.ceph.api.v1.0+json:
8567 description: Operation is still executing. Please check the task queue.
8570 application/vnd.ceph.api.v1.0+json:
8572 description: Resource deleted.
8574 description: Operation exception. Please check the response body for details.
8576 description: Unauthenticated access. Please login first.
8578 description: Unauthorized access. Please check your permissions.
8580 description: Unexpected error. Please check the response body for the stack
8593 - allowEmptyValue: true
8606 application/vnd.ceph.api.v1.0+json:
8610 description: Operation exception. Please check the response body for details.
8612 description: Unauthenticated access. Please login first.
8614 description: Unauthorized access. Please check your permissions.
8616 description: Unexpected error. Please check the response body for the stack
8648 application/vnd.ceph.api.v1.0+json:
8650 description: Resource updated.
8653 application/vnd.ceph.api.v1.0+json:
8655 description: Operation is still executing. Please check the task queue.
8657 description: Operation exception. Please check the response body for details.
8659 description: Unauthenticated access. Please login first.
8661 description: Unauthorized access. Please check your permissions.
8663 description: Unexpected error. Please check the response body for the stack
8669 /api/rgw/user/{uid}/capability:
8687 - allowEmptyValue: true
8695 application/vnd.ceph.api.v1.0+json:
8697 description: Operation is still executing. Please check the task queue.
8700 application/vnd.ceph.api.v1.0+json:
8702 description: Resource deleted.
8704 description: Operation exception. Please check the response body for details.
8706 description: Unauthenticated access. Please login first.
8708 description: Unauthorized access. Please check your permissions.
8710 description: Unexpected error. Please check the response body for the stack
8741 application/vnd.ceph.api.v1.0+json:
8743 description: Resource created.
8746 application/vnd.ceph.api.v1.0+json:
8748 description: Operation is still executing. Please check the task queue.
8750 description: Operation exception. Please check the response body for details.
8752 description: Unauthenticated access. Please login first.
8754 description: Unauthorized access. Please check your permissions.
8756 description: Unexpected error. Please check the response body for the stack
8762 /api/rgw/user/{uid}/key:
8775 - allowEmptyValue: true
8780 - allowEmptyValue: true
8785 - allowEmptyValue: true
8793 application/vnd.ceph.api.v1.0+json:
8795 description: Operation is still executing. Please check the task queue.
8798 application/vnd.ceph.api.v1.0+json:
8800 description: Resource deleted.
8802 description: Operation exception. Please check the response body for details.
8804 description: Unauthenticated access. Please login first.
8806 description: Unauthorized access. Please check your permissions.
8808 description: Unexpected error. Please check the response body for the stack
8844 application/vnd.ceph.api.v1.0+json:
8846 description: Resource created.
8849 application/vnd.ceph.api.v1.0+json:
8851 description: Operation is still executing. Please check the task queue.
8853 description: Operation exception. Please check the response body for details.
8855 description: Unauthenticated access. Please login first.
8857 description: Unauthorized access. Please check your permissions.
8859 description: Unexpected error. Please check the response body for the stack
8865 /api/rgw/user/{uid}/quota:
8873 - allowEmptyValue: true
8881 application/vnd.ceph.api.v1.0+json:
8885 description: Operation exception. Please check the response body for details.
8887 description: Unauthenticated access. Please login first.
8889 description: Unauthorized access. Please check your permissions.
8891 description: Unexpected error. Please check the response body for the stack
8928 application/vnd.ceph.api.v1.0+json:
8930 description: Resource updated.
8933 application/vnd.ceph.api.v1.0+json:
8935 description: Operation is still executing. Please check the task queue.
8937 description: Operation exception. Please check the response body for details.
8939 description: Unauthenticated access. Please login first.
8941 description: Unauthorized access. Please check your permissions.
8943 description: Unexpected error. Please check the response body for the stack
8949 /api/rgw/user/{uid}/subuser:
8985 application/vnd.ceph.api.v1.0+json:
8987 description: Resource created.
8990 application/vnd.ceph.api.v1.0+json:
8992 description: Operation is still executing. Please check the task queue.
8994 description: Operation exception. Please check the response body for details.
8996 description: Unauthenticated access. Please login first.
8998 description: Unauthorized access. Please check your permissions.
9000 description: Unexpected error. Please check the response body for the stack
9006 /api/rgw/user/{uid}/subuser/{subuser}:
9008 description: "\n :param purge_keys: Set to False to do not purge the\
9009 \ keys.\n Note, this only works for s3 subusers.\n\
9027 - allowEmptyValue: true
9035 application/vnd.ceph.api.v1.0+json:
9037 description: Operation is still executing. Please check the task queue.
9040 application/vnd.ceph.api.v1.0+json:
9042 description: Resource deleted.
9044 description: Operation exception. Please check the response body for details.
9046 description: Unauthenticated access. Please login first.
9048 description: Unauthorized access. Please check your permissions.
9050 description: Unexpected error. Please check the response body for the stack
9062 application/vnd.ceph.api.v1.0+json:
9067 description: Role Descriptions
9070 description: Role Name
9090 - scopes_permissions
9095 description: Operation exception. Please check the response body for details.
9097 description: Unauthenticated access. Please login first.
9099 description: Unauthorized access. Please check your permissions.
9101 description: Unexpected error. Please check the response body for the stack
9105 summary: Display Role list
9125 application/vnd.ceph.api.v1.0+json:
9127 description: Resource created.
9130 application/vnd.ceph.api.v1.0+json:
9132 description: Operation is still executing. Please check the task queue.
9134 description: Operation exception. Please check the response body for details.
9136 description: Unauthenticated access. Please login first.
9138 description: Unauthorized access. Please check your permissions.
9140 description: Unexpected error. Please check the response body for the stack
9157 application/vnd.ceph.api.v1.0+json:
9159 description: Operation is still executing. Please check the task queue.
9162 application/vnd.ceph.api.v1.0+json:
9164 description: Resource deleted.
9166 description: Operation exception. Please check the response body for details.
9168 description: Unauthenticated access. Please login first.
9170 description: Unauthorized access. Please check your permissions.
9172 description: Unexpected error. Please check the response body for the stack
9188 application/vnd.ceph.api.v1.0+json:
9192 description: Operation exception. Please check the response body for details.
9194 description: Unauthenticated access. Please login first.
9196 description: Unauthorized access. Please check your permissions.
9198 description: Unexpected error. Please check the response body for the stack
9224 application/vnd.ceph.api.v1.0+json:
9226 description: Resource updated.
9229 application/vnd.ceph.api.v1.0+json:
9231 description: Operation is still executing. Please check the task queue.
9233 description: Operation exception. Please check the response body for details.
9235 description: Unauthenticated access. Please login first.
9237 description: Unauthorized access. Please check your permissions.
9239 description: Unexpected error. Please check the response body for the stack
9245 /api/role/{name}/clone:
9266 application/vnd.ceph.api.v1.0+json:
9268 description: Resource created.
9271 application/vnd.ceph.api.v1.0+json:
9273 description: Operation is still executing. Please check the task queue.
9275 description: Operation exception. Please check the response body for details.
9277 description: Unauthenticated access. Please login first.
9279 description: Unauthorized access. Please check your permissions.
9281 description: Unexpected error. Please check the response body for the stack
9290 - allowEmptyValue: true
9310 - default: +service_name
9318 application/vnd.ceph.api.v2.0+json:
9322 description: Operation exception. Please check the response body for details.
9324 description: Unauthenticated access. Please login first.
9326 description: Unauthorized access. Please check your permissions.
9328 description: Unexpected error. Please check the response body for the stack
9335 description: "\n :param service_spec: The service specification as JSON.\n\
9336 \ :param service_name: The service name, e.g. 'alertmanager'.\n \
9355 application/vnd.ceph.api.v1.0+json:
9357 description: Resource created.
9360 application/vnd.ceph.api.v1.0+json:
9362 description: Operation is still executing. Please check the task queue.
9364 description: Operation exception. Please check the response body for details.
9366 description: Unauthenticated access. Please login first.
9368 description: Unauthorized access. Please check your permissions.
9370 description: Unexpected error. Please check the response body for the stack
9376 /api/service/known_types:
9378 description: "\n Get a list of known service types, e.g. 'alertmanager',\n\
9379 \ 'node-exporter', 'osd' or 'rgw'.\n "
9384 application/vnd.ceph.api.v1.0+json:
9388 description: Operation exception. Please check the response body for details.
9390 description: Unauthenticated access. Please login first.
9392 description: Unauthorized access. Please check your permissions.
9394 description: Unexpected error. Please check the response body for the stack
9400 /api/service/{service_name}:
9402 description: "\n :param service_name: The service name, e.g. 'mds' or\
9403 \ 'crash.foo'.\n :return: None\n "
9413 application/vnd.ceph.api.v1.0+json:
9415 description: Operation is still executing. Please check the task queue.
9418 application/vnd.ceph.api.v1.0+json:
9420 description: Resource deleted.
9422 description: Operation exception. Please check the response body for details.
9424 description: Unauthenticated access. Please login first.
9426 description: Unauthorized access. Please check your permissions.
9428 description: Unexpected error. Please check the response body for the stack
9444 application/vnd.ceph.api.v1.0+json:
9448 description: Operation exception. Please check the response body for details.
9450 description: Unauthenticated access. Please login first.
9452 description: Unauthorized access. Please check your permissions.
9454 description: Unexpected error. Please check the response body for the stack
9461 description: "\n :param service_spec: The service specification as JSON.\n\
9462 \ :param service_name: The service name, e.g. 'alertmanager'.\n \
9483 application/vnd.ceph.api.v1.0+json:
9485 description: Resource updated.
9488 application/vnd.ceph.api.v1.0+json:
9490 description: Operation is still executing. Please check the task queue.
9492 description: Operation exception. Please check the response body for details.
9494 description: Unauthenticated access. Please login first.
9496 description: Unauthorized access. Please check your permissions.
9498 description: Unexpected error. Please check the response body for the stack
9504 /api/service/{service_name}/daemons:
9515 application/vnd.ceph.api.v1.0+json:
9519 description: Operation exception. Please check the response body for details.
9521 description: Unauthenticated access. Please login first.
9523 description: Unauthorized access. Please check your permissions.
9525 description: Unexpected error. Please check the response body for the stack
9533 description: "\n Get the list of available options.\n :param names:\
9534 \ A comma separated list of option names that should\n be processed.\
9535 \ Defaults to ``None``.\n :type names: None|str\n :return: A\
9536 \ list of available options.\n :rtype: list[dict]\n "
9538 - allowEmptyValue: true
9539 description: Name of Settings
9547 application/vnd.ceph.api.v1.0+json:
9552 description: Default Settings
9555 description: Settings Name
9558 description: Type of Settings
9561 description: Settings Value
9572 description: Operation exception. Please check the response body for details.
9574 description: Unauthenticated access. Please login first.
9576 description: Unauthorized access. Please check your permissions.
9578 description: Unexpected error. Please check the response body for the stack
9582 summary: Display Settings Information
9590 application/vnd.ceph.api.v1.0+json:
9592 description: Resource updated.
9595 application/vnd.ceph.api.v1.0+json:
9597 description: Operation is still executing. Please check the task queue.
9599 description: Operation exception. Please check the response body for details.
9601 description: Unauthenticated access. Please login first.
9603 description: Unauthorized access. Please check your permissions.
9605 description: Unexpected error. Please check the response body for the stack
9611 /api/settings/{name}:
9622 application/vnd.ceph.api.v1.0+json:
9624 description: Operation is still executing. Please check the task queue.
9627 application/vnd.ceph.api.v1.0+json:
9629 description: Resource deleted.
9631 description: Operation exception. Please check the response body for details.
9633 description: Unauthenticated access. Please login first.
9635 description: Unauthorized access. Please check your permissions.
9637 description: Unexpected error. Please check the response body for the stack
9644 description: "\n Get the given option.\n :param name: The name\
9645 \ of the option.\n :return: Returns a dict containing the name, type,\n\
9646 \ default value and current value of the given option.\n :rtype:\
9657 application/vnd.ceph.api.v1.0+json:
9661 description: Operation exception. Please check the response body for details.
9663 description: Unauthenticated access. Please login first.
9665 description: Unauthorized access. Please check your permissions.
9667 description: Unexpected error. Please check the response body for the stack
9693 application/vnd.ceph.api.v1.0+json:
9695 description: Resource updated.
9698 application/vnd.ceph.api.v1.0+json:
9700 description: Operation is still executing. Please check the task queue.
9702 description: Operation exception. Please check the response body for details.
9704 description: Unauthenticated access. Please login first.
9706 description: Unauthorized access. Please check your permissions.
9708 description: Unexpected error. Please check the response body for the stack
9720 application/vnd.ceph.api.v1.0+json:
9777 have_mon_connection:
9809 - have_mon_connection
9817 description: Operation exception. Please check the response body for details.
9819 description: Unauthenticated access. Please login first.
9821 description: Unauthorized access. Please check your permissions.
9823 description: Unexpected error. Please check the response body for the stack
9827 summary: Display Summary
9833 - allowEmptyValue: true
9834 description: Task Name
9842 application/vnd.ceph.api.v1.0+json:
9846 description: ongoing executing tasks
9853 description: Task begin time
9859 description: Task end time
9874 description: finished tasks name
9877 description: Progress of tasks
9903 description: Operation exception. Please check the response body for details.
9905 description: Unauthenticated access. Please login first.
9907 description: Unauthorized access. Please check your permissions.
9909 description: Unexpected error. Please check the response body for the stack
9913 summary: Display Tasks
9918 description: "\n Enables or disables sending data collected by the Telemetry\n\
9919 \ module.\n :param enable: Enable or disable sending data\n\
9920 \ :type enable: bool\n :param license_name: License string e.g.\
9921 \ 'sharing-1-0' to\n make sure the user is aware of and accepts the\
9922 \ license\n for sharing Telemetry data.\n :type license_name:\
9939 application/vnd.ceph.api.v1.0+json:
9941 description: Resource updated.
9944 application/vnd.ceph.api.v1.0+json:
9946 description: Operation is still executing. Please check the task queue.
9948 description: Operation exception. Please check the response body for details.
9950 description: Unauthenticated access. Please login first.
9952 description: Unauthorized access. Please check your permissions.
9954 description: Unexpected error. Please check the response body for the stack
9960 /api/telemetry/report:
9962 description: "\n Get Ceph and device report data\n :return: Ceph\
9963 \ and device report data\n :rtype: dict\n "
9968 application/vnd.ceph.api.v1.0+json:
10089 allowed_bucket_algs:
10092 choose_local_fallback_tries:
10095 choose_local_tries:
10098 choose_total_tries:
10101 chooseleaf_descend_once:
10125 minimum_required_version:
10134 require_feature_tunables:
10137 require_feature_tunables2:
10140 require_feature_tunables3:
10143 require_feature_tunables5:
10146 straw_calc_version:
10150 - choose_local_tries
10151 - choose_local_fallback_tries
10152 - choose_total_tries
10153 - chooseleaf_descend_once
10154 - chooseleaf_vary_r
10155 - chooseleaf_stable
10156 - straw_calc_version
10157 - allowed_bucket_algs
10161 - minimum_required_version
10162 - require_feature_tunables
10163 - require_feature_tunables2
10165 - require_feature_tunables3
10168 - require_feature_tunables5
10178 - compat_weight_set
10196 ever_enabled_multiple:
10201 - ever_enabled_multiple
10270 ceph version 16.0.0-3151-gf202994fcf:
10274 - ceph version 16.0.0-3151-gf202994fcf
10279 Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz:
10283 - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz
10294 distro_description:
10297 CentOS Linux 8 (Core):
10301 - CentOS Linux 8 (Core)
10303 kernel_description:
10306 '#1 SMP Wed Jul 1 19:53:01 UTC 2020':
10310 - '#1 SMP Wed Jul 1 19:53:01 UTC 2020'
10315 5.7.7-200.fc32.x86_64:
10319 - 5.7.7-200.fc32.x86_64
10335 - kernel_description
10337 - distro_description
10355 ceph version 16.0.0-3151-gf202994fcf:
10359 - ceph version 16.0.0-3151-gf202994fcf
10364 Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz:
10368 - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz
10379 distro_description:
10382 CentOS Linux 8 (Core):
10386 - CentOS Linux 8 (Core)
10388 kernel_description:
10391 '#1 SMP Wed Jul 1 19:53:01 UTC 2020':
10395 - '#1 SMP Wed Jul 1 19:53:01 UTC 2020'
10400 5.7.7-200.fc32.x86_64:
10404 - 5.7.7-200.fc32.x86_64
10440 - kernel_description
10442 - distro_description
10505 require_min_compat_client:
10508 require_osd_release:
10513 - require_osd_release
10514 - require_min_compat_client
10524 erasure_code_profile:
10548 target_max_objects:
10561 - pg_autoscale_mode
10563 - target_max_objects
10564 - erasure_code_profile
10576 num_images_by_pool:
10586 - num_images_by_pool
10587 - mirroring_by_pool
10653 - total_avail_bytes
10661 - channels_available
10685 description: Operation exception. Please check the response body for details.
10687 description: Unauthenticated access. Please login first.
10689 description: Unauthorized access. Please check your permissions.
10691 description: Unexpected error. Please check the response body for the stack
10695 summary: Get Detailed Telemetry report
10704 application/vnd.ceph.api.v1.0+json:
10708 description: User email address
10711 description: Is the user enabled?
10714 description: Details last updated
10717 description: User Name
10720 description: Password Expiration date
10723 description: Is Password Update Required?
10726 description: User Roles
10731 description: Username of the user
10740 - pwdExpirationDate
10741 - pwdUpdateRequired
10745 description: Operation exception. Please check the response body for details.
10747 description: Unauthenticated access. Please login first.
10749 description: Unauthorized access. Please check your permissions.
10751 description: Unexpected error. Please check the response body for the stack
10755 summary: Get List Of Users
10787 application/vnd.ceph.api.v1.0+json:
10789 description: Resource created.
10792 application/vnd.ceph.api.v1.0+json:
10794 description: Operation is still executing. Please check the task queue.
10796 description: Operation exception. Please check the response body for details.
10798 description: Unauthenticated access. Please login first.
10800 description: Unauthorized access. Please check your permissions.
10802 description: Unexpected error. Please check the response body for the stack
10808 /api/user/validate_password:
10810 description: "\n Check if the password meets the password policy.\n \
10811 \ :param password: The password to validate.\n :param username:\
10812 \ The name of the user (optional).\n :param old_password: The old password\
10813 \ (optional).\n :return: An object with properties valid, credits and\
10814 \ valuation.\n 'credits' contains the password complexity credits and\n\
10815 \ 'valuation' the textual summary of the validation.\n "
10834 application/vnd.ceph.api.v1.0+json:
10836 description: Resource created.
10839 application/vnd.ceph.api.v1.0+json:
10841 description: Operation is still executing. Please check the task queue.
10843 description: Operation exception. Please check the response body for details.
10845 description: Unauthenticated access. Please login first.
10847 description: Unauthorized access. Please check your permissions.
10849 description: Unexpected error. Please check the response body for the stack
10854 - UserPasswordPolicy
10855 /api/user/{username}:
10866 application/vnd.ceph.api.v1.0+json:
10868 description: Operation is still executing. Please check the task queue.
10871 application/vnd.ceph.api.v1.0+json:
10873 description: Resource deleted.
10875 description: Operation exception. Please check the response body for details.
10877 description: Unauthenticated access. Please login first.
10879 description: Unauthorized access. Please check your permissions.
10881 description: Unexpected error. Please check the response body for the stack
10897 application/vnd.ceph.api.v1.0+json:
10901 description: Operation exception. Please check the response body for details.
10903 description: Unauthenticated access. Please login first.
10905 description: Unauthorized access. Please check your permissions.
10907 description: Unexpected error. Please check the response body for the stack
10944 application/vnd.ceph.api.v1.0+json:
10946 description: Resource updated.
10949 application/vnd.ceph.api.v1.0+json:
10951 description: Operation is still executing. Please check the task queue.
10953 description: Operation exception. Please check the response body for details.
10955 description: Unauthenticated access. Please login first.
10957 description: Unauthorized access. Please check your permissions.
10959 description: Unexpected error. Please check the response body for the stack
10965 /api/user/{username}/change_password:
10989 application/vnd.ceph.api.v1.0+json:
10991 description: Resource created.
10994 application/vnd.ceph.api.v1.0+json:
10996 description: Operation is still executing. Please check the task queue.
10998 description: Operation exception. Please check the response body for details.
11000 description: Unauthenticated access. Please login first.
11002 description: Unauthorized access. Please check your permissions.
11004 description: Unexpected error. Please check the response body for the stack
11009 - UserChangePassword
11015 - description: Initiate a session with Ceph
11017 - description: Cephfs Management API
11019 - description: Get Cluster Details
11021 - description: Manage Cluster Configurations
11022 name: ClusterConfiguration
11023 - description: Crush Rule Management API
11025 - description: Perform actions on daemons
11027 - description: Erasure Code Profile Management API
11028 name: ErasureCodeProfile
11029 - description: Manage Features API
11030 name: FeatureTogglesEndpoint
11031 - description: Grafana Management API
11033 - description: Display Detailed Cluster health Status
11035 - description: Get Host Details
11037 - description: Iscsi Management API
11039 - description: Get Iscsi Target Details
11041 - description: Logs Management API
11043 - description: Mds Perf Counters Management API
11044 name: MdsPerfCounter
11045 - description: Get details of MGR Module
11047 - description: Mgr Perf Counters Management API
11048 name: MgrPerfCounter
11049 - description: Mon Perf Counters Management API
11050 name: MonPerfCounter
11051 - description: Get Monitor Details
11053 - description: NFS-Ganesha Cluster Management API
11055 - description: OSD management API
11057 - description: OSD Perf Counters Management API
11058 name: OsdPerfCounter
11059 - description: Perf Counters Management API
11061 - description: Get pool details by pool name
11063 - description: Prometheus Management API
11065 - description: Prometheus Notifications Management API
11066 name: PrometheusNotifications
11067 - description: List of RGW roles
11069 - description: RBD Management API
11071 - description: RBD Mirroring Management API
11073 - description: RBD Mirroring Pool Bootstrap Management API
11074 name: RbdMirroringPoolBootstrap
11075 - description: RBD Mirroring Pool Mode Management API
11076 name: RbdMirroringPoolMode
11077 - description: RBD Mirroring Pool Peer Management API
11078 name: RbdMirroringPoolPeer
11079 - description: RBD Mirroring Summary Management API
11080 name: RbdMirroringSummary
11081 - description: RBD Namespace Management API
11083 - description: RBD Snapshot Management API
11085 - description: RBD Trash Management API
11087 - description: Feedback API
11089 - description: RGW Bucket Management API
11091 - description: RGW Daemon Management API
11093 - description: Rgw Mirroring Perf Counters Management API
11094 name: RgwMirrorPerfCounter
11095 - description: Rgw Perf Counters Management API
11096 name: RgwPerfCounter
11097 - description: RGW Site Management API
11099 - description: RGW User Management API
11101 - description: Role Management API
11103 - description: Service Management API
11105 - description: Settings Management API
11107 - description: Get Ceph Summary Details
11109 - description: Task Management API
11111 - description: Tcmu Runner Perf Counters Management API
11112 name: TcmuRunnerPerfCounter
11113 - description: Display Telemetry Report
11115 - description: Display User Details
11117 - description: Change User Password
11118 name: UserChangePassword
11119 - description: Get User Password Policy Details
11120 name: UserPasswordPolicy