PoseidonOS Command Line Interface (1.0.0-202201261) Syntax

Letter

ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
Letter = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" ;

Items referencing Letter:

Digit

0123456789
Digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;

Items referencing Digit:

Number

Number = Digit , { Digit } ;

Items referencing Number:

Number is referencing:

Symbol

[]{}()<>=|.,;
Symbol = "[" | "]" | "{" | "}" | "(" | ")" | "<" | ">" | "=" | "|" | "." | "," | ";" ;

Identifier

Identifier = Letter , { Letter | Digit | "-" | "_" } ;

Items referencing Identifier:

Identifier is referencing:

BooleanValue

truefalse
BooleanValue = "true" | "false" ;

Items referencing BooleanValue:

ArrayName

ArrayName = Identifier ;

Items referencing ArrayName:

ArrayName is referencing:

DeviceName

DeviceName = Identifier ;

Items referencing DeviceName:

DeviceName is referencing:

DeviceType

urampram
DeviceType = "uram" | "pram" ;

Items referencing DeviceType:

DeviceNameList

DeviceNameList = DeviceName , { "," , DeviceName } ;

Items referencing DeviceNameList:

DeviceNameList is referencing:

VolumeName

VolumeName = Identifier ;

Items referencing VolumeName:

VolumeName is referencing:

VolumeNameList

VolumeNameList = VolumeName , { "," , VolumeName } ;

Items referencing VolumeNameList:

VolumeNameList is referencing:

TargetNVMSubsystemNVMeQualifiedName

TargetNVMSubsystemNVMeQualifiedName = Identifier ;

Items referencing TargetNVMSubsystemNVMeQualifiedName:

TargetNVMSubsystemNVMeQualifiedName is referencing:

TransportServiceId

TransportServiceId = Identifier ;

Items referencing TransportServiceId:

TransportServiceId is referencing:

TargetAddress

TargetAddress = Identifier ;

Items referencing TargetAddress:

TargetAddress is referencing:

SerialNumber

SerialNumber = Identifier ;

Items referencing SerialNumber:

SerialNumber is referencing:

ModelNumber

ModelNumber = Identifier ;

Items referencing ModelNumber:

ModelNumber is referencing:

MaxNamespaces

MaxNamespaces = Number ;

Items referencing MaxNamespaces:

MaxNamespaces is referencing:

TransportType

TransportType = Identifier ;

Items referencing TransportType:

TransportType is referencing:

BufCacheSize

BufCacheSize = Number ;

Items referencing BufCacheSize:

BufCacheSize is referencing:

NumSharedBuffers

NumSharedBuffers = Number ;

Items referencing NumSharedBuffers:

NumSharedBuffers is referencing:

RaidType

RAID5raid5RAID0raid0RAID10raid10
RaidType = [ "RAID5" | "raid5" | "RAID0" | "raid0" | "RAID10" | "raid10" ] ;

Items referencing RaidType:

SubsystemNQN

SubsystemNQN = Letter , { Letter | Digit | "-" | "_" } ;

Items referencing SubsystemNQN:

SubsystemNQN is referencing:

VolumeSize

NumberBKKiBKBGGiBGBTTiBTBPPiBPBEEiBEB
VolumeSize = Number , ( "B" | "K" | "KiB" | "KB" | "G" | "GiB" | "GB" | "T" | "TiB" | "TB" | "P" | "PiB" | "PB" | "E" | "EiB" | "EB" ) ;

Items referencing VolumeSize:

VolumeSize is referencing:

IOPS

IOPS = Number ;

Items referencing IOPS:

IOPS is referencing:

Bandwidth

NumberMB/s
Bandwidth = Number , "MB/s" ;

Items referencing Bandwidth:

Bandwidth is referencing:

ApplicationName

poseidonos-cli
ApplicationName = "poseidonos-cli" ;

Items referencing ApplicationName:

Cmd

poseidonos-cliApplicationNamearraymount--array-name-aLetterLetterDigit-_IdentifierArrayNameMountArrayCmdunmount--array-name-aArrayName--forceUnmountArrayCmdlist--array-name-aArrayNameListArrayCmdaddspare--spare-sIdentifierDeviceName--array-name-aArrayNameAddSpareCmdrmspare--spare-sDeviceName--array-name-aArrayName--forceRemoveSpareCmddelete--array-name-aArrayName--forceDeleteArrayCmdcreate--array-name-aArrayName--buffer-bDeviceName--data-devs-dDeviceName,DeviceNameList--spare-sDeviceName--raidRAID5raid5RAID0raid0RAID10raid10RaidType--no-bufferCreateArrayCmdautocreate--array-name-aArrayName--buffer-bDeviceName--num-data-devs-dDigitNumber--num-spare-sNumber--raidRaidType--no-bufferAutoCreateArrayCmdArrayCmdvolumecreate--volume-name-vIdentifierVolumeName--array-name-aArrayName--sizeNumberBKKiBKBGGiBGBTTiBTBPPiBPBEEiBEBVolumeSize--maxiopsNumberIOPS--maxbwNumberMB/sBandwidthVolumeCreateCmddelete--volume-name-vVolumeName--array-name-aArrayName--forceVolumeDeleteCmdmount--volume-name-vVolumeName--array-name-aArrayName--subnqnIdentifierTargetNVMSubsystemNVMeQualifiedName--trtype-tIdentifierTransportType--traddr-iIdentifierTargetAddress--trsvcid-pIdentifierTransportServiceId--forceVolumeMountCmdmount--volume-name-vVolumeName--subnqn-qLetterLetterDigit-_SubsystemNQN--array-name-aArrayName--trtype-tTransportType--traddr-iTargetAddress--trsvcid-pTransportServiceIdVolumeMountWithSubsystemCmdunmount--volume-name-vVolumeName--array-name-aArrayName--forceVolumeUnmountCmdlist--array-name-aArrayName--volume-name-vVolumeNameVolumeListCmdrename--volume-name-vVolumeName--new-volume-name-nVolumeName--array-name-aArrayNameVolumeRenameCmdVolumeCmddevicecreate--device-name-dDeviceName--num-blocksDigit--block-sizeDigit--device-typeDeviceTypeCreateDeviceCmdscanScanDeviceCmdlistListDeviceCmdsmart-log--device-name-dDeviceNameSMARTLOGCmdDeviceCmdsystemstartStartSystemCmdstop--forceStopSystemCmdinfoSystemInfoCmdset-property--rebuild-impacthighlowSetSystemPropertyCmdSystemCmdloggerset-level--levelLogLevelSetLogLevelCmdget-levelGetLogLevelCmdapply-filterApplyLogFilterCmdinfoLoggerInfoCmdset-preference--log-jsonBooleanValueSetPreferenceCmdLoggerCmdsubsystemcreate--subnqn-qSubsystemNQN--serial-numberIdentifierSerialNumber--model-numberIdentifierModelNumber--max-namespaces-mNumberMaxNamespaces--allow-any-host-o--ana-reporting-rCreateSubsystemCmddelete--subnqn-qSubsystemNQN--forceDeleteSubsystemCmdlist--subnqn-qSubsystemNQNListSubsystemCmdadd-listener--subnqn-qSubsystemNQN--trtype-tTransportType--traddr-iTargetAddress--trsvcid-pTransportServiceIdAddListenerCmdcreate-transport--trtype-tTransportType--buf-cache-size-cNumberBufCacheSize--num-shared-bufNumberNumSharedBuffersCreateTransportCmdSubsystemCmdqoscreate--volume-name-vVolumeName,VolumeNameList--array-name-aArrayName--miniopsIOPS--maxiopsIOPS--minbwBandwidth--maxbwBandwidthQosVolumePolicyCmdreset--volume-name-vVolumeNameList--array-name-aArrayNameQosVolumeResetCmdlist--volume-name-vVolumeNameList--array-name-aArrayNameQosListCmdQosCmdtelemetryTelemetryCmdstartTelemetryStartCmdTelemetryCmdstopTelemetryStopCmdTelemetryCmddevelresetmbrResetMbrCmdstop-rebuilding--array-name-aArrayNameStopRebuildingCmdupdate-event-wrr--nameflushfe_rebuildrebuildgc--weight123UpdateEventWrrCmdreset-event-wrrResetEventWrrCmdDevelCmd
Cmd = ApplicationName , ( ArrayCmd | VolumeCmd | DeviceCmd | SystemCmd | LoggerCmd | SubsystemCmd | QosCmd | TelemetryCmd | DevelCmd ) ;

Cmd is referencing:

ArrayCmd

ArrayCmd = "array" , ( MountArrayCmd | UnmountArrayCmd | ListArrayCmd | AddSpareCmd | RemoveSpareCmd | DeleteArrayCmd | CreateArrayCmd | AutoCreateArrayCmd ) ;

Items referencing ArrayCmd:

ArrayCmd is referencing:

MountArrayCmd

mount--array-name-aArrayName
MountArrayCmd = "mount" , ( "--array-name" | "-a" ) , ArrayName ;

Items referencing MountArrayCmd:

MountArrayCmd is referencing:

UnmountArrayCmd

unmount--array-name-aArrayName--force
UnmountArrayCmd = "unmount" , ( "--array-name" | "-a" ) , ArrayName , [ "--force" ] ;

Items referencing UnmountArrayCmd:

UnmountArrayCmd is referencing:

ListArrayCmd

list--array-name-aArrayName
ListArrayCmd = "list" , [ ( "--array-name" | "-a" ) , ArrayName ] ;

Items referencing ListArrayCmd:

ListArrayCmd is referencing:

AddSpareCmd

addspare--spare-sDeviceName--array-name-aArrayName
AddSpareCmd = "addspare" , ( "--spare" | "-s" ) , DeviceName , ( "--array-name" | "-a" ) , ArrayName ;

Items referencing AddSpareCmd:

AddSpareCmd is referencing:

RemoveSpareCmd

rmspare--spare-sDeviceName--array-name-aArrayName--force
RemoveSpareCmd = "rmspare" , ( "--spare" | "-s" ) , DeviceName , ( "--array-name" | "-a" ) , ArrayName , [ "--force" ] ;

Items referencing RemoveSpareCmd:

RemoveSpareCmd is referencing:

DeleteArrayCmd

delete--array-name-aArrayName--force
DeleteArrayCmd = "delete" , ( "--array-name" | "-a" ) , ArrayName , [ "--force" ] ;

Items referencing DeleteArrayCmd:

DeleteArrayCmd is referencing:

CreateArrayCmd

create--array-name-aArrayName--buffer-bDeviceName--data-devs-dDeviceNameList--spare-sDeviceName--raidRaidType--no-buffer
CreateArrayCmd = "create" , ( "--array-name" | "-a" ) , ArrayName , ( "--buffer" | "-b" ) , DeviceName , ( "--data-devs" | "-d" ) , DeviceNameList , [ ( "--spare" | "-s" ) , DeviceName ] , [ "--raid" , RaidType ] , [ "--no-buffer" ] ;

Items referencing CreateArrayCmd:

CreateArrayCmd is referencing:

AutoCreateArrayCmd

autocreate--array-name-aArrayName--buffer-bDeviceName--num-data-devs-dNumber--num-spare-sNumber--raidRaidType--no-buffer
AutoCreateArrayCmd = "autocreate" , ( "--array-name" | "-a" ) , ArrayName , ( "--buffer" | "-b" ) , DeviceName , ( "--num-data-devs" | "-d" ) , Number , [ ( "--num-spare" | "-s" ) , Number ] , [ "--raid" , RaidType ] , [ "--no-buffer" ] ;

Items referencing AutoCreateArrayCmd:

AutoCreateArrayCmd is referencing:

VolumeCmd

VolumeCmd = "volume" , ( VolumeCreateCmd | VolumeDeleteCmd | VolumeMountCmd | VolumeMountWithSubsystemCmd | VolumeUnmountCmd | VolumeListCmd | VolumeRenameCmd ) ;

Items referencing VolumeCmd:

VolumeCmd is referencing:

VolumeCreateCmd

create--volume-name-vVolumeName--array-name-aArrayName--sizeVolumeSize--maxiopsIOPS--maxbwBandwidth
VolumeCreateCmd = "create" , ( "--volume-name" | "-v" ) , VolumeName , ( "--array-name" | "-a" ) , ArrayName , "--size" , VolumeSize , [ "--maxiops" , IOPS ] , [ "--maxbw" , Bandwidth ] ;

Items referencing VolumeCreateCmd:

VolumeCreateCmd is referencing:

VolumeDeleteCmd

delete--volume-name-vVolumeName--array-name-aArrayName--force
VolumeDeleteCmd = "delete" , ( "--volume-name" | "-v" ) , VolumeName , ( "--array-name" | "-a" ) , ArrayName , [ "--force" ] ;

Items referencing VolumeDeleteCmd:

VolumeDeleteCmd is referencing:

VolumeMountCmd

mount--volume-name-vVolumeName--array-name-aArrayName--subnqnTargetNVMSubsystemNVMeQualifiedName--trtype-tTransportType--traddr-iTargetAddress--trsvcid-pTransportServiceId--force
VolumeMountCmd = "mount" , ( "--volume-name" | "-v" ) , VolumeName , ( "--array-name" | "-a" ) , ArrayName , [ "--subnqn" , TargetNVMSubsystemNVMeQualifiedName ] , [ ( "--trtype" | "-t" ) , TransportType ] , [ ( "--traddr" | "-i" ) , TargetAddress ] , [ ( "--trsvcid" | "-p" ) , TransportServiceId ] , [ "--force" ] ;

Items referencing VolumeMountCmd:

VolumeMountCmd is referencing:

VolumeMountWithSubsystemCmd

mount--volume-name-vVolumeName--subnqn-qSubsystemNQN--array-name-aArrayName--trtype-tTransportType--traddr-iTargetAddress--trsvcid-pTransportServiceId
VolumeMountWithSubsystemCmd = "mount" , ( "--volume-name" | "-v" ) , VolumeName , ( "--subnqn" | "-q" ) , SubsystemNQN , ( "--array-name" | "-a" ) , ArrayName , ( "--trtype" | "-t" ) , TransportType , ( "--traddr" | "-i" ) , TargetAddress , ( "--trsvcid" | "-p" ) , TransportServiceId ;

Items referencing VolumeMountWithSubsystemCmd:

VolumeMountWithSubsystemCmd is referencing:

VolumeUnmountCmd

unmount--volume-name-vVolumeName--array-name-aArrayName--force
VolumeUnmountCmd = "unmount" , ( "--volume-name" | "-v" ) , VolumeName , ( "--array-name" | "-a" ) , ArrayName , [ "--force" ] ;

Items referencing VolumeUnmountCmd:

VolumeUnmountCmd is referencing:

VolumeListCmd

list--array-name-aArrayName--volume-name-vVolumeName
VolumeListCmd = "list" , ( "--array-name" | "-a" ) , ArrayName , [ ( "--volume-name" | "-v" ) , VolumeName ] ;

Items referencing VolumeListCmd:

VolumeListCmd is referencing:

VolumeRenameCmd

rename--volume-name-vVolumeName--new-volume-name-nVolumeName--array-name-aArrayName
VolumeRenameCmd = "rename" , ( "--volume-name" | "-v" ) , VolumeName , ( "--new-volume-name" | "-n" ) , VolumeName , ( "--array-name" | "-a" ) , ArrayName ;

Items referencing VolumeRenameCmd:

VolumeRenameCmd is referencing:

DeviceCmd

DeviceCmd = "device" , ( CreateDeviceCmd | ScanDeviceCmd | ListDeviceCmd | SMARTLOGCmd ) ;

Items referencing DeviceCmd:

DeviceCmd is referencing:

CreateDeviceCmd

create--device-name-dDeviceName--num-blocksDigit--block-sizeDigit--device-typeDeviceType
CreateDeviceCmd = "create" , ( "--device-name" | "-d" ) , DeviceName , [ "--num-blocks" , { Digit } ] , [ "--block-size" , { Digit } ] , [ "--device-type" , DeviceType ] ;

Items referencing CreateDeviceCmd:

CreateDeviceCmd is referencing:

ScanDeviceCmd

scan
ScanDeviceCmd = "scan" ;

Items referencing ScanDeviceCmd:

ListDeviceCmd

list
ListDeviceCmd = "list" ;

Items referencing ListDeviceCmd:

SMARTLOGCmd

smart-log--device-name-dDeviceName
SMARTLOGCmd = "smart-log" , ( "--device-name" | "-d" ) , DeviceName ;

Items referencing SMARTLOGCmd:

SMARTLOGCmd is referencing:

SystemCmd

SystemCmd = "system" , ( StartSystemCmd | StopSystemCmd | SystemInfoCmd | SetSystemPropertyCmd ) ;

Items referencing SystemCmd:

SystemCmd is referencing:

StartSystemCmd

start
StartSystemCmd = "start" ;

Items referencing StartSystemCmd:

StopSystemCmd

stop--force
StopSystemCmd = "stop" , [ "--force" ] ;

Items referencing StopSystemCmd:

SystemInfoCmd

info
SystemInfoCmd = "info" ;

Items referencing SystemInfoCmd:

SetSystemPropertyCmd

set-property--rebuild-impacthighlow
SetSystemPropertyCmd = "set-property" , [ "--rebuild-impact" , ( "high" | "low" ) ] ;

Items referencing SetSystemPropertyCmd:

LoggerCmd

LoggerCmd = "logger" , ( SetLogLevelCmd | GetLogLevelCmd | ApplyLogFilterCmd | LoggerInfoCmd | SetPreferenceCmd ) ;

Items referencing LoggerCmd:

LoggerCmd is referencing:

SetLogLevelCmd

set-level--levelLogLevel
SetLogLevelCmd = "set-level" , "--level" , LogLevel ;

Items referencing SetLogLevelCmd:

SetLogLevelCmd is referencing:

LogLevel

infodebugwarningerrorcritical
LogLevel = "info" | "debug" | "warning" | "error" | "critical" ;

Items referencing LogLevel:

GetLogLevelCmd

get-level
GetLogLevelCmd = "get-level" ;

Items referencing GetLogLevelCmd:

ApplyLogFilterCmd

apply-filter
ApplyLogFilterCmd = "apply-filter" ;

Items referencing ApplyLogFilterCmd:

LoggerInfoCmd

info
LoggerInfoCmd = "info" ;

Items referencing LoggerInfoCmd:

SetPreferenceCmd

set-preference--log-jsonBooleanValue
SetPreferenceCmd = "set-preference" , [ "--log-json" , BooleanValue ] ;

Items referencing SetPreferenceCmd:

SetPreferenceCmd is referencing:

QosCmd

QosCmd = "qos" , ( QosVolumePolicyCmd | QosVolumeResetCmd | QosListCmd ) ;

Items referencing QosCmd:

QosCmd is referencing:

QosVolumePolicyCmd

create--volume-name-vVolumeNameList--array-name-aArrayName--miniopsIOPS--maxiopsIOPS--minbwBandwidth--maxbwBandwidth
QosVolumePolicyCmd = "create" , ( "--volume-name" | "-v" ) , VolumeNameList , ( "--array-name" | "-a" ) , ArrayName , [ "--miniops" , IOPS ] , [ "--maxiops" , IOPS ] , [ "--minbw" , Bandwidth ] , [ "--maxbw" , Bandwidth ] ;

Items referencing QosVolumePolicyCmd:

QosVolumePolicyCmd is referencing:

QosVolumeResetCmd

reset--volume-name-vVolumeNameList--array-name-aArrayName
QosVolumeResetCmd = "reset" , ( "--volume-name" | "-v" ) , VolumeNameList , ( "--array-name" | "-a" ) , ArrayName ;

Items referencing QosVolumeResetCmd:

QosVolumeResetCmd is referencing:

QosListCmd

list--volume-name-vVolumeNameList--array-name-aArrayName
QosListCmd = "list" , [ ( "--volume-name" | "-v" ) , VolumeNameList ] , [ ( "--array-name" | "-a" ) , ArrayName ] ;

Items referencing QosListCmd:

QosListCmd is referencing:

SubsystemCmd

SubsystemCmd = "subsystem" , ( CreateSubsystemCmd | DeleteSubsystemCmd | ListSubsystemCmd | AddListenerCmd | CreateTransportCmd ) ;

Items referencing SubsystemCmd:

SubsystemCmd is referencing:

CreateSubsystemCmd

create--subnqn-qSubsystemNQN--serial-numberSerialNumber--model-numberModelNumber--max-namespaces-mMaxNamespaces--allow-any-host-o--ana-reporting-r
CreateSubsystemCmd = "create" , ( "--subnqn" | "-q" ) , SubsystemNQN , [ "--serial-number" , SerialNumber ] , [ "--model-number" , ModelNumber ] , [ ( "--max-namespaces" | "-m" ) , MaxNamespaces ] , [ "--allow-any-host" | "-o" ] , [ "--ana-reporting" | "-r" ] ;

Items referencing CreateSubsystemCmd:

CreateSubsystemCmd is referencing:

DeleteSubsystemCmd

delete--subnqn-qSubsystemNQN--force
DeleteSubsystemCmd = "delete" , ( "--subnqn" | "-q" ) , SubsystemNQN , [ "--force" ] ;

Items referencing DeleteSubsystemCmd:

DeleteSubsystemCmd is referencing:

ListSubsystemCmd

list--subnqn-qSubsystemNQN
ListSubsystemCmd = "list" , [ ( "--subnqn" | "-q" ) , SubsystemNQN ] ;

Items referencing ListSubsystemCmd:

ListSubsystemCmd is referencing:

AddListenerCmd

add-listener--subnqn-qSubsystemNQN--trtype-tTransportType--traddr-iTargetAddress--trsvcid-pTransportServiceId
AddListenerCmd = "add-listener" , ( "--subnqn" | "-q" ) , SubsystemNQN , ( "--trtype" | "-t" ) , TransportType , ( "--traddr" | "-i" ) , TargetAddress , ( "--trsvcid" | "-p" ) , TransportServiceId ;

Items referencing AddListenerCmd:

AddListenerCmd is referencing:

CreateTransportCmd

create-transport--trtype-tTransportType--buf-cache-size-cBufCacheSize--num-shared-bufNumSharedBuffers
CreateTransportCmd = "create-transport" , ( "--trtype" | "-t" ) , TransportType , [ ( "--buf-cache-size" | "-c" ) , BufCacheSize ] , [ "--num-shared-buf" , NumSharedBuffers ] ;

Items referencing CreateTransportCmd:

CreateTransportCmd is referencing:

TelemetryCmd

TelemetryCmd = "telemetry" , ( TelemetryStartCmd | TelemetryStopCmd ) ;

Items referencing TelemetryCmd:

TelemetryCmd is referencing:

TelemetryStartCmd

TelemetryStartCmd = TelemetryCmd , "start" ;

Items referencing TelemetryStartCmd:

TelemetryStartCmd is referencing:

TelemetryStopCmd

TelemetryStopCmd = TelemetryCmd , "stop" ;

Items referencing TelemetryStopCmd:

TelemetryStopCmd is referencing:

DevelCmd

DevelCmd = "devel" , ( ResetMbrCmd | StopRebuildingCmd | UpdateEventWrrCmd | ResetEventWrrCmd ) ;

Items referencing DevelCmd:

DevelCmd is referencing:

ResetMbrCmd

resetmbr
ResetMbrCmd = "resetmbr" ;

Items referencing ResetMbrCmd:

StopRebuildingCmd

stop-rebuilding--array-name-aArrayName
StopRebuildingCmd = "stop-rebuilding" , ( "--array-name" | "-a" ) , ArrayName ;

Items referencing StopRebuildingCmd:

StopRebuildingCmd is referencing:

UpdateEventWrrCmd

update-event-wrr--nameflushfe_rebuildrebuildgc--weight123
UpdateEventWrrCmd = "update-event-wrr" , "--name" , ( "flush" | "fe_rebuild" | "rebuild" | "gc" ) , "--weight" , ( "1" | "2" | "3" ) ;

Items referencing UpdateEventWrrCmd:

ResetEventWrrCmd

reset-event-wrr
ResetEventWrrCmd = "reset-event-wrr" ;

Items referencing ResetEventWrrCmd: