xref: /spdk/scripts/rpc.py (revision 7506a7aa53d239f533af3bc768f0d2af55e735fe) 
1#!/usr/bin/env python3
2
3import logging
4import argparse
5import importlib
6import os
7import sys
8import shlex
9import json
10
11try:
12    from shlex import quote
13except ImportError:
14    from pipes import quote
15
16sys.path.append(os.path.dirname(__file__) + '/../python')
17
18import spdk.rpc as rpc  # noqa
19from spdk.rpc.client import print_dict, print_json, JSONRPCException  # noqa
20from spdk.rpc.helpers import deprecated_aliases  # noqa
21
22
23def print_array(a):
24    print(" ".join((quote(v) for v in a)))
25
26
27if __name__ == "__main__":
28    parser = argparse.ArgumentParser(
29        description='SPDK RPC command line interface', usage='%(prog)s [options]')
30    parser.add_argument('-s', dest='server_addr',
31                        help='RPC domain socket path or IP address', default='/var/tmp/spdk.sock')
32    parser.add_argument('-p', dest='port',
33                        help='RPC port number (if server_addr is IP address)',
34                        default=5260, type=int)
35    parser.add_argument('-t', dest='timeout',
36                        help='Timeout as a floating point number expressed in seconds waiting for response. Default: 60.0',
37                        default=60.0, type=float)
38    parser.add_argument('-r', dest='conn_retries',
39                        help='Retry connecting to the RPC server N times with 0.2s interval. Default: 0',
40                        default=0, type=int)
41    parser.add_argument('-v', dest='verbose', action='store_const', const="INFO",
42                        help='Set verbose mode to INFO', default="ERROR")
43    parser.add_argument('--verbose', dest='verbose', choices=['DEBUG', 'INFO', 'ERROR'],
44                        help="""Set verbose level. """)
45    parser.add_argument('--dry-run', dest='dry_run', action='store_true', help="Display request and exit")
46    parser.set_defaults(dry_run=False)
47    parser.add_argument('--server', dest='is_server', action='store_true',
48                        help="Start listening on stdin, parse each line as a regular rpc.py execution and create \
49                                a separate connection for each command. Each command's output ends with either \
50                                **STATUS=0 if the command succeeded or **STATUS=1 if it failed. --server is meant \
51                                to be used in conjunction with bash coproc, where stdin and stdout are connected to \
52                                pipes and can be used as a faster way to send RPC commands. If enabled, rpc.py \
53                                must be executed without any other parameters.")
54    parser.set_defaults(is_server=False)
55    parser.add_argument('--plugin', dest='rpc_plugin', help='Module name of plugin with additional RPC commands')
56    subparsers = parser.add_subparsers(help='RPC methods', dest='called_rpc_name', metavar='')
57
58    def framework_start_init(args):
59        rpc.framework_start_init(args.client)
60
61    p = subparsers.add_parser('framework_start_init', aliases=['start_subsystem_init'],
62                              help='Start initialization of subsystems')
63    p.set_defaults(func=framework_start_init)
64
65    def framework_wait_init(args):
66        rpc.framework_wait_init(args.client)
67
68    p = subparsers.add_parser('framework_wait_init', aliases=['wait_subsystem_init'],
69                              help='Block until subsystems have been initialized')
70    p.set_defaults(func=framework_wait_init)
71
72    def rpc_get_methods(args):
73        print_dict(rpc.rpc_get_methods(args.client,
74                                       current=args.current,
75                                       include_aliases=args.include_aliases))
76
77    p = subparsers.add_parser('rpc_get_methods', aliases=['get_rpc_methods'],
78                              help='Get list of supported RPC methods')
79    p.add_argument('-c', '--current', help='Get list of RPC methods only callable in the current state.', action='store_true')
80    p.add_argument('-i', '--include-aliases', help='include RPC aliases', action='store_true')
81    p.set_defaults(func=rpc_get_methods)
82
83    def spdk_get_version(args):
84        print_json(rpc.spdk_get_version(args.client))
85
86    p = subparsers.add_parser('spdk_get_version', aliases=['get_spdk_version'],
87                              help='Get SPDK version')
88    p.set_defaults(func=spdk_get_version)
89
90    def save_config(args):
91        rpc.save_config(args.client,
92                        sys.stdout,
93                        indent=args.indent)
94
95    p = subparsers.add_parser('save_config', help="""Write current (live) configuration of SPDK subsystems and targets to stdout.
96    """)
97    p.add_argument('-i', '--indent', help="""Indent level. Value less than 0 mean compact mode. Default indent level is 2.
98    """, type=int, default=2)
99    p.set_defaults(func=save_config)
100
101    def load_config(args):
102        rpc.load_config(args.client, args.json_conf,
103                        include_aliases=args.include_aliases)
104
105    p = subparsers.add_parser('load_config', help="""Configure SPDK subsystems and targets using JSON RPC.""")
106    p.add_argument('-i', '--include-aliases', help='include RPC aliases', action='store_true')
107    p.add_argument('-j', '--json-conf', help='Valid JSON configuration', default=sys.stdin)
108    p.set_defaults(func=load_config)
109
110    def save_subsystem_config(args):
111        rpc.save_subsystem_config(args.client,
112                                  sys.stdout,
113                                  indent=args.indent,
114                                  name=args.name)
115
116    p = subparsers.add_parser('save_subsystem_config', help="""Write current (live) configuration of SPDK subsystem to stdout.
117    """)
118    p.add_argument('-i', '--indent', help="""Indent level. Value less than 0 mean compact mode. Default indent level is 2.
119    """, type=int, default=2)
120    p.add_argument('-n', '--name', help='Name of subsystem', required=True)
121    p.set_defaults(func=save_subsystem_config)
122
123    def load_subsystem_config(args):
124        rpc.load_subsystem_config(args.client,
125                                  args.json_conf)
126
127    p = subparsers.add_parser('load_subsystem_config', help="""Configure SPDK subsystem using JSON RPC.""")
128    p.add_argument('-j', '--json-conf', help='Valid JSON configuration', default=sys.stdin)
129    p.set_defaults(func=load_subsystem_config)
130
131    # app
132    def spdk_kill_instance(args):
133        rpc.app.spdk_kill_instance(args.client,
134                                   sig_name=args.sig_name)
135
136    p = subparsers.add_parser('spdk_kill_instance', help='Send signal to instance')
137    p.add_argument('sig_name', help='signal will be sent to server.')
138    p.set_defaults(func=spdk_kill_instance)
139
140    def framework_monitor_context_switch(args):
141        enabled = None
142        if args.enable:
143            enabled = True
144        if args.disable:
145            enabled = False
146        print_dict(rpc.app.framework_monitor_context_switch(args.client,
147                                                            enabled=enabled))
148
149    p = subparsers.add_parser('framework_monitor_context_switch',
150                              help='Control whether the context switch monitor is enabled')
151    p.add_argument('-e', '--enable', action='store_true', help='Enable context switch monitoring')
152    p.add_argument('-d', '--disable', action='store_true', help='Disable context switch monitoring')
153    p.set_defaults(func=framework_monitor_context_switch)
154
155    def framework_get_reactors(args):
156        print_dict(rpc.app.framework_get_reactors(args.client))
157
158    p = subparsers.add_parser(
159        'framework_get_reactors', help='Display list of all reactors')
160    p.set_defaults(func=framework_get_reactors)
161
162    def framework_set_scheduler(args):
163        rpc.app.framework_set_scheduler(args.client,
164                                        name=args.name,
165                                        period=args.period,
166                                        load_limit=args.load_limit,
167                                        core_limit=args.core_limit,
168                                        core_busy=args.core_busy)
169
170    p = subparsers.add_parser(
171        'framework_set_scheduler', help='Select thread scheduler that will be activated and its period (experimental)')
172    p.add_argument('name', help="Name of a scheduler")
173    p.add_argument('-p', '--period', help="Scheduler period in microseconds", type=int)
174    p.add_argument('--load-limit', help="Scheduler load limit. Reserved for dynamic scheduler", type=int, required=False)
175    p.add_argument('--core-limit', help="Scheduler core limit. Reserved for dynamic scheduler", type=int, required=False)
176    p.add_argument('--core-busy', help="Scheduler core busy limit. Reserved for dynamic schedler", type=int, required=False)
177    p.set_defaults(func=framework_set_scheduler)
178
179    def framework_get_scheduler(args):
180        print_dict(rpc.app.framework_get_scheduler(args.client))
181
182    p = subparsers.add_parser(
183        'framework_get_scheduler', help='Display currently set scheduler and its properties.')
184    p.set_defaults(func=framework_get_scheduler)
185
186    # bdev
187    def bdev_set_options(args):
188        rpc.bdev.bdev_set_options(args.client,
189                                  bdev_io_pool_size=args.bdev_io_pool_size,
190                                  bdev_io_cache_size=args.bdev_io_cache_size,
191                                  bdev_auto_examine=args.bdev_auto_examine,
192                                  small_buf_pool_size=args.small_buf_pool_size,
193                                  large_buf_pool_size=args.large_buf_pool_size)
194
195    p = subparsers.add_parser('bdev_set_options',
196                              help="""Set options of bdev subsystem""")
197    p.add_argument('-p', '--bdev-io-pool-size', help='Number of bdev_io structures in shared buffer pool', type=int)
198    p.add_argument('-c', '--bdev-io-cache-size', help='Maximum number of bdev_io structures cached per thread', type=int)
199    p.add_argument('-s', '--small-buf-pool-size', help='Maximum number of small buf (i.e., 8KB) pool size', type=int)
200    p.add_argument('-l', '--large-buf-pool-size', help='Maximum number of large buf (i.e., 64KB) pool size', type=int)
201    group = p.add_mutually_exclusive_group()
202    group.add_argument('-e', '--enable-auto-examine', dest='bdev_auto_examine', help='Allow to auto examine', action='store_true')
203    group.add_argument('-d', '--disable-auto-examine', dest='bdev_auto_examine', help='Not allow to auto examine', action='store_false')
204    p.set_defaults(bdev_auto_examine=True)
205    p.set_defaults(func=bdev_set_options)
206
207    def bdev_examine(args):
208        rpc.bdev.bdev_examine(args.client,
209                              name=args.name)
210
211    p = subparsers.add_parser('bdev_examine',
212                              help="""examine a bdev if it exists, or will examine it after it is created""")
213    p.add_argument('-b', '--name', help='Name or alias of the bdev')
214    p.set_defaults(func=bdev_examine)
215
216    def bdev_wait_for_examine(args):
217        rpc.bdev.bdev_wait_for_examine(args.client)
218
219    p = subparsers.add_parser('bdev_wait_for_examine',
220                              help="""Report when all bdevs have been examined""")
221    p.set_defaults(func=bdev_wait_for_examine)
222
223    def bdev_compress_create(args):
224        print_json(rpc.bdev.bdev_compress_create(args.client,
225                                                 base_bdev_name=args.base_bdev_name,
226                                                 pm_path=args.pm_path,
227                                                 lb_size=args.lb_size))
228
229    p = subparsers.add_parser('bdev_compress_create', help='Add a compress vbdev')
230    p.add_argument('-b', '--base-bdev-name', help="Name of the base bdev")
231    p.add_argument('-p', '--pm-path', help="Path to persistent memory")
232    p.add_argument('-l', '--lb-size', help="Compressed vol logical block size (optional, if used must be 512 or 4096)", type=int, default=0)
233    p.set_defaults(func=bdev_compress_create)
234
235    def bdev_compress_delete(args):
236        rpc.bdev.bdev_compress_delete(args.client,
237                                      name=args.name)
238
239    p = subparsers.add_parser('bdev_compress_delete', help='Delete a compress disk')
240    p.add_argument('name', help='compress bdev name')
241    p.set_defaults(func=bdev_compress_delete)
242
243    def bdev_compress_set_pmd(args):
244        rpc.bdev.bdev_compress_set_pmd(args.client,
245                                       pmd=args.pmd)
246    p = subparsers.add_parser('bdev_compress_set_pmd', help='Set pmd option for a compress disk')
247    p.add_argument('-p', '--pmd', type=int, help='0 = auto-select, 1= QAT only, 2 = ISAL only, 3 = mlx5_pci only')
248    p.set_defaults(func=bdev_compress_set_pmd)
249
250    def bdev_compress_get_orphans(args):
251        print_dict(rpc.bdev.bdev_compress_get_orphans(args.client,
252                                                      name=args.name))
253    p = subparsers.add_parser(
254        'bdev_compress_get_orphans', help='Display list of orphaned compress bdevs.')
255    p.add_argument('-b', '--name', help="Name of a comp bdev. Example: COMP_Nvme0n1", required=False)
256    p.set_defaults(func=bdev_compress_get_orphans)
257
258    def bdev_crypto_create(args):
259        print_json(rpc.bdev.bdev_crypto_create(args.client,
260                                               base_bdev_name=args.base_bdev_name,
261                                               name=args.name,
262                                               crypto_pmd=args.crypto_pmd,
263                                               key=args.key,
264                                               cipher=args.cipher,
265                                               key2=args.key2))
266    p = subparsers.add_parser('bdev_crypto_create', help='Add a crypto vbdev')
267    p.add_argument('base_bdev_name', help="Name of the base bdev")
268    p.add_argument('name', help="Name of the crypto vbdev")
269    p.add_argument('crypto_pmd', help="Name of the crypto device driver")
270    p.add_argument('key', help="Key")
271    p.add_argument('-c', '--cipher', help="cipher to use, AES_CBC or AES_XTS (QAT only)", default="AES_CBC")
272    p.add_argument('-k2', '--key2', help="2nd key for cipher AET_XTS", default=None)
273    p.set_defaults(func=bdev_crypto_create)
274
275    def bdev_crypto_delete(args):
276        rpc.bdev.bdev_crypto_delete(args.client,
277                                    name=args.name)
278
279    p = subparsers.add_parser('bdev_crypto_delete', help='Delete a crypto disk')
280    p.add_argument('name', help='crypto bdev name')
281    p.set_defaults(func=bdev_crypto_delete)
282
283    def bdev_ocf_create(args):
284        print_json(rpc.bdev.bdev_ocf_create(args.client,
285                                            name=args.name,
286                                            mode=args.mode,
287                                            cache_line_size=args.cache_line_size,
288                                            cache_bdev_name=args.cache_bdev_name,
289                                            core_bdev_name=args.core_bdev_name))
290    p = subparsers.add_parser('bdev_ocf_create', help='Add an OCF block device')
291    p.add_argument('name', help='Name of resulting OCF bdev')
292    p.add_argument('mode', help='OCF cache mode', choices=['wb', 'wt', 'pt', 'wa', 'wi', 'wo'])
293    p.add_argument(
294        '--cache-line-size',
295        help='OCF cache line size. The unit is KiB',
296        type=int,
297        choices=[4, 8, 16, 32, 64],
298        required=False,
299        default=0,
300    )
301    p.add_argument('cache_bdev_name', help='Name of underlying cache bdev')
302    p.add_argument('core_bdev_name', help='Name of underlying core bdev')
303    p.set_defaults(func=bdev_ocf_create)
304
305    def bdev_ocf_delete(args):
306        rpc.bdev.bdev_ocf_delete(args.client,
307                                 name=args.name)
308
309    p = subparsers.add_parser('bdev_ocf_delete', help='Delete an OCF block device')
310    p.add_argument('name', help='Name of OCF bdev')
311    p.set_defaults(func=bdev_ocf_delete)
312
313    def bdev_ocf_get_stats(args):
314        print_dict(rpc.bdev.bdev_ocf_get_stats(args.client,
315                                               name=args.name))
316    p = subparsers.add_parser('bdev_ocf_get_stats', help='Get statistics of chosen OCF block device')
317    p.add_argument('name', help='Name of OCF bdev')
318    p.set_defaults(func=bdev_ocf_get_stats)
319
320    def bdev_ocf_get_bdevs(args):
321        print_dict(rpc.bdev.bdev_ocf_get_bdevs(args.client,
322                                               name=args.name))
323    p = subparsers.add_parser('bdev_ocf_get_bdevs', help='Get list of OCF devices including unregistered ones')
324    p.add_argument('name', nargs='?', default=None, help='name of OCF vbdev or name of cache device or name of core device (optional)')
325    p.set_defaults(func=bdev_ocf_get_bdevs)
326
327    def bdev_ocf_set_cache_mode(args):
328        print_json(rpc.bdev.bdev_ocf_set_cache_mode(args.client,
329                                                    name=args.name,
330                                                    mode=args.mode))
331    p = subparsers.add_parser('bdev_ocf_set_cache_mode',
332                              help='Set cache mode of OCF block device')
333    p.add_argument('name', help='Name of OCF bdev')
334    p.add_argument('mode', help='OCF cache mode', choices=['wb', 'wt', 'pt', 'wa', 'wi', 'wo'])
335    p.set_defaults(func=bdev_ocf_set_cache_mode)
336
337    def bdev_ocf_set_seqcutoff(args):
338        rpc.bdev.bdev_ocf_set_seqcutoff(args.client,
339                                        name=args.name,
340                                        policy=args.policy,
341                                        threshold=args.threshold,
342                                        promotion_count=args.promotion_count)
343    p = subparsers.add_parser('bdev_ocf_set_seqcutoff',
344                              help='Set sequential cutoff parameters on all cores for the given OCF cache device')
345    p.add_argument('name', help='Name of OCF cache bdev')
346    p.add_argument('-t', '--threshold', type=int,
347                   help='Activation threshold [KiB]')
348    p.add_argument('-c', '--promotion-count', type=int,
349                   help='Promotion request count')
350    p.add_argument('-p', '--policy', choices=['always', 'full', 'never'], required=True,
351                   help='Sequential cutoff policy')
352    p.set_defaults(func=bdev_ocf_set_seqcutoff)
353
354    def bdev_malloc_create(args):
355        num_blocks = (args.total_size * 1024 * 1024) // args.block_size
356        print_json(rpc.bdev.bdev_malloc_create(args.client,
357                                               num_blocks=int(num_blocks),
358                                               block_size=args.block_size,
359                                               name=args.name,
360                                               uuid=args.uuid,
361                                               optimal_io_boundary=args.optimal_io_boundary))
362    p = subparsers.add_parser('bdev_malloc_create', help='Create a bdev with malloc backend')
363    p.add_argument('-b', '--name', help="Name of the bdev")
364    p.add_argument('-u', '--uuid', help="UUID of the bdev")
365    p.add_argument(
366        'total_size', help='Size of malloc bdev in MB (float > 0)', type=float)
367    p.add_argument('block_size', help='Block size for this bdev', type=int)
368    p.add_argument('-o', '--optimal-io-boundary', help="""Split on optimal IO boundary, in number of
369    blocks, default 0 (disabled)""", type=int)
370    p.set_defaults(func=bdev_malloc_create)
371
372    def bdev_malloc_delete(args):
373        rpc.bdev.bdev_malloc_delete(args.client,
374                                    name=args.name)
375
376    p = subparsers.add_parser('bdev_malloc_delete', help='Delete a malloc disk')
377    p.add_argument('name', help='malloc bdev name')
378    p.set_defaults(func=bdev_malloc_delete)
379
380    def bdev_null_create(args):
381        num_blocks = (args.total_size * 1024 * 1024) // args.block_size
382        if args.dif_type and not args.md_size:
383            print("ERROR: --md-size must be > 0 when --dif-type is > 0")
384            exit(1)
385        print_json(rpc.bdev.bdev_null_create(args.client,
386                                             num_blocks=num_blocks,
387                                             block_size=args.block_size,
388                                             name=args.name,
389                                             uuid=args.uuid,
390                                             md_size=args.md_size,
391                                             dif_type=args.dif_type,
392                                             dif_is_head_of_md=args.dif_is_head_of_md))
393
394    p = subparsers.add_parser('bdev_null_create', help='Add a bdev with null backend')
395    p.add_argument('name', help='Block device name')
396    p.add_argument('-u', '--uuid', help='UUID of the bdev')
397    p.add_argument('total_size', help='Size of null bdev in MB (int > 0). Includes only data blocks.', type=int)
398    p.add_argument('block_size', help='Block size for this bdev.'
399                                      'Should be a sum of block size and metadata size if --md-size is used.', type=int)
400    p.add_argument('-m', '--md-size', type=int,
401                   help='Metadata size for this bdev. Default=0.')
402    p.add_argument('-t', '--dif-type', type=int, default=0, choices=[0, 1, 2, 3],
403                   help='Protection information type. Parameter --md-size needs'
404                        'to be set along --dif-type. Default=0 - no protection.')
405    p.add_argument('-d', '--dif-is-head-of-md', action='store_true',
406                   help='Protection information is in the first 8 bytes of metadata. Default=false.')
407    p.set_defaults(func=bdev_null_create)
408
409    def bdev_null_delete(args):
410        rpc.bdev.bdev_null_delete(args.client,
411                                  name=args.name)
412
413    p = subparsers.add_parser('bdev_null_delete', help='Delete a null bdev')
414    p.add_argument('name', help='null bdev name')
415    p.set_defaults(func=bdev_null_delete)
416
417    def bdev_null_resize(args):
418        print_json(rpc.bdev.bdev_null_resize(args.client,
419                                             name=args.name,
420                                             new_size=int(args.new_size)))
421
422    p = subparsers.add_parser('bdev_null_resize',
423                              help='Resize a null bdev')
424    p.add_argument('name', help='null bdev name')
425    p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB')
426    p.set_defaults(func=bdev_null_resize)
427
428    def bdev_aio_create(args):
429        print_json(rpc.bdev.bdev_aio_create(args.client,
430                                            filename=args.filename,
431                                            name=args.name,
432                                            block_size=args.block_size))
433
434    p = subparsers.add_parser('bdev_aio_create', help='Add a bdev with aio backend')
435    p.add_argument('filename', help='Path to device or file (ex: /dev/sda)')
436    p.add_argument('name', help='Block device name')
437    p.add_argument('block_size', help='Block size for this bdev', type=int, nargs='?', default=0)
438    p.set_defaults(func=bdev_aio_create)
439
440    def bdev_aio_rescan(args):
441        print_json(rpc.bdev.bdev_aio_rescan(args.client,
442                                            name=args.name))
443
444    p = subparsers.add_parser('bdev_aio_rescan', help='Rescan a bdev size with aio backend')
445    p.add_argument('name', help='Block device name')
446    p.set_defaults(func=bdev_aio_rescan)
447
448    def bdev_aio_delete(args):
449        rpc.bdev.bdev_aio_delete(args.client,
450                                 name=args.name)
451
452    p = subparsers.add_parser('bdev_aio_delete', help='Delete an aio disk')
453    p.add_argument('name', help='aio bdev name')
454    p.set_defaults(func=bdev_aio_delete)
455
456    def bdev_uring_create(args):
457        print_json(rpc.bdev.bdev_uring_create(args.client,
458                                              filename=args.filename,
459                                              name=args.name,
460                                              block_size=args.block_size))
461
462    p = subparsers.add_parser('bdev_uring_create', help='Create a bdev with io_uring backend')
463    p.add_argument('filename', help='Path to device or file (ex: /dev/nvme0n1)')
464    p.add_argument('name', help='bdev name')
465    p.add_argument('block_size', help='Block size for this bdev', type=int, nargs='?', default=0)
466    p.set_defaults(func=bdev_uring_create)
467
468    def bdev_uring_delete(args):
469        rpc.bdev.bdev_uring_delete(args.client,
470                                   name=args.name)
471
472    p = subparsers.add_parser('bdev_uring_delete', help='Delete a uring bdev')
473    p.add_argument('name', help='uring bdev name')
474    p.set_defaults(func=bdev_uring_delete)
475
476    def bdev_nvme_set_options(args):
477        rpc.bdev.bdev_nvme_set_options(args.client,
478                                       action_on_timeout=args.action_on_timeout,
479                                       timeout_us=args.timeout_us,
480                                       timeout_admin_us=args.timeout_admin_us,
481                                       keep_alive_timeout_ms=args.keep_alive_timeout_ms,
482                                       retry_count=args.retry_count,
483                                       arbitration_burst=args.arbitration_burst,
484                                       low_priority_weight=args.low_priority_weight,
485                                       medium_priority_weight=args.medium_priority_weight,
486                                       high_priority_weight=args.high_priority_weight,
487                                       nvme_adminq_poll_period_us=args.nvme_adminq_poll_period_us,
488                                       nvme_ioq_poll_period_us=args.nvme_ioq_poll_period_us,
489                                       io_queue_requests=args.io_queue_requests,
490                                       delay_cmd_submit=args.delay_cmd_submit,
491                                       transport_retry_count=args.transport_retry_count,
492                                       bdev_retry_count=args.bdev_retry_count,
493                                       transport_ack_timeout=args.transport_ack_timeout,
494                                       ctrlr_loss_timeout_sec=args.ctrlr_loss_timeout_sec,
495                                       reconnect_delay_sec=args.reconnect_delay_sec,
496                                       fast_io_fail_timeout_sec=args.fast_io_fail_timeout_sec,
497                                       disable_auto_failback=args.disable_auto_failback)
498
499    p = subparsers.add_parser('bdev_nvme_set_options',
500                              help='Set options for the bdev nvme type. This is startup command.')
501    p.add_argument('-a', '--action-on-timeout',
502                   help="Action to take on command time out. Valid values are: none, reset, abort")
503    p.add_argument('-t', '--timeout-us',
504                   help="Timeout for each command, in microseconds. If 0, don't track timeouts.", type=int)
505    p.add_argument('--timeout-admin-us',
506                   help="Timeout for each admin command, in microseconds. If 0, treat same as io timeouts.", type=int)
507    p.add_argument('-k', '--keep-alive-timeout-ms',
508                   help="Keep alive timeout period in millisecond. If 0, disable keep-alive.", type=int)
509    p.add_argument('-n', '--retry-count',
510                   help='the number of attempts per I/O when an I/O fails. (deprecated, please use --transport-retry-count.)', type=int)
511    p.add_argument('--arbitration-burst',
512                   help='the value is expressed as a power of two', type=int)
513    p.add_argument('--low-priority-weight',
514                   help='the maximum number of commands that the controller may launch at one time from a low priority queue', type=int)
515    p.add_argument('--medium-priority-weight',
516                   help='the maximum number of commands that the controller may launch at one time from a medium priority queue', type=int)
517    p.add_argument('--high-priority-weight',
518                   help='the maximum number of commands that the controller may launch at one time from a high priority queue', type=int)
519    p.add_argument('-p', '--nvme-adminq-poll-period-us',
520                   help='How often the admin queue is polled for asynchronous events', type=int)
521    p.add_argument('-i', '--nvme-ioq-poll-period-us',
522                   help='How often to poll I/O queues for completions', type=int)
523    p.add_argument('-s', '--io-queue-requests',
524                   help='The number of requests allocated for each NVMe I/O queue. Default: 512', type=int)
525    p.add_argument('-d', '--disable-delay-cmd-submit',
526                   help='Disable delaying NVMe command submission, i.e. no batching of multiple commands',
527                   action='store_false', dest='delay_cmd_submit', default=True)
528    p.add_argument('-c', '--transport-retry-count',
529                   help='the number of attempts per I/O in the transport layer when an I/O fails.', type=int)
530    p.add_argument('-r', '--bdev-retry-count',
531                   help='the number of attempts per I/O in the bdev layer when an I/O fails. -1 means infinite retries.', type=int)
532    p.add_argument('-e', '--transport-ack-timeout',
533                   help="""Time to wait ack until packet retransmission for RDMA or until closes connection for TCP.
534                   Range 0-31 where 0 is driver-specific default value.""", type=int)
535    p.add_argument('-l', '--ctrlr-loss-timeout-sec',
536                   help="""Time to wait until ctrlr is reconnected before deleting ctrlr.
537                   -1 means infinite reconnect retries. 0 means no reconnect retry.
538                   If reconnect_delay_sec is zero, ctrlr_loss_timeout_sec has to be zero.
539                   If reconnect_delay_sec is non-zero, ctrlr_loss_timeout_sec has to be -1 or not less than
540                   reconnect_delay_sec.
541                   This can be overridden by bdev_nvme_attach_controller.""",
542                   type=int)
543    p.add_argument('-o', '--reconnect-delay-sec',
544                   help="""Time to delay a reconnect retry.
545                   If ctrlr_loss_timeout_sec is zero, reconnect_delay_sec has to be zero.
546                   If ctrlr_loss_timeout_sec is -1, reconnect_delay_sec has to be non-zero.
547                   If ctrlr_loss_timeout_sec is not -1 or zero, reconnect_delay_sec has to be non-zero and
548                   less than ctrlr_loss_timeout_sec.
549                   This can be overridden by bdev_nvme_attach_controller.""",
550                   type=int)
551    p.add_argument('-u', '--fast-io-fail-timeout-sec',
552                   help="""Time to wait until ctrlr is reconnected before failing I/O to ctrlr.
553                   0 means no such timeout.
554                   If fast_io_fail_timeout_sec is not zero, it has to be not less than reconnect_delay_sec and
555                   less than ctrlr_loss_timeout_sec if ctrlr_loss_timeout_sec is not -1.
556                   This can be overridden by bdev_nvme_attach_controller.""",
557                   type=int)
558    p.add_argument('-f', '--disable-auto-failback',
559                   help="""Disable automatic failback. bdev_nvme_set_preferred_path can be used to do manual failback.
560                   By default, immediately failback to the preferred I/O path if it restored.""",
561                   action='store_true')
562
563    p.set_defaults(func=bdev_nvme_set_options)
564
565    def bdev_nvme_set_hotplug(args):
566        rpc.bdev.bdev_nvme_set_hotplug(args.client, enable=args.enable, period_us=args.period_us)
567
568    p = subparsers.add_parser('bdev_nvme_set_hotplug', help='Set hotplug options for bdev nvme type.')
569    p.add_argument('-d', '--disable', dest='enable', default=False, action='store_false', help="Disable hotplug (default)")
570    p.add_argument('-e', '--enable', dest='enable', action='store_true', help="Enable hotplug")
571    p.add_argument('-r', '--period-us',
572                   help='How often the hotplug is processed for insert and remove events', type=int)
573    p.set_defaults(func=bdev_nvme_set_hotplug)
574
575    def bdev_nvme_attach_controller(args):
576        print_array(rpc.bdev.bdev_nvme_attach_controller(args.client,
577                                                         name=args.name,
578                                                         trtype=args.trtype,
579                                                         traddr=args.traddr,
580                                                         adrfam=args.adrfam,
581                                                         trsvcid=args.trsvcid,
582                                                         priority=args.priority,
583                                                         subnqn=args.subnqn,
584                                                         hostnqn=args.hostnqn,
585                                                         hostaddr=args.hostaddr,
586                                                         hostsvcid=args.hostsvcid,
587                                                         prchk_reftag=args.prchk_reftag,
588                                                         prchk_guard=args.prchk_guard,
589                                                         hdgst=args.hdgst,
590                                                         ddgst=args.ddgst,
591                                                         fabrics_timeout=args.fabrics_timeout,
592                                                         multipath=args.multipath,
593                                                         num_io_queues=args.num_io_queues,
594                                                         ctrlr_loss_timeout_sec=args.ctrlr_loss_timeout_sec,
595                                                         reconnect_delay_sec=args.reconnect_delay_sec,
596                                                         fast_io_fail_timeout_sec=args.fast_io_fail_timeout_sec))
597
598    p = subparsers.add_parser('bdev_nvme_attach_controller', help='Add bdevs with nvme backend')
599    p.add_argument('-b', '--name', help="Name of the NVMe controller, prefix for each bdev name", required=True)
600    p.add_argument('-t', '--trtype',
601                   help='NVMe-oF target trtype: e.g., rdma, pcie', required=True)
602    p.add_argument('-a', '--traddr',
603                   help='NVMe-oF target address: e.g., an ip address or BDF', required=True)
604    p.add_argument('-f', '--adrfam',
605                   help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
606    p.add_argument('-s', '--trsvcid',
607                   help='NVMe-oF target trsvcid: e.g., a port number')
608    p.add_argument('-p', '--priority',
609                   help='NVMe-oF connection priority: e.g., a priority number')
610    p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn')
611    p.add_argument('-q', '--hostnqn', help='NVMe-oF host subnqn')
612    p.add_argument('-i', '--hostaddr',
613                   help='NVMe-oF host address: e.g., an ip address')
614    p.add_argument('-c', '--hostsvcid',
615                   help='NVMe-oF host svcid: e.g., a port number')
616    p.add_argument('-r', '--prchk-reftag',
617                   help='Enable checking of PI reference tag for I/O processing.', action='store_true')
618    p.add_argument('-g', '--prchk-guard',
619                   help='Enable checking of PI guard for I/O processing.', action='store_true')
620    p.add_argument('-e', '--hdgst',
621                   help='Enable TCP header digest.', action='store_true')
622    p.add_argument('-d', '--ddgst',
623                   help='Enable TCP data digest.', action='store_true')
624    p.add_argument('--fabrics-timeout', type=int, help='Fabrics connect timeout in microseconds')
625    p.add_argument('-x', '--multipath', help='Set multipath behavior (disable, failover, multipath)')
626    p.add_argument('--num-io-queues', type=int, help='Set the number of IO queues to request during initialization.')
627    p.add_argument('-l', '--ctrlr-loss-timeout-sec',
628                   help="""Time to wait until ctrlr is reconnected before deleting ctrlr.
629                   -1 means infinite reconnect retries. 0 means no reconnect retry.
630                   If reconnect_delay_sec is zero, ctrlr_loss_timeout_sec has to be zero.
631                   If reconnect_delay_sec is non-zero, ctrlr_loss_timeout_sec has to be -1 or not less than
632                   reconnect_delay_sec.""",
633                   type=int)
634    p.add_argument('-o', '--reconnect-delay-sec',
635                   help="""Time to delay a reconnect retry.
636                   If ctrlr_loss_timeout_sec is zero, reconnect_delay_sec has to be zero.
637                   If ctrlr_loss_timeout_sec is -1, reconnect_delay_sec has to be non-zero.
638                   If ctrlr_loss_timeout_sec is not -1 or zero, reconnect_delay_sec has to be non-zero and
639                   less than ctrlr_loss_timeout_sec.""",
640                   type=int)
641    p.add_argument('-u', '--fast-io-fail-timeout-sec',
642                   help="""Time to wait until ctrlr is reconnected before failing I/O to ctrlr.
643                   0 means no such timeout.
644                   If fast_io_fail_timeout_sec is not zero, it has to be not less than reconnect_delay_sec and
645                   less than ctrlr_loss_timeout_sec if ctrlr_loss_timeout_sec is not -1.""",
646                   type=int)
647    p.set_defaults(func=bdev_nvme_attach_controller)
648
649    def bdev_nvme_get_controllers(args):
650        print_dict(rpc.nvme.bdev_nvme_get_controllers(args.client,
651                                                      name=args.name))
652
653    p = subparsers.add_parser(
654        'bdev_nvme_get_controllers', help='Display current NVMe controllers list or required NVMe controller')
655    p.add_argument('-n', '--name', help="Name of the NVMe controller. Example: Nvme0", required=False)
656    p.set_defaults(func=bdev_nvme_get_controllers)
657
658    def bdev_nvme_detach_controller(args):
659        rpc.bdev.bdev_nvme_detach_controller(args.client,
660                                             name=args.name,
661                                             trtype=args.trtype,
662                                             traddr=args.traddr,
663                                             adrfam=args.adrfam,
664                                             trsvcid=args.trsvcid,
665                                             subnqn=args.subnqn,
666                                             hostaddr=args.hostaddr,
667                                             hostsvcid=args.hostsvcid)
668
669    p = subparsers.add_parser('bdev_nvme_detach_controller',
670                              help='Detach an NVMe controller and delete any associated bdevs')
671    p.add_argument('name', help="Name of the controller")
672    p.add_argument('-t', '--trtype',
673                   help='NVMe-oF target trtype: e.g., rdma, pcie')
674    p.add_argument('-a', '--traddr',
675                   help='NVMe-oF target address: e.g., an ip address or BDF')
676    p.add_argument('-f', '--adrfam',
677                   help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
678    p.add_argument('-s', '--trsvcid',
679                   help='NVMe-oF target trsvcid: e.g., a port number')
680    p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn')
681    p.add_argument('-i', '--hostaddr',
682                   help='NVMe-oF host address: e.g., an ip address')
683    p.add_argument('-c', '--hostsvcid',
684                   help='NVMe-oF host svcid: e.g., a port number')
685    p.set_defaults(func=bdev_nvme_detach_controller)
686
687    def bdev_nvme_reset_controller(args):
688        rpc.bdev.bdev_nvme_reset_controller(args.client, name=args.name)
689
690    p = subparsers.add_parser('bdev_nvme_reset_controller',
691                              help='Reset an NVMe controller')
692    p.add_argument('name', help="Name of the NVMe controller")
693    p.set_defaults(func=bdev_nvme_reset_controller)
694
695    def bdev_nvme_start_discovery(args):
696        rpc.bdev.bdev_nvme_start_discovery(args.client,
697                                           name=args.name,
698                                           trtype=args.trtype,
699                                           traddr=args.traddr,
700                                           adrfam=args.adrfam,
701                                           trsvcid=args.trsvcid,
702                                           hostnqn=args.hostnqn,
703                                           wait_for_attach=args.wait_for_attach,
704                                           attach_timeout_ms=args.attach_timeout_ms,
705                                           ctrlr_loss_timeout_sec=args.ctrlr_loss_timeout_sec,
706                                           reconnect_delay_sec=args.reconnect_delay_sec,
707                                           fast_io_fail_timeout_sec=args.fast_io_fail_timeout_sec)
708
709    p = subparsers.add_parser('bdev_nvme_start_discovery', help='Start automatic discovery')
710    p.add_argument('-b', '--name', help="Name of the NVMe controller prefix for each bdev name", required=True)
711    p.add_argument('-t', '--trtype',
712                   help='NVMe-oF target trtype: e.g., rdma, pcie', required=True)
713    p.add_argument('-a', '--traddr',
714                   help='NVMe-oF target address: e.g., an ip address or BDF', required=True)
715    p.add_argument('-f', '--adrfam',
716                   help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
717    p.add_argument('-s', '--trsvcid',
718                   help='NVMe-oF target trsvcid: e.g., a port number')
719    p.add_argument('-q', '--hostnqn', help='NVMe-oF host subnqn')
720    p.add_argument('-w', '--wait-for-attach', action='store_true',
721                   help='Do not complete RPC until all discovered NVM subsystems are attached')
722    p.add_argument('-T', '--attach-timeout-ms', type=int, required=False,
723                   help="""Time to wait until the discovery and all discovered NVM subsystems
724                        are attached (default: 0, meaning wait indefinitely).  Automatically
725                        selects the --wait-for-attach option.""")
726    p.add_argument('-l', '--ctrlr-loss-timeout-sec',
727                   help="""Time to wait until ctrlr is reconnected before deleting ctrlr.
728                   -1 means infinite reconnect retries. 0 means no reconnect retry.
729                   If reconnect_delay_sec is zero, ctrlr_loss_timeout_sec has to be zero.
730                   If reconnect_delay_sec is non-zero, ctrlr_loss_timeout_sec has to be -1 or not less than
731                   reconnect_delay_sec.""",
732                   type=int)
733    p.add_argument('-o', '--reconnect-delay-sec',
734                   help="""Time to delay a reconnect retry.
735                   If ctrlr_loss_timeout_sec is zero, reconnect_delay_sec has to be zero.
736                   If ctrlr_loss_timeout_sec is -1, reconnect_delay_sec has to be non-zero.
737                   If ctrlr_loss_timeout_sec is not -1 or zero, reconnect_delay_sec has to be non-zero and
738                   less than ctrlr_loss_timeout_sec.""",
739                   type=int)
740    p.add_argument('-u', '--fast-io-fail-timeout-sec',
741                   help="""Time to wait until ctrlr is reconnected before failing I/O to ctrlr.
742                   0 means no such timeout.
743                   If fast_io_fail_timeout_sec is not zero, it has to be not less than reconnect_delay_sec and
744                   less than ctrlr_loss_timeout_sec if ctrlr_loss_timeout_sec is not -1.""",
745                   type=int)
746    p.set_defaults(func=bdev_nvme_start_discovery)
747
748    def bdev_nvme_stop_discovery(args):
749        rpc.bdev.bdev_nvme_stop_discovery(args.client, name=args.name)
750
751    p = subparsers.add_parser('bdev_nvme_stop_discovery', help='Stop automatic discovery')
752    p.add_argument('-b', '--name', help="Name of the service to stop", required=True)
753    p.set_defaults(func=bdev_nvme_stop_discovery)
754
755    def bdev_nvme_get_discovery_info(args):
756        print_dict(rpc.bdev.bdev_nvme_get_discovery_info(args.client))
757
758    p = subparsers.add_parser('bdev_nvme_get_discovery_info', help='Get information about the automatic discovery')
759    p.set_defaults(func=bdev_nvme_get_discovery_info)
760
761    def bdev_nvme_get_io_paths(args):
762        print_dict(rpc.bdev.bdev_nvme_get_io_paths(args.client, name=args.name))
763
764    p = subparsers.add_parser('bdev_nvme_get_io_paths', help='Display active I/O paths')
765    p.add_argument('-n', '--name', help="Name of the NVMe bdev", required=False)
766    p.set_defaults(func=bdev_nvme_get_io_paths)
767
768    def bdev_nvme_set_preferred_path(args):
769        rpc.bdev.bdev_nvme_set_preferred_path(args.client,
770                                              name=args.name,
771                                              cntlid=args.cntlid)
772
773    p = subparsers.add_parser('bdev_nvme_set_preferred_path',
774                              help="""Set the preferred I/O path for an NVMe bdev when in multipath mode""")
775    p.add_argument('-b', '--name', help='Name of the NVMe bdev', required=True)
776    p.add_argument('-c', '--cntlid', help='NVMe-oF controller ID', type=int, required=True)
777    p.set_defaults(func=bdev_nvme_set_preferred_path)
778
779    def bdev_nvme_set_multipath_policy(args):
780        rpc.bdev.bdev_nvme_set_multipath_policy(args.client,
781                                                name=args.name,
782                                                policy=args.policy)
783
784    p = subparsers.add_parser('bdev_nvme_set_multipath_policy',
785                              help="""Set multipath policy of the NVMe bdev""")
786    p.add_argument('-b', '--name', help='Name of the NVMe bdev', required=True)
787    p.add_argument('-p', '--policy', help='Multipath policy (active_passive or active_active)', required=True)
788    p.set_defaults(func=bdev_nvme_set_multipath_policy)
789
790    def bdev_nvme_cuse_register(args):
791        rpc.bdev.bdev_nvme_cuse_register(args.client,
792                                         name=args.name)
793
794    p = subparsers.add_parser('bdev_nvme_cuse_register',
795                              help='Register CUSE devices on NVMe controller')
796    p.add_argument('-n', '--name',
797                   help='Name of the NVMe controller. Example: Nvme0', required=True)
798    p.set_defaults(func=bdev_nvme_cuse_register)
799
800    def bdev_nvme_cuse_unregister(args):
801        rpc.bdev.bdev_nvme_cuse_unregister(args.client,
802                                           name=args.name)
803
804    p = subparsers.add_parser('bdev_nvme_cuse_unregister',
805                              help='Unregister CUSE devices on NVMe controller')
806    p.add_argument('-n', '--name',
807                   help='Name of the NVMe controller. Example: Nvme0', required=True)
808    p.set_defaults(func=bdev_nvme_cuse_unregister)
809
810    def bdev_zone_block_create(args):
811        print_json(rpc.bdev.bdev_zone_block_create(args.client,
812                                                   name=args.name,
813                                                   base_bdev=args.base_bdev,
814                                                   zone_capacity=args.zone_capacity,
815                                                   optimal_open_zones=args.optimal_open_zones))
816
817    p = subparsers.add_parser('bdev_zone_block_create',
818                              help='Create virtual zone namespace device with block device backend')
819    p.add_argument('-b', '--name', help="Name of the zone device", required=True)
820    p.add_argument('-n', '--base-bdev', help='Name of underlying, non-zoned bdev', required=True)
821    p.add_argument('-z', '--zone-capacity', help='Surfaced zone capacity in blocks', type=int, required=True)
822    p.add_argument('-o', '--optimal-open-zones', help='Number of zones required to reach optimal write speed', type=int, required=True)
823    p.set_defaults(func=bdev_zone_block_create)
824
825    def bdev_zone_block_delete(args):
826        rpc.bdev.bdev_zone_block_delete(args.client,
827                                        name=args.name)
828
829    p = subparsers.add_parser('bdev_zone_block_delete', help='Delete a virtual zone namespace device')
830    p.add_argument('name', help='Virtual zone bdev name')
831    p.set_defaults(func=bdev_zone_block_delete)
832
833    def bdev_rbd_register_cluster(args):
834        config_param = None
835        if args.config_param:
836            config_param = {}
837            for entry in args.config_param:
838                parts = entry.split('=', 1)
839                if len(parts) != 2:
840                    raise Exception('--config %s not in key=value form' % entry)
841                config_param[parts[0]] = parts[1]
842        print_json(rpc.bdev.bdev_rbd_register_cluster(args.client,
843                                                      name=args.name,
844                                                      user=args.user,
845                                                      config_param=config_param,
846                                                      config_file=args.config_file,
847                                                      key_file=args.key_file))
848
849    p = subparsers.add_parser('bdev_rbd_register_cluster',
850                              help='Add a Rados cluster with ceph rbd backend')
851    p.add_argument('name', help="Name of the Rados cluster only known to rbd bdev")
852    p.add_argument('--user', help="Ceph user name (i.e. admin, not client.admin)", required=False)
853    p.add_argument('--config-param', action='append', metavar='key=value',
854                   help="adds a key=value configuration option for rados_conf_set (default: rely on config file)")
855    p.add_argument('--config-file', help="The file path of the Rados configuration file", required=False)
856    p.add_argument('--key-file', help="The file path of the Rados keyring file", required=False)
857    p.set_defaults(func=bdev_rbd_register_cluster)
858
859    def bdev_rbd_unregister_cluster(args):
860        rpc.bdev.bdev_rbd_unregister_cluster(args.client, name=args.name)
861
862    p = subparsers.add_parser('bdev_rbd_unregister_cluster',
863                              help='Unregister a Rados cluster object')
864    p.add_argument('name', help='Name of the Rados Cluster only known to rbd bdev')
865    p.set_defaults(func=bdev_rbd_unregister_cluster)
866
867    def bdev_rbd_get_clusters_info(args):
868        print_json(rpc.bdev.bdev_rbd_get_clusters_info(args.client, name=args.name))
869
870    p = subparsers.add_parser('bdev_rbd_get_clusters_info',
871                              help='Display registered Rados Cluster names and related info')
872    p.add_argument('-b', '--name', help="Name of the registered Rados Cluster Name. Example: Cluster1", required=False)
873    p.set_defaults(func=bdev_rbd_get_clusters_info)
874
875    def bdev_rbd_create(args):
876        config = None
877        if args.config:
878            config = {}
879            for entry in args.config:
880                parts = entry.split('=', 1)
881                if len(parts) != 2:
882                    raise Exception('--config %s not in key=value form' % entry)
883                config[parts[0]] = parts[1]
884        print_json(rpc.bdev.bdev_rbd_create(args.client,
885                                            name=args.name,
886                                            user=args.user,
887                                            config=config,
888                                            pool_name=args.pool_name,
889                                            rbd_name=args.rbd_name,
890                                            block_size=args.block_size,
891                                            cluster_name=args.cluster_name,
892                                            uuid=args.uuid))
893
894    p = subparsers.add_parser('bdev_rbd_create', help='Add a bdev with ceph rbd backend')
895    p.add_argument('-b', '--name', help="Name of the bdev", required=False)
896    p.add_argument('--user', help="Ceph user name (i.e. admin, not client.admin)", required=False)
897    p.add_argument('--config', action='append', metavar='key=value',
898                   help="adds a key=value configuration option for rados_conf_set (default: rely on config file)")
899    p.add_argument('pool_name', help='rbd pool name')
900    p.add_argument('rbd_name', help='rbd image name')
901    p.add_argument('block_size', help='rbd block size', type=int)
902    p.add_argument('-c', '--cluster-name', help="cluster name to identify the Rados cluster", required=False)
903    p.add_argument('-u', '--uuid', help="UUID of the bdev")
904    p.set_defaults(func=bdev_rbd_create)
905
906    def bdev_rbd_delete(args):
907        rpc.bdev.bdev_rbd_delete(args.client,
908                                 name=args.name)
909
910    p = subparsers.add_parser('bdev_rbd_delete', help='Delete a rbd bdev')
911    p.add_argument('name', help='rbd bdev name')
912    p.set_defaults(func=bdev_rbd_delete)
913
914    def bdev_rbd_resize(args):
915        print_json(rpc.bdev.bdev_rbd_resize(args.client,
916                                            name=args.name,
917                                            new_size=int(args.new_size)))
918
919    p = subparsers.add_parser('bdev_rbd_resize',
920                              help='Resize a rbd bdev')
921    p.add_argument('name', help='rbd bdev name')
922    p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB')
923    p.set_defaults(func=bdev_rbd_resize)
924
925    def bdev_delay_create(args):
926        print_json(rpc.bdev.bdev_delay_create(args.client,
927                                              base_bdev_name=args.base_bdev_name,
928                                              name=args.name,
929                                              avg_read_latency=args.avg_read_latency,
930                                              p99_read_latency=args.nine_nine_read_latency,
931                                              avg_write_latency=args.avg_write_latency,
932                                              p99_write_latency=args.nine_nine_write_latency))
933
934    p = subparsers.add_parser('bdev_delay_create',
935                              help='Add a delay bdev on existing bdev')
936    p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True)
937    p.add_argument('-d', '--name', help="Name of the delay bdev", required=True)
938    p.add_argument('-r', '--avg-read-latency',
939                   help="Average latency to apply before completing read ops (in microseconds)", required=True, type=int)
940    p.add_argument('-t', '--nine-nine-read-latency',
941                   help="latency to apply to 1 in 100 read ops (in microseconds)", required=True, type=int)
942    p.add_argument('-w', '--avg-write-latency',
943                   help="Average latency to apply before completing write ops (in microseconds)", required=True, type=int)
944    p.add_argument('-n', '--nine-nine-write-latency',
945                   help="latency to apply to 1 in 100 write ops (in microseconds)", required=True, type=int)
946    p.set_defaults(func=bdev_delay_create)
947
948    def bdev_delay_delete(args):
949        rpc.bdev.bdev_delay_delete(args.client,
950                                   name=args.name)
951
952    p = subparsers.add_parser('bdev_delay_delete', help='Delete a delay bdev')
953    p.add_argument('name', help='delay bdev name')
954    p.set_defaults(func=bdev_delay_delete)
955
956    def bdev_delay_update_latency(args):
957        print_json(rpc.bdev.bdev_delay_update_latency(args.client,
958                                                      delay_bdev_name=args.delay_bdev_name,
959                                                      latency_type=args.latency_type,
960                                                      latency_us=args.latency_us))
961    p = subparsers.add_parser('bdev_delay_update_latency',
962                              help='Update one of the latency values for a given delay bdev')
963    p.add_argument('delay_bdev_name', help='The name of the given delay bdev')
964    p.add_argument('latency_type', help='one of: avg_read, avg_write, p99_read, p99_write. No other values accepted.')
965    p.add_argument('latency_us', help='new latency value in microseconds.', type=int)
966    p.set_defaults(func=bdev_delay_update_latency)
967
968    def bdev_error_create(args):
969        print_json(rpc.bdev.bdev_error_create(args.client,
970                                              base_name=args.base_name))
971
972    p = subparsers.add_parser('bdev_error_create', help='Add bdev with error injection backend')
973    p.add_argument('base_name', help='base bdev name')
974    p.set_defaults(func=bdev_error_create)
975
976    def bdev_error_delete(args):
977        rpc.bdev.bdev_error_delete(args.client,
978                                   name=args.name)
979
980    p = subparsers.add_parser('bdev_error_delete', help='Delete an error bdev')
981    p.add_argument('name', help='error bdev name')
982    p.set_defaults(func=bdev_error_delete)
983
984    def bdev_iscsi_create(args):
985        print_json(rpc.bdev.bdev_iscsi_create(args.client,
986                                              name=args.name,
987                                              url=args.url,
988                                              initiator_iqn=args.initiator_iqn))
989
990    p = subparsers.add_parser('bdev_iscsi_create',
991                              help='Add bdev with iSCSI initiator backend')
992    p.add_argument('-b', '--name', help="Name of the bdev", required=True)
993    p.add_argument('-i', '--initiator-iqn', help="Initiator IQN", required=True)
994    p.add_argument('--url', help="iSCSI Lun URL", required=True)
995    p.set_defaults(func=bdev_iscsi_create)
996
997    def bdev_iscsi_delete(args):
998        rpc.bdev.bdev_iscsi_delete(args.client,
999                                   name=args.name)
1000
1001    p = subparsers.add_parser('bdev_iscsi_delete', help='Delete an iSCSI bdev')
1002    p.add_argument('name', help='iSCSI bdev name')
1003    p.set_defaults(func=bdev_iscsi_delete)
1004
1005    def bdev_pmem_create(args):
1006        print_json(rpc.bdev.bdev_pmem_create(args.client,
1007                                             pmem_file=args.pmem_file,
1008                                             name=args.name))
1009
1010    p = subparsers.add_parser('bdev_pmem_create', help='Add a bdev with pmem backend')
1011    p.add_argument('pmem_file', help='Path to pmemblk pool file')
1012    p.add_argument('-n', '--name', help='Block device name', required=True)
1013    p.set_defaults(func=bdev_pmem_create)
1014
1015    def bdev_pmem_delete(args):
1016        rpc.bdev.bdev_pmem_delete(args.client,
1017                                  name=args.name)
1018
1019    p = subparsers.add_parser('bdev_pmem_delete', help='Delete a pmem bdev')
1020    p.add_argument('name', help='pmem bdev name')
1021    p.set_defaults(func=bdev_pmem_delete)
1022
1023    def bdev_passthru_create(args):
1024        print_json(rpc.bdev.bdev_passthru_create(args.client,
1025                                                 base_bdev_name=args.base_bdev_name,
1026                                                 name=args.name))
1027
1028    p = subparsers.add_parser('bdev_passthru_create', help='Add a pass through bdev on existing bdev')
1029    p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True)
1030    p.add_argument('-p', '--name', help="Name of the pass through bdev", required=True)
1031    p.set_defaults(func=bdev_passthru_create)
1032
1033    def bdev_passthru_delete(args):
1034        rpc.bdev.bdev_passthru_delete(args.client,
1035                                      name=args.name)
1036
1037    p = subparsers.add_parser('bdev_passthru_delete', help='Delete a pass through bdev')
1038    p.add_argument('name', help='pass through bdev name')
1039    p.set_defaults(func=bdev_passthru_delete)
1040
1041    def bdev_get_bdevs(args):
1042        print_dict(rpc.bdev.bdev_get_bdevs(args.client,
1043                                           name=args.name, timeout=args.timeout_ms))
1044
1045    p = subparsers.add_parser('bdev_get_bdevs',
1046                              help='Display current blockdev list or required blockdev')
1047    p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False)
1048    p.add_argument('-t', '--timeout-ms', help="""Time in ms to wait for the bdev to appear (only used
1049    with the -b|--name option). The default timeout is 0, meaning the RPC returns immediately
1050    whether the bdev exists or not.""",
1051                   type=int, required=False)
1052    p.set_defaults(func=bdev_get_bdevs)
1053
1054    def bdev_get_iostat(args):
1055        print_dict(rpc.bdev.bdev_get_iostat(args.client,
1056                                            name=args.name))
1057
1058    p = subparsers.add_parser('bdev_get_iostat',
1059                              help='Display current I/O statistics of all the blockdevs or required blockdev.')
1060    p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False)
1061    p.set_defaults(func=bdev_get_iostat)
1062
1063    def bdev_enable_histogram(args):
1064        rpc.bdev.bdev_enable_histogram(args.client, name=args.name, enable=args.enable)
1065
1066    p = subparsers.add_parser('bdev_enable_histogram',
1067                              help='Enable or disable histogram for specified bdev')
1068    p.add_argument('-e', '--enable', default=True, dest='enable', action='store_true', help='Enable histograms on specified device')
1069    p.add_argument('-d', '--disable', dest='enable', action='store_false', help='Disable histograms on specified device')
1070    p.add_argument('name', help='bdev name')
1071    p.set_defaults(func=bdev_enable_histogram)
1072
1073    def bdev_get_histogram(args):
1074        print_dict(rpc.bdev.bdev_get_histogram(args.client, name=args.name))
1075
1076    p = subparsers.add_parser('bdev_get_histogram',
1077                              help='Get histogram for specified bdev')
1078    p.add_argument('name', help='bdev name')
1079    p.set_defaults(func=bdev_get_histogram)
1080
1081    def bdev_set_qd_sampling_period(args):
1082        rpc.bdev.bdev_set_qd_sampling_period(args.client,
1083                                             name=args.name,
1084                                             period=args.period)
1085
1086    p = subparsers.add_parser('bdev_set_qd_sampling_period',
1087                              help="Enable or disable tracking of a bdev's queue depth.")
1088    p.add_argument('name', help='Blockdev name. Example: Malloc0')
1089    p.add_argument('period', help='Period with which to poll the block device queue depth in microseconds.'
1090                   ' If set to 0, polling will be disabled.',
1091                   type=int)
1092    p.set_defaults(func=bdev_set_qd_sampling_period)
1093
1094    def bdev_set_qos_limit(args):
1095        rpc.bdev.bdev_set_qos_limit(args.client,
1096                                    name=args.name,
1097                                    rw_ios_per_sec=args.rw_ios_per_sec,
1098                                    rw_mbytes_per_sec=args.rw_mbytes_per_sec,
1099                                    r_mbytes_per_sec=args.r_mbytes_per_sec,
1100                                    w_mbytes_per_sec=args.w_mbytes_per_sec)
1101
1102    p = subparsers.add_parser('bdev_set_qos_limit',
1103                              help='Set QoS rate limit on a blockdev')
1104    p.add_argument('name', help='Blockdev name to set QoS. Example: Malloc0')
1105    p.add_argument('--rw-ios-per-sec',
1106                   help='R/W IOs per second limit (>=1000, example: 20000). 0 means unlimited.',
1107                   type=int, required=False)
1108    p.add_argument('--rw-mbytes-per-sec',
1109                   help="R/W megabytes per second limit (>=10, example: 100). 0 means unlimited.",
1110                   type=int, required=False)
1111    p.add_argument('--r-mbytes-per-sec',
1112                   help="Read megabytes per second limit (>=10, example: 100). 0 means unlimited.",
1113                   type=int, required=False)
1114    p.add_argument('--w-mbytes-per-sec',
1115                   help="Write megabytes per second limit (>=10, example: 100). 0 means unlimited.",
1116                   type=int, required=False)
1117    p.set_defaults(func=bdev_set_qos_limit)
1118
1119    def bdev_error_inject_error(args):
1120        rpc.bdev.bdev_error_inject_error(args.client,
1121                                         name=args.name,
1122                                         io_type=args.io_type,
1123                                         error_type=args.error_type,
1124                                         num=args.num)
1125
1126    p = subparsers.add_parser('bdev_error_inject_error', help='bdev inject error')
1127    p.add_argument('name', help="""the name of the error injection bdev""")
1128    p.add_argument('io_type', help="""io_type: 'clear' 'read' 'write' 'unmap' 'flush' 'all'""")
1129    p.add_argument('error_type', help="""error_type: 'failure' 'pending'""")
1130    p.add_argument(
1131        '-n', '--num', help='the number of commands you want to fail', type=int, default=1)
1132    p.set_defaults(func=bdev_error_inject_error)
1133
1134    def bdev_nvme_apply_firmware(args):
1135        print_dict(rpc.bdev.bdev_nvme_apply_firmware(args.client,
1136                                                     bdev_name=args.bdev_name,
1137                                                     filename=args.filename))
1138
1139    p = subparsers.add_parser('bdev_nvme_apply_firmware', help='Download and commit firmware to NVMe device')
1140    p.add_argument('filename', help='filename of the firmware to download')
1141    p.add_argument('bdev_name', help='name of the NVMe device')
1142    p.set_defaults(func=bdev_nvme_apply_firmware)
1143
1144    def bdev_nvme_get_transport_statistics(args):
1145        print_dict(rpc.bdev.bdev_nvme_get_transport_statistics(args.client))
1146
1147    p = subparsers.add_parser('bdev_nvme_get_transport_statistics',
1148                              help='Get bdev_nvme poll group transport statistics')
1149    p.set_defaults(func=bdev_nvme_get_transport_statistics)
1150
1151    def bdev_nvme_get_controller_health_info(args):
1152        print_dict(rpc.bdev.bdev_nvme_get_controller_health_info(args.client,
1153                                                                 name=args.name))
1154
1155    p = subparsers.add_parser('bdev_nvme_get_controller_health_info',
1156                              help='Display health log of the required NVMe bdev controller.')
1157    p.add_argument('-c', '--name', help="Name of the NVMe bdev controller. Example: Nvme0", required=True)
1158    p.set_defaults(func=bdev_nvme_get_controller_health_info)
1159
1160    # iSCSI
1161    def iscsi_set_options(args):
1162        rpc.iscsi.iscsi_set_options(
1163            args.client,
1164            auth_file=args.auth_file,
1165            node_base=args.node_base,
1166            nop_timeout=args.nop_timeout,
1167            nop_in_interval=args.nop_in_interval,
1168            disable_chap=args.disable_chap,
1169            require_chap=args.require_chap,
1170            mutual_chap=args.mutual_chap,
1171            chap_group=args.chap_group,
1172            max_sessions=args.max_sessions,
1173            max_queue_depth=args.max_queue_depth,
1174            max_connections_per_session=args.max_connections_per_session,
1175            default_time2wait=args.default_time2wait,
1176            default_time2retain=args.default_time2retain,
1177            first_burst_length=args.first_burst_length,
1178            immediate_data=args.immediate_data,
1179            error_recovery_level=args.error_recovery_level,
1180            allow_duplicated_isid=args.allow_duplicated_isid,
1181            max_large_datain_per_connection=args.max_large_datain_per_connection,
1182            max_r2t_per_connection=args.max_r2t_per_connection,
1183            pdu_pool_size=args.pdu_pool_size,
1184            immediate_data_pool_size=args.immediate_data_pool_size,
1185            data_out_pool_size=args.data_out_pool_size)
1186
1187    p = subparsers.add_parser('iscsi_set_options',
1188                              help="""Set options of iSCSI subsystem""")
1189    p.add_argument('-f', '--auth-file', help='Path to CHAP shared secret file')
1190    p.add_argument('-b', '--node-base', help='Prefix of the name of iSCSI target node')
1191    p.add_argument('-o', '--nop-timeout', help='Timeout in seconds to nop-in request to the initiator', type=int)
1192    p.add_argument('-n', '--nop-in-interval', help='Time interval in secs between nop-in requests by the target', type=int)
1193    p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled.
1194    *** Mutually exclusive with --require-chap""", action='store_true')
1195    p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required.
1196    *** Mutually exclusive with --disable-chap""", action='store_true')
1197    p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true')
1198    p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session.
1199    *** Authentication group must be precreated ***""", type=int)
1200    p.add_argument('-a', '--max-sessions', help='Maximum number of sessions in the host.', type=int)
1201    p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/Os per queue.', type=int)
1202    p.add_argument('-c', '--max-connections-per-session', help='Negotiated parameter, MaxConnections.', type=int)
1203    p.add_argument('-w', '--default-time2wait', help='Negotiated parameter, DefaultTime2Wait.', type=int)
1204    p.add_argument('-v', '--default-time2retain', help='Negotiated parameter, DefaultTime2Retain.', type=int)
1205    p.add_argument('-s', '--first-burst-length', help='Negotiated parameter, FirstBurstLength.', type=int)
1206    p.add_argument('-i', '--immediate-data', help='Negotiated parameter, ImmediateData.', action='store_true')
1207    p.add_argument('-l', '--error-recovery-level', help='Negotiated parameter, ErrorRecoveryLevel', type=int)
1208    p.add_argument('-p', '--allow-duplicated-isid', help='Allow duplicated initiator session ID.', action='store_true')
1209    p.add_argument('-x', '--max-large-datain-per-connection', help='Max number of outstanding split read I/Os per connection', type=int)
1210    p.add_argument('-k', '--max-r2t-per-connection', help='Max number of outstanding R2Ts per connection', type=int)
1211    p.add_argument('-u', '--pdu-pool-size', help='Number of PDUs in the pool', type=int)
1212    p.add_argument('-j', '--immediate-data-pool-size', help='Number of immediate data buffers in the pool', type=int)
1213    p.add_argument('-z', '--data-out-pool-size', help='Number of data out buffers in the pool', type=int)
1214    p.set_defaults(func=iscsi_set_options)
1215
1216    def iscsi_set_discovery_auth(args):
1217        rpc.iscsi.iscsi_set_discovery_auth(
1218            args.client,
1219            disable_chap=args.disable_chap,
1220            require_chap=args.require_chap,
1221            mutual_chap=args.mutual_chap,
1222            chap_group=args.chap_group)
1223
1224    p = subparsers.add_parser('iscsi_set_discovery_auth',
1225                              help="""Set CHAP authentication for discovery session.""")
1226    p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled.
1227    *** Mutually exclusive with --require-chap""", action='store_true')
1228    p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required.
1229    *** Mutually exclusive with --disable-chap""", action='store_true')
1230    p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true')
1231    p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session.
1232    *** Authentication group must be precreated ***""", type=int)
1233    p.set_defaults(func=iscsi_set_discovery_auth)
1234
1235    def iscsi_create_auth_group(args):
1236        secrets = None
1237        if args.secrets:
1238            secrets = [dict(u.split(":") for u in a.split(" ")) for a in args.secrets.split(",")]
1239
1240        rpc.iscsi.iscsi_create_auth_group(args.client, tag=args.tag, secrets=secrets)
1241
1242    p = subparsers.add_parser('iscsi_create_auth_group',
1243                              help='Create authentication group for CHAP authentication.')
1244    p.add_argument('tag', help='Authentication group tag (unique, integer > 0).', type=int)
1245    p.add_argument('-c', '--secrets', help="""Comma-separated list of CHAP secrets
1246<user:user_name secret:chap_secret muser:mutual_user_name msecret:mutual_chap_secret> enclosed in quotes.
1247Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 msecret:ms2'""", required=False)
1248    p.set_defaults(func=iscsi_create_auth_group)
1249
1250    def iscsi_delete_auth_group(args):
1251        rpc.iscsi.iscsi_delete_auth_group(args.client, tag=args.tag)
1252
1253    p = subparsers.add_parser('iscsi_delete_auth_group',
1254                              help='Delete an authentication group.')
1255    p.add_argument('tag', help='Authentication group tag', type=int)
1256    p.set_defaults(func=iscsi_delete_auth_group)
1257
1258    def iscsi_auth_group_add_secret(args):
1259        rpc.iscsi.iscsi_auth_group_add_secret(
1260            args.client,
1261            tag=args.tag,
1262            user=args.user,
1263            secret=args.secret,
1264            muser=args.muser,
1265            msecret=args.msecret)
1266
1267    p = subparsers.add_parser('iscsi_auth_group_add_secret',
1268                              help='Add a secret to an authentication group.')
1269    p.add_argument('tag', help='Authentication group tag', type=int)
1270    p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True)
1271    p.add_argument('-s', '--secret', help='Secret for one-way CHAP authentication', required=True)
1272    p.add_argument('-m', '--muser', help='User name for mutual CHAP authentication')
1273    p.add_argument('-r', '--msecret', help='Secret for mutual CHAP authentication')
1274    p.set_defaults(func=iscsi_auth_group_add_secret)
1275
1276    def iscsi_auth_group_remove_secret(args):
1277        rpc.iscsi.iscsi_auth_group_remove_secret(args.client, tag=args.tag, user=args.user)
1278
1279    p = subparsers.add_parser('iscsi_auth_group_remove_secret',
1280                              help='Remove a secret from an authentication group.')
1281    p.add_argument('tag', help='Authentication group tag', type=int)
1282    p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True)
1283    p.set_defaults(func=iscsi_auth_group_remove_secret)
1284
1285    def iscsi_get_auth_groups(args):
1286        print_dict(rpc.iscsi.iscsi_get_auth_groups(args.client))
1287
1288    p = subparsers.add_parser('iscsi_get_auth_groups',
1289                              help='Display current authentication group configuration')
1290    p.set_defaults(func=iscsi_get_auth_groups)
1291
1292    def iscsi_get_portal_groups(args):
1293        print_dict(rpc.iscsi.iscsi_get_portal_groups(args.client))
1294
1295    p = subparsers.add_parser('iscsi_get_portal_groups', help='Display current portal group configuration')
1296    p.set_defaults(func=iscsi_get_portal_groups)
1297
1298    def iscsi_get_initiator_groups(args):
1299        print_dict(rpc.iscsi.iscsi_get_initiator_groups(args.client))
1300
1301    p = subparsers.add_parser('iscsi_get_initiator_groups',
1302                              help='Display current initiator group configuration')
1303    p.set_defaults(func=iscsi_get_initiator_groups)
1304
1305    def iscsi_get_target_nodes(args):
1306        print_dict(rpc.iscsi.iscsi_get_target_nodes(args.client))
1307
1308    p = subparsers.add_parser('iscsi_get_target_nodes', help='Display target nodes')
1309    p.set_defaults(func=iscsi_get_target_nodes)
1310
1311    def iscsi_create_target_node(args):
1312        luns = []
1313        for u in args.bdev_name_id_pairs.strip().split(" "):
1314            bdev_name, lun_id = u.split(":")
1315            luns.append({"bdev_name": bdev_name, "lun_id": int(lun_id)})
1316
1317        pg_ig_maps = []
1318        for u in args.pg_ig_mappings.strip().split(" "):
1319            pg, ig = u.split(":")
1320            pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)})
1321
1322        rpc.iscsi.iscsi_create_target_node(
1323            args.client,
1324            luns=luns,
1325            pg_ig_maps=pg_ig_maps,
1326            name=args.name,
1327            alias_name=args.alias_name,
1328            queue_depth=args.queue_depth,
1329            chap_group=args.chap_group,
1330            disable_chap=args.disable_chap,
1331            require_chap=args.require_chap,
1332            mutual_chap=args.mutual_chap,
1333            header_digest=args.header_digest,
1334            data_digest=args.data_digest)
1335
1336    p = subparsers.add_parser('iscsi_create_target_node', help='Add a target node')
1337    p.add_argument('name', help='Target node name (ASCII)')
1338    p.add_argument('alias_name', help='Target node alias name (ASCII)')
1339    p.add_argument('bdev_name_id_pairs', help="""Whitespace-separated list of <bdev name:LUN ID> pairs enclosed
1340    in quotes.  Format:  'bdev_name0:id0 bdev_name1:id1' etc
1341    Example: 'Malloc0:0 Malloc1:1 Malloc5:2'
1342    *** The bdevs must pre-exist ***
1343    *** LUN0 (id = 0) is required ***
1344    *** bdevs names cannot contain space or colon characters ***""")
1345    p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings
1346    Whitespace separated, quoted, mapping defined with colon
1347    separated list of "tags" (int > 0)
1348    Example: '1:1 2:2 2:1'
1349    *** The Portal/Initiator Groups must be precreated ***""")
1350    p.add_argument('queue_depth', help='Desired target queue depth', type=int)
1351    p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node.
1352    *** Authentication group must be precreated ***""", type=int, default=0)
1353    p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node.
1354    *** Mutually exclusive with --require-chap ***""", action='store_true')
1355    p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node.
1356    *** Mutually exclusive with --disable-chap ***""", action='store_true')
1357    p.add_argument(
1358        '-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', action='store_true')
1359    p.add_argument('-H', '--header-digest',
1360                   help='Header Digest should be required for this target node.', action='store_true')
1361    p.add_argument('-D', '--data-digest',
1362                   help='Data Digest should be required for this target node.', action='store_true')
1363    p.set_defaults(func=iscsi_create_target_node)
1364
1365    def iscsi_target_node_add_lun(args):
1366        rpc.iscsi.iscsi_target_node_add_lun(
1367            args.client,
1368            name=args.name,
1369            bdev_name=args.bdev_name,
1370            lun_id=args.lun_id)
1371
1372    p = subparsers.add_parser('iscsi_target_node_add_lun',
1373                              help='Add LUN to the target node')
1374    p.add_argument('name', help='Target node name (ASCII)')
1375    p.add_argument('bdev_name', help="""bdev name enclosed in quotes.
1376    *** bdev name cannot contain space or colon characters ***""")
1377    p.add_argument('-i', dest='lun_id', help="""LUN ID (integer >= 0)
1378    *** If LUN ID is omitted or -1, the lowest free one is assigned ***""", type=int, required=False)
1379    p.set_defaults(func=iscsi_target_node_add_lun)
1380
1381    def iscsi_target_node_set_auth(args):
1382        rpc.iscsi.iscsi_target_node_set_auth(
1383            args.client,
1384            name=args.name,
1385            chap_group=args.chap_group,
1386            disable_chap=args.disable_chap,
1387            require_chap=args.require_chap,
1388            mutual_chap=args.mutual_chap)
1389
1390    p = subparsers.add_parser('iscsi_target_node_set_auth',
1391                              help='Set CHAP authentication for the target node')
1392    p.add_argument('name', help='Target node name (ASCII)')
1393    p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node.
1394    *** Authentication group must be precreated ***""", type=int, default=0)
1395    p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node.
1396    *** Mutually exclusive with --require-chap ***""", action='store_true')
1397    p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node.
1398    *** Mutually exclusive with --disable-chap ***""", action='store_true')
1399    p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.',
1400                   action='store_true')
1401    p.set_defaults(func=iscsi_target_node_set_auth)
1402
1403    def iscsi_target_node_add_pg_ig_maps(args):
1404        pg_ig_maps = []
1405        for u in args.pg_ig_mappings.strip().split(" "):
1406            pg, ig = u.split(":")
1407            pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)})
1408        rpc.iscsi.iscsi_target_node_add_pg_ig_maps(
1409            args.client,
1410            pg_ig_maps=pg_ig_maps,
1411            name=args.name)
1412
1413    p = subparsers.add_parser('iscsi_target_node_add_pg_ig_maps',
1414                              help='Add PG-IG maps to the target node')
1415    p.add_argument('name', help='Target node name (ASCII)')
1416    p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings
1417    Whitespace separated, quoted, mapping defined with colon
1418    separated list of "tags" (int > 0)
1419    Example: '1:1 2:2 2:1'
1420    *** The Portal/Initiator Groups must be precreated ***""")
1421    p.set_defaults(func=iscsi_target_node_add_pg_ig_maps)
1422
1423    def iscsi_target_node_remove_pg_ig_maps(args):
1424        pg_ig_maps = []
1425        for u in args.pg_ig_mappings.strip().split(" "):
1426            pg, ig = u.split(":")
1427            pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)})
1428        rpc.iscsi.iscsi_target_node_remove_pg_ig_maps(
1429            args.client, pg_ig_maps=pg_ig_maps, name=args.name)
1430
1431    p = subparsers.add_parser('iscsi_target_node_remove_pg_ig_maps',
1432                              help='Delete PG-IG maps from the target node')
1433    p.add_argument('name', help='Target node name (ASCII)')
1434    p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings
1435    Whitespace separated, quoted, mapping defined with colon
1436    separated list of "tags" (int > 0)
1437    Example: '1:1 2:2 2:1'
1438    *** The Portal/Initiator Groups must be precreated ***""")
1439    p.set_defaults(func=iscsi_target_node_remove_pg_ig_maps)
1440
1441    def iscsi_target_node_set_redirect(args):
1442        rpc.iscsi.iscsi_target_node_set_redirect(
1443            args.client,
1444            name=args.name,
1445            pg_tag=args.pg_tag,
1446            redirect_host=args.redirect_host,
1447            redirect_port=args.redirect_port)
1448
1449    p = subparsers.add_parser('iscsi_target_node_set_redirect',
1450                              help="""Update redirect portal of the public portal group for the target node.
1451    Omit redirect host and port to clear previously set redirect settings.""")
1452    p.add_argument('name', help='Target node name (ASCII)')
1453    p.add_argument('pg_tag', help='Portal group tag (unique, integer > 0)', type=int)
1454    p.add_argument('-a', '--redirect-host', help='Numeric IP address for redirect portal', required=False)
1455    p.add_argument('-p', '--redirect-port', help='Numeric TCP port for redirect portal', required=False)
1456    p.set_defaults(func=iscsi_target_node_set_redirect)
1457
1458    def iscsi_target_node_request_logout(args):
1459        rpc.iscsi.iscsi_target_node_request_logout(
1460            args.client,
1461            name=args.name,
1462            pg_tag=args.pg_tag)
1463
1464    p = subparsers.add_parser('iscsi_target_node_request_logout',
1465                              help="""For the target node, request connections whose portal group tag
1466    match to logout, or request all connections if portal group tag is omitted.""")
1467    p.add_argument('name', help='Target node name (ASCII)')
1468    p.add_argument('-t', '--pg-tag', help='Portal group tag (unique, integer > 0)', type=int, required=False)
1469    p.set_defaults(func=iscsi_target_node_request_logout)
1470
1471    def iscsi_create_portal_group(args):
1472        portals = []
1473        for p in args.portal_list.strip().split(' '):
1474            ip, separator, port_cpumask = p.rpartition(':')
1475            split_port_cpumask = port_cpumask.split('@')
1476            if len(split_port_cpumask) == 1:
1477                port = port_cpumask
1478                portals.append({'host': ip, 'port': port})
1479            else:
1480                port = split_port_cpumask[0]
1481                cpumask = split_port_cpumask[1]
1482                portals.append({'host': ip, 'port': port})
1483                print("WARNING: Specifying a portal group with a CPU mask is no longer supported. Ignoring it.")
1484        rpc.iscsi.iscsi_create_portal_group(
1485            args.client,
1486            portals=portals,
1487            tag=args.tag,
1488            private=args.private,
1489            wait=args.wait)
1490
1491    p = subparsers.add_parser('iscsi_create_portal_group',
1492                              help='Add a portal group')
1493    p.add_argument(
1494        'tag', help='Portal group tag (unique, integer > 0)', type=int)
1495    p.add_argument('portal_list', help="""List of portals in host:port format, separated by whitespace
1496    Example: '192.168.100.100:3260 192.168.100.100:3261 192.168.100.100:3262""")
1497    p.add_argument('-p', '--private', help="""Public (false) or private (true) portal group.
1498    Private portal groups do not have their portals returned by a discovery session. A public
1499    portal group may optionally specify a redirect portal for non-discovery logins. This redirect
1500    portal must be from a private portal group.""", action='store_true')
1501    p.add_argument('-w', '--wait', help="""Do not listening on portals until it is started explicitly.
1502    One major iSCSI initiator may not retry login once it failed. Hence for such initiator, listening
1503    on portals should be allowed after all associated target nodes are created.""", action='store_true')
1504    p.set_defaults(func=iscsi_create_portal_group)
1505
1506    def iscsi_start_portal_group(args):
1507        rpc.iscsi.iscsi_start_portal_group(args.client, tag=args.tag)
1508
1509    p = subparsers.add_parser('iscsi_start_portal_group',
1510                              help='Start listening on portals if it is not started yet.')
1511    p.add_argument(
1512        'tag', help='Portal group tag (unique, integer > 0)', type=int)
1513    p.set_defaults(func=iscsi_start_portal_group)
1514
1515    def iscsi_create_initiator_group(args):
1516        initiators = []
1517        netmasks = []
1518        for i in args.initiator_list.strip().split(' '):
1519            initiators.append(i)
1520        for n in args.netmask_list.strip().split(' '):
1521            netmasks.append(n)
1522        rpc.iscsi.iscsi_create_initiator_group(
1523            args.client,
1524            tag=args.tag,
1525            initiators=initiators,
1526            netmasks=netmasks)
1527
1528    p = subparsers.add_parser('iscsi_create_initiator_group',
1529                              help='Add an initiator group')
1530    p.add_argument(
1531        'tag', help='Initiator group tag (unique, integer > 0)', type=int)
1532    p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses,
1533    enclosed in quotes.  Example: 'ANY' or 'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""")
1534    p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes.
1535    Example: '255.255.0.0 255.248.0.0' etc""")
1536    p.set_defaults(func=iscsi_create_initiator_group)
1537
1538    def iscsi_initiator_group_add_initiators(args):
1539        initiators = None
1540        netmasks = None
1541        if args.initiator_list:
1542            initiators = []
1543            for i in args.initiator_list.strip().split(' '):
1544                initiators.append(i)
1545        if args.netmask_list:
1546            netmasks = []
1547            for n in args.netmask_list.strip().split(' '):
1548                netmasks.append(n)
1549        rpc.iscsi.iscsi_initiator_group_add_initiators(
1550            args.client,
1551            tag=args.tag,
1552            initiators=initiators,
1553            netmasks=netmasks)
1554
1555    p = subparsers.add_parser('iscsi_initiator_group_add_initiators',
1556                              help='Add initiators to an existing initiator group')
1557    p.add_argument(
1558        'tag', help='Initiator group tag (unique, integer > 0)', type=int)
1559    p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses,
1560    enclosed in quotes.  This parameter can be omitted.  Example: 'ANY' or
1561    'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""", required=False)
1562    p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes.
1563    This parameter can be omitted.  Example: '255.255.0.0 255.248.0.0' etc""", required=False)
1564    p.set_defaults(func=iscsi_initiator_group_add_initiators)
1565
1566    def iscsi_initiator_group_remove_initiators(args):
1567        initiators = None
1568        netmasks = None
1569        if args.initiator_list:
1570            initiators = []
1571            for i in args.initiator_list.strip().split(' '):
1572                initiators.append(i)
1573        if args.netmask_list:
1574            netmasks = []
1575            for n in args.netmask_list.strip().split(' '):
1576                netmasks.append(n)
1577        rpc.iscsi.iscsi_initiator_group_remove_initiators(
1578            args.client,
1579            tag=args.tag,
1580            initiators=initiators,
1581            netmasks=netmasks)
1582
1583    p = subparsers.add_parser('iscsi_initiator_group_remove_initiators',
1584                              help='Delete initiators from an existing initiator group')
1585    p.add_argument(
1586        'tag', help='Initiator group tag (unique, integer > 0)', type=int)
1587    p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses,
1588    enclosed in quotes.  This parameter can be omitted.  Example: 'ANY' or
1589    'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""", required=False)
1590    p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes.
1591    This parameter can be omitted.  Example: '255.255.0.0 255.248.0.0' etc""", required=False)
1592    p.set_defaults(func=iscsi_initiator_group_remove_initiators)
1593
1594    def iscsi_delete_target_node(args):
1595        rpc.iscsi.iscsi_delete_target_node(
1596            args.client, target_node_name=args.target_node_name)
1597
1598    p = subparsers.add_parser('iscsi_delete_target_node',
1599                              help='Delete a target node')
1600    p.add_argument('target_node_name',
1601                   help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.')
1602    p.set_defaults(func=iscsi_delete_target_node)
1603
1604    def iscsi_delete_portal_group(args):
1605        rpc.iscsi.iscsi_delete_portal_group(args.client, tag=args.tag)
1606
1607    p = subparsers.add_parser('iscsi_delete_portal_group',
1608                              help='Delete a portal group')
1609    p.add_argument(
1610        'tag', help='Portal group tag (unique, integer > 0)', type=int)
1611    p.set_defaults(func=iscsi_delete_portal_group)
1612
1613    def iscsi_delete_initiator_group(args):
1614        rpc.iscsi.iscsi_delete_initiator_group(args.client, tag=args.tag)
1615
1616    p = subparsers.add_parser('iscsi_delete_initiator_group',
1617                              help='Delete an initiator group')
1618    p.add_argument(
1619        'tag', help='Initiator group tag (unique, integer > 0)', type=int)
1620    p.set_defaults(func=iscsi_delete_initiator_group)
1621
1622    def iscsi_portal_group_set_auth(args):
1623        rpc.iscsi.iscsi_portal_group_set_auth(
1624            args.client,
1625            tag=args.tag,
1626            chap_group=args.chap_group,
1627            disable_chap=args.disable_chap,
1628            require_chap=args.require_chap,
1629            mutual_chap=args.mutual_chap)
1630
1631    p = subparsers.add_parser('iscsi_portal_group_set_auth',
1632                              help='Set CHAP authentication for discovery sessions specific for the portal group')
1633    p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int)
1634    p.add_argument('-g', '--chap-group', help="""Authentication group ID for this portal group.
1635    *** Authentication group must be precreated ***""", type=int, default=0)
1636    p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this portal group.
1637    *** Mutually exclusive with --require-chap ***""", action='store_true')
1638    p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this portal group.
1639    *** Mutually exclusive with --disable-chap ***""", action='store_true')
1640    p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.',
1641                   action='store_true')
1642    p.set_defaults(func=iscsi_portal_group_set_auth)
1643
1644    def iscsi_get_connections(args):
1645        print_dict(rpc.iscsi.iscsi_get_connections(args.client))
1646
1647    p = subparsers.add_parser('iscsi_get_connections',
1648                              help='Display iSCSI connections')
1649    p.set_defaults(func=iscsi_get_connections)
1650
1651    def iscsi_get_options(args):
1652        print_dict(rpc.iscsi.iscsi_get_options(args.client))
1653
1654    p = subparsers.add_parser('iscsi_get_options',
1655                              help='Display iSCSI global parameters')
1656    p.set_defaults(func=iscsi_get_options)
1657
1658    def scsi_get_devices(args):
1659        print_dict(rpc.iscsi.scsi_get_devices(args.client))
1660
1661    p = subparsers.add_parser('scsi_get_devices', help='Display SCSI devices')
1662    p.set_defaults(func=scsi_get_devices)
1663
1664    # trace
1665    def trace_enable_tpoint_group(args):
1666        rpc.trace.trace_enable_tpoint_group(args.client, name=args.name)
1667
1668    p = subparsers.add_parser('trace_enable_tpoint_group', aliases=['enable_tpoint_group'],
1669                              help='enable trace on a specific tpoint group')
1670    p.add_argument(
1671        'name', help="""trace group name we want to enable in tpoint_group_mask.
1672        (for example "bdev" for bdev trace group, "all" for all trace groups).""")
1673    p.set_defaults(func=trace_enable_tpoint_group)
1674
1675    def trace_disable_tpoint_group(args):
1676        rpc.trace.trace_disable_tpoint_group(args.client, name=args.name)
1677
1678    p = subparsers.add_parser('trace_disable_tpoint_group', aliases=['disable_tpoint_group'],
1679                              help='disable trace on a specific tpoint group')
1680    p.add_argument(
1681        'name', help="""trace group name we want to disable in tpoint_group_mask.
1682        (for example "bdev" for bdev trace group, "all" for all trace groups).""")
1683    p.set_defaults(func=trace_disable_tpoint_group)
1684
1685    def trace_set_tpoint_mask(args):
1686        rpc.trace.trace_set_tpoint_mask(args.client, name=args.name, tpoint_mask=args.tpoint_mask)
1687
1688    p = subparsers.add_parser('trace_set_tpoint_mask',
1689                              help='enable tracepoint mask on a specific tpoint group')
1690    p.add_argument(
1691        'name', help="""trace group name we want to enable in tpoint_group_mask.
1692        (for example "bdev" for bdev trace group)""")
1693    p.add_argument(
1694        'tpoint_mask', help="""tracepoints to be enabled inside a given trace group.
1695        (for example value of "0x3" will enable only the first two tpoints in this group)""",
1696        type=lambda m: int(m, 16))
1697    p.set_defaults(func=trace_set_tpoint_mask)
1698
1699    def trace_clear_tpoint_mask(args):
1700        rpc.trace.trace_clear_tpoint_mask(args.client, name=args.name, tpoint_mask=args.tpoint_mask)
1701
1702    p = subparsers.add_parser('trace_clear_tpoint_mask',
1703                              help='disable tracepoint mask on a specific tpoint group')
1704    p.add_argument(
1705        'name', help="""trace group name we want to disable in tpoint_group_mask.
1706        (for example "bdev" for bdev trace group)""")
1707    p.add_argument(
1708        'tpoint_mask', help="""tracepoints to be disabled inside a given trace group.
1709        (for example value of "0x3" will disable the first two tpoints in this group)""",
1710        type=lambda m: int(m, 16))
1711    p.set_defaults(func=trace_clear_tpoint_mask)
1712
1713    def trace_get_tpoint_group_mask(args):
1714        print_dict(rpc.trace.trace_get_tpoint_group_mask(args.client))
1715
1716    p = subparsers.add_parser('trace_get_tpoint_group_mask', aliases=['get_tpoint_group_mask'],
1717                              help='get trace point group mask')
1718    p.set_defaults(func=trace_get_tpoint_group_mask)
1719
1720    # log
1721    def log_set_flag(args):
1722        rpc.log.log_set_flag(args.client, flag=args.flag)
1723
1724    p = subparsers.add_parser('log_set_flag', help='set log flag')
1725    p.add_argument(
1726        'flag', help='log flag we want to set. (for example "nvme").')
1727    p.set_defaults(func=log_set_flag)
1728
1729    def log_clear_flag(args):
1730        rpc.log.log_clear_flag(args.client, flag=args.flag)
1731
1732    p = subparsers.add_parser('log_clear_flag', help='clear log flag')
1733    p.add_argument(
1734        'flag', help='log flag we want to clear. (for example "nvme").')
1735    p.set_defaults(func=log_clear_flag)
1736
1737    def log_get_flags(args):
1738        print_dict(rpc.log.log_get_flags(args.client))
1739
1740    p = subparsers.add_parser('log_get_flags', help='get log flags')
1741    p.set_defaults(func=log_get_flags)
1742
1743    def log_set_level(args):
1744        rpc.log.log_set_level(args.client, level=args.level)
1745
1746    p = subparsers.add_parser('log_set_level', help='set log level')
1747    p.add_argument('level', help='log level we want to set. (for example "DEBUG").')
1748    p.set_defaults(func=log_set_level)
1749
1750    def log_get_level(args):
1751        print_dict(rpc.log.log_get_level(args.client))
1752
1753    p = subparsers.add_parser('log_get_level', help='get log level')
1754    p.set_defaults(func=log_get_level)
1755
1756    def log_set_print_level(args):
1757        rpc.log.log_set_print_level(args.client, level=args.level)
1758
1759    p = subparsers.add_parser('log_set_print_level', help='set log print level')
1760    p.add_argument('level', help='log print level we want to set. (for example "DEBUG").')
1761    p.set_defaults(func=log_set_print_level)
1762
1763    def log_get_print_level(args):
1764        print_dict(rpc.log.log_get_print_level(args.client))
1765
1766    p = subparsers.add_parser('log_get_print_level', help='get log print level')
1767    p.set_defaults(func=log_get_print_level)
1768
1769    # lvol
1770    def bdev_lvol_create_lvstore(args):
1771        print_json(rpc.lvol.bdev_lvol_create_lvstore(args.client,
1772                                                     bdev_name=args.bdev_name,
1773                                                     lvs_name=args.lvs_name,
1774                                                     cluster_sz=args.cluster_sz,
1775                                                     clear_method=args.clear_method))
1776
1777    p = subparsers.add_parser('bdev_lvol_create_lvstore', help='Add logical volume store on base bdev')
1778    p.add_argument('bdev_name', help='base bdev name')
1779    p.add_argument('lvs_name', help='name for lvol store')
1780    p.add_argument('-c', '--cluster-sz', help='size of cluster (in bytes)', type=int, required=False)
1781    p.add_argument('--clear-method', help="""Change clear method for data region.
1782        Available: none, unmap, write_zeroes""", required=False)
1783    p.set_defaults(func=bdev_lvol_create_lvstore)
1784
1785    def bdev_lvol_rename_lvstore(args):
1786        rpc.lvol.bdev_lvol_rename_lvstore(args.client,
1787                                          old_name=args.old_name,
1788                                          new_name=args.new_name)
1789
1790    p = subparsers.add_parser('bdev_lvol_rename_lvstore', help='Change logical volume store name')
1791    p.add_argument('old_name', help='old name')
1792    p.add_argument('new_name', help='new name')
1793    p.set_defaults(func=bdev_lvol_rename_lvstore)
1794
1795    def bdev_lvol_create(args):
1796        print_json(rpc.lvol.bdev_lvol_create(args.client,
1797                                             lvol_name=args.lvol_name,
1798                                             size=args.size * 1024 * 1024,
1799                                             thin_provision=args.thin_provision,
1800                                             clear_method=args.clear_method,
1801                                             uuid=args.uuid,
1802                                             lvs_name=args.lvs_name))
1803
1804    p = subparsers.add_parser('bdev_lvol_create', help='Add a bdev with an logical volume backend')
1805    p.add_argument('-u', '--uuid', help='lvol store UUID', required=False)
1806    p.add_argument('-l', '--lvs-name', help='lvol store name', required=False)
1807    p.add_argument('-t', '--thin-provision', action='store_true', help='create lvol bdev as thin provisioned')
1808    p.add_argument('-c', '--clear-method', help="""Change default data clusters clear method.
1809        Available: none, unmap, write_zeroes""", required=False)
1810    p.add_argument('lvol_name', help='name for this lvol')
1811    p.add_argument('size', help='size in MiB for this bdev', type=int)
1812    p.set_defaults(func=bdev_lvol_create)
1813
1814    def bdev_lvol_snapshot(args):
1815        print_json(rpc.lvol.bdev_lvol_snapshot(args.client,
1816                                               lvol_name=args.lvol_name,
1817                                               snapshot_name=args.snapshot_name))
1818
1819    p = subparsers.add_parser('bdev_lvol_snapshot', help='Create a snapshot of an lvol bdev')
1820    p.add_argument('lvol_name', help='lvol bdev name')
1821    p.add_argument('snapshot_name', help='lvol snapshot name')
1822    p.set_defaults(func=bdev_lvol_snapshot)
1823
1824    def bdev_lvol_clone(args):
1825        print_json(rpc.lvol.bdev_lvol_clone(args.client,
1826                                            snapshot_name=args.snapshot_name,
1827                                            clone_name=args.clone_name))
1828
1829    p = subparsers.add_parser('bdev_lvol_clone', help='Create a clone of an lvol snapshot')
1830    p.add_argument('snapshot_name', help='lvol snapshot name')
1831    p.add_argument('clone_name', help='lvol clone name')
1832    p.set_defaults(func=bdev_lvol_clone)
1833
1834    def bdev_lvol_rename(args):
1835        rpc.lvol.bdev_lvol_rename(args.client,
1836                                  old_name=args.old_name,
1837                                  new_name=args.new_name)
1838
1839    p = subparsers.add_parser('bdev_lvol_rename', help='Change lvol bdev name')
1840    p.add_argument('old_name', help='lvol bdev name')
1841    p.add_argument('new_name', help='new lvol name')
1842    p.set_defaults(func=bdev_lvol_rename)
1843
1844    def bdev_lvol_inflate(args):
1845        rpc.lvol.bdev_lvol_inflate(args.client,
1846                                   name=args.name)
1847
1848    p = subparsers.add_parser('bdev_lvol_inflate', help='Make thin provisioned lvol a thick provisioned lvol')
1849    p.add_argument('name', help='lvol bdev name')
1850    p.set_defaults(func=bdev_lvol_inflate)
1851
1852    def bdev_lvol_decouple_parent(args):
1853        rpc.lvol.bdev_lvol_decouple_parent(args.client,
1854                                           name=args.name)
1855
1856    p = subparsers.add_parser('bdev_lvol_decouple_parent', help='Decouple parent of lvol')
1857    p.add_argument('name', help='lvol bdev name')
1858    p.set_defaults(func=bdev_lvol_decouple_parent)
1859
1860    def bdev_lvol_resize(args):
1861        rpc.lvol.bdev_lvol_resize(args.client,
1862                                  name=args.name,
1863                                  size=args.size * 1024 * 1024)
1864
1865    p = subparsers.add_parser('bdev_lvol_resize', help='Resize existing lvol bdev')
1866    p.add_argument('name', help='lvol bdev name')
1867    p.add_argument('size', help='new size in MiB for this bdev', type=int)
1868    p.set_defaults(func=bdev_lvol_resize)
1869
1870    def bdev_lvol_set_read_only(args):
1871        rpc.lvol.bdev_lvol_set_read_only(args.client,
1872                                         name=args.name)
1873
1874    p = subparsers.add_parser('bdev_lvol_set_read_only', help='Mark lvol bdev as read only')
1875    p.add_argument('name', help='lvol bdev name')
1876    p.set_defaults(func=bdev_lvol_set_read_only)
1877
1878    def bdev_lvol_delete(args):
1879        rpc.lvol.bdev_lvol_delete(args.client,
1880                                  name=args.name)
1881
1882    p = subparsers.add_parser('bdev_lvol_delete', help='Destroy a logical volume')
1883    p.add_argument('name', help='lvol bdev name')
1884    p.set_defaults(func=bdev_lvol_delete)
1885
1886    def bdev_lvol_delete_lvstore(args):
1887        rpc.lvol.bdev_lvol_delete_lvstore(args.client,
1888                                          uuid=args.uuid,
1889                                          lvs_name=args.lvs_name)
1890
1891    p = subparsers.add_parser('bdev_lvol_delete_lvstore', help='Destroy an logical volume store')
1892    p.add_argument('-u', '--uuid', help='lvol store UUID', required=False)
1893    p.add_argument('-l', '--lvs-name', help='lvol store name', required=False)
1894    p.set_defaults(func=bdev_lvol_delete_lvstore)
1895
1896    def bdev_lvol_get_lvstores(args):
1897        print_dict(rpc.lvol.bdev_lvol_get_lvstores(args.client,
1898                                                   uuid=args.uuid,
1899                                                   lvs_name=args.lvs_name))
1900
1901    p = subparsers.add_parser('bdev_lvol_get_lvstores', help='Display current logical volume store list')
1902    p.add_argument('-u', '--uuid', help='lvol store UUID', required=False)
1903    p.add_argument('-l', '--lvs-name', help='lvol store name', required=False)
1904    p.set_defaults(func=bdev_lvol_get_lvstores)
1905
1906    def bdev_raid_get_bdevs(args):
1907        print_array(rpc.bdev.bdev_raid_get_bdevs(args.client,
1908                                                 category=args.category))
1909
1910    p = subparsers.add_parser('bdev_raid_get_bdevs',
1911                              help="""This is used to list all the raid bdev names based on the input category
1912    requested. Category should be one of 'all', 'online', 'configuring' or 'offline'. 'all' means all the raid bdevs whether
1913    they are online or configuring or offline. 'online' is the raid bdev which is registered with bdev layer. 'configuring'
1914    is the raid bdev which does not have full configuration discovered yet. 'offline' is the raid bdev which is not registered
1915    with bdev as of now and it has encountered any error or user has requested to offline the raid bdev""")
1916    p.add_argument('category', help='all or online or configuring or offline')
1917    p.set_defaults(func=bdev_raid_get_bdevs)
1918
1919    def bdev_raid_create(args):
1920        base_bdevs = []
1921        for u in args.base_bdevs.strip().split(" "):
1922            base_bdevs.append(u)
1923
1924        rpc.bdev.bdev_raid_create(args.client,
1925                                  name=args.name,
1926                                  strip_size_kb=args.strip_size_kb,
1927                                  raid_level=args.raid_level,
1928                                  base_bdevs=base_bdevs)
1929    p = subparsers.add_parser('bdev_raid_create', help='Create new raid bdev')
1930    p.add_argument('-n', '--name', help='raid bdev name', required=True)
1931    p.add_argument('-z', '--strip-size-kb', help='strip size in KB', type=int)
1932    p.add_argument('-r', '--raid-level', help='raid level, raid0 and a special level concat are supported', required=True)
1933    p.add_argument('-b', '--base-bdevs', help='base bdevs name, whitespace separated list in quotes', required=True)
1934    p.set_defaults(func=bdev_raid_create)
1935
1936    def bdev_raid_delete(args):
1937        rpc.bdev.bdev_raid_delete(args.client,
1938                                  name=args.name)
1939    p = subparsers.add_parser('bdev_raid_delete', help='Delete existing raid bdev')
1940    p.add_argument('name', help='raid bdev name')
1941    p.set_defaults(func=bdev_raid_delete)
1942
1943    # split
1944    def bdev_split_create(args):
1945        print_array(rpc.bdev.bdev_split_create(args.client,
1946                                               base_bdev=args.base_bdev,
1947                                               split_count=args.split_count,
1948                                               split_size_mb=args.split_size_mb))
1949
1950    p = subparsers.add_parser('bdev_split_create',
1951                              help="""Add given disk name to split config. If bdev with base_name
1952    name exist the split bdevs will be created right away, if not split bdevs will be created when base bdev became
1953    available (during examination process).""")
1954    p.add_argument('base_bdev', help='base bdev name')
1955    p.add_argument('-s', '--split-size-mb', help='size in MiB for each bdev', type=int, default=0)
1956    p.add_argument('split_count', help="""Optional - number of split bdevs to create. Total size * split_count must not
1957    exceed the base bdev size.""", type=int)
1958    p.set_defaults(func=bdev_split_create)
1959
1960    def bdev_split_delete(args):
1961        rpc.bdev.bdev_split_delete(args.client,
1962                                   base_bdev=args.base_bdev)
1963
1964    p = subparsers.add_parser('bdev_split_delete', help="""Delete split config with all created splits.""")
1965    p.add_argument('base_bdev', help='base bdev name')
1966    p.set_defaults(func=bdev_split_delete)
1967
1968    # ftl
1969    ftl_valid_limits = ('crit', 'high', 'low', 'start')
1970
1971    def bdev_ftl_create(args):
1972        def parse_limits(limits, arg_dict, key_suffix=''):
1973            for limit in limits.split(','):
1974                key, value = limit.split(':', 1)
1975                if key in ftl_valid_limits:
1976                    arg_dict['limit_' + key + key_suffix] = int(value)
1977                else:
1978                    raise ValueError('Limit {} is not supported'.format(key))
1979
1980        arg_limits = {}
1981        if args.limit_threshold:
1982            parse_limits(args.limit_threshold, arg_limits, '_threshold')
1983
1984        if args.limit:
1985            parse_limits(args.limit, arg_limits)
1986
1987        print_dict(rpc.bdev.bdev_ftl_create(args.client,
1988                                            name=args.name,
1989                                            base_bdev=args.base_bdev,
1990                                            uuid=args.uuid,
1991                                            cache=args.cache,
1992                                            allow_open_bands=args.allow_open_bands,
1993                                            overprovisioning=args.overprovisioning,
1994                                            l2p_path=args.l2p_path,
1995                                            use_append=args.use_append,
1996                                            **arg_limits))
1997
1998    p = subparsers.add_parser('bdev_ftl_create', help='Add FTL bdev')
1999    p.add_argument('-b', '--name', help="Name of the bdev", required=True)
2000    p.add_argument('-d', '--base-bdev', help='Name of zoned bdev used as underlying device',
2001                   required=True)
2002    p.add_argument('-u', '--uuid', help='UUID of restored bdev (not applicable when creating new '
2003                   'instance): e.g. b286d19a-0059-4709-abcd-9f7732b1567d (optional)')
2004    p.add_argument('-c', '--cache', help='Name of the bdev to be used as a write buffer cache (optional)')
2005    p.add_argument('-o', '--allow-open-bands', help='Restoring after dirty shutdown without cache will'
2006                   ' result in partial data recovery, instead of error', action='store_true')
2007    p.add_argument('--overprovisioning', help='Percentage of device used for relocation, not exposed'
2008                   ' to user (optional)', type=int)
2009    p.add_argument('--l2p-path', help='Path to persistent memory file or device to store l2p onto, '
2010                                      'by default l2p is kept in DRAM and is volatile (optional)')
2011    p.add_argument('--use-append', help='Use appends instead of writes', action='store_true')
2012
2013    limits = p.add_argument_group('Defrag limits', 'Configures defrag limits and thresholds for'
2014                                  ' levels ' + str(ftl_valid_limits)[1:-1])
2015    limits.add_argument('--limit', help='Percentage of allowed user versus internal writes at given'
2016                        ' levels, e.g. crit:0,high:20,low:80')
2017    limits.add_argument('--limit-threshold', help='Number of free bands triggering a given level of'
2018                        ' write limiting e.g. crit:1,high:2,low:3,start:4')
2019    p.set_defaults(func=bdev_ftl_create)
2020
2021    def bdev_ftl_delete(args):
2022        print_dict(rpc.bdev.bdev_ftl_delete(args.client, name=args.name))
2023
2024    p = subparsers.add_parser('bdev_ftl_delete', help='Delete FTL bdev')
2025    p.add_argument('-b', '--name', help="Name of the bdev", required=True)
2026    p.set_defaults(func=bdev_ftl_delete)
2027
2028    # vmd
2029    def enable_vmd(args):
2030        print_dict(rpc.vmd.enable_vmd(args.client))
2031
2032    p = subparsers.add_parser('enable_vmd', help='Enable VMD enumeration')
2033    p.set_defaults(func=enable_vmd)
2034
2035    # nbd
2036    def nbd_start_disk(args):
2037        print(rpc.nbd.nbd_start_disk(args.client,
2038                                     bdev_name=args.bdev_name,
2039                                     nbd_device=args.nbd_device))
2040
2041    p = subparsers.add_parser('nbd_start_disk',
2042                              help='Export a bdev as an nbd disk')
2043    p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.')
2044    p.add_argument('nbd_device', help='Nbd device name to be assigned. Example: /dev/nbd0.', nargs='?')
2045    p.set_defaults(func=nbd_start_disk)
2046
2047    def nbd_stop_disk(args):
2048        rpc.nbd.nbd_stop_disk(args.client,
2049                              nbd_device=args.nbd_device)
2050
2051    p = subparsers.add_parser('nbd_stop_disk',
2052                              help='Stop an nbd disk')
2053    p.add_argument('nbd_device', help='Nbd device name to be stopped. Example: /dev/nbd0.')
2054    p.set_defaults(func=nbd_stop_disk)
2055
2056    def nbd_get_disks(args):
2057        print_dict(rpc.nbd.nbd_get_disks(args.client,
2058                                         nbd_device=args.nbd_device))
2059
2060    p = subparsers.add_parser('nbd_get_disks',
2061                              help='Display full or specified nbd device list')
2062    p.add_argument('-n', '--nbd-device', help="Path of the nbd device. Example: /dev/nbd0", required=False)
2063    p.set_defaults(func=nbd_get_disks)
2064
2065    # NVMe-oF
2066    def nvmf_set_max_subsystems(args):
2067        rpc.nvmf.nvmf_set_max_subsystems(args.client,
2068                                         max_subsystems=args.max_subsystems)
2069
2070    p = subparsers.add_parser('nvmf_set_max_subsystems',
2071                              help='Set the maximum number of NVMf target subsystems')
2072    p.add_argument('-x', '--max-subsystems', help='Max number of NVMf subsystems', type=int, required=True)
2073    p.set_defaults(func=nvmf_set_max_subsystems)
2074
2075    def nvmf_set_config(args):
2076        rpc.nvmf.nvmf_set_config(args.client,
2077                                 passthru_identify_ctrlr=args.passthru_identify_ctrlr,
2078                                 poll_groups_mask=args.poll_groups_mask,
2079                                 discovery_filter=args.discovery_filter)
2080
2081    p = subparsers.add_parser('nvmf_set_config', help='Set NVMf target config')
2082    p.add_argument('-i', '--passthru-identify-ctrlr', help="""Passthrough fields like serial number and model number
2083    when the controller has a single namespace that is an NVMe bdev""", action='store_true')
2084    p.add_argument('-m', '--poll-groups-mask', help='Set cpumask for NVMf poll groups (optional)', type=str)
2085    p.add_argument('-d', '--discovery-filter', help="""Set discovery filter (optional), possible values are: `match_any` (default) or
2086         comma separated values: `transport`, `address`, `svcid`""", type=str)
2087    p.set_defaults(func=nvmf_set_config)
2088
2089    def nvmf_create_transport(args):
2090        rpc.nvmf.nvmf_create_transport(**vars(args))
2091
2092    p = subparsers.add_parser('nvmf_create_transport', help='Create NVMf transport')
2093    p.add_argument('-t', '--trtype', help='Transport type (ex. RDMA)', type=str, required=True)
2094    p.add_argument('-g', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2095    p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/O per queue', type=int)
2096    p.add_argument('-m', '--max-io-qpairs-per-ctrlr', help='Max number of IO qpairs per controller', type=int)
2097    p.add_argument('-c', '--in-capsule-data-size', help='Max number of in-capsule data size', type=int)
2098    p.add_argument('-i', '--max-io-size', help='Max I/O size (bytes)', type=int)
2099    p.add_argument('-u', '--io-unit-size', help='I/O unit size (bytes)', type=int)
2100    p.add_argument('-a', '--max-aq-depth', help='Max number of admin cmds per AQ', type=int)
2101    p.add_argument('-n', '--num-shared-buffers', help='The number of pooled data buffers available to the transport', type=int)
2102    p.add_argument('-b', '--buf-cache-size', help='The number of shared buffers to reserve for each poll group', type=int)
2103    p.add_argument('-z', '--zcopy', action='store_true', help='''Use zero-copy operations if the
2104    underlying bdev supports them''')
2105    p.add_argument('-d', '--num-cqe', help="""The number of CQ entires. Only used when no_srq=true.
2106    Relevant only for RDMA transport""", type=int)
2107    p.add_argument('-s', '--max-srq-depth', help='Max number of outstanding I/O per SRQ. Relevant only for RDMA transport', type=int)
2108    p.add_argument('-r', '--no-srq', action='store_true', help='Disable per-thread shared receive queue. Relevant only for RDMA transport')
2109    p.add_argument('-o', '--c2h-success', action='store_false', help='Disable C2H success optimization. Relevant only for TCP transport')
2110    p.add_argument('-f', '--dif-insert-or-strip', action='store_true', help='Enable DIF insert/strip. Relevant only for TCP transport')
2111    p.add_argument('-y', '--sock-priority', help='The sock priority of the tcp connection. Relevant only for TCP transport', type=int)
2112    p.add_argument('-l', '--acceptor-backlog', help='Pending connections allowed at one time. Relevant only for RDMA transport', type=int)
2113    p.add_argument('-x', '--abort-timeout-sec', help='Abort execution timeout value, in seconds', type=int)
2114    p.add_argument('-w', '--no-wr-batching', action='store_true', help='Disable work requests batching. Relevant only for RDMA transport')
2115    p.add_argument('-e', '--control-msg-num', help="""The number of control messages per poll group.
2116    Relevant only for TCP transport""", type=int)
2117    p.add_argument('-M', '--disable-mappable-bar0', action='store_true', help="""Disable mmap() of BAR0.
2118    Relevant only for VFIO-USER transport""")
2119    p.add_argument('-I', '--disable-adaptive-irq', action='store_true', help="""Disable adaptive interrupt feature.
2120    Relevant only for VFIO-USER transport""")
2121    p.add_argument('-S', '--disable-shadow-doorbells', action='store_true', help="""Disable shadow doorbell support.
2122    Relevant only for VFIO-USER transport""")
2123    p.add_argument('--acceptor-poll-rate', help='Polling interval of the acceptor for incoming connections (usec)', type=int)
2124    p.set_defaults(func=nvmf_create_transport)
2125
2126    def nvmf_get_transports(args):
2127        print_dict(rpc.nvmf.nvmf_get_transports(args.client, trtype=args.trtype, tgt_name=args.tgt_name))
2128
2129    p = subparsers.add_parser('nvmf_get_transports', help='Display nvmf transports or required transport')
2130    p.add_argument('--trtype', help='Transport type (optional)')
2131    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2132    p.set_defaults(func=nvmf_get_transports)
2133
2134    def nvmf_get_subsystems(args):
2135        print_dict(rpc.nvmf.nvmf_get_subsystems(args.client, nqn=args.nqn, tgt_name=args.tgt_name))
2136
2137    p = subparsers.add_parser('nvmf_get_subsystems', help='Display nvmf subsystems or required subsystem')
2138    p.add_argument('nqn', help='Subsystem NQN (optional)', nargs="?", default=None)
2139    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2140    p.set_defaults(func=nvmf_get_subsystems)
2141
2142    def nvmf_create_subsystem(args):
2143        rpc.nvmf.nvmf_create_subsystem(args.client,
2144                                       nqn=args.nqn,
2145                                       tgt_name=args.tgt_name,
2146                                       serial_number=args.serial_number,
2147                                       model_number=args.model_number,
2148                                       allow_any_host=args.allow_any_host,
2149                                       max_namespaces=args.max_namespaces,
2150                                       ana_reporting=args.ana_reporting,
2151                                       min_cntlid=args.min_cntlid,
2152                                       max_cntlid=args.max_cntlid)
2153
2154    p = subparsers.add_parser('nvmf_create_subsystem', help='Create an NVMe-oF subsystem')
2155    p.add_argument('nqn', help='Subsystem NQN (ASCII)')
2156    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2157    p.add_argument("-s", "--serial-number", help="""
2158    Format:  'sn' etc
2159    Example: 'SPDK00000000000001'""", default='00000000000000000000')
2160    p.add_argument("-d", "--model-number", help="""
2161    Format:  'mn' etc
2162    Example: 'SPDK Controller'""", default='SPDK bdev Controller')
2163    p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce allowed host NQN list)")
2164    p.add_argument("-m", "--max-namespaces", help="Maximum number of namespaces allowed",
2165                   type=int, default=0)
2166    p.add_argument("-r", "--ana-reporting", action='store_true', help="Enable ANA reporting feature")
2167    p.add_argument("-i", "--min_cntlid", help="Minimum controller ID", type=int, default=1)
2168    p.add_argument("-I", "--max_cntlid", help="Maximum controller ID", type=int, default=0xffef)
2169    p.set_defaults(func=nvmf_create_subsystem)
2170
2171    def nvmf_delete_subsystem(args):
2172        rpc.nvmf.nvmf_delete_subsystem(args.client,
2173                                       nqn=args.subsystem_nqn,
2174                                       tgt_name=args.tgt_name)
2175
2176    p = subparsers.add_parser('nvmf_delete_subsystem', help='Delete a nvmf subsystem')
2177    p.add_argument('subsystem_nqn',
2178                   help='subsystem nqn to be deleted. Example: nqn.2016-06.io.spdk:cnode1.')
2179    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2180    p.set_defaults(func=nvmf_delete_subsystem)
2181
2182    def nvmf_subsystem_add_listener(args):
2183        rpc.nvmf.nvmf_subsystem_add_listener(**vars(args))
2184
2185    p = subparsers.add_parser('nvmf_subsystem_add_listener', help='Add a listener to an NVMe-oF subsystem')
2186    p.add_argument('nqn', help='NVMe-oF subsystem NQN (\'discovery\' can be used as shortcut for discovery NQN)')
2187    p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True)
2188    p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True)
2189    p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2190    p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
2191    p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for RDMA or TCP)')
2192    p.set_defaults(func=nvmf_subsystem_add_listener)
2193
2194    def nvmf_subsystem_remove_listener(args):
2195        rpc.nvmf.nvmf_subsystem_remove_listener(args.client,
2196                                                nqn=args.nqn,
2197                                                trtype=args.trtype,
2198                                                traddr=args.traddr,
2199                                                tgt_name=args.tgt_name,
2200                                                adrfam=args.adrfam,
2201                                                trsvcid=args.trsvcid)
2202
2203    p = subparsers.add_parser('nvmf_subsystem_remove_listener', help='Remove a listener from an NVMe-oF subsystem')
2204    p.add_argument('nqn', help='NVMe-oF subsystem NQN (\'discovery\' can be used as shortcut for discovery NQN)')
2205    p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True)
2206    p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True)
2207    p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2208    p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
2209    p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for TCP and RDMA transport types)')
2210    p.set_defaults(func=nvmf_subsystem_remove_listener)
2211
2212    def nvmf_subsystem_listener_set_ana_state(args):
2213        rpc.nvmf.nvmf_subsystem_listener_set_ana_state(args.client,
2214                                                       nqn=args.nqn,
2215                                                       ana_state=args.ana_state,
2216                                                       trtype=args.trtype,
2217                                                       traddr=args.traddr,
2218                                                       tgt_name=args.tgt_name,
2219                                                       adrfam=args.adrfam,
2220                                                       trsvcid=args.trsvcid,
2221                                                       anagrpid=args.anagrpid)
2222
2223    p = subparsers.add_parser('nvmf_subsystem_listener_set_ana_state', help='Set ANA state of a listener for an NVMe-oF subsystem')
2224    p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2225    p.add_argument('-n', '--ana-state', help='ANA state to set: optimized, non_optimized, or inaccessible', required=True)
2226    p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True)
2227    p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True)
2228    p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2229    p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
2230    p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number')
2231    p.add_argument('-g', '--anagrpid', help='ANA group ID (optional)', type=int)
2232    p.set_defaults(func=nvmf_subsystem_listener_set_ana_state)
2233
2234    def nvmf_subsystem_add_ns(args):
2235        rpc.nvmf.nvmf_subsystem_add_ns(args.client,
2236                                       nqn=args.nqn,
2237                                       bdev_name=args.bdev_name,
2238                                       tgt_name=args.tgt_name,
2239                                       ptpl_file=args.ptpl_file,
2240                                       nsid=args.nsid,
2241                                       nguid=args.nguid,
2242                                       eui64=args.eui64,
2243                                       uuid=args.uuid,
2244                                       anagrpid=args.anagrpid)
2245
2246    p = subparsers.add_parser('nvmf_subsystem_add_ns', help='Add a namespace to an NVMe-oF subsystem')
2247    p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2248    p.add_argument('bdev_name', help='The name of the bdev that will back this namespace')
2249    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2250    p.add_argument('-p', '--ptpl-file', help='The persistent reservation storage location (optional)', type=str)
2251    p.add_argument('-n', '--nsid', help='The requested NSID (optional)', type=int)
2252    p.add_argument('-g', '--nguid', help='Namespace globally unique identifier (optional)')
2253    p.add_argument('-e', '--eui64', help='Namespace EUI-64 identifier (optional)')
2254    p.add_argument('-u', '--uuid', help='Namespace UUID (optional)')
2255    p.add_argument('-a', '--anagrpid', help='ANA group ID (optional)', type=int)
2256    p.set_defaults(func=nvmf_subsystem_add_ns)
2257
2258    def nvmf_subsystem_remove_ns(args):
2259        rpc.nvmf.nvmf_subsystem_remove_ns(args.client,
2260                                          nqn=args.nqn,
2261                                          nsid=args.nsid,
2262                                          tgt_name=args.tgt_name)
2263
2264    p = subparsers.add_parser('nvmf_subsystem_remove_ns', help='Remove a namespace to an NVMe-oF subsystem')
2265    p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2266    p.add_argument('nsid', help='The requested NSID', type=int)
2267    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2268    p.set_defaults(func=nvmf_subsystem_remove_ns)
2269
2270    def nvmf_subsystem_add_host(args):
2271        rpc.nvmf.nvmf_subsystem_add_host(args.client,
2272                                         nqn=args.nqn,
2273                                         host=args.host,
2274                                         tgt_name=args.tgt_name)
2275
2276    p = subparsers.add_parser('nvmf_subsystem_add_host', help='Add a host to an NVMe-oF subsystem')
2277    p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2278    p.add_argument('host', help='Host NQN to allow')
2279    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2280    p.set_defaults(func=nvmf_subsystem_add_host)
2281
2282    def nvmf_subsystem_remove_host(args):
2283        rpc.nvmf.nvmf_subsystem_remove_host(args.client,
2284                                            nqn=args.nqn,
2285                                            host=args.host,
2286                                            tgt_name=args.tgt_name)
2287
2288    p = subparsers.add_parser('nvmf_subsystem_remove_host', help='Remove a host from an NVMe-oF subsystem')
2289    p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2290    p.add_argument('host', help='Host NQN to remove')
2291    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2292    p.set_defaults(func=nvmf_subsystem_remove_host)
2293
2294    def nvmf_subsystem_allow_any_host(args):
2295        rpc.nvmf.nvmf_subsystem_allow_any_host(args.client,
2296                                               nqn=args.nqn,
2297                                               disable=args.disable,
2298                                               tgt_name=args.tgt_name)
2299
2300    p = subparsers.add_parser('nvmf_subsystem_allow_any_host', help='Allow any host to connect to the subsystem')
2301    p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2302    p.add_argument('-e', '--enable', action='store_true', help='Enable allowing any host')
2303    p.add_argument('-d', '--disable', action='store_true', help='Disable allowing any host')
2304    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2305    p.set_defaults(func=nvmf_subsystem_allow_any_host)
2306
2307    def nvmf_subsystem_get_controllers(args):
2308        print_dict(rpc.nvmf.nvmf_subsystem_get_controllers(args.client,
2309                                                           nqn=args.nqn,
2310                                                           tgt_name=args.tgt_name))
2311
2312    p = subparsers.add_parser('nvmf_subsystem_get_controllers',
2313                              help='Display controllers of an NVMe-oF subsystem.')
2314    p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2315    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2316    p.set_defaults(func=nvmf_subsystem_get_controllers)
2317
2318    def nvmf_subsystem_get_qpairs(args):
2319        print_dict(rpc.nvmf.nvmf_subsystem_get_qpairs(args.client,
2320                                                      nqn=args.nqn,
2321                                                      tgt_name=args.tgt_name))
2322
2323    p = subparsers.add_parser('nvmf_subsystem_get_qpairs',
2324                              help='Display queue pairs of an NVMe-oF subsystem.')
2325    p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2326    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2327    p.set_defaults(func=nvmf_subsystem_get_qpairs)
2328
2329    def nvmf_subsystem_get_listeners(args):
2330        print_dict(rpc.nvmf.nvmf_subsystem_get_listeners(args.client,
2331                                                         nqn=args.nqn,
2332                                                         tgt_name=args.tgt_name))
2333
2334    p = subparsers.add_parser('nvmf_subsystem_get_listeners',
2335                              help='Display listeners of an NVMe-oF subsystem.')
2336    p.add_argument('nqn', help='NVMe-oF subsystem NQN')
2337    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2338    p.set_defaults(func=nvmf_subsystem_get_listeners)
2339
2340    def nvmf_get_stats(args):
2341        print_dict(rpc.nvmf.nvmf_get_stats(args.client, tgt_name=args.tgt_name))
2342
2343    p = subparsers.add_parser(
2344        'nvmf_get_stats', help='Display current statistics for NVMf subsystem')
2345    p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str)
2346    p.set_defaults(func=nvmf_get_stats)
2347
2348    def nvmf_set_crdt(args):
2349        print_dict(rpc.nvmf.nvmf_set_crdt(args.client, args.crdt1, args.crdt2, args.crdt3))
2350
2351    p = subparsers.add_parser(
2352        'nvmf_set_crdt',
2353        help="""Set the 3 crdt (Command Retry Delay Time) values for NVMf subsystem. All
2354        values are in units of 100 milliseconds (same as the NVM Express specification).""")
2355    p.add_argument('-t1', '--crdt1', help='Command Retry Delay Time 1, in units of 100 milliseconds', type=int)
2356    p.add_argument('-t2', '--crdt2', help='Command Retry Delay Time 2, in units of 100 milliseconds', type=int)
2357    p.add_argument('-t3', '--crdt3', help='Command Retry Delay Time 3, in units of 100 milliseconds', type=int)
2358    p.set_defaults(func=nvmf_set_crdt)
2359
2360    # pmem
2361    def bdev_pmem_create_pool(args):
2362        num_blocks = int((args.total_size * 1024 * 1024) / args.block_size)
2363        rpc.pmem.bdev_pmem_create_pool(args.client,
2364                                       pmem_file=args.pmem_file,
2365                                       num_blocks=num_blocks,
2366                                       block_size=args.block_size)
2367
2368    p = subparsers.add_parser('bdev_pmem_create_pool', help='Create pmem pool')
2369    p.add_argument('pmem_file', help='Path to pmemblk pool file')
2370    p.add_argument('total_size', help='Size of pmem bdev in MB (int > 0)', type=int)
2371    p.add_argument('block_size', help='Block size for this pmem pool', type=int)
2372    p.set_defaults(func=bdev_pmem_create_pool)
2373
2374    def bdev_pmem_get_pool_info(args):
2375        print_dict(rpc.pmem.bdev_pmem_get_pool_info(args.client,
2376                                                    pmem_file=args.pmem_file))
2377
2378    p = subparsers.add_parser('bdev_pmem_get_pool_info', help='Display pmem pool info and check consistency')
2379    p.add_argument('pmem_file', help='Path to pmemblk pool file')
2380    p.set_defaults(func=bdev_pmem_get_pool_info)
2381
2382    def bdev_pmem_delete_pool(args):
2383        rpc.pmem.bdev_pmem_delete_pool(args.client,
2384                                       pmem_file=args.pmem_file)
2385
2386    p = subparsers.add_parser('bdev_pmem_delete_pool', help='Delete pmem pool')
2387    p.add_argument('pmem_file', help='Path to pmemblk pool file')
2388    p.set_defaults(func=bdev_pmem_delete_pool)
2389
2390    # subsystem
2391    def framework_get_subsystems(args):
2392        print_dict(rpc.subsystem.framework_get_subsystems(args.client))
2393
2394    p = subparsers.add_parser('framework_get_subsystems',
2395                              help="""Print subsystems array in initialization order. Each subsystem
2396    entry contain (unsorted) array of subsystems it depends on.""")
2397    p.set_defaults(func=framework_get_subsystems)
2398
2399    def framework_get_config(args):
2400        print_dict(rpc.subsystem.framework_get_config(args.client, args.name))
2401
2402    p = subparsers.add_parser('framework_get_config', help="""Print subsystem configuration""")
2403    p.add_argument('name', help='Name of subsystem to query')
2404    p.set_defaults(func=framework_get_config)
2405
2406    # vhost
2407    def vhost_controller_set_coalescing(args):
2408        rpc.vhost.vhost_controller_set_coalescing(args.client,
2409                                                  ctrlr=args.ctrlr,
2410                                                  delay_base_us=args.delay_base_us,
2411                                                  iops_threshold=args.iops_threshold)
2412
2413    p = subparsers.add_parser('vhost_controller_set_coalescing', help='Set vhost controller coalescing')
2414    p.add_argument('ctrlr', help='controller name')
2415    p.add_argument('delay_base_us', help='Base delay time', type=int)
2416    p.add_argument('iops_threshold', help='IOPS threshold when coalescing is enabled', type=int)
2417    p.set_defaults(func=vhost_controller_set_coalescing)
2418
2419    def virtio_blk_create_transport(args):
2420        rpc.vhost.virtio_blk_create_transport(args.client,
2421                                              name=args.name,
2422                                              opts=args.opts)
2423
2424    p = subparsers.add_parser('virtio_blk_create_transport',
2425                              help='Create virtio blk transport')
2426    p.add_argument('name', help='transport name')
2427    p.set_defaults(func=virtio_blk_create_transport)
2428
2429    def vhost_create_scsi_controller(args):
2430        rpc.vhost.vhost_create_scsi_controller(args.client,
2431                                               ctrlr=args.ctrlr,
2432                                               cpumask=args.cpumask)
2433
2434    p = subparsers.add_parser('vhost_create_scsi_controller', help='Add new vhost controller')
2435    p.add_argument('ctrlr', help='controller name')
2436    p.add_argument('--cpumask', help='cpu mask for this controller')
2437    p.set_defaults(func=vhost_create_scsi_controller)
2438
2439    def vhost_scsi_controller_add_target(args):
2440        print_json(rpc.vhost.vhost_scsi_controller_add_target(args.client,
2441                                                              ctrlr=args.ctrlr,
2442                                                              scsi_target_num=args.scsi_target_num,
2443                                                              bdev_name=args.bdev_name))
2444
2445    p = subparsers.add_parser('vhost_scsi_controller_add_target', help='Add lun to vhost controller')
2446    p.add_argument('ctrlr', help='controller name where add lun')
2447    p.add_argument('scsi_target_num', help='scsi_target_num', type=int)
2448    p.add_argument('bdev_name', help='bdev name')
2449    p.set_defaults(func=vhost_scsi_controller_add_target)
2450
2451    def vhost_scsi_controller_remove_target(args):
2452        rpc.vhost.vhost_scsi_controller_remove_target(args.client,
2453                                                      ctrlr=args.ctrlr,
2454                                                      scsi_target_num=args.scsi_target_num)
2455
2456    p = subparsers.add_parser('vhost_scsi_controller_remove_target',
2457                              help='Remove target from vhost controller')
2458    p.add_argument('ctrlr', help='controller name to remove target from')
2459    p.add_argument('scsi_target_num', help='scsi_target_num', type=int)
2460    p.set_defaults(func=vhost_scsi_controller_remove_target)
2461
2462    def vhost_create_blk_controller(args):
2463        rpc.vhost.vhost_create_blk_controller(args.client,
2464                                              ctrlr=args.ctrlr,
2465                                              dev_name=args.dev_name,
2466                                              cpumask=args.cpumask,
2467                                              transport=args.transport,
2468                                              readonly=args.readonly,
2469                                              packed_ring=args.packed_ring,
2470                                              packed_ring_recovery=args.packed_ring_recovery)
2471
2472    p = subparsers.add_parser('vhost_create_blk_controller', help='Add a new vhost block controller')
2473    p.add_argument('ctrlr', help='controller name')
2474    p.add_argument('dev_name', help='device name')
2475    p.add_argument('--cpumask', help='cpu mask for this controller')
2476    p.add_argument('--transport', help='virtio blk transport name (default: vhost_user_blk)')
2477    p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only')
2478    p.add_argument("-p", "--packed_ring", action='store_true', help='Set controller as packed ring supported')
2479    p.add_argument("-l", "--packed_ring_recovery", action='store_true', help='Enable packed ring live recovery')
2480    p.set_defaults(func=vhost_create_blk_controller)
2481
2482    def vhost_get_controllers(args):
2483        print_dict(rpc.vhost.vhost_get_controllers(args.client, args.name))
2484
2485    p = subparsers.add_parser('vhost_get_controllers', help='List all or specific vhost controller(s)')
2486    p.add_argument('-n', '--name', help="Name of vhost controller", required=False)
2487    p.set_defaults(func=vhost_get_controllers)
2488
2489    def vhost_delete_controller(args):
2490        rpc.vhost.vhost_delete_controller(args.client,
2491                                          ctrlr=args.ctrlr)
2492
2493    p = subparsers.add_parser('vhost_delete_controller', help='Delete a vhost controller')
2494    p.add_argument('ctrlr', help='controller name')
2495    p.set_defaults(func=vhost_delete_controller)
2496
2497    def bdev_virtio_attach_controller(args):
2498        print_array(rpc.vhost.bdev_virtio_attach_controller(args.client,
2499                                                            name=args.name,
2500                                                            trtype=args.trtype,
2501                                                            traddr=args.traddr,
2502                                                            dev_type=args.dev_type,
2503                                                            vq_count=args.vq_count,
2504                                                            vq_size=args.vq_size))
2505
2506    p = subparsers.add_parser('bdev_virtio_attach_controller',
2507                              help="""Attach virtio controller using provided
2508    transport type and device type. This will also create bdevs for any block devices connected to the
2509    controller (for example, SCSI devices for a virtio-scsi controller).
2510    Result is array of added bdevs.""")
2511    p.add_argument('name', help="Use this name as base for new created bdevs")
2512    p.add_argument('-t', '--trtype',
2513                   help='Virtio target transport type: pci or user', required=True)
2514    p.add_argument('-a', '--traddr',
2515                   help='Transport type specific target address: e.g. UNIX domain socket path or BDF', required=True)
2516    p.add_argument('-d', '--dev-type',
2517                   help='Device type: blk or scsi', required=True)
2518    p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int)
2519    p.add_argument('--vq-size', help='Size of each queue', type=int)
2520    p.set_defaults(func=bdev_virtio_attach_controller)
2521
2522    def bdev_virtio_scsi_get_devices(args):
2523        print_dict(rpc.vhost.bdev_virtio_scsi_get_devices(args.client))
2524
2525    p = subparsers.add_parser('bdev_virtio_scsi_get_devices', help='List all Virtio-SCSI devices.')
2526    p.set_defaults(func=bdev_virtio_scsi_get_devices)
2527
2528    def bdev_virtio_detach_controller(args):
2529        rpc.vhost.bdev_virtio_detach_controller(args.client,
2530                                                name=args.name)
2531
2532    p = subparsers.add_parser('bdev_virtio_detach_controller', help="""Remove a Virtio device
2533    This will delete all bdevs exposed by this device""")
2534    p.add_argument('name', help='Virtio device name. E.g. VirtioUser0')
2535    p.set_defaults(func=bdev_virtio_detach_controller)
2536
2537    def bdev_virtio_blk_set_hotplug(args):
2538        rpc.vhost.bdev_virtio_blk_set_hotplug(args.client, enable=args.enable, period_us=args.period_us)
2539
2540    p = subparsers.add_parser('bdev_virtio_blk_set_hotplug', help='Set hotplug options for bdev virtio_blk type.')
2541    p.add_argument('-d', '--disable', dest='enable', default=False, action='store_false', help="Disable hotplug (default)")
2542    p.add_argument('-e', '--enable', dest='enable', action='store_true', help="Enable hotplug")
2543    p.add_argument('-r', '--period-us',
2544                   help='How often the hotplug is processed for insert and remove events', type=int)
2545    p.set_defaults(func=bdev_virtio_blk_set_hotplug)
2546
2547    # ioat
2548    def ioat_scan_accel_engine(args):
2549        rpc.ioat.ioat_scan_accel_engine(args.client)
2550
2551    p = subparsers.add_parser('ioat_scan_accel_engine', help='Enable IOAT accel engine offload.')
2552    p.set_defaults(func=ioat_scan_accel_engine)
2553
2554    # dsa
2555    def dsa_scan_accel_engine(args):
2556        rpc.dsa.dsa_scan_accel_engine(args.client, config_kernel_mode=args.config_kernel_mode)
2557
2558    p = subparsers.add_parser('dsa_scan_accel_engine',
2559                              help='Set config and enable dsa accel engine offload.')
2560    p.add_argument('-k', '--config-kernel-mode', help='Use Kernel mode dsa',
2561                   action='store_true', dest='config_kernel_mode')
2562    p.set_defaults(func=dsa_scan_accel_engine, config_kernel_mode=None)
2563
2564    # iaa
2565    def iaa_scan_accel_engine(args):
2566        rpc.iaa.iaa_scan_accel_engine(args.client)
2567
2568    p = subparsers.add_parser('iaa_scan_accel_engine',
2569                              help='Set config and enable iaa accel engine offload.')
2570    p.set_defaults(func=iaa_scan_accel_engine)
2571
2572    # opal
2573    def bdev_nvme_opal_init(args):
2574        rpc.nvme.bdev_nvme_opal_init(args.client,
2575                                     nvme_ctrlr_name=args.nvme_ctrlr_name,
2576                                     password=args.password)
2577
2578    p = subparsers.add_parser('bdev_nvme_opal_init', help='take ownership and activate')
2579    p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name')
2580    p.add_argument('-p', '--password', help='password for admin')
2581    p.set_defaults(func=bdev_nvme_opal_init)
2582
2583    def bdev_nvme_opal_revert(args):
2584        rpc.nvme.bdev_nvme_opal_revert(args.client,
2585                                       nvme_ctrlr_name=args.nvme_ctrlr_name,
2586                                       password=args.password)
2587    p = subparsers.add_parser('bdev_nvme_opal_revert', help='Revert to default factory settings')
2588    p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name')
2589    p.add_argument('-p', '--password', help='password')
2590    p.set_defaults(func=bdev_nvme_opal_revert)
2591
2592    def bdev_opal_create(args):
2593        print_json(rpc.bdev.bdev_opal_create(args.client,
2594                                             nvme_ctrlr_name=args.nvme_ctrlr_name,
2595                                             nsid=args.nsid,
2596                                             locking_range_id=args.locking_range_id,
2597                                             range_start=args.range_start,
2598                                             range_length=args.range_length,
2599                                             password=args.password))
2600
2601    p = subparsers.add_parser('bdev_opal_create', help="""Create opal bdev on specified NVMe controller""")
2602    p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name', required=True)
2603    p.add_argument('-n', '--nsid', help='namespace ID (only support nsid=1 for now)', type=int, required=True)
2604    p.add_argument('-i', '--locking-range-id', help='locking range id', type=int, required=True)
2605    p.add_argument('-s', '--range-start', help='locking range start LBA', type=int, required=True)
2606    p.add_argument('-l', '--range-length', help='locking range length (in blocks)', type=int, required=True)
2607    p.add_argument('-p', '--password', help='admin password', required=True)
2608    p.set_defaults(func=bdev_opal_create)
2609
2610    def bdev_opal_get_info(args):
2611        print_dict(rpc.bdev.bdev_opal_get_info(args.client,
2612                                               bdev_name=args.bdev_name,
2613                                               password=args.password))
2614
2615    p = subparsers.add_parser('bdev_opal_get_info', help='get opal locking range info for this bdev')
2616    p.add_argument('-b', '--bdev-name', help='opal bdev')
2617    p.add_argument('-p', '--password', help='password')
2618    p.set_defaults(func=bdev_opal_get_info)
2619
2620    def bdev_opal_delete(args):
2621        rpc.bdev.bdev_opal_delete(args.client,
2622                                  bdev_name=args.bdev_name,
2623                                  password=args.password)
2624
2625    p = subparsers.add_parser('bdev_opal_delete', help="""delete a virtual opal bdev""")
2626    p.add_argument('-b', '--bdev-name', help='opal virtual bdev', required=True)
2627    p.add_argument('-p', '--password', help='admin password', required=True)
2628    p.set_defaults(func=bdev_opal_delete)
2629
2630    def bdev_opal_new_user(args):
2631        rpc.bdev.bdev_opal_new_user(args.client,
2632                                    bdev_name=args.bdev_name,
2633                                    admin_password=args.admin_password,
2634                                    user_id=args.user_id,
2635                                    user_password=args.user_password)
2636
2637    p = subparsers.add_parser('bdev_opal_new_user', help="""Add a user to opal bdev who can set lock state for this bdev""")
2638    p.add_argument('-b', '--bdev-name', help='opal bdev', required=True)
2639    p.add_argument('-p', '--admin-password', help='admin password', required=True)
2640    p.add_argument('-i', '--user-id', help='ID for new user', type=int, required=True)
2641    p.add_argument('-u', '--user-password', help='password set for this user', required=True)
2642    p.set_defaults(func=bdev_opal_new_user)
2643
2644    def bdev_opal_set_lock_state(args):
2645        rpc.bdev.bdev_opal_set_lock_state(args.client,
2646                                          bdev_name=args.bdev_name,
2647                                          user_id=args.user_id,
2648                                          password=args.password,
2649                                          lock_state=args.lock_state)
2650
2651    p = subparsers.add_parser('bdev_opal_set_lock_state', help="""set lock state for an opal bdev""")
2652    p.add_argument('-b', '--bdev-name', help='opal bdev', required=True)
2653    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',
2654                   type=int, required=True)
2655    p.add_argument('-p', '--password', help='password of this user', required=True)
2656    p.add_argument('-l', '--lock-state', help='lock state to set, choose from {readwrite, readonly, rwlock}', required=True)
2657    p.set_defaults(func=bdev_opal_set_lock_state)
2658
2659    # bdev_nvme_send_cmd
2660    def bdev_nvme_send_cmd(args):
2661        print_dict(rpc.nvme.bdev_nvme_send_cmd(args.client,
2662                                               name=args.nvme_name,
2663                                               cmd_type=args.cmd_type,
2664                                               data_direction=args.data_direction,
2665                                               cmdbuf=args.cmdbuf,
2666                                               data=args.data,
2667                                               metadata=args.metadata,
2668                                               data_len=args.data_length,
2669                                               metadata_len=args.metadata_length,
2670                                               timeout_ms=args.timeout_ms))
2671
2672    p = subparsers.add_parser('bdev_nvme_send_cmd', help='NVMe passthrough cmd.')
2673    p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""")
2674    p.add_argument('-t', '--cmd-type', help="""Type of nvme cmd. Valid values are: admin, io""")
2675    p.add_argument('-r', '--data-direction', help="""Direction of data transfer. Valid values are: c2h, h2c""")
2676    p.add_argument('-c', '--cmdbuf', help="""NVMe command encoded by base64 urlsafe""")
2677    p.add_argument('-d', '--data', help="""Data transferring to controller from host, encoded by base64 urlsafe""")
2678    p.add_argument('-m', '--metadata', help="""Metadata transferring to controller from host, encoded by base64 urlsafe""")
2679    p.add_argument('-D', '--data-length', help="""Data length required to transfer from controller to host""", type=int)
2680    p.add_argument('-M', '--metadata-length', help="""Metadata length required to transfer from controller to host""", type=int)
2681    p.add_argument('-T', '--timeout-ms',
2682                   help="""Command execution timeout value, in milliseconds,  if 0, don't track timeout""", type=int, default=0)
2683    p.set_defaults(func=bdev_nvme_send_cmd)
2684
2685    # Notifications
2686    def notify_get_types(args):
2687        print_dict(rpc.notify.notify_get_types(args.client))
2688
2689    p = subparsers.add_parser('notify_get_types', help='List available notifications that user can subscribe to.')
2690    p.set_defaults(func=notify_get_types)
2691
2692    def notify_get_notifications(args):
2693        ret = rpc.notify.notify_get_notifications(args.client,
2694                                                  id=args.id,
2695                                                  max=args.max)
2696        print_dict(ret)
2697
2698    p = subparsers.add_parser('notify_get_notifications', help='Get notifications')
2699    p.add_argument('-i', '--id', help="""First ID to start fetching from""", type=int)
2700    p.add_argument('-n', '--max', help="""Maximum number of notifications to return in response""", type=int)
2701    p.set_defaults(func=notify_get_notifications)
2702
2703    def thread_get_stats(args):
2704        print_dict(rpc.app.thread_get_stats(args.client))
2705
2706    p = subparsers.add_parser(
2707        'thread_get_stats', help='Display current statistics of all the threads')
2708    p.set_defaults(func=thread_get_stats)
2709
2710    def thread_set_cpumask(args):
2711        ret = rpc.app.thread_set_cpumask(args.client,
2712                                         id=args.id,
2713                                         cpumask=args.cpumask)
2714    p = subparsers.add_parser('thread_set_cpumask',
2715                              help="""set the cpumask of the thread whose ID matches to the
2716    specified value. The thread may be migrated to one of the specified CPUs.""")
2717    p.add_argument('-i', '--id', type=int, help='thread ID')
2718    p.add_argument('-m', '--cpumask', help='cpumask for this thread')
2719    p.set_defaults(func=thread_set_cpumask)
2720
2721    def log_enable_timestamps(args):
2722        ret = rpc.app.log_enable_timestamps(args.client,
2723                                            enabled=args.enabled)
2724    p = subparsers.add_parser('log_enable_timestamps',
2725                              help='Enable or disable timestamps.')
2726    p.add_argument('-d', '--disable', dest='enabled', default=False, action='store_false', help="Disable timestamps")
2727    p.add_argument('-e', '--enable', dest='enabled', action='store_true', help="Enable timestamps")
2728    p.set_defaults(func=log_enable_timestamps)
2729
2730    def thread_get_pollers(args):
2731        print_dict(rpc.app.thread_get_pollers(args.client))
2732
2733    p = subparsers.add_parser(
2734        'thread_get_pollers', help='Display current pollers of all the threads')
2735    p.set_defaults(func=thread_get_pollers)
2736
2737    def thread_get_io_channels(args):
2738        print_dict(rpc.app.thread_get_io_channels(args.client))
2739
2740    p = subparsers.add_parser(
2741        'thread_get_io_channels', help='Display current IO channels of all the threads')
2742    p.set_defaults(func=thread_get_io_channels)
2743
2744    def env_dpdk_get_mem_stats(args):
2745        print_dict(rpc.env_dpdk.env_dpdk_get_mem_stats(args.client))
2746
2747    p = subparsers.add_parser(
2748        'env_dpdk_get_mem_stats', help='write the dpdk memory stats to a file.')
2749    p.set_defaults(func=env_dpdk_get_mem_stats)
2750
2751    # blobfs
2752    def blobfs_detect(args):
2753        print(rpc.blobfs.blobfs_detect(args.client,
2754                                       bdev_name=args.bdev_name))
2755
2756    p = subparsers.add_parser('blobfs_detect', help='Detect whether a blobfs exists on bdev')
2757    p.add_argument('bdev_name', help='Blockdev name to detect blobfs. Example: Malloc0.')
2758    p.set_defaults(func=blobfs_detect)
2759
2760    def blobfs_create(args):
2761        print(rpc.blobfs.blobfs_create(args.client,
2762                                       bdev_name=args.bdev_name,
2763                                       cluster_sz=args.cluster_sz))
2764
2765    p = subparsers.add_parser('blobfs_create', help='Build a blobfs on bdev')
2766    p.add_argument('bdev_name', help='Blockdev name to build blobfs. Example: Malloc0.')
2767    p.add_argument('-c', '--cluster-sz',
2768                   help="""Size of cluster in bytes (Optional). Must be multiple of 4KB page size. Default and minimal value is 1M.""")
2769    p.set_defaults(func=blobfs_create)
2770
2771    def blobfs_mount(args):
2772        print(rpc.blobfs.blobfs_mount(args.client,
2773                                      bdev_name=args.bdev_name,
2774                                      mountpoint=args.mountpoint))
2775
2776    p = subparsers.add_parser('blobfs_mount', help='Mount a blobfs on bdev to host path by FUSE')
2777    p.add_argument('bdev_name', help='Blockdev name where the blobfs is. Example: Malloc0.')
2778    p.add_argument('mountpoint', help='Mountpoint path in host to mount blobfs. Example: /mnt/.')
2779    p.set_defaults(func=blobfs_mount)
2780
2781    def blobfs_set_cache_size(args):
2782        print(rpc.blobfs.blobfs_set_cache_size(args.client,
2783                                               size_in_mb=args.size_in_mb))
2784
2785    p = subparsers.add_parser('blobfs_set_cache_size', help='Set cache size for blobfs')
2786    p.add_argument('size_in_mb', help='Cache size for blobfs in megabytes.', type=int)
2787    p.set_defaults(func=blobfs_set_cache_size)
2788
2789    # sock
2790    def sock_impl_get_options(args):
2791        print_json(rpc.sock.sock_impl_get_options(args.client,
2792                                                  impl_name=args.impl))
2793
2794    p = subparsers.add_parser('sock_impl_get_options', help="""Get options of socket layer implementation""")
2795    p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True)
2796    p.set_defaults(func=sock_impl_get_options)
2797
2798    def sock_impl_set_options(args):
2799        rpc.sock.sock_impl_set_options(args.client,
2800                                       impl_name=args.impl,
2801                                       recv_buf_size=args.recv_buf_size,
2802                                       send_buf_size=args.send_buf_size,
2803                                       enable_recv_pipe=args.enable_recv_pipe,
2804                                       enable_quickack=args.enable_quickack,
2805                                       enable_placement_id=args.enable_placement_id,
2806                                       enable_zerocopy_send_server=args.enable_zerocopy_send_server,
2807                                       enable_zerocopy_send_client=args.enable_zerocopy_send_client,
2808                                       zerocopy_threshold=args.zerocopy_threshold)
2809
2810    p = subparsers.add_parser('sock_impl_set_options', help="""Set options of socket layer implementation""")
2811    p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True)
2812    p.add_argument('-r', '--recv-buf-size', help='Size of receive buffer on socket in bytes', type=int)
2813    p.add_argument('-s', '--send-buf-size', help='Size of send buffer on socket in bytes', type=int)
2814    p.add_argument('-p', '--enable-placement-id', help='Option for placement-id. 0:disable,1:incoming_napi,2:incoming_cpu', type=int)
2815    p.add_argument('--enable-recv-pipe', help='Enable receive pipe',
2816                   action='store_true', dest='enable_recv_pipe')
2817    p.add_argument('--disable-recv-pipe', help='Disable receive pipe',
2818                   action='store_false', dest='enable_recv_pipe')
2819    p.add_argument('--enable-quickack', help='Enable quick ACK',
2820                   action='store_true', dest='enable_quickack')
2821    p.add_argument('--disable-quickack', help='Disable quick ACK',
2822                   action='store_false', dest='enable_quickack')
2823    p.add_argument('--enable-zerocopy-send-server', help='Enable zerocopy on send for server sockets',
2824                   action='store_true', dest='enable_zerocopy_send_server')
2825    p.add_argument('--disable-zerocopy-send-server', help='Disable zerocopy on send for server sockets',
2826                   action='store_false', dest='enable_zerocopy_send_server')
2827    p.add_argument('--enable-zerocopy-send-client', help='Enable zerocopy on send for client sockets',
2828                   action='store_true', dest='enable_zerocopy_send_client')
2829    p.add_argument('--disable-zerocopy-send-client', help='Disable zerocopy on send for client sockets',
2830                   action='store_false', dest='enable_zerocopy_send_client')
2831    p.add_argument('--zerocopy-threshold', help='Set zerocopy_threshold in bytes',
2832                   action='store_true', dest='zerocopy_threshold')
2833    p.set_defaults(func=sock_impl_set_options, enable_recv_pipe=None, enable_quickack=None,
2834                   enable_placement_id=None, enable_zerocopy_send_server=None, enable_zerocopy_send_client=None,
2835                   zerocopy_threshold=None)
2836
2837    def sock_set_default_impl(args):
2838        print_json(rpc.sock.sock_set_default_impl(args.client,
2839                                                  impl_name=args.impl))
2840
2841    p = subparsers.add_parser('sock_set_default_impl', help="""Set the default sock implementation""")
2842    p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True)
2843    p.set_defaults(func=sock_set_default_impl)
2844
2845    def framework_get_pci_devices(args):
2846        def splitbuf(buf, step):
2847            return [buf[i:i+step] for i in range(0, len(buf), step)]
2848
2849        devices = rpc.subsystem.framework_get_pci_devices(args.client)
2850        if not args.format_lspci:
2851            print_json(devices)
2852        else:
2853            for devid, dev in enumerate(devices):
2854                print('{} device #{}'.format(dev['address'], devid))
2855                for lineid, line in enumerate(splitbuf(dev['config_space'], 32)):
2856                    print('{:02x}: {}'.format(lineid * 16, ' '.join(splitbuf(line.lower(), 2))))
2857                print()
2858
2859    p = subparsers.add_parser('framework_get_pci_devices', help='''Get a list of attached PCI devices''')
2860    p.add_argument('--format-lspci', help='Format the output in a way to be consumed by lspci -F',
2861                   action='store_true')
2862    p.set_defaults(func=framework_get_pci_devices)
2863
2864    # bdev_nvme_add_error_injection
2865    def bdev_nvme_add_error_injection(args):
2866        print_dict(rpc.nvme.bdev_nvme_add_error_injection(args.client,
2867                                                          name=args.nvme_name,
2868                                                          cmd_type=args.cmd_type,
2869                                                          opc=args.opc,
2870                                                          do_not_submit=args.do_not_submit,
2871                                                          timeout_in_us=args.timeout_in_us,
2872                                                          err_count=args.err_count,
2873                                                          sct=args.sct,
2874                                                          sc=args.sc))
2875    p = subparsers.add_parser('bdev_nvme_add_error_injection',
2876                              help='Add a NVMe command error injection.')
2877    p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""", required=True)
2878    p.add_argument('-t', '--cmd-type', help="""Type of NVMe command. Valid values are: admin, io""", required=True)
2879    p.add_argument('-o', '--opc', help="""Opcode of the NVMe command.""", required=True, type=int)
2880    p.add_argument('-s', '--do-not-submit',
2881                   help="""Set to true if request should not be submitted to the controller (default false)""",
2882                   default=False, dest="do_not_submit", action='store_true')
2883    p.add_argument('-w', '--timeout-in-us', help="""Wait specified microseconds when do_not_submit is true""", type=int)
2884    p.add_argument('-e', '--err-count', help="""Number of matching NVMe commands to inject errors (default 1)""", type=int, default=1)
2885    p.add_argument('-u', '--sct', help="""Status code type""", type=int)
2886    p.add_argument('-c', '--sc', help="""Status code""", type=int)
2887    p.set_defaults(func=bdev_nvme_add_error_injection)
2888
2889    # bdev_nvme_remove_error_injection
2890    def bdev_nvme_remove_error_injection(args):
2891        print_dict(rpc.nvme.bdev_nvme_remove_error_injection(args.client,
2892                                                             name=args.nvme_name,
2893                                                             cmd_type=args.cmd_type,
2894                                                             opc=args.opc))
2895    p = subparsers.add_parser('bdev_nvme_remove_error_injection',
2896                              help='Removes a NVMe command error injection.')
2897    p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""", required=True)
2898    p.add_argument('-t', '--cmd-type', help="""Type of nvme cmd. Valid values are: admin, io""", required=True)
2899    p.add_argument('-o', '--opc', help="""Opcode of the nvme cmd.""", required=True, type=int)
2900    p.set_defaults(func=bdev_nvme_remove_error_injection)
2901
2902    def check_called_name(name):
2903        if name in deprecated_aliases:
2904            print("{} is deprecated, use {} instead.".format(name, deprecated_aliases[name]), file=sys.stderr)
2905
2906    class dry_run_client:
2907        def call(self, method, params=None):
2908            print("Request:\n" + json.dumps({"method": method, "params": params}, indent=2))
2909
2910    def null_print(arg):
2911        pass
2912
2913    def call_rpc_func(args):
2914        args.func(args)
2915        check_called_name(args.called_rpc_name)
2916
2917    def execute_script(parser, client, fd):
2918        executed_rpc = ""
2919        for rpc_call in map(str.rstrip, fd):
2920            if not rpc_call.strip():
2921                continue
2922            executed_rpc = "\n".join([executed_rpc, rpc_call])
2923            rpc_args = shlex.split(rpc_call)
2924            if rpc_args[0][0] == '#':
2925                # Ignore lines starting with # - treat them as comments
2926                continue
2927            args = parser.parse_args(rpc_args)
2928            args.client = client
2929            try:
2930                call_rpc_func(args)
2931            except JSONRPCException as ex:
2932                print("Exception:")
2933                print(executed_rpc.strip() + " <<<")
2934                print(ex.message)
2935                exit(1)
2936
2937    def load_plugin(args):
2938        # Create temporary parser, pull out the plugin parameter, load the module, and then run the real argument parser
2939        plugin_parser = argparse.ArgumentParser(add_help=False)
2940        plugin_parser.add_argument('--plugin', dest='rpc_plugin', help='Module name of plugin with additional RPC commands')
2941
2942        rpc_module = plugin_parser.parse_known_args()[0].rpc_plugin
2943        if args is not None:
2944            rpc_module = plugin_parser.parse_known_args(args)[0].rpc_plugin
2945
2946        if rpc_module is not None:
2947            try:
2948                rpc_plugin = importlib.import_module(rpc_module)
2949                try:
2950                    rpc_plugin.spdk_rpc_plugin_initialize(subparsers)
2951                except AttributeError:
2952                    print("Module %s does not contain 'spdk_rpc_plugin_initialize' function" % rpc_module)
2953            except ModuleNotFoundError:
2954                print("Module %s not found" % rpc_module)
2955
2956    def replace_arg_underscores(args):
2957        # All option names are defined with dashes only - for example: --tgt-name
2958        # But if user used underscores, convert them to dashes (--tgt_name => --tgt-name)
2959        # SPDK was inconsistent previously and had some options with underscores, so
2960        # doing this conversion ensures backward compatibility with older scripts.
2961        for i in range(len(args)):
2962            arg = args[i]
2963            if arg.startswith('--') and "_" in arg:
2964                args[i] = arg.replace('_', '-')
2965
2966    load_plugin(None)
2967
2968    replace_arg_underscores(sys.argv)
2969
2970    args = parser.parse_args()
2971
2972    if sys.stdin.isatty() and not hasattr(args, 'func'):
2973        # No arguments and no data piped through stdin
2974        parser.print_help()
2975        exit(1)
2976    if args.is_server:
2977        for input in sys.stdin:
2978            cmd = shlex.split(input)
2979            replace_arg_underscores(cmd)
2980            try:
2981                load_plugin(cmd)
2982                tmp_args = parser.parse_args(cmd)
2983            except SystemExit as ex:
2984                print("**STATUS=1", flush=True)
2985                continue
2986
2987            try:
2988                tmp_args.client = rpc.client.JSONRPCClient(
2989                    tmp_args.server_addr, tmp_args.port, tmp_args.timeout,
2990                    log_level=getattr(logging, tmp_args.verbose.upper()), conn_retries=tmp_args.conn_retries)
2991                call_rpc_func(tmp_args)
2992                print("**STATUS=0", flush=True)
2993            except JSONRPCException as ex:
2994                print(ex.message)
2995                print("**STATUS=1", flush=True)
2996        exit(0)
2997    elif args.dry_run:
2998        args.client = dry_run_client()
2999        print_dict = null_print
3000        print_json = null_print
3001        print_array = null_print
3002    else:
3003        try:
3004            args.client = rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout,
3005                                                   log_level=getattr(logging, args.verbose.upper()),
3006                                                   conn_retries=args.conn_retries)
3007        except JSONRPCException as ex:
3008            print(ex.message)
3009            exit(1)
3010
3011    if hasattr(args, 'func'):
3012        try:
3013            call_rpc_func(args)
3014        except JSONRPCException as ex:
3015            print(ex.message)
3016            exit(1)
3017    else:
3018        execute_script(parser, args.client, sys.stdin)
3019