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