Lines Matching refs:p
38 parser.add_argument('-p', dest='port',
69 p = subparsers.add_parser('framework_start_init', help='Start initialization of subsystems')
70 p.set_defaults(func=framework_start_init)
75 p = subparsers.add_parser('framework_wait_init', help='Block until subsystems have been initialized')
76 p.set_defaults(func=framework_wait_init)
83 p = subparsers.add_parser('rpc_get_methods', help='Get list of supported RPC methods')
84 p.add_argument('-c', '--current', help='Get list of RPC methods only callable in the current state.', action='store_true')
85 p.add_argument('-i', '--include-aliases', help='include RPC aliases', action='store_true')
86 p.set_defaults(func=rpc_get_methods)
91 p = subparsers.add_parser('spdk_get_version', help='Get SPDK version')
92 p.set_defaults(func=spdk_get_version)
100 p = subparsers.add_parser('save_config', help="""Write current (live) configuration of SPDK subsystems and targets to stdout.
102 p.add_argument('-i', '--indent', help="""Indent level. Value less than 0 mean compact mode. Default indent level is 2.
104 p.add_argument('-s', '--subsystems', help="""Comma-separated list of subsystems (and their dependencies) to save""")
105 p.set_defaults(func=save_config)
111 p = subparsers.add_parser('load_config', help="""Configure SPDK subsystems and targets using JSON RPC.""")
112 p.add_argument('-i', '--include-aliases', help='include RPC aliases', action='store_true')
113 p.add_argument('-j', '--json-conf', help='Valid JSON configuration', default=sys.stdin)
114 p.set_defaults(func=load_config)
122 p = subparsers.add_parser('save_subsystem_config', help="""Write current (live) configuration of SPDK subsystem to stdout.
124 p.add_argument('-i', '--indent', help="""Indent level. Value less than 0 mean compact mode. Default indent level is 2.
126 p.add_argument('-n', '--name', help='Name of subsystem', required=True)
127 p.set_defaults(func=save_subsystem_config)
133 p = subparsers.add_parser('load_subsystem_config', help="""Configure SPDK subsystem using JSON RPC.""")
134 p.add_argument('-j', '--json-conf', help='Valid JSON configuration', default=sys.stdin)
135 p.set_defaults(func=load_subsystem_config)
142 p = subparsers.add_parser('spdk_kill_instance', help='Send signal to instance')
143 p.add_argument('sig_name', help='signal will be sent to server.')
144 p.set_defaults(func=spdk_kill_instance)
155 p = subparsers.add_parser('framework_monitor_context_switch',
157 p.add_argument('-e', '--enable', action='store_true', help='Enable context switch monitoring')
158 p.add_argument('-d', '--disable', action='store_true', help='Disable context switch monitoring')
159 p.set_defaults(func=framework_monitor_context_switch)
164 p = subparsers.add_parser(
166 p.set_defaults(func=framework_get_reactors)
177 p = subparsers.add_parser(
179 p.add_argument('name', help="Name of a scheduler")
180 p.add_argument('-p', '--period', help="Scheduler period in microseconds", type=int)
181 p.add_argument('--load-limit', help="Scheduler load limit. Reserved for dynamic scheduler", type=int)
182 p.add_argument('--core-limit', help="Scheduler core limit. Reserved for dynamic scheduler", type=int)
183 p.add_argument('--core-busy', help="Scheduler core busy limit. Reserved for dynamic scheduler", type=int)
184 p.add_argument('--mappings', help="Comma-separated list of thread:core mappings. Reserved for static scheduler")
185 p.set_defaults(func=framework_set_scheduler)
190 p = subparsers.add_parser(
192 p.set_defaults(func=framework_get_scheduler)
197 p = subparsers.add_parser(
199 p.set_defaults(func=framework_get_governor)
205 p = subparsers.add_parser('scheduler_set_options', help='Set scheduler options')
206 p.add_argument('-i', '--isolated-core-mask', help="Mask of CPU cores to isolate from scheduling change", type=str)
207 p.add_argument('-s', '--scheduling-core', help="Scheduler scheduling core. Idle threads will move to scheduling core."
209 p.set_defaults(func=scheduler_set_options)
214 p = subparsers.add_parser('framework_disable_cpumask_locks',
216 p.set_defaults(func=framework_disable_cpumask_locks)
221 p = subparsers.add_parser('framework_enable_cpumask_locks',
223 p.set_defaults(func=framework_enable_cpumask_locks)
234 p = subparsers.add_parser('bdev_set_options',
236 p.add_argument('-p', '--bdev-io-pool-size', help='Number of bdev_io structures in shared buffer pool', type=int)
237 p.add_argument('-c', '--bdev-io-cache-size', help='Maximum number of bdev_io structures cached per thread', type=int)
238 group = p.add_mutually_exclusive_group()
241 p.add_argument('--iobuf-small-cache-size', help='Size of the small iobuf per thread cache', type=int)
242 p.add_argument('--iobuf-large-cache-size', help='Size of the large iobuf per thread cache', type=int)
243 p.set_defaults(bdev_auto_examine=True)
244 p.set_defaults(func=bdev_set_options)
250 p = subparsers.add_parser('bdev_examine',
252 p.add_argument('-b', '--name', help='Name or alias of the bdev')
253 p.set_defaults(func=bdev_examine)
258 p = subparsers.add_parser('bdev_wait_for_examine',
260 p.set_defaults(func=bdev_wait_for_examine)
270 p = subparsers.add_parser('bdev_compress_create', help='Add a compress vbdev')
271 p.add_argument('-b', '--base-bdev-name', help="Name of the base bdev", required=True)
272 p.add_argument('-p', '--pm-path', help="Path to persistent memory", required=True)
273 p.add_argument('-l', '--lb-size', help="Compressed vol logical block size (optional, if used must be 512 or 4096)", type=int)
274 p.add_argument('-c', '--comp-algo', help='Compression algorithm, (deflate, lz4). Default is deflate')
275 p.add_argument('-L', '--comp-level',
280 p.set_defaults(func=bdev_compress_create)
286 p = subparsers.add_parser('bdev_compress_delete', help='Delete a compress disk')
287 p.add_argument('name', help='compress bdev name')
288 p.set_defaults(func=bdev_compress_delete)
293 p = subparsers.add_parser(
295 p.add_argument('-b', '--name', help="Name of a comp bdev. Example: COMP_Nvme0n1")
296 p.set_defaults(func=bdev_compress_get_orphans)
307 p = subparsers.add_parser('bdev_crypto_create', help='Add a crypto vbdev')
308 p.add_argument('base_bdev_name', help="Name of the base bdev")
309 p.add_argument('name', help="Name of the crypto vbdev")
310 p.add_argument('-p', '--crypto-pmd', help="Name of the crypto device driver. Obsolete, see dpdk_cryptodev_set_driver")
311 p.add_argument('-k', '--key', help="Key. Obsolete, see accel_crypto_key_create")
312 p.add_argument('-c', '--cipher', help="cipher to use. Obsolete, see accel_crypto_key_create")
313 p.add_argument('-k2', '--key2', help="2nd key for cipher AES_XTS. Obsolete, see accel_crypto_key_create", default=None)
314 p.add_argument('-n', '--key-name', help="Key name to use, see accel_crypto_key_create")
315 p.set_defaults(func=bdev_crypto_create)
321 p = subparsers.add_parser('bdev_crypto_delete', help='Delete a crypto disk')
322 p.add_argument('name', help='crypto bdev name')
323 p.set_defaults(func=bdev_crypto_delete)
332 p = subparsers.add_parser('bdev_ocf_create', help='Add an OCF block device')
333 p.add_argument('name', help='Name of resulting OCF bdev')
334 p.add_argument('mode', help='OCF cache mode', choices=['wb', 'wt', 'pt', 'wa', 'wi', 'wo'])
335 p.add_argument(
341 p.add_argument('cache_bdev_name', help='Name of underlying cache bdev')
342 p.add_argument('core_bdev_name', help='Name of underlying core bdev')
343 p.set_defaults(func=bdev_ocf_create)
349 p = subparsers.add_parser('bdev_ocf_delete', help='Delete an OCF block device')
350 p.add_argument('name', help='Name of OCF bdev')
351 p.set_defaults(func=bdev_ocf_delete)
356 p = subparsers.add_parser('bdev_ocf_get_stats', help='Get statistics of chosen OCF block device')
357 p.add_argument('name', help='Name of OCF bdev')
358 p.set_defaults(func=bdev_ocf_get_stats)
363 p = subparsers.add_parser('bdev_ocf_reset_stats', help='Reset statistics of chosen OCF block device')
364 p.add_argument('name', help='Name of OCF bdev')
365 p.set_defaults(func=bdev_ocf_reset_stats)
370 p = subparsers.add_parser('bdev_ocf_get_bdevs', help='Get list of OCF devices including unregistered ones')
371 p.add_argument('name', nargs='?', help='name of OCF vbdev or name of cache device or name of core device (optional)')
372 p.set_defaults(func=bdev_ocf_get_bdevs)
378 p = subparsers.add_parser('bdev_ocf_set_cache_mode',
380 p.add_argument('name', help='Name of OCF bdev')
381 p.add_argument('mode', help='OCF cache mode', choices=['wb', 'wt', 'pt', 'wa', 'wi', 'wo'])
382 p.set_defaults(func=bdev_ocf_set_cache_mode)
390 p = subparsers.add_parser('bdev_ocf_set_seqcutoff',
392 p.add_argument('name', help='Name of OCF cache bdev')
393 p.add_argument('-t', '--threshold', type=int,
395 p.add_argument('-c', '--promotion-count', type=int,
397 p.add_argument('-p', '--policy', choices=['always', 'full', 'never'], required=True,
399 p.set_defaults(func=bdev_ocf_set_seqcutoff)
403 p = subparsers.add_parser('bdev_ocf_flush_start',
405 p.add_argument('name', help='Name of OCF bdev')
406 p.set_defaults(func=bdev_ocf_flush_start)
410 p = subparsers.add_parser('bdev_ocf_flush_status',
412 p.add_argument('name', help='Name of OCF bdev')
413 p.set_defaults(func=bdev_ocf_flush_status)
429 p = subparsers.add_parser('bdev_malloc_create', help='Create a bdev with malloc backend')
430 p.add_argument('-b', '--name', help="Name of the bdev")
431 p.add_argument('-u', '--uuid', help="UUID of the bdev (optional)")
432 p.add_argument(
434 p.add_argument('block_size', help='Data block size for this bdev', type=int)
435 p.add_argument('-p', '--physical-block-size', help='Physical block size for this bdev.', type=int)
436 p.add_argument('-o', '--optimal-io-boundary', help="""Split on optimal IO boundary, in number of
438 p.add_argument('-m', '--md-size', type=int,
440 p.add_argument('-i', '--md-interleave', action='store_true',
442 p.add_argument('-t', '--dif-type', type=int, choices=[0, 1, 2, 3],
445 p.add_argument('-d', '--dif-is-head-of-md', action='store_true',
447 p.add_argument('-f', '--dif-pi-format', type=int, choices=[0, 1, 2],
450 p.set_defaults(func=bdev_malloc_create)
456 p = subparsers.add_parser('bdev_malloc_delete', help='Delete a malloc disk')
457 p.add_argument('name', help='malloc bdev name')
458 p.set_defaults(func=bdev_malloc_delete)
476 p = subparsers.add_parser('bdev_null_create', help='Add a bdev with null backend')
477 p.add_argument('name', help='Block device name')
478 p.add_argument('-u', '--uuid', help='UUID of the bdev (optional)')
479 p.add_argument('total_size', help='Size of null bdev in MB (int > 0). Includes only data blocks.', type=int)
480 p.add_argument('block_size', help='Data block size for this bdev.', type=int)
481 p.add_argument('-p', '--physical-block-size', help='Physical block size for this bdev.', type=int)
482 p.add_argument('-m', '--md-size', type=int,
484 p.add_argument('-t', '--dif-type', type=int, choices=[0, 1, 2, 3],
487 p.add_argument('-d', '--dif-is-head-of-md', action='store_true',
489 p.add_argument('-f', '--dif-pi-format', type=int, choices=[0, 1, 2],
492 p.set_defaults(func=bdev_null_create)
498 p = subparsers.add_parser('bdev_null_delete', help='Delete a null bdev')
499 p.add_argument('name', help='null bdev name')
500 p.set_defaults(func=bdev_null_delete)
507 p = subparsers.add_parser('bdev_null_resize',
509 p.add_argument('name', help='null bdev name')
510 p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB')
511 p.set_defaults(func=bdev_null_resize)
522 p = subparsers.add_parser('bdev_aio_create', help='Add a bdev with aio backend')
523 p.add_argument('filename', help='Path to device or file (ex: /dev/sda)')
524 p.add_argument('name', help='Block device name')
525 p.add_argument('block_size', help='Block size for this bdev', type=int, nargs='?')
526 p.add_argument("-r", "--readonly", action='store_true', help='Set this bdev as read-only')
527 p.add_argument("--fallocate", action='store_true', help='Support unmap/writezeros by fallocate')
528 p.add_argument('-u', '--uuid', help="UUID of the bdev (optional)")
529 p.set_defaults(func=bdev_aio_create)
535 p = subparsers.add_parser('bdev_aio_rescan', help='Rescan a bdev size with aio backend')
536 p.add_argument('name', help='Block device name')
537 p.set_defaults(func=bdev_aio_rescan)
543 p = subparsers.add_parser('bdev_aio_delete', help='Delete an aio disk')
544 p.add_argument('name', help='aio bdev name')
545 p.set_defaults(func=bdev_aio_delete)
554 p = subparsers.add_parser('bdev_uring_create', help='Create a bdev with io_uring backend')
555 p.add_argument('filename', help='Path to device or file (ex: /dev/nvme0n1)')
556 p.add_argument('name', help='bdev name')
557 p.add_argument('block_size', help='Block size for this bdev', type=int, nargs='?')
558 p.add_argument('-u', '--uuid', help="UUID of the bdev")
559 p.set_defaults(func=bdev_uring_create)
565 p = subparsers.add_parser('bdev_uring_rescan', help='Rescan a bdev size with uring backend')
566 p.add_argument('name', help='Block device name')
567 p.set_defaults(func=bdev_uring_rescan)
573 p = subparsers.add_parser('bdev_uring_delete', help='Delete a uring bdev')
574 p.add_argument('name', help='uring bdev name')
575 p.set_defaults(func=bdev_uring_delete)
584 p = subparsers.add_parser('bdev_xnvme_create', help='Create a bdev with xNVMe backend')
585 p.add_argument('filename', help='Path to device or file (ex: /dev/nvme0n1)')
586 p.add_argument('name', help='name of xNVMe bdev to create')
587 p.add_argument('io_mechanism', help='IO mechanism to use (ex: libaio, io_uring, io_uring_cmd, etc.)')
588 p.add_argument('-c', '--conserve-cpu', action='store_true', help='Whether or not to conserve CPU when polling')
589 p.set_defaults(func=bdev_xnvme_create)
595 p = subparsers.add_parser('bdev_xnvme_delete', help='Delete a xNVMe bdev')
596 p.add_argument('name', help='xNVMe bdev name')
597 p.set_defaults(func=bdev_xnvme_delete)
632 p = subparsers.add_parser('bdev_nvme_set_options',
634 p.add_argument('-a', '--action-on-timeout',
636 p.add_argument('-t', '--timeout-us',
638 p.add_argument('--timeout-admin-us',
640 p.add_argument('-k', '--keep-alive-timeout-ms',
642 p.add_argument('--arbitration-burst',
644 p.add_argument('--low-priority-weight',
646 p.add_argument('--medium-priority-weight',
648 p.add_argument('--high-priority-weight',
650 p.add_argument('-p', '--nvme-adminq-poll-period-us',
652 p.add_argument('-i', '--nvme-ioq-poll-period-us',
654 p.add_argument('-s', '--io-queue-requests',
656 p.add_argument('-d', '--disable-delay-cmd-submit',
659 p.add_argument('-c', '--transport-retry-count',
661 p.add_argument('-r', '--bdev-retry-count',
663 p.add_argument('-e', '--transport-ack-timeout',
666 p.add_argument('-l', '--ctrlr-loss-timeout-sec',
674 p.add_argument('-o', '--reconnect-delay-sec',
682 p.add_argument('-u', '--fast-io-fail-timeout-sec',
689 p.add_argument('-f', '--disable-auto-failback',
693 p.add_argument('--generate-uuids',
697 p.add_argument('--transport-tos',
700 p.add_argument('-m', '--nvme-error-stat', help="Enable collecting NVMe error counts.", action='store_true')
701 p.add_argument('-q', '--rdma-srq-size',
703 p.add_argument('--io-path-stat',
706 p.add_argument('--allow-accel-sequence',
709 p.add_argument('--rdma-max-cq-size',
711 p.add_argument('--rdma-cm-event-timeout-ms',
713 p.add_argument('--dhchap-digests', help='Comma-separated list of allowed DH-HMAC-CHAP digests',
715 p.add_argument('--dhchap-dhgroups', help='Comma-separated list of allowed DH-HMAC-CHAP DH groups',
717 p.add_argument('--enable-rdma-umr-per-io',
720 p.add_argument('--disable-rdma-umr-per-io',
724 p.set_defaults(func=bdev_nvme_set_options)
729 p = subparsers.add_parser('bdev_nvme_set_hotplug', help='Set hotplug options for bdev nvme type.')
730 p.add_argument('-d', '--disable', dest='enable', default=False, action='store_false', help="Disable hotplug (default)")
731 p.add_argument('-e', '--enable', dest='enable', action='store_true', help="Enable hotplug")
732 p.add_argument('-r', '--period-us',
734 p.set_defaults(func=bdev_nvme_set_hotplug)
764 p = subparsers.add_parser('bdev_nvme_attach_controller', help='Add bdevs with nvme backend')
765 p.add_argument('-b', '--name', help="Name of the NVMe controller, prefix for each bdev name", required=True)
766 p.add_argument('-t', '--trtype',
768 p.add_argument('-a', '--traddr',
770 p.add_argument('-f', '--adrfam',
772 p.add_argument('-s', '--trsvcid',
774 p.add_argument('-p', '--priority',
776 p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn')
777 p.add_argument('-q', '--hostnqn', help='NVMe-oF host subnqn')
778 p.add_argument('-i', '--hostaddr',
780 p.add_argument('-c', '--hostsvcid',
782 p.add_argument('-r', '--prchk-reftag',
784 p.add_argument('-g', '--prchk-guard',
786 p.add_argument('-e', '--hdgst',
788 p.add_argument('-d', '--ddgst',
790 p.add_argument('--fabrics-timeout', type=int, help='Fabrics connect timeout in microseconds',
792 p.add_argument('-x', '--multipath', help='Set multipath behavior (disable, failover, multipath)')
793 p.add_argument('--num-io-queues', type=int, help='Set the number of IO queues to request during initialization.')
794 p.add_argument('-l', '--ctrlr-loss-timeout-sec',
801 p.add_argument('-o', '--reconnect-delay-sec',
808 p.add_argument('-u', '--fast-io-fail-timeout-sec',
814 p.add_argument('-k', '--psk',
818 p.add_argument('-m', '--max-bdevs', type=int,
820 p.add_argument('--dhchap-key', help='DH-HMAC-CHAP key name')
821 p.add_argument('--dhchap-ctrlr-key', help='DH-HMAC-CHAP controller key name')
822 p.add_argument('-U', '--allow-unrecognized-csi', help="""Allow attaching namespaces with unrecognized command set identifiers.
825 p.set_defaults(func=bdev_nvme_attach_controller)
831 p = subparsers.add_parser(
833 p.add_argument('-n', '--name', help="Name of the NVMe controller. Example: Nvme0")
834 p.set_defaults(func=bdev_nvme_get_controllers)
847 p = subparsers.add_parser('bdev_nvme_detach_controller',
849 p.add_argument('name', help="Name of the controller")
850 p.add_argument('-t', '--trtype',
852 p.add_argument('-a', '--traddr',
854 p.add_argument('-f', '--adrfam',
856 p.add_argument('-s', '--trsvcid',
858 p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn')
859 p.add_argument('-i', '--hostaddr',
861 p.add_argument('-c', '--hostsvcid',
863 p.set_defaults(func=bdev_nvme_detach_controller)
870 p = subparsers.add_parser('bdev_nvme_reset_controller',
872 p.add_argument('name', help="Name of the NVMe controller")
873 p.add_argument('-c', '--cntlid', help="NVMe controller ID", type=int)
874 p.set_defaults(func=bdev_nvme_reset_controller)
881 p = subparsers.add_parser('bdev_nvme_enable_controller',
883 p.add_argument('name', help="Name of the NVMe controller")
884 p.add_argument('-c', '--cntlid', help="NVMe controller ID", type=int)
885 p.set_defaults(func=bdev_nvme_enable_controller)
892 p = subparsers.add_parser('bdev_nvme_disable_controller',
894 p.add_argument('name', help="Name of the NVMe controller")
895 p.add_argument('-c', '--cntlid', help="NVMe controller ID", type=int)
896 p.set_defaults(func=bdev_nvme_disable_controller)
912 p = subparsers.add_parser('bdev_nvme_start_discovery', help='Start automatic discovery')
913 p.add_argument('-b', '--name', help="Name of the NVMe controller prefix for each bdev name", required=True)
914 p.add_argument('-t', '--trtype',
916 p.add_argument('-a', '--traddr',
918 p.add_argument('-f', '--adrfam',
920 p.add_argument('-s', '--trsvcid',
922 p.add_argument('-q', '--hostnqn', help='NVMe-oF host subnqn')
923 p.add_argument('-w', '--wait-for-attach', action='store_true',
925 p.add_argument('-T', '--attach-timeout-ms', type=int,
929 p.add_argument('-l', '--ctrlr-loss-timeout-sec',
936 p.add_argument('-o', '--reconnect-delay-sec',
943 p.add_argument('-u', '--fast-io-fail-timeout-sec',
949 p.set_defaults(func=bdev_nvme_start_discovery)
954 p = subparsers.add_parser('bdev_nvme_stop_discovery', help='Stop automatic discovery')
955 p.add_argument('-b', '--name', help="Name of the service to stop", required=True)
956 p.set_defaults(func=bdev_nvme_stop_discovery)
961 p = subparsers.add_parser('bdev_nvme_get_discovery_info', help='Get information about the automatic discovery')
962 p.set_defaults(func=bdev_nvme_get_discovery_info)
967 p = subparsers.add_parser('bdev_nvme_get_io_paths', help='Display active I/O paths')
968 p.add_argument('-n', '--name', help="Name of the NVMe bdev")
969 p.set_defaults(func=bdev_nvme_get_io_paths)
976 p = subparsers.add_parser('bdev_nvme_set_preferred_path',
978 p.add_argument('-b', '--name', help='Name of the NVMe bdev', required=True)
979 p.add_argument('-c', '--cntlid', help='NVMe-oF controller ID', type=int, required=True)
980 p.set_defaults(func=bdev_nvme_set_preferred_path)
989 p = subparsers.add_parser('bdev_nvme_set_multipath_policy',
991 p.add_argument('-b', '--name', help='Name of the NVMe bdev', required=True)
992 p.add_argument('-p', '--policy', help='Multipath policy (active_passive or active_active)', required=True)
993 p.add_argument('-s', '--selector', help='Multipath selector (round_robin, queue_depth)')
994 p.add_argument('-r', '--rr-min-io',
997 p.set_defaults(func=bdev_nvme_set_multipath_policy)
1003 p = subparsers.add_parser('bdev_nvme_get_path_iostat',
1006 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: NVMe0n1", required=True)
1007 p.set_defaults(func=bdev_nvme_get_path_iostat)
1013 p = subparsers.add_parser('bdev_nvme_cuse_register',
1015 p.add_argument('-n', '--name',
1017 p.set_defaults(func=bdev_nvme_cuse_register)
1023 p = subparsers.add_parser('bdev_nvme_cuse_unregister',
1025 p.add_argument('-n', '--name',
1027 p.set_defaults(func=bdev_nvme_cuse_unregister)
1032 p = subparsers.add_parser('bdev_nvme_set_keys',
1035 p.add_argument('name', help='Name of the NVMe controller')
1036 p.add_argument('--dhchap-key', help='DH-HMAC-CHAP key name')
1037 p.add_argument('--dhchap-ctrlr-key', help='DH-HMAC-CHAP controller key name')
1038 p.set_defaults(func=bdev_nvme_set_keys)
1047 p = subparsers.add_parser('bdev_zone_block_create',
1049 p.add_argument('-b', '--name', help="Name of the zone device", required=True)
1050 p.add_argument('-n', '--base-bdev', help='Name of underlying, non-zoned bdev', required=True)
1051 p.add_argument('-z', '--zone-capacity', help='Surfaced zone capacity in blocks', type=int, required=True)
1052 p.add_argument('-o', '--optimal-open-zones', help='Number of zones required to reach optimal write speed', type=int, required=True)
1053 p.set_defaults(func=bdev_zone_block_create)
1059 p = subparsers.add_parser('bdev_zone_block_delete', help='Delete a virtual zone namespace device')
1060 p.add_argument('name', help='Virtual zone bdev name')
1061 p.set_defaults(func=bdev_zone_block_delete)
1080 p = subparsers.add_parser('bdev_rbd_register_cluster',
1082 p.add_argument('name', help="Name of the Rados cluster only known to rbd bdev")
1083 p.add_argument('--user', help="Ceph user name (i.e. admin, not client.admin)")
1084 p.add_argument('--config-param', action='append', metavar='key=value',
1086 p.add_argument('--config-file', help="The file path of the Rados configuration file")
1087 p.add_argument('--key-file', help="The file path of the Rados keyring file")
1088 p.add_argument('--core-mask', help="Set core mask for librbd IO context threads")
1089 p.set_defaults(func=bdev_rbd_register_cluster)
1094 p = subparsers.add_parser('bdev_rbd_unregister_cluster',
1096 p.add_argument('name', help='Name of the Rados Cluster only known to rbd bdev')
1097 p.set_defaults(func=bdev_rbd_unregister_cluster)
1102 p = subparsers.add_parser('bdev_rbd_get_clusters_info',
1104 p.add_argument('-b', '--name', help="Name of the registered Rados Cluster Name. Example: Cluster1")
1105 p.set_defaults(func=bdev_rbd_get_clusters_info)
1126 p = subparsers.add_parser('bdev_rbd_create', help='Add a bdev with ceph rbd backend')
1127 p.add_argument('-b', '--name', help="Name of the bdev")
1128 p.add_argument('--user', help="Ceph user name (i.e. admin, not client.admin)")
1129 p.add_argument('--config', action='append', metavar='key=value',
1131 p.add_argument('pool_name', help='rbd pool name')
1132 p.add_argument('rbd_name', help='rbd image name')
1133 p.add_argument('block_size', help='rbd block size', type=int)
1134 p.add_argument('-c', '--cluster-name', help="cluster name to identify the Rados cluster")
1135 p.add_argument('-u', '--uuid', help="UUID of the bdev")
1136 p.set_defaults(func=bdev_rbd_create)
1142 p = subparsers.add_parser('bdev_rbd_delete', help='Delete a rbd bdev')
1143 p.add_argument('name', help='rbd bdev name')
1144 p.set_defaults(func=bdev_rbd_delete)
1151 p = subparsers.add_parser('bdev_rbd_resize',
1153 p.add_argument('name', help='rbd bdev name')
1154 p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB')
1155 p.set_defaults(func=bdev_rbd_resize)
1167 p = subparsers.add_parser('bdev_delay_create',
1169 p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True)
1170 p.add_argument('-d', '--name', help="Name of the delay bdev", required=True)
1171 p.add_argument('-u', '--uuid', help='UUID of the bdev (optional)')
1172 p.add_argument('-r', '--avg-read-latency',
1174 p.add_argument('-t', '--nine-nine-read-latency',
1176 p.add_argument('-w', '--avg-write-latency',
1178 p.add_argument('-n', '--nine-nine-write-latency',
1180 p.set_defaults(func=bdev_delay_create)
1186 p = subparsers.add_parser('bdev_delay_delete', help='Delete a delay bdev')
1187 p.add_argument('name', help='delay bdev name')
1188 p.set_defaults(func=bdev_delay_delete)
1195 p = subparsers.add_parser('bdev_delay_update_latency',
1197 p.add_argument('delay_bdev_name', help='The name of the given delay bdev')
1198 p.add_argument('latency_type', help='one of: avg_read, avg_write, p99_read, p99_write. No other values accepted.')
1199 p.add_argument('latency_us', help='new latency value in microseconds.', type=int)
1200 p.set_defaults(func=bdev_delay_update_latency)
1207 p = subparsers.add_parser('bdev_error_create', help='Add bdev with error injection backend')
1208 p.add_argument('base_name', help='base bdev name')
1209 p.add_argument('--uuid', help='UUID for this bdev')
1210 p.set_defaults(func=bdev_error_create)
1216 p = subparsers.add_parser('bdev_error_delete', help='Delete an error bdev')
1217 p.add_argument('name', help='error bdev name')
1218 p.set_defaults(func=bdev_error_delete)
1224 p = subparsers.add_parser('bdev_iscsi_set_options', help='Set options for the bdev iscsi type.')
1225 p.add_argument('-t', '--timeout-sec', help="Timeout for command, in seconds, if 0, don't track timeout.", type=int)
1226 p.set_defaults(func=bdev_iscsi_set_options)
1234 p = subparsers.add_parser('bdev_iscsi_create',
1236 p.add_argument('-b', '--name', help="Name of the bdev", required=True)
1237 p.add_argument('-i', '--initiator-iqn', help="Initiator IQN", required=True)
1238 p.add_argument('--url', help="iSCSI Lun URL", required=True)
1239 p.set_defaults(func=bdev_iscsi_create)
1245 p = subparsers.add_parser('bdev_iscsi_delete', help='Delete an iSCSI bdev')
1246 p.add_argument('name', help='iSCSI bdev name')
1247 p.set_defaults(func=bdev_iscsi_delete)
1255 p = subparsers.add_parser('bdev_passthru_create', help='Add a pass through bdev on existing bdev')
1256 p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True)
1257 p.add_argument('-p', '--name', help="Name of the pass through bdev", required=True)
1258 p.add_argument('-u', '--uuid', help="UUID of the bdev")
1259 p.set_defaults(func=bdev_passthru_create)
1265 p = subparsers.add_parser('bdev_passthru_delete', help='Delete a pass through bdev')
1266 p.add_argument('name', help='pass through bdev name')
1267 p.set_defaults(func=bdev_passthru_delete)
1273 p = subparsers.add_parser('bdev_get_bdevs',
1275 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1")
1276 p.add_argument('-t', '--timeout-ms', help="""Time in ms to wait for the bdev to appear (only used
1280 p.set_defaults(func=bdev_get_bdevs)
1288 p = subparsers.add_parser('bdev_get_iostat',
1290 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1")
1291 p.add_argument('-c', '--per-channel', default=False, dest='per_channel', help='Display per channel IO stats for specified device',
1293 p.add_argument('--reset-mode', help="Mode to reset I/O statistics after getting", choices=['all', 'maxmin', 'none'])
1294 p.set_defaults(func=bdev_get_iostat)
1299 p = subparsers.add_parser('bdev_reset_iostat',
1301 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1")
1302 p.add_argument('-m', '--mode', help="Mode to reset I/O statistics", choices=['all', 'maxmin', 'none'])
1303 p.set_defaults(func=bdev_reset_iostat)
1308 p = subparsers.add_parser('bdev_enable_histogram',
1310 p.add_argument('-e', '--enable', default=True, dest='enable', action='store_true', help='Enable histograms on specified device')
1311 p.add_argument('-d', '--disable', dest='enable', action='store_false', help='Disable histograms on specified device')
1312 p.add_argument('-o', '--opc', help='Enable histogram for specified io type. Defaults to all io types if not specified.'
1314 p.add_argument('name', help='bdev name')
1315 p.set_defaults(func=bdev_enable_histogram)
1320 p = subparsers.add_parser('bdev_get_histogram',
1322 p.add_argument('name', help='bdev name')
1323 p.set_defaults(func=bdev_get_histogram)
1330 p = subparsers.add_parser('bdev_set_qd_sampling_period',
1332 p.add_argument('name', help='Blockdev name. Example: Malloc0')
1333 p.add_argument('period', help='Period with which to poll the block device queue depth in microseconds.'
1336 p.set_defaults(func=bdev_set_qd_sampling_period)
1346 p = subparsers.add_parser('bdev_set_qos_limit',
1348 p.add_argument('name', help='Blockdev name to set QoS. Example: Malloc0')
1349 p.add_argument('--rw-ios-per-sec',
1352 p.add_argument('--rw-mbytes-per-sec',
1355 p.add_argument('--r-mbytes-per-sec',
1358 p.add_argument('--w-mbytes-per-sec',
1361 p.set_defaults(func=bdev_set_qos_limit)
1373 p = subparsers.add_parser('bdev_error_inject_error', help='bdev inject error')
1374 p.add_argument('name', help="""the name of the error injection bdev""")
1375 p.add_argument('io_type', help="""io_type: 'clear' 'read' 'write' 'unmap' 'flush' 'all'""")
1376 p.add_argument('error_type', help="""error_type: 'failure' 'pending' 'corrupt_data' 'nomem'""")
1377 p.add_argument(
1379 p.add_argument(
1381 p.add_argument(
1383 p.add_argument(
1385 p.set_defaults(func=bdev_error_inject_error)
1392 p = subparsers.add_parser('bdev_nvme_apply_firmware', help='Download and commit firmware to NVMe device')
1393 p.add_argument('filename', help='filename of the firmware to download')
1394 p.add_argument('bdev_name', help='name of the NVMe device')
1395 p.set_defaults(func=bdev_nvme_apply_firmware)
1400 p = subparsers.add_parser('bdev_nvme_get_transport_statistics',
1402 p.set_defaults(func=bdev_nvme_get_transport_statistics)
1408 p = subparsers.add_parser('bdev_nvme_get_controller_health_info',
1410 p.add_argument('-c', '--name', help="Name of the NVMe bdev controller. Example: Nvme0", required=True)
1411 p.set_defaults(func=bdev_nvme_get_controller_health_info)
1440 p = subparsers.add_parser('iscsi_set_options',
1442 p.add_argument('-f', '--auth-file', help='Path to CHAP shared secret file')
1443 p.add_argument('-b', '--node-base', help='Prefix of the name of iSCSI target node')
1444 p.add_argument('-o', '--nop-timeout', help='Timeout in seconds to nop-in request to the initiator', type=int)
1445 p.add_argument('-n', '--nop-in-interval', help='Time interval in secs between nop-in requests by the target', type=int)
1446 p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled.
1448 p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required.
1450 p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true')
1451 p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session.
1453 p.add_argument('-a', '--max-sessions', help='Maximum number of sessions in the host.', type=int)
1454 p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/Os per queue.', type=int)
1455 p.add_argument('-c', '--max-connections-per-session', help='Negotiated parameter, MaxConnections.', type=int)
1456 p.add_argument('-w', '--default-time2wait', help='Negotiated parameter, DefaultTime2Wait.', type=int)
1457 p.add_argument('-v', '--default-time2retain', help='Negotiated parameter, DefaultTime2Retain.', type=int)
1458 p.add_argument('-s', '--first-burst-length', help='Negotiated parameter, FirstBurstLength.', type=int)
1459 p.add_argument('-i', '--immediate-data', help='Negotiated parameter, ImmediateData.', action='store_true')
1460 p.add_argument('-l', '--error-recovery-level', help='Negotiated parameter, ErrorRecoveryLevel', type=int)
1461 p.add_argument('-p', '--allow-duplicated-isid', help='Allow duplicated initiator session ID.', action='store_true')
1462 p.add_argument('-x', '--max-large-datain-per-connection', help='Max number of outstanding split read I/Os per connection', type=int)
1463 p.add_argument('-k', '--max-r2t-per-connection', help='Max number of outstanding R2Ts per connection', type=int)
1464 p.add_argument('-u', '--pdu-pool-size', help='Number of PDUs in the pool', type=int)
1465 p.add_argument('-j', '--immediate-data-pool-size', help='Number of immediate data buffers in the pool', type=int)
1466 p.add_argument('-z', '--data-out-pool-size', help='Number of data out buffers in the pool', type=int)
1467 p.set_defaults(func=iscsi_set_options)
1477 p = subparsers.add_parser('iscsi_set_discovery_auth',
1479 p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled.
1481 p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required.
1483 p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true')
1484 p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session.
1486 p.set_defaults(func=iscsi_set_discovery_auth)
1495 p = subparsers.add_parser('iscsi_create_auth_group',
1497 p.add_argument('tag', help='Authentication group tag (unique, integer > 0).', type=int)
1498 p.add_argument('-c', '--secrets', help="""Comma-separated list of CHAP secrets
1501 p.set_defaults(func=iscsi_create_auth_group)
1506 p = subparsers.add_parser('iscsi_delete_auth_group',
1508 p.add_argument('tag', help='Authentication group tag', type=int)
1509 p.set_defaults(func=iscsi_delete_auth_group)
1520 p = subparsers.add_parser('iscsi_auth_group_add_secret',
1522 p.add_argument('tag', help='Authentication group tag', type=int)
1523 p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True)
1524 p.add_argument('-s', '--secret', help='Secret for one-way CHAP authentication', required=True)
1525 p.add_argument('-m', '--muser', help='User name for mutual CHAP authentication')
1526 p.add_argument('-r', '--msecret', help='Secret for mutual CHAP authentication')
1527 p.set_defaults(func=iscsi_auth_group_add_secret)
1532 p = subparsers.add_parser('iscsi_auth_group_remove_secret',
1534 p.add_argument('tag', help='Authentication group tag', type=int)
1535 p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True)
1536 p.set_defaults(func=iscsi_auth_group_remove_secret)
1541 p = subparsers.add_parser('iscsi_get_auth_groups',
1543 p.set_defaults(func=iscsi_get_auth_groups)
1548 p = subparsers.add_parser('iscsi_get_portal_groups', help='Display current portal group configuration')
1549 p.set_defaults(func=iscsi_get_portal_groups)
1554 p = subparsers.add_parser('iscsi_get_initiator_groups',
1556 p.set_defaults(func=iscsi_get_initiator_groups)
1561 p = subparsers.add_parser('iscsi_get_target_nodes', help='Display target nodes')
1562 p.set_defaults(func=iscsi_get_target_nodes)
1567 p = subparsers.add_parser('iscsi_enable_histogram',
1569 p.add_argument('-e', '--enable', default=True, dest='enable', action='store_true', help='Enable histograms on specified iscsi target')
1570 p.add_argument('-d', '--disable', dest='enable', action='store_false', help='Disable histograms on specified iscsi target')
1571 p.add_argument('name', help='iscsi target name')
1572 p.set_defaults(func=iscsi_enable_histogram)
1577 p = subparsers.add_parser('iscsi_get_histogram',
1579 p.add_argument('name', help='target name')
1580 p.set_defaults(func=iscsi_get_histogram)
1607 p = subparsers.add_parser('iscsi_create_target_node', help='Add a target node')
1608 p.add_argument('name', help='Target node name (ASCII)')
1609 p.add_argument('alias_name', help='Target node alias name (ASCII)')
1610 p.add_argument('bdev_name_id_pairs', help="""Whitespace-separated list of <bdev name:LUN ID> pairs enclosed
1616 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings
1621 p.add_argument('queue_depth', help='Desired target queue depth', type=int)
1622 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node.
1624 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node.
1626 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node.
1628 p.add_argument(
1630 p.add_argument('-H', '--header-digest',
1632 p.add_argument('-D', '--data-digest',
1634 p.set_defaults(func=iscsi_create_target_node)
1643 p = subparsers.add_parser('iscsi_target_node_add_lun',
1645 p.add_argument('name', help='Target node name (ASCII)')
1646 p.add_argument('bdev_name', help="""bdev name enclosed in quotes.
1648 p.add_argument('-i', dest='lun_id', help="""LUN ID (integer >= 0)
1650 p.set_defaults(func=iscsi_target_node_add_lun)
1661 p = subparsers.add_parser('iscsi_target_node_set_auth',
1663 p.add_argument('name', help='Target node name (ASCII)')
1664 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node.
1666 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node.
1668 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node.
1670 p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.',
1672 p.set_defaults(func=iscsi_target_node_set_auth)
1684 p = subparsers.add_parser('iscsi_target_node_add_pg_ig_maps',
1686 p.add_argument('name', help='Target node name (ASCII)')
1687 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings
1692 p.set_defaults(func=iscsi_target_node_add_pg_ig_maps)
1702 p = subparsers.add_parser('iscsi_target_node_remove_pg_ig_maps',
1704 p.add_argument('name', help='Target node name (ASCII)')
1705 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings
1710 p.set_defaults(func=iscsi_target_node_remove_pg_ig_maps)
1720 p = subparsers.add_parser('iscsi_target_node_set_redirect',
1723 p.add_argument('name', help='Target node name (ASCII)')
1724 p.add_argument('pg_tag', help='Portal group tag (unique, integer > 0)', type=int)
1725 p.add_argument('-a', '--redirect-host', help='Numeric IP address for redirect portal')
1726 p.add_argument('-p', '--redirect-port', help='Numeric TCP port for redirect portal')
1727 p.set_defaults(func=iscsi_target_node_set_redirect)
1735 p = subparsers.add_parser('iscsi_target_node_request_logout',
1738 p.add_argument('name', help='Target node name (ASCII)')
1739 p.add_argument('-t', '--pg-tag', help='Portal group tag (unique, integer > 0)', type=int)
1740 p.set_defaults(func=iscsi_target_node_request_logout)
1744 for p in args.portal_list.strip().split(' '):
1745 ip, separator, port_cpumask = p.rpartition(':')
1762 p = subparsers.add_parser('iscsi_create_portal_group',
1764 p.add_argument(
1766 p.add_argument('portal_list', help="""List of portals in host:port format, separated by whitespace
1768 p.add_argument('-p', '--private', help="""Public (false) or private (true) portal group.
1772 p.add_argument('-w', '--wait', help="""Do not listening on portals until it is started explicitly.
1775 p.set_defaults(func=iscsi_create_portal_group)
1780 p = subparsers.add_parser('iscsi_start_portal_group',
1782 p.add_argument(
1784 p.set_defaults(func=iscsi_start_portal_group)
1799 p = subparsers.add_parser('iscsi_create_initiator_group',
1801 p.add_argument(
1803 p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses,
1805 p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes.
1807 p.set_defaults(func=iscsi_create_initiator_group)
1826 p = subparsers.add_parser('iscsi_initiator_group_add_initiators',
1828 p.add_argument(
1830 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses,
1833 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes.
1835 p.set_defaults(func=iscsi_initiator_group_add_initiators)
1854 p = subparsers.add_parser('iscsi_initiator_group_remove_initiators',
1856 p.add_argument(
1858 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses,
1861 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes.
1863 p.set_defaults(func=iscsi_initiator_group_remove_initiators)
1869 p = subparsers.add_parser('iscsi_delete_target_node',
1871 p.add_argument('target_node_name',
1873 p.set_defaults(func=iscsi_delete_target_node)
1878 p = subparsers.add_parser('iscsi_delete_portal_group',
1880 p.add_argument(
1882 p.set_defaults(func=iscsi_delete_portal_group)
1887 p = subparsers.add_parser('iscsi_delete_initiator_group',
1889 p.add_argument(
1891 p.set_defaults(func=iscsi_delete_initiator_group)
1902 p = subparsers.add_parser('iscsi_portal_group_set_auth',
1904 p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int)
1905 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this portal group.
1907 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this portal group.
1909 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this portal group.
1911 p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.',
1913 p.set_defaults(func=iscsi_portal_group_set_auth)
1918 p = subparsers.add_parser('iscsi_get_connections',
1920 p.set_defaults(func=iscsi_get_connections)
1925 p = subparsers.add_parser('iscsi_get_stats',
1927 p.set_defaults(func=iscsi_get_stats)
1932 p = subparsers.add_parser('iscsi_get_options',
1934 p.set_defaults(func=iscsi_get_options)
1939 p = subparsers.add_parser('scsi_get_devices', help='Display SCSI devices')
1940 p.set_defaults(func=scsi_get_devices)
1946 p = subparsers.add_parser('trace_enable_tpoint_group',
1948 p.add_argument(
1951 p.set_defaults(func=trace_enable_tpoint_group)
1956 p = subparsers.add_parser('trace_disable_tpoint_group',
1958 p.add_argument(
1961 p.set_defaults(func=trace_disable_tpoint_group)
1966 p = subparsers.add_parser('trace_set_tpoint_mask',
1968 p.add_argument(
1971 p.add_argument(
1975 p.set_defaults(func=trace_set_tpoint_mask)
1980 p = subparsers.add_parser('trace_clear_tpoint_mask',
1982 p.add_argument(
1985 p.add_argument(
1989 p.set_defaults(func=trace_clear_tpoint_mask)
1994 p = subparsers.add_parser('trace_get_tpoint_group_mask', help='get trace point group mask')
1995 p.set_defaults(func=trace_get_tpoint_group_mask)
2000 p = subparsers.add_parser('trace_get_info',
2002 p.set_defaults(func=trace_get_info)
2008 p = subparsers.add_parser('log_set_flag', help='set log flag')
2009 p.add_argument(
2011 p.set_defaults(func=log_set_flag)
2016 p = subparsers.add_parser('log_clear_flag', help='clear log flag')
2017 p.add_argument(
2019 p.set_defaults(func=log_clear_flag)
2024 p = subparsers.add_parser('log_get_flags', help='get log flags')
2025 p.set_defaults(func=log_get_flags)
2030 p = subparsers.add_parser('log_set_level', help='set log level')
2031 p.add_argument('level', help='log level we want to set. (for example "DEBUG").')
2032 p.set_defaults(func=log_set_level)
2037 p = subparsers.add_parser('log_get_level', help='get log level')
2038 p.set_defaults(func=log_get_level)
2043 p = subparsers.add_parser('log_set_print_level', help='set log print level')
2044 p.add_argument('level', help='log print level we want to set. (for example "DEBUG").')
2045 p.set_defaults(func=log_set_print_level)
2050 p = subparsers.add_parser('log_get_print_level', help='get log print level')
2051 p.set_defaults(func=log_get_print_level)
2066 p = subparsers.add_parser('bdev_lvol_create_lvstore', help='Add logical volume store on base bdev')
2067 p.add_argument('bdev_name', help='base bdev name')
2068 p.add_argument('lvs_name', help='name for lvol store')
2069 p.add_argument('-c', '--cluster-sz', help='size of cluster (in bytes)', type=int)
2070 p.add_argument('--clear-method', help="""Change clear method for data region.
2072 p.add_argument('-m', '--md-pages-per-cluster-ratio', help='reserved metadata pages for each cluster', type=int)
2073 p.add_argument('-s', '--md-page-size', help='size of metadata page (in bytes)', type=int)
2074 p.set_defaults(func=bdev_lvol_create_lvstore)
2081 p = subparsers.add_parser('bdev_lvol_rename_lvstore', help='Change logical volume store name')
2082 p.add_argument('old_name', help='old name')
2083 p.add_argument('new_name', help='new name')
2084 p.set_defaults(func=bdev_lvol_rename_lvstore)
2091 p = subparsers.add_parser('bdev_lvol_grow_lvstore',
2093 p.add_argument('-u', '--uuid', help='lvol store UUID')
2094 p.add_argument('-l', '--lvs-name', help='lvol store name')
2095 p.set_defaults(func=bdev_lvol_grow_lvstore)
2106 p = subparsers.add_parser('bdev_lvol_create', help='Add a bdev with an logical volume backend')
2107 p.add_argument('-u', '--uuid', help='lvol store UUID')
2108 p.add_argument('-l', '--lvs-name', help='lvol store name')
2109 p.add_argument('-t', '--thin-provision', action='store_true', help='create lvol bdev as thin provisioned')
2110 p.add_argument('-c', '--clear-method', help="""Change default data clusters clear method.
2112 p.add_argument('lvol_name', help='name for this lvol')
2113 p.add_argument('size_in_mib', help='size in MiB for this bdev', type=int)
2114 p.set_defaults(func=bdev_lvol_create)
2121 p = subparsers.add_parser('bdev_lvol_snapshot', help='Create a snapshot of an lvol bdev')
2122 p.add_argument('lvol_name', help='lvol bdev name')
2123 p.add_argument('snapshot_name', help='lvol snapshot name')
2124 p.set_defaults(func=bdev_lvol_snapshot)
2131 p = subparsers.add_parser('bdev_lvol_clone', help='Create a clone of an lvol snapshot')
2132 p.add_argument('snapshot_name', help='lvol snapshot name')
2133 p.add_argument('clone_name', help='lvol clone name')
2134 p.set_defaults(func=bdev_lvol_clone)
2142 p = subparsers.add_parser('bdev_lvol_clone_bdev',
2144 p.add_argument('bdev', help='bdev to clone')
2145 p.add_argument('lvs_name', help='logical volume store name')
2146 p.add_argument('clone_name', help='lvol clone name')
2147 p.set_defaults(func=bdev_lvol_clone_bdev)
2154 p = subparsers.add_parser('bdev_lvol_rename', help='Change lvol bdev name')
2155 p.add_argument('old_name', help='lvol bdev name')
2156 p.add_argument('new_name', help='new lvol name')
2157 p.set_defaults(func=bdev_lvol_rename)
2163 p = subparsers.add_parser('bdev_lvol_inflate', help='Make thin provisioned lvol a thick provisioned lvol')
2164 p.add_argument('name', help='lvol bdev name')
2165 p.set_defaults(func=bdev_lvol_inflate)
2171 p = subparsers.add_parser('bdev_lvol_decouple_parent', help='Decouple parent of lvol')
2172 p.add_argument('name', help='lvol bdev name')
2173 p.set_defaults(func=bdev_lvol_decouple_parent)
2180 p = subparsers.add_parser('bdev_lvol_resize', help='Resize existing lvol bdev')
2181 p.add_argument('name', help='lvol bdev name')
2182 p.add_argument('size_in_mib', help='new size in MiB for this bdev', type=int)
2183 p.set_defaults(func=bdev_lvol_resize)
2189 p = subparsers.add_parser('bdev_lvol_set_read_only', help='Mark lvol bdev as read only')
2190 p.add_argument('name', help='lvol bdev name')
2191 p.set_defaults(func=bdev_lvol_set_read_only)
2197 p = subparsers.add_parser('bdev_lvol_delete', help='Destroy a logical volume')
2198 p.add_argument('name', help='lvol bdev name')
2199 p.set_defaults(func=bdev_lvol_delete)
2206 p = subparsers.add_parser('bdev_lvol_start_shallow_copy',
2209 p.add_argument('src_lvol_name', help='source lvol name')
2210 p.add_argument('dst_bdev_name', help='destination bdev name')
2211 p.set_defaults(func=bdev_lvol_start_shallow_copy)
2217 p = subparsers.add_parser('bdev_lvol_check_shallow_copy', help='Get shallow copy status')
2218 p.add_argument('operation_id', help='operation identifier', type=int)
2219 p.set_defaults(func=bdev_lvol_check_shallow_copy)
2226 p = subparsers.add_parser('bdev_lvol_set_parent', help='Set the parent snapshot of a lvol')
2227 p.add_argument('lvol_name', help='lvol name')
2228 p.add_argument('parent_name', help='parent snapshot name')
2229 p.set_defaults(func=bdev_lvol_set_parent)
2236 p = subparsers.add_parser('bdev_lvol_set_parent_bdev', help='Set the parent external snapshot of a lvol')
2237 p.add_argument('lvol_name', help='lvol name')
2238 p.add_argument('parent_name', help='parent external snapshot name')
2239 p.set_defaults(func=bdev_lvol_set_parent_bdev)
2246 p = subparsers.add_parser('bdev_lvol_delete_lvstore', help='Destroy an logical volume store')
2247 p.add_argument('-u', '--uuid', help='lvol store UUID')
2248 p.add_argument('-l', '--lvs-name', help='lvol store name')
2249 p.set_defaults(func=bdev_lvol_delete_lvstore)
2256 p = subparsers.add_parser('bdev_lvol_get_lvstores', help='Display current logical volume store list')
2257 p.add_argument('-u', '--uuid', help='lvol store UUID')
2258 p.add_argument('-l', '--lvs-name', help='lvol store name')
2259 p.set_defaults(func=bdev_lvol_get_lvstores)
2266 p = subparsers.add_parser('bdev_lvol_get_lvols', help='Display current logical volume list')
2267 p.add_argument('-u', '--lvs-uuid', help='only lvols in lvol store UUID')
2268 p.add_argument('-l', '--lvs-name', help='only lvols in lvol store name')
2269 p.set_defaults(func=bdev_lvol_get_lvols)
2276 p = subparsers.add_parser('bdev_raid_set_options',
2278 p.add_argument('-w', '--process-window-size-kb', type=int,
2280 p.add_argument('-b', '--process-max-bandwidth-mb-sec', type=int,
2283 p.set_defaults(func=bdev_raid_set_options)
2289 p = subparsers.add_parser('bdev_raid_get_bdevs',
2295 p.add_argument('category', help='all or online or configuring or offline')
2296 p.set_defaults(func=bdev_raid_get_bdevs)
2310 p = subparsers.add_parser('bdev_raid_create', help='Create new raid bdev')
2311 p.add_argument('-n', '--name', help='raid bdev name', required=True)
2312 p.add_argument('-z', '--strip-size-kb', help='strip size in KB', type=int)
2313 p.add_argument('-r', '--raid-level', help='raid level, raid0, raid1 and a special level concat are supported', required=True)
2314 p.add_argument('-b', '--base-bdevs', help='base bdevs name, whitespace separated list in quotes', required=True)
2315 p.add_argument('--uuid', help='UUID for this raid bdev')
2316 p.add_argument('-s', '--superblock', help='information about raid bdev will be stored in superblock on each base bdev, '
2318 p.set_defaults(func=bdev_raid_create)
2323 p = subparsers.add_parser('bdev_raid_delete', help='Delete existing raid bdev')
2324 p.add_argument('name', help='raid bdev name')
2325 p.set_defaults(func=bdev_raid_delete)
2331 p = subparsers.add_parser('bdev_raid_add_base_bdev', help='Add base bdev to existing raid bdev')
2332 p.add_argument('raid_bdev', help='raid bdev name')
2333 p.add_argument('base_bdev', help='base bdev name')
2334 p.set_defaults(func=bdev_raid_add_base_bdev)
2339 p = subparsers.add_parser('bdev_raid_remove_base_bdev', help='Remove base bdev from existing raid bdev')
2340 p.add_argument('name', help='base bdev name')
2341 p.set_defaults(func=bdev_raid_remove_base_bdev)
2350 p = subparsers.add_parser('bdev_split_create',
2354 p.add_argument('base_bdev', help='base bdev name')
2355 p.add_argument('-s', '--split-size-mb', help='size in MiB for each bdev', type=int)
2356 p.add_argument('split_count', help="""Optional - number of split bdevs to create. Total size * split_count must not
2358 p.set_defaults(func=bdev_split_create)
2364 p = subparsers.add_parser('bdev_split_delete', help="""Delete split config with all created splits.""")
2365 p.add_argument('base_bdev', help='base bdev name')
2366 p.set_defaults(func=bdev_split_delete)
2380 p = subparsers.add_parser('bdev_ftl_create', help='Add FTL bdev')
2381 p.add_argument('-b', '--name', help="Name of the bdev", required=True)
2382 p.add_argument('-d', '--base-bdev', help='Name of bdev used as underlying device',
2384 p.add_argument('-u', '--uuid', help='UUID of restored bdev (not applicable when creating new '
2386 p.add_argument('-c', '--cache', help='Name of the bdev to be used as a write buffer cache',
2388 p.add_argument('--overprovisioning', help='Percentage of device used for relocation, not exposed'
2390 p.add_argument('--l2p-dram-limit', help='l2p size that could reside in DRAM (optional); default 2048',
2392 p.add_argument('--core-mask', help='CPU core mask - which cores will be used for ftl core thread, '
2394 p.add_argument('-f', '--fast-shutdown', help="Enable fast shutdown", action='store_true')
2395 p.set_defaults(func=bdev_ftl_create)
2408 p = subparsers.add_parser('bdev_ftl_load', help='Load FTL bdev')
2409 p.add_argument('-b', '--name', help="Name of the bdev", required=True)
2410 p.add_argument('-d', '--base-bdev', help='Name of bdev used as underlying device',
2412 p.add_argument('-u', '--uuid', help='UUID of restored bdev', required=True)
2413 p.add_argument('-c', '--cache', help='Name of the bdev to be used as a write buffer cache',
2415 p.add_argument('--overprovisioning', help='Percentage of device used for relocation, not exposed'
2417 p.add_argument('--l2p-dram-limit', help='l2p size that could reside in DRAM (optional); default 2048',
2419 p.add_argument('--core-mask', help='CPU core mask - which cores will be used for ftl core thread, '
2421 p.add_argument('-f', '--fast-shutdown', help="Enable fast shutdown", action='store_true')
2422 p.set_defaults(func=bdev_ftl_load)
2427 p = subparsers.add_parser('bdev_ftl_unload', help='Unload FTL bdev')
2428 p.add_argument('-b', '--name', help="Name of the bdev", required=True)
2429 p.add_argument('-f', '--fast-shutdown', help="Fast shutdown", action='store_true')
2430 p.set_defaults(func=bdev_ftl_unload)
2435 p = subparsers.add_parser('bdev_ftl_delete', help='Delete FTL bdev')
2436 p.add_argument('-b', '--name', help="Name of the bdev", required=True)
2437 p.add_argument('-f', '--fast-shutdown', help="Fast shutdown", action='store_true')
2438 p.set_defaults(func=bdev_ftl_delete)
2445 p = subparsers.add_parser('bdev_ftl_unmap', help='FTL unmap')
2446 p.add_argument('-b', '--name', help="Name of the bdev", required=True)
2447 p.add_argument('--lba', help='start LBA', required=True, type=int)
2448 p.add_argument('--num-blocks', help='num blocks', required=True, type=int)
2449 p.set_defaults(func=bdev_ftl_unmap)
2454 p = subparsers.add_parser('bdev_ftl_get_stats', help='print ftl stats')
2455 p.add_argument('-b', '--name', help="Name of the bdev", required=True)
2456 p.set_defaults(func=bdev_ftl_get_stats)
2461 p = subparsers.add_parser('bdev_ftl_get_properties', help='Print FTL properties')
2462 p.add_argument('-b', '--name', help="Name of the bdev", required=True)
2463 p.set_defaults(func=bdev_ftl_get_properties)
2470 p = subparsers.add_parser('bdev_ftl_set_property', help='Set FTL property')
2471 p.add_argument('-b', '--name', help="Name of the bdev", required=True)
2472 p.add_argument('-p', '--property', help="Name of the property to be set", required=True)
2473 p.add_argument('-v', '--value', help="Value of the property", required=True)
2474 p.set_defaults(func=bdev_ftl_set_property)
2480 p = subparsers.add_parser('vmd_enable', aliases=['enable_vmd'], help='Enable VMD enumeration')
2481 p.set_defaults(func=vmd_enable)
2486 p = subparsers.add_parser('vmd_remove_device', help='Remove a device behind VMD')
2487 p.add_argument('addr', help='Address of the device to remove', type=str)
2488 p.set_defaults(func=vmd_remove_device)
2493 p = subparsers.add_parser('vmd_rescan', help='Force a rescan of the devices behind VMD')
2494 p.set_defaults(func=vmd_rescan)
2501 p = subparsers.add_parser('ublk_create_target',
2503 p.add_argument('-m', '--cpumask', help='cpu mask for ublk dev')
2504 p.add_argument('--disable-user-copy', help='Disable user copy feature', action='store_true')
2505 p.set_defaults(func=ublk_create_target)
2509 p = subparsers.add_parser('ublk_destroy_target',
2511 p.set_defaults(func=ublk_destroy_target)
2520 p = subparsers.add_parser('ublk_start_disk',
2522 p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.')
2523 p.add_argument('ublk_id', help='ublk device id to be assigned. Example: 1.', type=int)
2524 p.add_argument('-q', '--num-queues', help="the total number of queues. Example: 1", type=int)
2525 p.add_argument('-d', '--queue-depth', help="queue depth. Example: 128", type=int)
2526 p.set_defaults(func=ublk_start_disk)
2532 p = subparsers.add_parser('ublk_stop_disk',
2534 p.add_argument('ublk_id', help='ublk device id to be deleted. Example: 1.', type=int)
2535 p.set_defaults(func=ublk_stop_disk)
2542 p = subparsers.add_parser('ublk_recover_disk',
2544 p.add_argument('bdev_name', help='Blockdev name to be recovered. Example: Malloc0.')
2545 p.add_argument('ublk_id', help='ublk device id to be recovered. Example: 1.', type=int)
2546 p.set_defaults(func=ublk_recover_disk)
2552 p = subparsers.add_parser('ublk_get_disks',
2554 p.add_argument('-n', '--ublk-id', help="ublk device id. Example: 1", type=int)
2555 p.set_defaults(func=ublk_get_disks)
2563 p = subparsers.add_parser('nbd_start_disk',
2565 p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.')
2566 p.add_argument('nbd_device', help='Nbd device name to be assigned. Example: /dev/nbd0.', nargs='?')
2567 p.set_defaults(func=nbd_start_disk)
2573 p = subparsers.add_parser('nbd_stop_disk',
2575 p.add_argument('nbd_device', help='Nbd device name to be stopped. Example: /dev/nbd0.')
2576 p.set_defaults(func=nbd_stop_disk)
2582 p = subparsers.add_parser('nbd_get_disks',
2584 p.add_argument('-n', '--nbd-device', help="Path of the nbd device. Example: /dev/nbd0")
2585 p.set_defaults(func=nbd_get_disks)
2592 p = subparsers.add_parser('nvmf_set_max_subsystems',
2594 p.add_argument('-x', '--max-subsystems', help='Max number of NVMf subsystems', type=int, required=True)
2595 p.set_defaults(func=nvmf_set_max_subsystems)
2605 p = subparsers.add_parser('nvmf_set_config', help='Set NVMf target config')
2606 p.add_argument('-i', '--passthru-identify-ctrlr', help="""Passthrough fields like serial number and model number
2608 p.add_argument('-m', '--poll-groups-mask', help='Set cpumask for NVMf poll groups (optional)', type=str)
2609 p.add_argument('-d', '--discovery-filter', help="""Set discovery filter (optional), possible values are: `match_any` (default) or
2611 p.add_argument('--dhchap-digests', help='Comma-separated list of allowed DH-HMAC-CHAP digests',
2613 p.add_argument('--dhchap-dhgroups', help='Comma-separated list of allowed DH-HMAC-CHAP DH groups',
2615 p.set_defaults(func=nvmf_set_config)
2620 p = subparsers.add_parser('nvmf_create_transport', help='Create NVMf transport')
2621 p.add_argument('-t', '--trtype', help='Transport type (ex. RDMA)', type=str, required=True)
2622 p.add_argument('-g', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2623 p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/O per queue', type=int)
2624 p.add_argument('-m', '--max-io-qpairs-per-ctrlr', help='Max number of IO qpairs per controller', type=int)
2625 p.add_argument('-c', '--in-capsule-data-size', help='Max number of in-capsule data size', type=int)
2626 p.add_argument('-i', '--max-io-size', help='Max I/O size (bytes)', type=int)
2627 p.add_argument('-u', '--io-unit-size', help='I/O unit size (bytes)', type=int)
2628 p.add_argument('-a', '--max-aq-depth', help='Max number of admin cmds per AQ', type=int)
2629 p.add_argument('-n', '--num-shared-buffers', help='The number of pooled data buffers available to the transport', type=int)
2630 p.add_argument('-b', '--buf-cache-size', help='The number of shared buffers to reserve for each poll group', type=int)
2631 p.add_argument('-z', '--zcopy', action='store_true', help='''Use zero-copy operations if the
2633 p.add_argument('-d', '--num-cqe', help="""The number of CQ entries. Only used when no_srq=true.
2635 p.add_argument('-s', '--max-srq-depth', help='Max number of outstanding I/O per SRQ. Relevant only for RDMA transport', type=int)
2636 p.add_argument('-r', '--no-srq', action='store_true', help='Disable per-thread shared receive queue. Relevant only for RDMA transport')
2637 p.add_argument('-o', '--c2h-success', action='store_false', help='Disable C2H success optimization. Relevant only for TCP transport')
2638 p.add_argument('-f', '--dif-insert-or-strip', action='store_true', help='Enable DIF insert/strip. Relevant only for TCP transport')
2639 p.add_argument('-y', '--sock-priority', help='The sock priority of the tcp connection. Relevant only for TCP transport', type=int)
2640 p.add_argument('-l', '--acceptor-backlog', help='Pending connections allowed at one time. Relevant only for RDMA transport', type=int)
2641 p.add_argument('-x', '--abort-timeout-sec', help='Abort execution timeout value, in seconds', type=int)
2642 p.add_argument('-w', '--no-wr-batching', action='store_true', help='Disable work requests batching. Relevant only for RDMA transport')
2643 p.add_argument('-e', '--control-msg-num', help="""The number of control messages per poll group.
2645 p.add_argument('-M', '--disable-mappable-bar0', action='store_true', help="""Disable mmap() of BAR0.
2647 p.add_argument('-I', '--disable-adaptive-irq', action='store_true', help="""Disable adaptive interrupt feature.
2649 p.add_argument('-S', '--disable-shadow-doorbells', action='store_true', help="""Disable shadow doorbell support.
2651 p.add_argument('--acceptor-poll-rate', help='Polling interval of the acceptor for incoming connections (usec)', type=int)
2652 p.add_argument('--ack-timeout', help='ACK timeout in milliseconds', type=int)
2653 p.add_argument('--data-wr-pool-size', help='RDMA data WR pool size. Relevant only for RDMA transport', type=int)
2654 p.add_argument('--disable-command-passthru', help='Disallow command passthru', action='store_true')
2655 p.set_defaults(func=nvmf_create_transport)
2660 p = subparsers.add_parser('nvmf_get_transports', help='Display nvmf transports or required transport')
2661 p.add_argument('--trtype', help='Transport type (optional)')
2662 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2663 p.set_defaults(func=nvmf_get_transports)
2668 p = subparsers.add_parser('nvmf_get_subsystems', help='Display nvmf subsystems or required subsystem')
2669 p.add_argument('nqn', help='Subsystem NQN (optional)', nargs="?")
2670 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2671 p.set_defaults(func=nvmf_get_subsystems)
2688 p = subparsers.add_parser('nvmf_create_subsystem', help='Create an NVMe-oF subsystem')
2689 p.add_argument('nqn', help='Subsystem NQN (ASCII)')
2690 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2691 p.add_argument("-s", "--serial-number", help="""
2694 p.add_argument("-d", "--model-number", help="""
2697 p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce allowed host NQN list)")
2698 p.add_argument("-m", "--max-namespaces", help="Maximum number of namespaces allowed",
2700 p.add_argument("-r", "--ana-reporting", action='store_true', help="Enable ANA reporting feature")
2701 p.add_argument("-i", "--min_cntlid", help="Minimum controller ID", type=int)
2702 p.add_argument("-I", "--max_cntlid", help="Maximum controller ID", type=int)
2703 p.add_argument("--max-discard-size", help="Maximum discard size (Kib)", type=int)
2704 p.add_argument("--max-write-zeroes-size", help="Maximum write_zeroes size (Kib)", type=int)
2705 p.add_argument("-p", "--passthrough", action='store_true', help="""Use NVMe passthrough for all I/O commands and namespace-directed
2707 p.set_defaults(func=nvmf_create_subsystem)
2714 p = subparsers.add_parser('nvmf_delete_subsystem', help='Delete a nvmf subsystem')
2715 p.add_argument('subsystem_nqn',
2717 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2718 p.set_defaults(func=nvmf_delete_subsystem)
2723 p = subparsers.add_parser('nvmf_subsystem_add_listener', help='Add a listener to an NVMe-oF subsystem')
2724 p.add_argument('nqn', help='NVMe-oF subsystem NQN (\'discovery\' can be used as shortcut for discovery NQN)')
2725 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True)
2726 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True)
2727 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2728 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
2729 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for RDMA or TCP)')
2730 p.add_argument('-k', '--secure-channel', help='Immediately establish a secure channel', action="store_true")
2731 p.add_argument('-n', '--ana-state', help='ANA state to set: optimized, non_optimized, or inaccessible', type=str)
2732 p.add_argument('-S', '--sock-impl', help='The socket implementation to use for the listener (ex. posix)', type=str)
2733 p.set_defaults(func=nvmf_subsystem_add_listener)
2744 p = subparsers.add_parser('nvmf_subsystem_remove_listener', help='Remove a listener from an NVMe-oF subsystem')
2745 p.add_argument('nqn', help='NVMe-oF subsystem NQN (\'discovery\' can be used as shortcut for discovery NQN)')
2746 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True)
2747 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True)
2748 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2749 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
2750 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for TCP and RDMA transport types)')
2751 p.set_defaults(func=nvmf_subsystem_remove_listener)
2764 p = subparsers.add_parser('nvmf_subsystem_listener_set_ana_state', help='Set ANA state of a listener for an NVMe-oF subsystem')
2765 p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2766 p.add_argument('-n', '--ana-state', help='ANA state to set: optimized, non_optimized, or inaccessible', required=True)
2767 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True)
2768 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True)
2769 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2770 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
2771 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number')
2772 p.add_argument('-g', '--anagrpid', help='ANA group ID (optional)', type=int)
2773 p.set_defaults(func=nvmf_subsystem_listener_set_ana_state)
2778 p = subparsers.add_parser('nvmf_discovery_add_referral', help='Add a discovery service referral to an NVMe-oF target')
2779 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True)
2780 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True)
2781 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2782 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
2783 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for RDMA or TCP)')
2784 p.add_argument('-k', '--secure-channel', help='The connection to that discovery subsystem requires a secure channel',
2786 p.add_argument('-n', '--subnqn', help='Subsystem NQN')
2787 p.set_defaults(func=nvmf_discovery_add_referral)
2798 p = subparsers.add_parser('nvmf_discovery_remove_referral', help='Remove a discovery service referral from an NVMe-oF target')
2799 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True)
2800 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True)
2801 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2802 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
2803 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for TCP and RDMA transport types)')
2804 p.add_argument('-n', '--subnqn', help='Subsystem NQN')
2805 p.set_defaults(func=nvmf_discovery_remove_referral)
2811 p = subparsers.add_parser('nvmf_discovery_get_referrals',
2813 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2814 p.set_defaults(func=nvmf_discovery_get_referrals)
2819 p = subparsers.add_parser('nvmf_subsystem_add_ns', help='Add a namespace to an NVMe-oF subsystem')
2820 p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2821 p.add_argument('bdev_name', help='The name of the bdev that will back this namespace')
2822 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2823 p.add_argument('-p', '--ptpl-file', help='The persistent reservation storage location (optional)', type=str)
2824 p.add_argument('-n', '--nsid', help='The requested NSID (optional)', type=int)
2825 p.add_argument('-g', '--nguid', help='Namespace globally unique identifier (optional)')
2826 p.add_argument('-e', '--eui64', help='Namespace EUI-64 identifier (optional)')
2827 p.add_argument('-u', '--uuid', help='Namespace UUID (optional)')
2828 p.add_argument('-a', '--anagrpid', help='ANA group ID (optional)', type=int)
2829 p.add_argument('-i', '--no-auto-visible', action='store_true',
2831 p.add_argument('-N', '--hide-metadata', action='store_true',
2833 p.set_defaults(func=nvmf_subsystem_add_ns)
2842 p = subparsers.add_parser('nvmf_subsystem_set_ns_ana_group', help='Change ANA group ID of a namespace')
2843 p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2844 p.add_argument('nsid', help='The requested NSID', type=int)
2845 p.add_argument('anagrpid', help='ANA group ID', type=int)
2846 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2847 p.set_defaults(func=nvmf_subsystem_set_ns_ana_group)
2855 p = subparsers.add_parser('nvmf_subsystem_remove_ns', help='Remove a namespace to an NVMe-oF subsystem')
2856 p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2857 p.add_argument('nsid', help='The requested NSID', type=int)
2858 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2859 p.set_defaults(func=nvmf_subsystem_remove_ns)
2869 def nvmf_ns_visible_add_args(p):
2870 p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2871 p.add_argument('nsid', help='The requested NSID', type=int)
2872 p.add_argument('host', help='Host NQN to make namespace visible to')
2873 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2875 p = subparsers.add_parser('nvmf_ns_add_host', help='Make namespace visible to controllers of host')
2876 nvmf_ns_visible_add_args(p)
2877 p.set_defaults(func=nvmf_ns_add_host)
2887 p = subparsers.add_parser('nvmf_ns_remove_host', help='Make namespace not visible to controllers of host')
2888 nvmf_ns_visible_add_args(p)
2889 p.set_defaults(func=nvmf_ns_remove_host)
2900 p = subparsers.add_parser('nvmf_subsystem_add_host', help='Add a host to an NVMe-oF subsystem')
2901 p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2902 p.add_argument('host', help='Host NQN to allow')
2903 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2904 p.add_argument('--psk', help='Path to PSK file for TLS authentication (optional). Only applicable for TCP transport.', type=str)
2905 p.add_argument('--dhchap-key', help='DH-HMAC-CHAP key name (optional)')
2906 p.add_argument('--dhchap-ctrlr-key', help='DH-HMAC-CHAP controller key name (optional)')
2907 p.set_defaults(func=nvmf_subsystem_add_host)
2915 p = subparsers.add_parser('nvmf_subsystem_remove_host', help='Remove a host from an NVMe-oF subsystem')
2916 p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2917 p.add_argument('host', help='Host NQN to remove')
2918 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2919 p.set_defaults(func=nvmf_subsystem_remove_host)
2929 p = subparsers.add_parser('nvmf_subsystem_set_keys', help='Set keys required for a host to connect to a given subsystem')
2930 p.add_argument('nqn', help='Subsystem NQN')
2931 p.add_argument('host', help='Host NQN')
2932 p.add_argument('-t', '--tgt-name', help='Name of the NVMe-oF target')
2933 p.add_argument('--dhchap-key', help='DH-HMAC-CHAP key name')
2934 p.add_argument('--dhchap-ctrlr-key', help='DH-HMAC-CHAP controller key name')
2935 p.set_defaults(func=nvmf_subsystem_set_keys)
2943 p = subparsers.add_parser('nvmf_subsystem_allow_any_host', help='Allow any host to connect to the subsystem')
2944 p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2945 p.add_argument('-e', '--enable', action='store_true', help='Enable allowing any host')
2946 p.add_argument('-d', '--disable', action='store_true', help='Disable allowing any host')
2947 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2948 p.set_defaults(func=nvmf_subsystem_allow_any_host)
2955 p = subparsers.add_parser('nvmf_subsystem_get_controllers',
2957 p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2958 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2959 p.set_defaults(func=nvmf_subsystem_get_controllers)
2966 p = subparsers.add_parser('nvmf_subsystem_get_qpairs',
2968 p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2969 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2970 p.set_defaults(func=nvmf_subsystem_get_qpairs)
2977 p = subparsers.add_parser('nvmf_subsystem_get_listeners',
2979 p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2980 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2981 p.set_defaults(func=nvmf_subsystem_get_listeners)
2986 p = subparsers.add_parser(
2988 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2989 p.set_defaults(func=nvmf_get_stats)
2994 p = subparsers.add_parser(
2998 p.add_argument('-t1', '--crdt1', help='Command Retry Delay Time 1, in units of 100 milliseconds', type=int)
2999 p.add_argument('-t2', '--crdt2', help='Command Retry Delay Time 2, in units of 100 milliseconds', type=int)
3000 p.add_argument('-t3', '--crdt3', help='Command Retry Delay Time 3, in units of 100 milliseconds', type=int)
3001 p.set_defaults(func=nvmf_set_crdt)
3006 p = subparsers.add_parser('nvmf_publish_mdns_prr',
3008 p.add_argument('-t', '--tgt-name', help='The name of the NVMe-oF target (optional)', type=str)
3009 p.set_defaults(func=nvmf_publish_mdns_prr)
3014 p = subparsers.add_parser('nvmf_stop_mdns_prr',
3016 p.add_argument('-t', '--tgt-name', help='The name of the NVMe-oF target (optional)', type=str)
3017 p.set_defaults(func=nvmf_stop_mdns_prr)
3023 p = subparsers.add_parser('framework_get_subsystems',
3026 p.set_defaults(func=framework_get_subsystems)
3031 p = subparsers.add_parser('framework_get_config', help="""Print subsystem configuration""")
3032 p.add_argument('name', help='Name of subsystem to query')
3033 p.set_defaults(func=framework_get_config)
3042 p = subparsers.add_parser('vhost_controller_set_coalescing', help='Set vhost controller coalescing')
3043 p.add_argument('ctrlr', help='controller name')
3044 p.add_argument('delay_base_us', help='Base delay time', type=int)
3045 p.add_argument('iops_threshold', help='IOPS threshold when coalescing is enabled', type=int)
3046 p.set_defaults(func=vhost_controller_set_coalescing)
3051 p = subparsers.add_parser('virtio_blk_create_transport',
3053 p.add_argument('name', help='transport name')
3054 p.set_defaults(func=virtio_blk_create_transport)
3059 p = subparsers.add_parser('virtio_blk_get_transports', help='Display virtio-blk transports or requested transport')
3060 p.add_argument('--name', help='Transport name (optional)', type=str)
3061 p.set_defaults(func=virtio_blk_get_transports)
3069 p = subparsers.add_parser('vhost_create_scsi_controller', help='Add new vhost controller')
3070 p.add_argument('ctrlr', help='controller name')
3071 p.add_argument('--cpumask', help='cpu mask for this controller')
3072 p.add_argument("--delay", action='store_true', help='whether delay starting controller or not')
3073 p.set_defaults(func=vhost_create_scsi_controller)
3079 p = subparsers.add_parser('vhost_start_scsi_controller', help='Start vhost scsi controller')
3080 p.add_argument('ctrlr', help='controller name')
3081 p.set_defaults(func=vhost_start_scsi_controller)
3089 p = subparsers.add_parser('vhost_scsi_controller_add_target', help='Add lun to vhost controller')
3090 p.add_argument('ctrlr', help='controller name where add lun')
3091 p.add_argument('scsi_target_num', help='scsi_target_num', type=int)
3092 p.add_argument('bdev_name', help='bdev name')
3093 p.set_defaults(func=vhost_scsi_controller_add_target)
3100 p = subparsers.add_parser('vhost_scsi_controller_remove_target',
3102 p.add_argument('ctrlr', help='controller name to remove target from')
3103 p.add_argument('scsi_target_num', help='scsi_target_num', type=int)
3104 p.set_defaults(func=vhost_scsi_controller_remove_target)
3109 p = subparsers.add_parser('vhost_create_blk_controller', help='Add a new vhost block controller')
3110 p.add_argument('ctrlr', help='controller name')
3111 p.add_argument('dev_name', help='device name')
3112 p.add_argument('--cpumask', help='cpu mask for this controller')
3113 p.add_argument('--transport', help='virtio blk transport name (default: vhost_user_blk)')
3114 p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only')
3115 p.add_argument("-p", "--packed_ring", action='store_true', help='Set controller as packed ring supported')
3116 p.set_defaults(func=vhost_create_blk_controller)
3121 p = subparsers.add_parser('vhost_get_controllers', help='List all or specific vhost controller(s)')
3122 p.add_argument('-n', '--name', help="Name of vhost controller")
3123 p.set_defaults(func=vhost_get_controllers)
3129 p = subparsers.add_parser('vhost_delete_controller', help='Delete a vhost controller')
3130 p.add_argument('ctrlr', help='controller name')
3131 p.set_defaults(func=vhost_delete_controller)
3142 p = subparsers.add_parser('bdev_virtio_attach_controller',
3147 p.add_argument('name', help="Use this name as base for new created bdevs")
3148 p.add_argument('-t', '--trtype',
3150 p.add_argument('-a', '--traddr',
3152 p.add_argument('-d', '--dev-type',
3154 p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int)
3155 p.add_argument('--vq-size', help='Size of each queue', type=int)
3156 p.set_defaults(func=bdev_virtio_attach_controller)
3161 p = subparsers.add_parser('bdev_virtio_scsi_get_devices', help='List all Virtio-SCSI devices.')
3162 p.set_defaults(func=bdev_virtio_scsi_get_devices)
3168 p = subparsers.add_parser('bdev_virtio_detach_controller', help="""Remove a Virtio device
3170 p.add_argument('name', help='Virtio device name. E.g. VirtioUser0')
3171 p.set_defaults(func=bdev_virtio_detach_controller)
3176 p = subparsers.add_parser('bdev_virtio_blk_set_hotplug', help='Set hotplug options for bdev virtio_blk type.')
3177 p.add_argument('-d', '--disable', dest='enable', default=False, action='store_false', help="Disable hotplug (default)")
3178 p.add_argument('-e', '--enable', dest='enable', action='store_true', help="Enable hotplug")
3179 p.add_argument('-r', '--period-us',
3181 p.set_defaults(func=bdev_virtio_blk_set_hotplug)
3187 p = subparsers.add_parser('vfu_tgt_set_base_path', help='Set socket base path.')
3188 p.add_argument('path', help='socket base path')
3189 p.set_defaults(func=vfu_tgt_set_base_path)
3194 p = subparsers.add_parser('vfu_virtio_delete_endpoint', help='Delete the PCI device via endpoint name.')
3195 p.add_argument('name', help='Endpoint name')
3196 p.set_defaults(func=vfu_virtio_delete_endpoint)
3207 p = subparsers.add_parser('vfu_virtio_create_blk_endpoint', help='Create virtio-blk endpoint.')
3208 p.add_argument('name', help='Name of the endpoint')
3209 p.add_argument('--bdev-name', help='block device name', type=str, required=True)
3210 p.add_argument('--cpumask', help='CPU masks')
3211 p.add_argument('--num-queues', help='number of vrings', type=int, default=0)
3212 p.add_argument('--qsize', help='number of element for each vring', type=int, default=0)
3213 p.add_argument("--packed-ring", action='store_true', help='Enable packed ring')
3214 p.set_defaults(func=vfu_virtio_create_blk_endpoint)
3222 p = subparsers.add_parser('vfu_virtio_scsi_add_target', help='Attach a block device to SCSI target of PCI endpoint.')
3223 p.add_argument('name', help='Name of the endpoint')
3224 p.add_argument('--scsi-target-num', help='number of SCSI Target', type=int, required=True)
3225 p.add_argument('--bdev-name', help='block device name', type=str, required=True)
3226 p.set_defaults(func=vfu_virtio_scsi_add_target)
3233 p = subparsers.add_parser('vfu_virtio_scsi_remove_target', help='Remove the specified SCSI target of PCI endpoint.')
3234 p.add_argument('name', help='Name of the endpoint')
3235 p.add_argument('--scsi-target-num', help='number of SCSI Target', type=int, required=True)
3236 p.set_defaults(func=vfu_virtio_scsi_remove_target)
3246 p = subparsers.add_parser('vfu_virtio_create_scsi_endpoint', help='Create virtio-scsi endpoint.')
3247 p.add_argument('name', help='Name of the endpoint')
3248 p.add_argument('--cpumask', help='CPU masks')
3249 p.add_argument('--num-io-queues', help='number of IO vrings', type=int, default=0)
3250 p.add_argument('--qsize', help='number of element for each vring', type=int, default=0)
3251 p.add_argument("--packed-ring", action='store_true', help='Enable packed ring')
3252 p.set_defaults(func=vfu_virtio_create_scsi_endpoint)
3264 p = subparsers.add_parser('vfu_virtio_create_fs_endpoint', help='Create virtio-fs endpoint.')
3265 p.add_argument('name', help='Name of the endpoint')
3266 p.add_argument('--fsdev-name', help='fsdev name', type=str, required=True)
3267 p.add_argument('--tag', help='virtiofs tag', type=str, required=True)
3268 p.add_argument('--cpumask', help='CPU masks')
3269 p.add_argument('--num-queues', help='number of vrings', type=int, default=0)
3270 p.add_argument('--qsize', help='number of element for each vring', type=int, default=0)
3271 p.add_argument("--packed-ring", action='store_true', help='Enable packed ring')
3272 p.set_defaults(func=vfu_virtio_create_fs_endpoint)
3278 p = subparsers.add_parser('accel_get_opc_assignments', help='Get list of opcode name to module assignments.')
3279 p.set_defaults(func=accel_get_opc_assignments)
3284 p = subparsers.add_parser('accel_get_module_info', aliases=['accel_get_engine_info'],
3286 p.set_defaults(func=accel_get_module_info)
3291 p = subparsers.add_parser('accel_assign_opc', help='Manually assign an operation to a module.')
3292 p.add_argument('-o', '--opname', help='opname')
3293 p.add_argument('-m', '--module', help='name of module')
3294 p.set_defaults(func=accel_assign_opc)
3304 p = subparsers.add_parser('accel_crypto_key_create', help='Create encryption key')
3305 p.add_argument('-c', '--cipher', help='cipher', required=True)
3306 p.add_argument('-k', '--key', help='key', required=True)
3307 p.add_argument('-e', '--key2', help='key2', default=None)
3308 p.add_argument('-t', '--tweak-mode', help='tweak mode', default=None)
3309 p.add_argument('-n', '--name', help='key name', required=True)
3310 p.set_defaults(func=accel_crypto_key_create)
3316 p = subparsers.add_parser('accel_crypto_key_destroy', help='Destroy encryption key')
3317 p.add_argument('-n', '--name', help='key name', required=True, type=str)
3318 p.set_defaults(func=accel_crypto_key_destroy)
3324 p = subparsers.add_parser('accel_crypto_keys_get', help='Get a list of the crypto keys')
3325 p.add_argument('-k', '--key-name', help='Get information about a specific key', type=str)
3326 p.set_defaults(func=accel_crypto_keys_get)
3331 p = subparsers.add_parser('accel_set_driver', help='Select accel platform driver to execute ' +
3333 p.add_argument('name', help='name of the platform driver')
3334 p.set_defaults(func=accel_set_driver)
3340 p = subparsers.add_parser('accel_set_options', help='Set accel framework\'s options')
3341 p.add_argument('--small-cache-size', type=int, help='Size of the small iobuf cache')
3342 p.add_argument('--large-cache-size', type=int, help='Size of the large iobuf cache')
3343 p.add_argument('--task-count', type=int, help='Maximum number of tasks per IO channel')
3344 p.add_argument('--sequence-count', type=int, help='Maximum number of sequences per IO channel')
3345 p.add_argument('--buf-count', type=int, help='Maximum number of buffers per IO channel')
3346 p.set_defaults(func=accel_set_options)
3351 p = subparsers.add_parser('accel_get_stats', help='Display accel framework\'s statistics')
3352 p.set_defaults(func=accel_get_stats)
3358 p = subparsers.add_parser('ioat_scan_accel_module', aliases=['ioat_scan_accel_engine'],
3360 p.set_defaults(func=ioat_scan_accel_module)
3366 p = subparsers.add_parser('compressdev_scan_accel_module', help='Scan and enable compressdev module and set pmd option.')
3367 p.add_argument('-p', '--pmd', type=int, help='0 = auto-select, 1= QAT only, 2 = mlx5_pci only, 3 = uadk only')
3368 p.set_defaults(func=compressdev_scan_accel_module)
3374 p = subparsers.add_parser('dsa_scan_accel_module', aliases=['dsa_scan_accel_engine'],
3376 p.add_argument('-k', '--config-kernel-mode', help='Use Kernel mode dsa',
3378 p.set_defaults(func=dsa_scan_accel_module, config_kernel_mode=None)
3384 p = subparsers.add_parser('iaa_scan_accel_module', aliases=['iaa_scan_accel_engine'],
3386 p.set_defaults(func=iaa_scan_accel_module)
3391 p = subparsers.add_parser('dpdk_cryptodev_scan_accel_module',
3393 p.set_defaults(func=dpdk_cryptodev_scan_accel_module)
3399 p = subparsers.add_parser('dpdk_cryptodev_set_driver',
3401 p.add_argument('-d', '--driver-name', help='The driver, can be one of crypto_aesni_mb, crypto_qat or mlx5_pci', type=str)
3402 p.set_defaults(func=dpdk_cryptodev_set_driver)
3407 p = subparsers.add_parser('dpdk_cryptodev_get_driver', help='Get the DPDK cryptodev driver')
3408 p.set_defaults(func=dpdk_cryptodev_get_driver)
3419 p = subparsers.add_parser('mlx5_scan_accel_module', help='Enable mlx5 accel module.')
3420 p.add_argument('-q', '--qp-size', type=int, help='QP size')
3421 p.add_argument('-r', '--num-requests', type=int, help='Size of the shared requests pool')
3422 p.add_argument('-d', '--allowed-devs', help="Comma separated list of allowed device names, e.g. mlx5_0,mlx5_1")
3423 p.add_argument('-s', '--crypto-split-blocks', type=int,
3425 p.add_argument('-e', '--enable-driver', dest='enable_driver', action='store_true', default=None,
3427 p.set_defaults(func=mlx5_scan_accel_module)
3432 p = subparsers.add_parser('accel_mlx5_dump_stats', help='Dump accel mlx5 module statistics.')
3433 p.add_argument('-l', '--level', type=str, help='Verbose level, one of \"total\", \"channel\" or \"device\"')
3434 p.set_defaults(func=accel_mlx5_dump_stats)
3442 p = subparsers.add_parser('accel_error_inject_error',
3444 p.add_argument('-o', '--opcode', help='Opcode')
3445 p.add_argument('-t', '--type',
3447 p.add_argument('-c', '--count', type=int,
3449 p.add_argument('-i', '--interval', type=int, help='Interval between injections')
3450 p.add_argument('--errcode', type=int, help='Error code to inject (only relevant for type=failure)')
3451 p.set_defaults(func=accel_error_inject_error)
3459 p = subparsers.add_parser('bdev_nvme_opal_init', help='take ownership and activate')
3460 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name')
3461 p.add_argument('-p', '--password', help='password for admin')
3462 p.set_defaults(func=bdev_nvme_opal_init)
3468 p = subparsers.add_parser('bdev_nvme_opal_revert', help='Revert to default factory settings')
3469 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name')
3470 p.add_argument('-p', '--password', help='password')
3471 p.set_defaults(func=bdev_nvme_opal_revert)
3482 p = subparsers.add_parser('bdev_opal_create', help="""Create opal bdev on specified NVMe controller""")
3483 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name', required=True)
3484 p.add_argument('-n', '--nsid', help='namespace ID (only support nsid=1 for now)', type=int, required=True)
3485 p.add_argument('-i', '--locking-range-id', help='locking range id', type=int, required=True)
3486 p.add_argument('-s', '--range-start', help='locking range start LBA', type=int, required=True)
3487 p.add_argument('-l', '--range-length', help='locking range length (in blocks)', type=int, required=True)
3488 p.add_argument('-p', '--password', help='admin password', required=True)
3489 p.set_defaults(func=bdev_opal_create)
3496 p = subparsers.add_parser('bdev_opal_get_info', help='get opal locking range info for this bdev')
3497 p.add_argument('-b', '--bdev-name', help='opal bdev')
3498 p.add_argument('-p', '--password', help='password')
3499 p.set_defaults(func=bdev_opal_get_info)
3506 p = subparsers.add_parser('bdev_opal_delete', help="""delete a virtual opal bdev""")
3507 p.add_argument('-b', '--bdev-name', help='opal virtual bdev', required=True)
3508 p.add_argument('-p', '--password', help='admin password', required=True)
3509 p.set_defaults(func=bdev_opal_delete)
3518 p = subparsers.add_parser('bdev_opal_new_user', help="""Add a user to opal bdev who can set lock state for this bdev""")
3519 p.add_argument('-b', '--bdev-name', help='opal bdev', required=True)
3520 p.add_argument('-p', '--admin-password', help='admin password', required=True)
3521 p.add_argument('-i', '--user-id', help='ID for new user', type=int, required=True)
3522 p.add_argument('-u', '--user-password', help='password set for this user', required=True)
3523 p.set_defaults(func=bdev_opal_new_user)
3532 p = subparsers.add_parser('bdev_opal_set_lock_state', help="""set lock state for an opal bdev""")
3533 p.add_argument('-b', '--bdev-name', help='opal bdev', required=True)
3534 p.add_argument('-i', '--user-id', help='ID of the user who want to set lock state, either admin or a user assigned to this bdev',
3536 p.add_argument('-p', '--password', help='password of this user', required=True)
3537 p.add_argument('-l', '--lock-state', help='lock state to set, choose from {readwrite, readonly, rwlock}', required=True)
3538 p.set_defaults(func=bdev_opal_set_lock_state)
3553 p = subparsers.add_parser('bdev_nvme_send_cmd', help='NVMe passthrough cmd.')
3554 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""")
3555 p.add_argument('-t', '--cmd-type', help="""Type of nvme cmd. Valid values are: admin, io""")
3556 p.add_argument('-r', '--data-direction', help="""Direction of data transfer. Valid values are: c2h, h2c""")
3557 p.add_argument('-c', '--cmdbuf', help="""NVMe command encoded by base64 urlsafe""")
3558 p.add_argument('-d', '--data', help="""Data transferring to controller from host, encoded by base64 urlsafe""")
3559 p.add_argument('-m', '--metadata', help="""Metadata transferring to controller from host, encoded by base64 urlsafe""")
3560 p.add_argument('-D', '--data-length', help="""Data length required to transfer from controller to host""", type=int)
3561 p.add_argument('-M', '--metadata-length', help="""Metadata length required to transfer from controller to host""", type=int)
3562 p.add_argument('-T', '--timeout-ms',
3564 p.set_defaults(func=bdev_nvme_send_cmd)
3570 p = subparsers.add_parser('notify_get_types', help='List available notifications that user can subscribe to.')
3571 p.set_defaults(func=notify_get_types)
3579 p = subparsers.add_parser('notify_get_notifications', help='Get notifications')
3580 p.add_argument('-i', '--id', help="""First ID to start fetching from""", type=int)
3581 p.add_argument('-n', '--max', help="""Maximum number of notifications to return in response""", type=int)
3582 p.set_defaults(func=notify_get_notifications)
3587 p = subparsers.add_parser(
3589 p.set_defaults(func=thread_get_stats)
3595 p = subparsers.add_parser('thread_set_cpumask',
3598 p.add_argument('-i', '--id', type=int, help='thread ID')
3599 p.add_argument('-m', '--cpumask', help='cpumask for this thread')
3600 p.set_defaults(func=thread_set_cpumask)
3605 p = subparsers.add_parser('log_enable_timestamps',
3607 p.add_argument('-d', '--disable', dest='enabled', default=False, action='store_false', help="Disable timestamps")
3608 p.add_argument('-e', '--enable', dest='enabled', action='store_true', help="Enable timestamps")
3609 p.set_defaults(func=log_enable_timestamps)
3614 p = subparsers.add_parser(
3616 p.set_defaults(func=thread_get_pollers)
3621 p = subparsers.add_parser(
3623 p.set_defaults(func=thread_get_io_channels)
3628 p = subparsers.add_parser(
3630 p.set_defaults(func=env_dpdk_get_mem_stats)
3637 p = subparsers.add_parser('blobfs_detect', help='Detect whether a blobfs exists on bdev')
3638 p.add_argument('bdev_name', help='Blockdev name to detect blobfs. Example: Malloc0.')
3639 p.set_defaults(func=blobfs_detect)
3646 p = subparsers.add_parser('blobfs_create', help='Build a blobfs on bdev')
3647 p.add_argument('bdev_name', help='Blockdev name to build blobfs. Example: Malloc0.')
3648 p.add_argument('-c', '--cluster-sz',
3650 p.set_defaults(func=blobfs_create)
3657 p = subparsers.add_parser('blobfs_mount', help='Mount a blobfs on bdev to host path by FUSE')
3658 p.add_argument('bdev_name', help='Blockdev name where the blobfs is. Example: Malloc0.')
3659 p.add_argument('mountpoint', help='Mountpoint path in host to mount blobfs. Example: /mnt/.')
3660 p.set_defaults(func=blobfs_mount)
3666 p = subparsers.add_parser('blobfs_set_cache_size', help='Set cache size for blobfs')
3667 p.add_argument('size_in_mb', help='Cache size for blobfs in megabytes.', type=int)
3668 p.set_defaults(func=blobfs_set_cache_size)
3674 p = subparsers.add_parser('fsdev_get_opts', help='Get the fsdev subsystem options')
3675 p.set_defaults(func=fsdev_get_opts)
3681 p = subparsers.add_parser('fsdev_set_opts', help='Set the fsdev subsystem options')
3682 p.add_argument('fsdev-io-pool-size', help='Size of fsdev IO objects pool', type=int)
3683 p.add_argument('fsdev-io-cache-size', help='Size of fsdev IO objects cache per thread', type=int)
3684 p.set_defaults(func=fsdev_set_opts)
3691 p = subparsers.add_parser('fsdev_aio_create', help='Create a aio filesystem')
3692 p.add_argument('name', help='Filesystem name. Example: aio0.')
3693 p.add_argument('root_path', help='Path on the system fs to expose as SPDK filesystem')
3695 group = p.add_mutually_exclusive_group()
3699 group = p.add_mutually_exclusive_group()
3704 p.add_argument('-w', '--max-write', help='Max write size in bytes', type=int)
3706 p.add_argument('--skip-rw', dest='skip_rw', help="Do not process read or write commands. This is used for testing.",
3709 p.set_defaults(func=fsdev_aio_create)
3714 p = subparsers.add_parser('fsdev_aio_delete', help='Delete a aio filesystem')
3715 p.add_argument('name', help='Filesystem name. Example: aio0.')
3716 p.set_defaults(func=fsdev_aio_delete)
3723 p = subparsers.add_parser('sock_impl_get_options', help="""Get options of socket layer implementation""")
3724 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True)
3725 p.set_defaults(func=sock_impl_get_options)
3741 p = subparsers.add_parser('sock_impl_set_options', help="""Set options of socket layer implementation""")
3742 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True)
3743 p.add_argument('-r', '--recv-buf-size', help='Size of receive buffer on socket in bytes', type=int)
3744 p.add_argument('-s', '--send-buf-size', help='Size of send buffer on socket in bytes', type=int)
3745 p.add_argument('-p', '--enable-placement-id', help='Option for placement-id. 0:disable,1:incoming_napi,2:incoming_cpu', type=int)
3746 p.add_argument('--enable-recv-pipe', help='Enable receive pipe',
3748 p.add_argument('--disable-recv-pipe', help='Disable receive pipe',
3750 p.add_argument('--enable-quickack', help='Enable quick ACK',
3752 p.add_argument('--disable-quickack', help='Disable quick ACK',
3754 p.add_argument('--enable-zerocopy-send-server', help='Enable zerocopy on send for server sockets',
3756 p.add_argument('--disable-zerocopy-send-server', help='Disable zerocopy on send for server sockets',
3758 p.add_argument('--enable-zerocopy-send-client', help='Enable zerocopy on send for client sockets',
3760 p.add_argument('--disable-zerocopy-send-client', help='Disable zerocopy on send for client sockets',
3762 p.add_argument('--zerocopy-threshold', help='Set zerocopy_threshold in bytes', type=int)
3763 p.add_argument('--tls-version', help='TLS protocol version', type=int)
3764 p.add_argument('--enable-ktls', help='Enable Kernel TLS',
3766 p.add_argument('--disable-ktls', help='Disable Kernel TLS',
3768 p.set_defaults(func=sock_impl_set_options, enable_recv_pipe=None, enable_quickack=None,
3776 p = subparsers.add_parser('sock_set_default_impl', help="""Set the default sock implementation""")
3777 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True)
3778 p.set_defaults(func=sock_set_default_impl)
3783 p = subparsers.add_parser('sock_get_default_impl', help="Get the default sock implementation name")
3784 p.set_defaults(func=sock_get_default_impl)
3800 p = subparsers.add_parser('framework_get_pci_devices', help='''Get a list of attached PCI devices''')
3801 p.add_argument('--format-lspci', help='Format the output in a way to be consumed by lspci -F',
3803 p.set_defaults(func=framework_get_pci_devices)
3816 p = subparsers.add_parser('bdev_nvme_add_error_injection',
3818 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""", required=True)
3819 p.add_argument('-t', '--cmd-type', help="""Type of NVMe command. Valid values are: admin, io""", required=True)
3820 p.add_argument('-o', '--opc', help="""Opcode of the NVMe command.""", required=True, type=int)
3821 p.add_argument('-s', '--do-not-submit',
3824 p.add_argument('-w', '--timeout-in-us', help="""Wait specified microseconds when do_not_submit is true""", type=int)
3825 p.add_argument('-e', '--err-count', help="""Number of matching NVMe commands to inject errors""", type=int)
3826 p.add_argument('-u', '--sct', help="""Status code type""", type=int)
3827 p.add_argument('-c', '--sc', help="""Status code""", type=int)
3828 p.set_defaults(func=bdev_nvme_add_error_injection)
3836 p = subparsers.add_parser('bdev_nvme_remove_error_injection',
3838 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""", required=True)
3839 p.add_argument('-t', '--cmd-type', help="""Type of nvme cmd. Valid values are: admin, io""", required=True)
3840 p.add_argument('-o', '--opc', help="""Opcode of the nvme cmd.""", required=True, type=int)
3841 p.set_defaults(func=bdev_nvme_remove_error_injection)
3853 p = subparsers.add_parser('bdev_daos_create',
3855 p.add_argument('name', help="Name of the bdev")
3856 p.add_argument('pool', help="UUID of the DAOS pool")
3857 p.add_argument('cont', help="UUID of the DAOS container")
3858 p.add_argument(
3860 p.add_argument('block_size', help='Block size for this bdev', type=int)
3861 p.add_argument('-u', '--uuid', help="UUID of the bdev")
3862 p.add_argument('-o', '--oclass', help="DAOS object class")
3863 p.set_defaults(func=bdev_daos_create)
3869 p = subparsers.add_parser('bdev_daos_delete',
3871 p.add_argument('name', help='DAOS bdev name')
3872 p.set_defaults(func=bdev_daos_delete)
3879 p = subparsers.add_parser('bdev_daos_resize',
3881 p.add_argument('name', help='DAOS bdev name')
3882 p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB')
3883 p.set_defaults(func=bdev_daos_resize)
3892 p = subparsers.add_parser('iobuf_set_options', help='Set iobuf pool options')
3893 p.add_argument('--small-pool-count', help='number of small buffers in the global pool', type=int)
3894 p.add_argument('--large-pool-count', help='number of large buffers in the global pool', type=int)
3895 p.add_argument('--small-bufsize', help='size of a small buffer', type=int)
3896 p.add_argument('--large-bufsize', help='size of a large buffer', type=int)
3897 p.add_argument('--enable-numa', help='enable per-NUMA node buffer pools', action='store_true')
3898 p.set_defaults(func=iobuf_set_options)
3903 p = subparsers.add_parser('iobuf_get_stats', help='Display iobuf statistics')
3904 p.set_defaults(func=iobuf_get_stats)
3912 p = subparsers.add_parser('bdev_nvme_start_mdns_discovery', help='Start mdns based automatic discovery')
3913 p.add_argument('-b', '--name', help="Name of the NVMe controller prefix for each bdev name", required=True)
3914 p.add_argument('-s', '--svcname', help='Service type to discover: e.g., _nvme-disc._tcp', required=True)
3915 p.add_argument('-q', '--hostnqn', help='NVMe-oF host subnqn')
3916 p.set_defaults(func=bdev_nvme_start_mdns_discovery)
3921 p = subparsers.add_parser('bdev_nvme_stop_mdns_discovery', help='Stop automatic mdns discovery')
3922 p.add_argument('-b', '--name', help="Name of the service to stop", required=True)
3923 p.set_defaults(func=bdev_nvme_stop_mdns_discovery)
3928 p = subparsers.add_parser('bdev_nvme_get_mdns_discovery_info', help='Get information about the automatic mdns discovery')
3929 p.set_defaults(func=bdev_nvme_get_mdns_discovery_info)
3934 p = subparsers.add_parser('keyring_file_add_key', help='Add a file-based key to the keyring')
3935 p.add_argument('name', help='Name of the key to add')
3936 p.add_argument('path', help='Path of the file containing the key')
3937 p.set_defaults(func=keyring_file_add_key)
3942 p = subparsers.add_parser('keyring_file_remove_key', help='Remove a file-based key from the keyring')
3943 p.add_argument('name', help='Name of the key to remove')
3944 p.set_defaults(func=keyring_file_remove_key)
3949 p = subparsers.add_parser('keyring_get_keys', help='Get a list of registered keys')
3950 p.set_defaults(func=keyring_get_keys)
3955 p = subparsers.add_parser('keyring_linux_set_options', help='Set options of the keyring_linux module')
3956 p.add_argument('-e', '--enable', help='Enable keyring_linux module', action='store_true')
3957 p.set_defaults(func=keyring_linux_set_options)