disk

---

disk

Conditions: !smips
Type: Directory

Flag	Name	Description
X	disabled	disabled
A	acquired	acquired
E	empty	empty
B	block-device	block-device
M	mounted	mounted
F	formatting	formatting
S	swap-enabled	swap-enabled
f	raid-member-failed	raid-member-failed
r	raid-member	raid-member
c	encrypted	encrypted
g	guid-partition-table	guid-partition-table
p	partition	partition
t	nvme-tcp-export	nvme-tcp-export
i	iscsi-export	iscsi-export
s	smb-sharing	smb-sharing
n	nfs-sharing	nfs-sharing
m	media-sharing	media-sharing
L	self-encrypted-and-locked	self-encrypted-and-locked
O	self-encryption-enabled	tcg-opal-self-encryption-enabled
o	self-encryption-supported	tcg-opal-self-encryption-supported

Argument	Type	Description
type ( mandatory )	enum (raid | nvme-tcp | iscsi | nfs | smb | partition | tmpfs | ramdisk | crypted | sshfs | file | hardware)
slot	string
parent	enum ()
mount-point-template	string
mount-filesystem	bool
mount-read-only	bool
compress	bool
partition-number	num
partition-offset	num
partition-size	num
raid-type (syscap=storage)	enum (0 | 1 | 4 | 5 | 6 | linear | faulty)
raid-device-count (syscap=storage)	num { }
raid-max-component-size (syscap=storage)	num { }
raid-chunk-size (syscap=storage)	enum (64K | 128K | 256K | 512K | 1M | 2M | 4M)
raid-master (syscap=storage)	enum (none)
raid-role (syscap=storage)	num { }
raid-member-failed (syscap=storage)	bool { }
nvme-tcp-export (syscap=storage)	bool
nvme-tcp-server-port (syscap=storage)	num { }
nvme-tcp-server-nqn (syscap=storage)	string { }
nvme-tcp-server-allow-host-name (syscap=storage)	string { }
nvme-tcp-server-password (syscap=storage)	string { }
nvme-tcp-address (syscap=storage)	ipAddr { }
nvme-tcp-nqn (syscap=storage)	string { }
nvme-tcp-host-name (syscap=storage)	string { }
nvme-tcp-password (syscap=storage)	string { }
nvme-tcp-port (syscap=storage)	num { }
iscsi-export (syscap=storage)	bool
iscsi-server-port (syscap=storage)	num { }
iscsi-server-iqn (syscap=storage)	string { }
iscsi-port (syscap=storage)	num { }
iscsi-address (syscap=storage)	ipAddr { }
iscsi-iqn (syscap=storage)	string { }
nfs-sharing (syscap=storage)	bool
nfs-address (syscap=storage)	ipAddr { }
nfs-share (syscap=storage)	string { }
smb-sharing	bool
smb-server-user	enum ()
smb-server-password	string { }
smb-server-encryption	bool { }
smb-address	ipAddr { }
smb-share	string { }
smb-user	string { }
smb-password	string { }
smb-encryption	bool { }
media-sharing	bool
media-interface	interface_enum { none:nv::BADID }
tmpfs-max-size	num { }
ramdisk-size (syscap=storage)	num { }
crypted-backend (syscap=storage)	enum (none)
encryption-key (syscap=storage)	string { }
self-encryption-password (syscap=storage)	string
sshfs-address	string { }
sshfs-port	num { }
sshfs-user	string { }
sshfs-password	string { }
sshfs-path	string { }
swap	bool
file-path	file_enum { }
file-size	num { }
file-offset	num { }

Read-only Argument	Type	Description
slot-default	string
fs-label	string
fs-uuid	string
fs	enum (fat32 | ext4 | btrfs | xfs | nfs | smb | wipe | wipe-quick | tmpfs | exfat | ntfs | sshfs | squashfs | iso | discard | discard-secure | -)
model	string
serial	string
fw-version	string
size	num
free	num
total-inodes	num
free-inodes	num
use	num
mount-point	string
sector-size	num
interface	string
interface-speed	num
raid-member-state (syscap=storage)	string
state	string
raid-uuid (syscap=storage)	string
nvme-tcp-server-secret (syscap=storage)	string { }
nvme-tcp-secret (syscap=storage)	string { }
sshfs-local-user	string { }
io-ops	num
io-errors	num
read-ops	num
read-ops-per-second	num
read-bytes	num
read-rate	num
read-merges	num
read-time	time
write-ops	num
write-ops-per-second	num
write-bytes	num
write-rate	num
write-merges	num
write-time	time
in-flight-ops	num
active-time	time
wait-time	time
discard-ops	num
discard-bytes	num
discard-merges	num
discard-time	time
flush-ops	num
flush-time	time
temperature	num
temperatures	multi_arg { array-id, num }
critical-warning	ubit (spare-space, temperature, reliability-degraded, read-only, volatile-backup-failed)
available-spare	num
available-spare-threshold	num
percentage-used	num
host-read-bytes	num
host-write-bytes	num
host-read-cmds	num
host-write-cmds	num
controller-busy-time	time
power-cycles	num
power-on-time	time
unsafe-shutdowns	num
unrecovered-integrity-errors	num
warning-temperature	num
warning-temperature-time	time
critical-temperature	num
critical-temperature-time	time

disk/format

Conditions: !smips
Type: Command

Argument	Type	Description
file-system	enum (fat32 | ext4 | btrfs | xfs | wipe | wipe-quick | exfat | discard | discard-secure)
label	string
mbr-partition-table	bool

Read-only Argument	Type	Description
output	string

disk/smart-info

Conditions: !smips
Syscap: storage
Type: Command

Read-only Argument	Type	Description
output	string

disk/check

Conditions: !smips
Syscap: storage
Type: Command

Read-only Argument	Type	Description
output	string

disk/repair

Conditions: !smips
Syscap: storage
Type: Command

Read-only Argument	Type	Description
output	string

disk/copy

Conditions: !smips
Type: Command

Argument	Type	Description
src	enum
dst	enum
src-offset	num
dst-offset	num
size	num

Read-only Argument	Type	Description
status	string

disk/eject

Conditions: !smips
Type: Command

disk/trim

Conditions: !smips
Type: Command

disk/raid-scrub

Conditions: !smips
Syscap: storage
Type: Command

disk/raid-scrub-cancel

Conditions: !smips
Syscap: storage
Type: Command

disk/scan

Conditions: !smips
Type: Command

disk/nvme-discover

Conditions: !smips
Syscap: storage
Type: Command

Argument	Type	Description
address	ipAddr
port	num
host-name	string

Read-only Argument	Type	Description
nqn	string

disk/blink

Conditions: !smips
Type: Command

Argument	Type	Description
slots	multi_arg { array-id, enum }

disk/monitor-traffic

Conditions: !smips
Type: Command

Read-only Argument	Type	Description
io-ops	num
io-errors	num
slot	string
read-ops	num
read-ops-per-second	num
read-bytes	num
read-rate	num
read-merges	num
read-time	time
write-ops	num
write-ops-per-second	num
write-bytes	num
write-rate	num
write-merges	num
write-time	time
in-flight-ops	num
active-time	time
wait-time	time
discard-ops	num
discard-bytes	num
discard-merges	num
discard-time	time
flush-ops	num
flush-time	time

disk/reset-counters

Conditions: !smips
Type: Command

disk/settings

Conditions: !smips
Type: Settings Directory

Argument	Type	Description
default-mount-point-template	string
auto-smb-sharing	bool
auto-smb-user	enum
auto-media-sharing	bool
auto-media-interface	interface_enum { none:nv::BADID }

disk/test

Conditions: !smips
Type: Command

Flag	Name	Description
N	initializing	initializing
R	running	running
F	failed	failed

Argument	Type	Description
disk	multi_arg { array-id, enum }
block-size	num
thread-count	num
direction	enum (read | write)
type	enum (device | filesystem)
pattern	enum (sequential | random)
entries-to-show	num

Read-only Argument	Type	Description
seq	enum (TOT)
rate	num
iops	num
bytes	num
disk	enum (TOT)
thread	enum (TOT)
type	enum (device | filesystem)
pattern	enum (sequential | random)
dir	enum (read | write)
bsize	num
state	string

disk/btrfs

Conditions: !smips
Syscap: storage
Type: Directory

disk/btrfs/filesystem

Conditions: !smips
Syscap: storage
Type: Directory

Flag	Name	Description
I	missing-devs	missing-devs
b	balancing	balancing
r	replacing	replacing
s	scrubbing	scrubbing

Argument	Type	Description
label	string
default-subvolume	enum

Read-only Argument	Type	Description
uuid	string
total-devs	num
dev-ids	multi_arg { array-id, num }
devs	multi_arg { array-id, enum }
spaces	multi_arg { array-id, string }
balance-status	string
replace-status	string
scrub-status	string
write-errors	multi_arg { num }
read-errors	multi_arg { num }
flush-errors	multi_arg { num }
corruption-errors	multi_arg { num }
generation-errors	multi_arg { num }

disk/btrfs/filesystem/add-device

Conditions: !smips
Type: Command

Argument	Type	Description
device	enum

disk/btrfs/filesystem/remove-device

Conditions: !smips
Type: Command

Argument	Type	Description
device	enum
device-id	num

disk/btrfs/filesystem/replace-device

Conditions: !smips
Type: Command

Argument	Type	Description
device-to-remove	enum
device-to-remove-id	num
device-to-add	enum

disk/btrfs/filesystem/replace-cancel

Conditions: !smips
Type: Command

disk/btrfs/filesystem/balance-start

Conditions: !smips
Type: Command

Argument	Type	Description
data-profile	enum ()
metadata-profile	enum ()
system-profile	enum ()
data-usage	range_arg
metadata-usage	range_arg
system-usage	range_arg

disk/btrfs/filesystem/balance-cancel

Conditions: !smips
Type: Command

disk/btrfs/filesystem/scrub-start

Conditions: !smips
Type: Command

disk/btrfs/filesystem/scrub-cancel

Conditions: !smips
Type: Command

disk/btrfs/filesystem/reset-counters

Conditions: !smips
Type: Command

disk/btrfs/subvolume

Conditions: !smips
Syscap: storage
Type: Directory

Flag	Name	Description
*	default	default
S	snapshot	snapshot
r	read-only	read-only
D	dead	dead
M	mounted	mounted

Argument	Type	Description
fs ( mandatory )	enum
parent	enum
name	string
read-only	bool
mount	bool
mountpoint	string

Read-only Argument	Type	Description
top-level	enum
fullname	string
uuid	string
received-uuid	string
creation-time	date_arg
subvolume-id	num
generation	num
dead	bool
snapshot	bool
send-trans-id	num
send-time	date_arg
recv-trans-id	num
recv-time	date_arg
snapshots	multi_arg { array-id, enum }
path	string

disk/btrfs/transfer

Conditions: !smips
Syscap: storage
Type: Directory

Argument	Type	Description
type ( mandatory )	enum (receive | send)
fs	enum
send-parent	enum
send-subvolumes	multi_arg { array-id, enum }
file	file_enum
ssh-address	string
ssh-receive-mount	string
ssh-port	num
ssh-user	string

Read-only Argument	Type	Description
bytes	num
status	string