Skip to content

Ceph

proxmox ceph --help

Input:

proxmox ceph --help

Output:

 Usage: proxmox ceph [OPTIONS] COMMAND [ARGS]...                                

 Browse Proxmox Ceph cluster, monitors, managers, OSDs, pools, and logs (PVE    
 only, read-only).                                                              

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ status    Show Ceph cluster-wide health and status.                          │
│ metadata  Show Ceph cluster metadata (versions, daemons summary).            │
│ flags     List Ceph cluster-wide flags.                                      │
│ flag      Show a single Ceph flag by name.                                   │
│ monitors  List Ceph monitors on a node.                                      │
│ managers  List Ceph managers on a node.                                      │
│ mds       List Ceph metadata servers on a node.                              │
│ osds      List Ceph OSDs on a node.                                          │
│ osd       Show a single Ceph OSD on a node.                                  │
│ pools     List Ceph pools on a node.                                         │
│ pool      Show a single Ceph pool on a node.                                 │
│ fs        List CephFS filesystems on a node.                                 │
│ rules     List CRUSH rules on a node.                                        │
│ log       Show recent Ceph log lines on a node.                              │
│ tui       Launch the Proxmox TUI rooted on Ceph paths.                       │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.721


proxmox ceph flag --help

Input:

proxmox ceph flag --help

Output:

 Usage: proxmox ceph flag [OPTIONS] NAME                                        

 Show a single Ceph flag by name.                                               

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    name      TEXT  Flag name (e.g. noout, nodown, pause). [required]       │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.724


proxmox ceph flags --help

Input:

proxmox ceph flags --help

Output:

 Usage: proxmox ceph flags [OPTIONS]                                            

 List Ceph cluster-wide flags.                                                  

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.743


proxmox ceph fs --help

Input:

proxmox ceph fs --help

Output:

 Usage: proxmox ceph fs [OPTIONS] NODE                                          

 List CephFS filesystems on a node.                                             

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    node      TEXT  Proxmox node name. [required]                           │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.737


proxmox ceph log --help

Input:

proxmox ceph log --help

Output:

 Usage: proxmox ceph log [OPTIONS] NODE                                         

 Show recent Ceph log lines on a node.                                          

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    node      TEXT  Proxmox node name. [required]                           │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --limit     -l      INTEGER  Max log lines to return.                        │
│ --start             INTEGER  Starting offset (0-based).                      │
│ --output    -o      TEXT     Output format.                                  │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                       Show this message and exit.                     │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.745


proxmox ceph managers --help

Input:

proxmox ceph managers --help

Output:

 Usage: proxmox ceph managers [OPTIONS] NODE                                    

 List Ceph managers on a node.                                                  

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    node      TEXT  Proxmox node name. [required]                           │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.736


proxmox ceph mds --help

Input:

proxmox ceph mds --help

Output:

 Usage: proxmox ceph mds [OPTIONS] NODE                                         

 List Ceph metadata servers on a node.                                          

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    node      TEXT  Proxmox node name. [required]                           │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.758


proxmox ceph metadata --help

Input:

proxmox ceph metadata --help

Output:

 Usage: proxmox ceph metadata [OPTIONS]                                         

 Show Ceph cluster metadata (versions, daemons summary).                        

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.736


proxmox ceph monitors --help

Input:

proxmox ceph monitors --help

Output:

 Usage: proxmox ceph monitors [OPTIONS] NODE                                    

 List Ceph monitors on a node.                                                  

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    node      TEXT  Proxmox node name. [required]                           │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.725


proxmox ceph osd --help

Input:

proxmox ceph osd --help

Output:

 Usage: proxmox ceph osd [OPTIONS] NODE OSDID                                   

 Show a single Ceph OSD on a node.                                              

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    node       TEXT  Proxmox node name. [required]                          │
│ *    osdid      TEXT  OSD id (numeric). [required]                           │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.732


proxmox ceph osds --help

Input:

proxmox ceph osds --help

Output:

 Usage: proxmox ceph osds [OPTIONS] NODE                                        

 List Ceph OSDs on a node.                                                      

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    node      TEXT  Proxmox node name. [required]                           │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.741


proxmox ceph pool --help

Input:

proxmox ceph pool --help

Output:

 Usage: proxmox ceph pool [OPTIONS] NODE NAME                                   

 Show a single Ceph pool on a node.                                             

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    node      TEXT  Proxmox node name. [required]                           │
│ *    name      TEXT  Pool name. [required]                                   │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.735


proxmox ceph pools --help

Input:

proxmox ceph pools --help

Output:

 Usage: proxmox ceph pools [OPTIONS] NODE                                       

 List Ceph pools on a node.                                                     

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    node      TEXT  Proxmox node name. [required]                           │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.737


proxmox ceph rules --help

Input:

proxmox ceph rules --help

Output:

 Usage: proxmox ceph rules [OPTIONS] NODE                                       

 List CRUSH rules on a node.                                                    

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    node      TEXT  Proxmox node name. [required]                           │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                                                                       │
│ --yaml                                                                       │
│ --markdown                                                                   │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.725


proxmox ceph status --help

Input:

proxmox ceph status --help

Output:

 Usage: proxmox ceph status [OPTIONS]                                           

 Show Ceph cluster-wide health and status.                                      

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output    -o      TEXT  Output format.                                     │
│ --json                    Shortcut for --output json                         │
│ --yaml                    Shortcut for --output yaml                         │
│ --markdown                Shortcut for --output markdown                     │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.719


proxmox ceph tui --help

Input:

proxmox ceph tui --help

Output:

 Usage: proxmox ceph tui [OPTIONS] [MODE]                                       

 Launch the Proxmox TUI rooted on Ceph paths.                                   

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│   mode      [MODE]  Optional mode. Use 'mock' to run against the in-memory   │
│                     mock backend.                                            │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --path  -p      TEXT  Initial API path to load (must be a Ceph path).        │
│                       [default: /cluster/ceph/status]                        │
│ --help                Show this message and exit.                            │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.719