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