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