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