How to run ydb-dstool from package

Install ydb-dstool package

Set up environment and run

How to run ydb-dstool from source

Clone ydb repository

Install grpctools python package

Compile proto files for python

Set up environment and run

How to build and upload ydb-dstool package

How to do things with ydb-dstool

Get available commands

Get help for a particular subset of commands or a command

Make command operation verbose

Don't show non-vital messages

Run command without side effects

Handle errors

Set endpoint

Set authentication token

Set output format

Exclude header from the output

Output all available columns

Output only certain columns

Sort output by certain columns

Output in a human-readable way

Do things with storage devices

List devices

Do things with pdisks

List pdisks

Show space usage of every pdisk

Prevent new groups from using certain pdisks

Move data out from certain pdisks

Move data out from broken pdisks

Activate broken pdisks after recovery

Do things with vdisks

List vdisks

Show status of pdisks were vdisks reside

Show space usage every vdisk

Unload certain pdisks by moving some vdisks from them

Wipe certain vdisks

Remove no longer needed donor vdisks

Do things with groups

List groups

Show aggregated statuses of vdisks within group

Show space usage of every group

Check certain groups for compliance with failure model

Show space usage of groups by tablets

Show info about certain blob from a certain group

Add new groups to certain pool

Figure out whether certain number of groups can be added

Do things with pools

List pools

Show aggregated statuses of groups within pool

Show aggregated statuses of vdisks within pool

Show space usage of pools

Show estimated space usage of pools

Do things with boxes

List boxes

Show aggregated statuses of pdisks within box

Show space usage of boxes

Do things with nodes

List nodes

Do things with a cluster as a whole

Show how many cluster entities there are

Move vdisks out from overpopulated pdisks

Enable/Disable self-healing

Enable/Disable donors

Adjust scrubbing intervals

Set maximum number of simultaneously scrubbed pdisks

Stress test failure model