> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xloud.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Software-Defined Storage CLI Reference

> Complete ceph CLI commands for managing Xloud XSDS — pools, OSDs, health, CRUSH maps, RBD images, and object gateway.

## Overview

Xloud Software-Defined Storage (XSDS) is powered by Ceph. Use `ceph` and `rbd` CLI commands to manage the cluster, pools, block storage images, and object gateway.

<Note>
  **Prerequisites**

  * SSH access to a Ceph monitor or admin node
  * `ceph` and `rbd` CLI tools installed (`apt install ceph-common`)
  * Ceph keyring with admin permissions: `/etc/ceph/ceph.client.admin.keyring`
</Note>

***

## Cluster Health

<CodeGroup>
  ```bash title="Cluster health summary" theme={null}
  ceph health
  ceph health detail
  ```

  ```bash title="Cluster status" theme={null}
  ceph status
  ceph -s
  ```

  ```bash title="Monitor quorum" theme={null}
  ceph quorum_status --format json | jq .quorum_names
  ```

  ```bash title="OSD tree" theme={null}
  ceph osd tree
  ```

  ```bash title="Cluster usage" theme={null}
  ceph df
  ceph df detail
  ```
</CodeGroup>

***

## Pools

<CodeGroup>
  ```bash title="List pools" theme={null}
  ceph osd pool ls
  ceph osd pool ls detail
  ```

  ```bash title="Create replicated pool" theme={null}
  ceph osd pool create volumes 128 replicated
  ceph osd pool set volumes size 3
  ```

  ```bash title="Create erasure-coded pool" theme={null}
  ceph osd pool create ec-data 64 erasure default
  ```

  ```bash title="Show pool stats" theme={null}
  ceph osd pool stats volumes
  ```

  ```bash title="Get pool parameter" theme={null}
  ceph osd pool get volumes size
  ceph osd pool get volumes crush_rule
  ```

  ```bash title="Set pool parameter" theme={null}
  ceph osd pool set volumes size 3
  ```

  ```bash title="Delete pool" theme={null}
  ceph osd pool delete volumes volumes --yes-i-really-really-mean-it
  ```
</CodeGroup>

***

## OSDs

<CodeGroup>
  ```bash title="List OSDs" theme={null}
  ceph osd ls
  ```

  ```bash title="Show OSD stats" theme={null}
  ceph osd df
  ```

  ```bash title="Mark OSD out (before removal)" theme={null}
  ceph osd out osd.3
  ```

  ```bash title="Mark OSD down" theme={null}
  ceph osd down osd.3
  ```

  ```bash title="Remove OSD" theme={null}
  ceph osd purge osd.3 --yes-i-really-mean-it
  ```

  ```bash title="Reweight OSD" theme={null}
  ceph osd reweight osd.3 0.9
  ```
</CodeGroup>

***

## RBD (Block Storage Images)

<CodeGroup>
  ```bash title="List images in pool" theme={null}
  rbd ls volumes
  ```

  ```bash title="Create image" theme={null}
  rbd create --size 50G volumes/my-image
  ```

  ```bash title="Show image info" theme={null}
  rbd info volumes/my-image
  ```

  ```bash title="Resize image" theme={null}
  rbd resize --size 100G volumes/my-image
  ```

  ```bash title="Create snapshot" theme={null}
  rbd snap create volumes/my-image@snap-1
  ```

  ```bash title="List snapshots" theme={null}
  rbd snap ls volumes/my-image
  ```

  ```bash title="Delete snapshot" theme={null}
  rbd snap rm volumes/my-image@snap-1
  ```

  ```bash title="Delete image" theme={null}
  rbd rm volumes/my-image
  ```
</CodeGroup>

***

## Object Gateway (RGW)

<CodeGroup>
  ```bash title="List buckets (admin)" theme={null}
  radosgw-admin bucket list
  ```

  ```bash title="Show bucket stats" theme={null}
  radosgw-admin bucket stats --bucket my-bucket
  ```

  ```bash title="Create RGW user" theme={null}
  radosgw-admin user create \
    --uid my-user \
    --display-name "My User" \
    --email user@example.com
  ```

  ```bash title="Show user info and keys" theme={null}
  radosgw-admin user info --uid my-user
  ```
</CodeGroup>

***

## Next Steps

<CardGroup cols={2}>
  <Card title="XSDS Architecture" href="/services/sds/admin-guide/architecture" color="#197560">
    Understand Ceph cluster components and data placement
  </Card>

  <Card title="Pool Management" href="/services/sds/admin-guide/pool-management" color="#197560">
    Create and configure Ceph storage pools
  </Card>
</CardGroup>