raid

Operations with the RAIDs.

Except for the show and import show subcommands, the commands listed in this chapter require superuser privileges.

# xicli raid <subcommand> <args> [optional_args]

Subcommands for the raid command:


create	Create the RAID.
destroy	Delete the RAID without possibility to restore the RAID and data on it.
import apply	Import (or restore) the RAID from drive metadata.
import show	Show info about the RAIDs that can be imported (restored) from the drives.
init start	Start or continue the RAID initialization.
init stop	Stop the RAID initialization.
modify	Modify the parameters of the created RAID.
recon start	Start the raid reconstruction.
recon stop	Stop the RAID reconstruction.
replace	Replace or remove the drive from the RAID.
resize	Change the RAID size.
restore	Restore the RAID from the drive metadata.
restripe continue	Continue the RAID restripe.
restripe start	Start the RAID restripe.
restripe stop	Pause the RAID restripe.
show	Show info about the RAID.
unload	Remove (unload) the RAID with possibility to restore the RAID and save data on it.

create

Create the RAID.

# xicli raid create <args> [optional_args]

Table 1. Arguments for the create subcommand
Required arguments
-n	--name	The name of the RAID. The maximum RAID name length is `28` charaters.
-l	--level	The level of the RAID: `0`, `1`, `5`, `6`, `7`, `10`, `50`, `60`, `70`, or `nm`. Tip: Use the value `7` to create RAID 7.3.
-d	--drives	The list of block devices (/dev/sd, /dev/mapper/mpath, /dev/nvme, /dev/dm-) separated by spaces.
-gs	--group_size	Only for RAIDs 50, 60, or 70. The number of drives for one RAID group of level 5, 6, or 7.3 of the appropriate RAID 50, 60, or 70. Possible values are integers from `4` to `32`.
-sc	--synd_cnt	Only for RAIDs N+M. The number of syndromes M. Possible values are integers from `4` to `32`. Additional conditions: N+M <= 64 and M <= N.
Optional arguments
-am	--adaptive_merge	Except RAIDs 0, 1, 10. Enable (`1`) or disable (`0`) the Adaptive Merge write function.
	--single_run	Except RAIDs 0, 1, 10. Use this parameter to adjust the Adaptive Merge values once at startup. After that, the values are set and do not change at system reboot. The Adaptive Merge write function is then turned off. Does not take any value. Can only be used with the --adaptive_merge parameter.
-bs	--block_size	RAID block size: `512` or `4096` bytes. The default: `4096`.
-ca	--cpu_allowed	Specify the CPUs on which the RAID will be allowed to run. Possible values: a comma-separated list of CPUs, a range of CPUs indicated by a hyphen, or the value 'all' (the RAID will run on all available CPUs). The default: all.
-inp	--init_prio	Except RAID 0. Initialization priority in %. Possible values are from `0` to `100` (maximum rate of initialization). The default: `100`.
-mwe	--merge_write_enabled	Except RAIDs 0, 1, 10. Enable (`1`) or disable (`0`) the Merge function for write operations. The default: `0`.
-mre	--merge_read_enabled	Except RAIDs 0, 1, 10. Enable (`1`) or disable (`0`) the Merge function for read operations. The default: `0`.
-mrm	--merge_read_max	Except RAIDs 0, 1, 10. Maximum wait time (in microseconds) for stripe accumulation with the Merge function enabled for read requests. Possible values: integers from `1` to `100000`. The default: `1000`.
-mrw	--merge_read_wait	Except RAIDs 0, 1, 10. Wait time (in microseconds) between read requests with the Merge function enabled. Possible values: integers from `1` to `100000`. The default: `300`.
-mwm	--merge_write_max	Except RAIDs 0, 1, 10. Maximum wait time (in microseconds) for stripe accumulation with the Merge function enabled for write requests. Possible values: integers from `1` to `100000`. The default: `1000`.
-mww	--merge_write_wait	Except RAIDs 0, 1, 10. Wait time (in microseconds) between write requests with the Merge function enabled. Possible values: integers from `1` to `100000`. The default: `300`.
-ml	--memory_limit	RAM usage limit in MiB. Possible values: `0` and integers from `1024` to `1048576`. The `0` value sets unlimited RAM usage. The default: `0`.
-rcp	--recon_prio	Except RAID 0. Reconstruction priority in %. Possible values are from `0` to `100` (maximum rate of reconstruction). The default: `100`.
-re	--resync_enabled	Except RAIDs 0, 1, 10. Enable (`1`) or disable (`0`) the Resync function. The default: `1`.
-rl	--request_limit	Number of simultaneous I/O requests on RAID. Possible values: from `0` (unlimited) to `4294967295`. The `0` value disables the restriction. The default: `0`.
-rsp	--restripe_prio	Restriping priority in %. Possible values are from `0` to `100` (maximum rate of restriping). The default: `100`.
-se	--sched_enabled	Enable (`1`) or disable (`0`) the scheduling function. The default: `0`.
-sp	--sparepool	Name of the spare pool to assign to the RAID.
-ss	--strip_size	Strip size in KiB. Possible values: `16`, `32`, `64`, `128`, or `256`. The default: `16`.
	--force_metadata	Allow overwriting metadata on disks.

destroy

Delete the RAID without possibility to restore the RAID and data on it.

# xicli raid destroy <arg>

Table 2. Arguments for the destroy subcommand
Mutually exclusive required arguments
-n	--name	The name of the RAID.
-a	--all	Delete all the xiRAID Classic RAIDs. The argument takes no value.

import apply

Import (or restore) the RAID from drive metadata.

# xicli raid import apply <arg> [optional_arg]

Table 3. Arguments for the import apply subcommand
Required argument
-id	--uuid	UUID of the RAID.
Optional argument
-nn	--new_name	The new name for the RAID.

import show

Show info about the RAIDs that can be imported (restored) from the drives.

# xicli raid import show [optional_args]

Table 4. Arguments for the import show subcommand
Optional arguments
-d	--drives	The list of block devices (/dev/sd, /dev/mapper/mpath, /dev/nvme, /dev/dm-) separated by a space to show the info. Without the argument, shows the info from all drives.
-f	--format	Output format: `table`; `json`; `prettyjson` – human-readable json. The default: `table`.
	--offline	Show non-recoverable RAIDs in the import list. The argument takes no value.

init start

Start or continue the RAID initialization.

# xicli raid init start <arg>

Table 5. Argument for the init start subcommand
Required argument
-n	--name	The name of the RAID.

init stop

Stop the RAID initialization.

# xicli raid init stop <arg>

Table 6. Argument for the init stop subcommand
Required argument
-n	--name	The name of the RAID.

modify

Modify the parameters of the created RAID.

# xicli raid modify <arg> [optional_args]

Table 7. Arguments for the modify subcommand
Required argument
-n	--name	The name of the RAID. The maximum RAID name length is `28` charaters.
Optional arguments
-am	--adaptive_merge	Except RAIDs 0, 1, 10. Enable (`1`) or disable (`0`) the Adaptive Merge write function.
	--single_run	Except RAIDs 0, 1, 10. Use this parameter to adjust the Adaptive Merge values once at startup. After that, the values are set and do not change at system reboot. The Adaptive Merge write function is then turned off. Does not take any value. Can only be used with the adaptive_merge parameter.
-ca	--cpu_allowed	Change the CPUs on which the RAID will be allowed to run. Possible values: a comma-separated list of CPUs, a range of CPUs indicated by a hyphen, or the value 'all' (the RAID will run on all available CPUs). The default: all.
-inp	--init_prio	Except RAID 0. Initialization priority in %. Possible values are from `0` to `100` (maximum rate of initialization). The default: `100`.
-mwe	--merge_write_enabled	Except RAIDs 0, 1, 10. Enable (`1`) or disable (`0`) the Merge function for write operations. The default: `0`.
-mre	--merge_read_enabled	Except RAIDs 0, 1, 10. Enable (`1`) or disable (`0`) the Merge function for read operations. The default: `0`.
-mrm	--merge_read_max	Except RAIDs 0, 1, 10. Maximum wait time (in microseconds) for stripe accumulation with the Merge function enabled for read requests. Possible values: integers from `1` to `100000`. The default: `1000`.
-mrw	--merge_read_wait	Except RAIDs 0, 1, 10. Wait time (in microseconds) between read requests with the Merge function enabled. Possible values: integers from `1` to `100000`. The default: `300`.
-mwm	--merge_write_max	Except RAIDs 0, 1, 10. Maximum wait time (in microseconds) for stripe accumulation with the Merge function enabled for write requests. Possible values: integers from `1` to `100000`. The default: `1000`.
-mww	--merge_write_wait	Except RAIDs 0, 1, 10. Wait time (in microseconds) between write requests with the Merge function enabled. Possible values: integers from `1` to `100000`. The default: `300`.
-ml	--memory_limit	RAM usage limit in MiB. Possible values: `0` and integers from `1024` to `1048576`. The `0` value sets unlimited RAM usage. The default: `0` (unlimited).
-rcp	--recon_prio	Except RAID 0. Reconstruction priority in %. Possible values: from `0` to `100` (maximum rate of reconstruction). The default: `100`.
-re	--resync_enabled	Except RAIDs 0, 1, 10. Enable (`1`) or disable (`0`) the resync function. The default: `1`.
-rl	--request_limit	Number of simultaneous I/O requests on RAID. Possible values: integers from `0` to `4294967295`. The `0` value disables the restriction. The default: `0`.
-rsp	--restripe_prio	Restriping priority in %. Possible values are from `0` to `100` (maximum rate of restriping). The default: `100`.
-se	--sched_enabled	Enable (`1`) or disable (`0`) the scheduling function. The default: `0`.
-sp	--sparepool	Name of the spare pool to assign to the RAID. The `null` value removes the spare pool from the RAID. Spare pool can not be assigned to RAID 0.
	--force_online	Change RAID state to online if the RAID has unrecoverable sections. I/O operations on unrecoverable sections may lead to data corruption. The argument takes no value.
	--force_resync	Except RAIDs 0, 1, 10. Force RAID re-initialization. The argument takes no value.

recon start

Start the RAID reconstruction.

# xicli raid recon start <arg>

Table 8. Argument for the recon start subcommand
Required argument
-n	--name	The name of the RAID.

recon stop

Stop the RAID reconstruction.

# xicli raid recon stop <arg>

Table 9. Argument for the recon stop subcommand
Required argument
-n	--name	The name of the RAID.

replace

Replace or remove the drive from the RAID.

# xicli raid replace <args>

Table 10. Arguments for the replace subcommand
Required arguments
-n	--name	The name of the RAID.
-no	--number	The number of the drive. To find out the number of the drive, use `# xicli raid show`
-d	--drive	The new block device. To remove the drive (to mark it as missing) set the `null` value.

resize

Change the RAID size.

# xicli raid resize <arg>

Table 11. Argument for the resize subcommand
Required argument
-n	--name	The name of the RAID.

restore

Restore the RAID from the current configuration file.

# xicli raid restore <arg>

Table 12. Arguments for the restore subcommand
Mutually exclusive required arguments
-n	--name	The name of the RAID.
-a	--all	Restore all available xiRAID Classic RAIDs. Argument takes no value.

restripe continue

Continue the RAID restripe.

# xicli raid restripe continue <arg>

Table 13. Argument for the restripe continue subcommand
Required argument
-n	--name	The name of the RAID.

restripe start

Start the RAID restripe.

# xicli raid restripe start <args>

Table 14. Arguments for the restripe start subcommand
Required arguments
-n	--name	The name of the RAID.
-l	--level	The new level for the RAID. If you are only increasing the RAID size, enter the current RAID level for this argument.
-gs	--group_size	Only for RAIDs 50, 60, and 70. The new group size for the RAID. Possible values: integers from `4` to `32`.
-d	--drives	The list of block devices (/dev/sd, /dev/mapper/mpath, /dev/nvme, /dev/dm-) separated by a space to add to the RAID.

restripe stop

Pause the RAID restripe.

# xicli raid restripe stop <arg>

Table 15. Argument for the restripe stop subcommand
Required argument
-n	--name	The name of the RAID.

show

Show info about the RAID.

# xicli raid show [optional_args]

Table 16. Arguments for the show subcommand
Optional arguments
-n	--name	The name of the RAID. Without the argument, show info on all xiRAID Classic RAIDs.
-o	--online	Only show RAIDs that are in the “online” state (RAIDs that were not unloaded by the raid unload command and are not offline). The argument takes no value.
-u	--units	Dimension: `s` – sectors (1 sector=512 bytes); `k` – kilobytes; `m` – megabytes; `g` – gigabytes. The default: `g`.
-f	--format	Output format: `table`; `json`; `prettyjson` – human-readable json. The default: `table`.
-e	--extended	Show extended output. The argument takes no value.

unload

Remove (unload) the RAID with possibility to restore the RAID and save data on it.

# xicli raid unload <arg>

Table 17. Arguments for the unload subcommand
Mutually exclusive required arguments
-n	--name	The name of the RAID.
-a	--all	Unload all available xiRAID Classic RAIDs. The argument takes no value.