CLI Reference

The DirectPV commands rely on the Kubernetes command line tool, kubectl. To install kubectl on your system, see the Kubernetes documentation.

DirectPV provides a kubectl plugin for managing DirectPV drives and volumes. Use this plugin at the command line to complete all of the functions required for adding, managing, scheduling, and removing DirectPV-managed drives and volumes in a Kubernetes cluster.

Install the directpv plugin by downloading the binary for your specific architecture and moving it to the /usr/local/bin folder on your local machine:

curl --retry 10 --progress-bar -L https://dl.min.io/aistor/directpv/release/linux-amd64/kubectl-directpv_5.1.0 -o kubectl-directpv

chmod +x ./kubectl-directpv
sudo mv ./kubectl-directpv /usr/local/bin/kubectl-directpv

kubectl directpv --help

curl --retry 10 --progress-bar -L https://dl.min.io/aistor/directpv/release/linux-arm64/kubectl-directpv_5.1.0 -o kubectl-directpv

chmod +x ./kubectl-directpv
sudo mv ./kubectl-directpv /usr/local/bin/kubectl-directpv

kubectl directpv --help

curl --retry 10 --progress-bar -L https://dl.min.io/aistor/directpv/release/linux-ppc64le/kubectl-directpv_5.1.0 -o kubectl-directpv

chmod +x ./kubectl-directpv
sudo mv ./kubectl-directpv /usr/local/bin/kubectl-directpv

kubectl directpv --help

curl --retry 10 --progress-bar -L https://dl.min.io/aistor/directpv/release/darwin-amd64/kubectl-directpv_5.1.0 -o kubectl-directpv

chmod +x ./kubectl-directpv
sudo mv ./kubectl-directpv /usr/local/bin/kubectl-directpv

kubectl directpv --help

curl --retry 10 --progress-bar -L https://dl.min.io/aistor/directpv/release/darwin-arm64/kubectl-directpv_5.1.0 -o kubectl-directpv

chmod +x ./kubectl-directpv
sudo mv ./kubectl-directpv /usr/local/bin/kubectl-directpv

kubectl directpv --help

Invoke-WebRequest https://dl.min.io/aistor/directpv/release/windows-amd64/kubectl-directpv.v5.1.0.exe -OutFile C:\kubectl-directpv.exe

C:\kubectl-directpv.exe --help

kubectl directpv [command] [flags]

The following flags are available for kubectl directpv and many of the commands included with the plugin.

Many DirectPV commands support ellipsis expansion notation for specifying ranges of nodes or drives. This allows you to target multiple resources with a single pattern instead of listing each one individually.

Use three dots (...) between the start and end values inside curly braces:

Example: List drives sda through sdf on nodes node1 through node4:

kubectl directpv list drives --nodes=node{1...4} --drives=sd{a...f}

Many DirectPV commands operate on drives or volumes that you select using flags or arguments. These commands require at least one selection method to prevent accidental operations on unintended resources.

Commands typically support one or more of the following selection methods:

Not every command supports all flags. See individual command documentation for supported selection methods.

• If you do not specify a selection method, the command returns an error.
• When you specify --all, DirectPV ignores other selection flags.
• You can combine multiple selection flags to narrow results (for example, --nodes=node1 --drives=sda). DirectPV only selects resources that match all selection flags, using AND logic.

This documentation includes details for each available command on separate subpages. The available commands include:

The following commands have been removed from DirectPV. See Deprecated Commands for historical reference.