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