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 rpc.bdev.bdev_rbd_resize(args.client, 930 name=args.name, 931 new_size=int(args.new_size)) 932 933 p = subparsers.add_parser('bdev_rbd_resize', 934 help='Resize a rbd bdev') 935 p.add_argument('name', help='rbd bdev name') 936 p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB') 937 p.set_defaults(func=bdev_rbd_resize) 938 939 def bdev_delay_create(args): 940 print_json(rpc.bdev.bdev_delay_create(args.client, 941 base_bdev_name=args.base_bdev_name, 942 name=args.name, 943 avg_read_latency=args.avg_read_latency, 944 p99_read_latency=args.nine_nine_read_latency, 945 avg_write_latency=args.avg_write_latency, 946 p99_write_latency=args.nine_nine_write_latency)) 947 948 p = subparsers.add_parser('bdev_delay_create', 949 help='Add a delay bdev on existing bdev') 950 p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True) 951 p.add_argument('-d', '--name', help="Name of the delay bdev", required=True) 952 p.add_argument('-r', '--avg-read-latency', 953 help="Average latency to apply before completing read ops (in microseconds)", required=True, type=int) 954 p.add_argument('-t', '--nine-nine-read-latency', 955 help="latency to apply to 1 in 100 read ops (in microseconds)", required=True, type=int) 956 p.add_argument('-w', '--avg-write-latency', 957 help="Average latency to apply before completing write ops (in microseconds)", required=True, type=int) 958 p.add_argument('-n', '--nine-nine-write-latency', 959 help="latency to apply to 1 in 100 write ops (in microseconds)", required=True, type=int) 960 p.set_defaults(func=bdev_delay_create) 961 962 def bdev_delay_delete(args): 963 rpc.bdev.bdev_delay_delete(args.client, 964 name=args.name) 965 966 p = subparsers.add_parser('bdev_delay_delete', help='Delete a delay bdev') 967 p.add_argument('name', help='delay bdev name') 968 p.set_defaults(func=bdev_delay_delete) 969 970 def bdev_delay_update_latency(args): 971 print_json(rpc.bdev.bdev_delay_update_latency(args.client, 972 delay_bdev_name=args.delay_bdev_name, 973 latency_type=args.latency_type, 974 latency_us=args.latency_us)) 975 p = subparsers.add_parser('bdev_delay_update_latency', 976 help='Update one of the latency values for a given delay bdev') 977 p.add_argument('delay_bdev_name', help='The name of the given delay bdev') 978 p.add_argument('latency_type', help='one of: avg_read, avg_write, p99_read, p99_write. No other values accepted.') 979 p.add_argument('latency_us', help='new latency value in microseconds.', type=int) 980 p.set_defaults(func=bdev_delay_update_latency) 981 982 def bdev_error_create(args): 983 print_json(rpc.bdev.bdev_error_create(args.client, 984 base_name=args.base_name)) 985 986 p = subparsers.add_parser('bdev_error_create', aliases=['construct_error_bdev'], 987 help='Add bdev with error injection backend') 988 p.add_argument('base_name', help='base bdev name') 989 p.set_defaults(func=bdev_error_create) 990 991 def bdev_error_delete(args): 992 rpc.bdev.bdev_error_delete(args.client, 993 name=args.name) 994 995 p = subparsers.add_parser('bdev_error_delete', aliases=['delete_error_bdev'], 996 help='Delete an error bdev') 997 p.add_argument('name', help='error bdev name') 998 p.set_defaults(func=bdev_error_delete) 999 1000 def bdev_iscsi_create(args): 1001 print_json(rpc.bdev.bdev_iscsi_create(args.client, 1002 name=args.name, 1003 url=args.url, 1004 initiator_iqn=args.initiator_iqn)) 1005 1006 p = subparsers.add_parser('bdev_iscsi_create', aliases=['construct_iscsi_bdev'], 1007 help='Add bdev with iSCSI initiator backend') 1008 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 1009 p.add_argument('-i', '--initiator-iqn', help="Initiator IQN", required=True) 1010 p.add_argument('--url', help="iSCSI Lun URL", required=True) 1011 p.set_defaults(func=bdev_iscsi_create) 1012 1013 def bdev_iscsi_delete(args): 1014 rpc.bdev.bdev_iscsi_delete(args.client, 1015 name=args.name) 1016 1017 p = subparsers.add_parser('bdev_iscsi_delete', aliases=['delete_iscsi_bdev'], 1018 help='Delete an iSCSI bdev') 1019 p.add_argument('name', help='iSCSI bdev name') 1020 p.set_defaults(func=bdev_iscsi_delete) 1021 1022 def bdev_pmem_create(args): 1023 print_json(rpc.bdev.bdev_pmem_create(args.client, 1024 pmem_file=args.pmem_file, 1025 name=args.name)) 1026 1027 p = subparsers.add_parser('bdev_pmem_create', aliases=['construct_pmem_bdev'], 1028 help='Add a bdev with pmem backend') 1029 p.add_argument('pmem_file', help='Path to pmemblk pool file') 1030 p.add_argument('-n', '--name', help='Block device name', required=True) 1031 p.set_defaults(func=bdev_pmem_create) 1032 1033 def bdev_pmem_delete(args): 1034 rpc.bdev.bdev_pmem_delete(args.client, 1035 name=args.name) 1036 1037 p = subparsers.add_parser('bdev_pmem_delete', aliases=['delete_pmem_bdev'], 1038 help='Delete a pmem bdev') 1039 p.add_argument('name', help='pmem bdev name') 1040 p.set_defaults(func=bdev_pmem_delete) 1041 1042 def bdev_passthru_create(args): 1043 print_json(rpc.bdev.bdev_passthru_create(args.client, 1044 base_bdev_name=args.base_bdev_name, 1045 name=args.name)) 1046 1047 p = subparsers.add_parser('bdev_passthru_create', aliases=['construct_passthru_bdev'], 1048 help='Add a pass through bdev on existing bdev') 1049 p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True) 1050 p.add_argument('-p', '--name', help="Name of the pass through bdev", required=True) 1051 p.set_defaults(func=bdev_passthru_create) 1052 1053 def bdev_passthru_delete(args): 1054 rpc.bdev.bdev_passthru_delete(args.client, 1055 name=args.name) 1056 1057 p = subparsers.add_parser('bdev_passthru_delete', aliases=['delete_passthru_bdev'], 1058 help='Delete a pass through bdev') 1059 p.add_argument('name', help='pass through bdev name') 1060 p.set_defaults(func=bdev_passthru_delete) 1061 1062 def bdev_get_bdevs(args): 1063 print_dict(rpc.bdev.bdev_get_bdevs(args.client, 1064 name=args.name, timeout=args.timeout_ms)) 1065 1066 p = subparsers.add_parser('bdev_get_bdevs', 1067 help='Display current blockdev list or required blockdev') 1068 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 1069 p.add_argument('-t', '--timeout-ms', help="""Time in ms to wait for the bdev to appear (only used 1070 with the -b|--name option). The default timeout is 0, meaning the RPC returns immediately 1071 whether the bdev exists or not.""", 1072 type=int, required=False) 1073 p.set_defaults(func=bdev_get_bdevs) 1074 1075 def bdev_get_iostat(args): 1076 print_dict(rpc.bdev.bdev_get_iostat(args.client, 1077 name=args.name)) 1078 1079 p = subparsers.add_parser('bdev_get_iostat', 1080 help='Display current I/O statistics of all the blockdevs or required blockdev.') 1081 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 1082 p.set_defaults(func=bdev_get_iostat) 1083 1084 def bdev_enable_histogram(args): 1085 rpc.bdev.bdev_enable_histogram(args.client, name=args.name, enable=args.enable) 1086 1087 p = subparsers.add_parser('bdev_enable_histogram', 1088 help='Enable or disable histogram for specified bdev') 1089 p.add_argument('-e', '--enable', default=True, dest='enable', action='store_true', help='Enable histograms on specified device') 1090 p.add_argument('-d', '--disable', dest='enable', action='store_false', help='Disable histograms on specified device') 1091 p.add_argument('name', help='bdev name') 1092 p.set_defaults(func=bdev_enable_histogram) 1093 1094 def bdev_get_histogram(args): 1095 print_dict(rpc.bdev.bdev_get_histogram(args.client, name=args.name)) 1096 1097 p = subparsers.add_parser('bdev_get_histogram', 1098 help='Get histogram for specified bdev') 1099 p.add_argument('name', help='bdev name') 1100 p.set_defaults(func=bdev_get_histogram) 1101 1102 def bdev_set_qd_sampling_period(args): 1103 rpc.bdev.bdev_set_qd_sampling_period(args.client, 1104 name=args.name, 1105 period=args.period) 1106 1107 p = subparsers.add_parser('bdev_set_qd_sampling_period', 1108 help="Enable or disable tracking of a bdev's queue depth.") 1109 p.add_argument('name', help='Blockdev name. Example: Malloc0') 1110 p.add_argument('period', help='Period with which to poll the block device queue depth in microseconds.' 1111 ' If set to 0, polling will be disabled.', 1112 type=int) 1113 p.set_defaults(func=bdev_set_qd_sampling_period) 1114 1115 def bdev_set_qos_limit(args): 1116 rpc.bdev.bdev_set_qos_limit(args.client, 1117 name=args.name, 1118 rw_ios_per_sec=args.rw_ios_per_sec, 1119 rw_mbytes_per_sec=args.rw_mbytes_per_sec, 1120 r_mbytes_per_sec=args.r_mbytes_per_sec, 1121 w_mbytes_per_sec=args.w_mbytes_per_sec) 1122 1123 p = subparsers.add_parser('bdev_set_qos_limit', 1124 help='Set QoS rate limit on a blockdev') 1125 p.add_argument('name', help='Blockdev name to set QoS. Example: Malloc0') 1126 p.add_argument('--rw-ios-per-sec', 1127 help='R/W IOs per second limit (>=1000, example: 20000). 0 means unlimited.', 1128 type=int, required=False) 1129 p.add_argument('--rw-mbytes-per-sec', 1130 help="R/W megabytes per second limit (>=10, example: 100). 0 means unlimited.", 1131 type=int, required=False) 1132 p.add_argument('--r-mbytes-per-sec', 1133 help="Read megabytes per second limit (>=10, example: 100). 0 means unlimited.", 1134 type=int, required=False) 1135 p.add_argument('--w-mbytes-per-sec', 1136 help="Write megabytes per second limit (>=10, example: 100). 0 means unlimited.", 1137 type=int, required=False) 1138 p.set_defaults(func=bdev_set_qos_limit) 1139 1140 def bdev_error_inject_error(args): 1141 rpc.bdev.bdev_error_inject_error(args.client, 1142 name=args.name, 1143 io_type=args.io_type, 1144 error_type=args.error_type, 1145 num=args.num) 1146 1147 p = subparsers.add_parser('bdev_error_inject_error', aliases=['bdev_inject_error'], 1148 help='bdev inject error') 1149 p.add_argument('name', help="""the name of the error injection bdev""") 1150 p.add_argument('io_type', help="""io_type: 'clear' 'read' 'write' 'unmap' 'flush' 'all'""") 1151 p.add_argument('error_type', help="""error_type: 'failure' 'pending'""") 1152 p.add_argument( 1153 '-n', '--num', help='the number of commands you want to fail', type=int, default=1) 1154 p.set_defaults(func=bdev_error_inject_error) 1155 1156 def bdev_nvme_apply_firmware(args): 1157 print_dict(rpc.bdev.bdev_nvme_apply_firmware(args.client, 1158 bdev_name=args.bdev_name, 1159 filename=args.filename)) 1160 1161 p = subparsers.add_parser('bdev_nvme_apply_firmware', aliases=['apply_firmware'], 1162 help='Download and commit firmware to NVMe device') 1163 p.add_argument('filename', help='filename of the firmware to download') 1164 p.add_argument('bdev_name', help='name of the NVMe device') 1165 p.set_defaults(func=bdev_nvme_apply_firmware) 1166 1167 def bdev_nvme_get_transport_statistics(args): 1168 print_dict(rpc.bdev.bdev_nvme_get_transport_statistics(args.client)) 1169 1170 p = subparsers.add_parser('bdev_nvme_get_transport_statistics', 1171 help='Get bdev_nvme poll group transport statistics') 1172 p.set_defaults(func=bdev_nvme_get_transport_statistics) 1173 1174 def bdev_nvme_get_controller_health_info(args): 1175 print_dict(rpc.bdev.bdev_nvme_get_controller_health_info(args.client, 1176 name=args.name)) 1177 1178 p = subparsers.add_parser('bdev_nvme_get_controller_health_info', 1179 help='Display health log of the required NVMe bdev controller.') 1180 p.add_argument('-c', '--name', help="Name of the NVMe bdev controller. Example: Nvme0", required=True) 1181 p.set_defaults(func=bdev_nvme_get_controller_health_info) 1182 1183 # iSCSI 1184 def iscsi_set_options(args): 1185 rpc.iscsi.iscsi_set_options( 1186 args.client, 1187 auth_file=args.auth_file, 1188 node_base=args.node_base, 1189 nop_timeout=args.nop_timeout, 1190 nop_in_interval=args.nop_in_interval, 1191 disable_chap=args.disable_chap, 1192 require_chap=args.require_chap, 1193 mutual_chap=args.mutual_chap, 1194 chap_group=args.chap_group, 1195 max_sessions=args.max_sessions, 1196 max_queue_depth=args.max_queue_depth, 1197 max_connections_per_session=args.max_connections_per_session, 1198 default_time2wait=args.default_time2wait, 1199 default_time2retain=args.default_time2retain, 1200 first_burst_length=args.first_burst_length, 1201 immediate_data=args.immediate_data, 1202 error_recovery_level=args.error_recovery_level, 1203 allow_duplicated_isid=args.allow_duplicated_isid, 1204 max_large_datain_per_connection=args.max_large_datain_per_connection, 1205 max_r2t_per_connection=args.max_r2t_per_connection, 1206 pdu_pool_size=args.pdu_pool_size, 1207 immediate_data_pool_size=args.immediate_data_pool_size, 1208 data_out_pool_size=args.data_out_pool_size) 1209 1210 p = subparsers.add_parser('iscsi_set_options', 1211 help="""Set options of iSCSI subsystem""") 1212 p.add_argument('-f', '--auth-file', help='Path to CHAP shared secret file') 1213 p.add_argument('-b', '--node-base', help='Prefix of the name of iSCSI target node') 1214 p.add_argument('-o', '--nop-timeout', help='Timeout in seconds to nop-in request to the initiator', type=int) 1215 p.add_argument('-n', '--nop-in-interval', help='Time interval in secs between nop-in requests by the target', type=int) 1216 p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled. 1217 *** Mutually exclusive with --require-chap""", action='store_true') 1218 p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required. 1219 *** Mutually exclusive with --disable-chap""", action='store_true') 1220 p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true') 1221 p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session. 1222 *** Authentication group must be precreated ***""", type=int) 1223 p.add_argument('-a', '--max-sessions', help='Maximum number of sessions in the host.', type=int) 1224 p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/Os per queue.', type=int) 1225 p.add_argument('-c', '--max-connections-per-session', help='Negotiated parameter, MaxConnections.', type=int) 1226 p.add_argument('-w', '--default-time2wait', help='Negotiated parameter, DefaultTime2Wait.', type=int) 1227 p.add_argument('-v', '--default-time2retain', help='Negotiated parameter, DefaultTime2Retain.', type=int) 1228 p.add_argument('-s', '--first-burst-length', help='Negotiated parameter, FirstBurstLength.', type=int) 1229 p.add_argument('-i', '--immediate-data', help='Negotiated parameter, ImmediateData.', action='store_true') 1230 p.add_argument('-l', '--error-recovery-level', help='Negotiated parameter, ErrorRecoveryLevel', type=int) 1231 p.add_argument('-p', '--allow-duplicated-isid', help='Allow duplicated initiator session ID.', action='store_true') 1232 p.add_argument('-x', '--max-large-datain-per-connection', help='Max number of outstanding split read I/Os per connection', type=int) 1233 p.add_argument('-k', '--max-r2t-per-connection', help='Max number of outstanding R2Ts per connection', type=int) 1234 p.add_argument('-u', '--pdu-pool-size', help='Number of PDUs in the pool', type=int) 1235 p.add_argument('-j', '--immediate-data-pool-size', help='Number of immediate data buffers in the pool', type=int) 1236 p.add_argument('-z', '--data-out-pool-size', help='Number of data out buffers in the pool', type=int) 1237 p.set_defaults(func=iscsi_set_options) 1238 1239 def iscsi_set_discovery_auth(args): 1240 rpc.iscsi.iscsi_set_discovery_auth( 1241 args.client, 1242 disable_chap=args.disable_chap, 1243 require_chap=args.require_chap, 1244 mutual_chap=args.mutual_chap, 1245 chap_group=args.chap_group) 1246 1247 p = subparsers.add_parser('iscsi_set_discovery_auth', 1248 help="""Set CHAP authentication for discovery session.""") 1249 p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled. 1250 *** Mutually exclusive with --require-chap""", action='store_true') 1251 p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required. 1252 *** Mutually exclusive with --disable-chap""", action='store_true') 1253 p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true') 1254 p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session. 1255 *** Authentication group must be precreated ***""", type=int) 1256 p.set_defaults(func=iscsi_set_discovery_auth) 1257 1258 def iscsi_create_auth_group(args): 1259 secrets = None 1260 if args.secrets: 1261 secrets = [dict(u.split(":") for u in a.split(" ")) for a in args.secrets.split(",")] 1262 1263 rpc.iscsi.iscsi_create_auth_group(args.client, tag=args.tag, secrets=secrets) 1264 1265 p = subparsers.add_parser('iscsi_create_auth_group', 1266 help='Create authentication group for CHAP authentication.') 1267 p.add_argument('tag', help='Authentication group tag (unique, integer > 0).', type=int) 1268 p.add_argument('-c', '--secrets', help="""Comma-separated list of CHAP secrets 1269<user:user_name secret:chap_secret muser:mutual_user_name msecret:mutual_chap_secret> enclosed in quotes. 1270Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 msecret:ms2'""", required=False) 1271 p.set_defaults(func=iscsi_create_auth_group) 1272 1273 def iscsi_delete_auth_group(args): 1274 rpc.iscsi.iscsi_delete_auth_group(args.client, tag=args.tag) 1275 1276 p = subparsers.add_parser('iscsi_delete_auth_group', 1277 help='Delete an authentication group.') 1278 p.add_argument('tag', help='Authentication group tag', type=int) 1279 p.set_defaults(func=iscsi_delete_auth_group) 1280 1281 def iscsi_auth_group_add_secret(args): 1282 rpc.iscsi.iscsi_auth_group_add_secret( 1283 args.client, 1284 tag=args.tag, 1285 user=args.user, 1286 secret=args.secret, 1287 muser=args.muser, 1288 msecret=args.msecret) 1289 1290 p = subparsers.add_parser('iscsi_auth_group_add_secret', 1291 help='Add a secret to an authentication group.') 1292 p.add_argument('tag', help='Authentication group tag', type=int) 1293 p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True) 1294 p.add_argument('-s', '--secret', help='Secret for one-way CHAP authentication', required=True) 1295 p.add_argument('-m', '--muser', help='User name for mutual CHAP authentication') 1296 p.add_argument('-r', '--msecret', help='Secret for mutual CHAP authentication') 1297 p.set_defaults(func=iscsi_auth_group_add_secret) 1298 1299 def iscsi_auth_group_remove_secret(args): 1300 rpc.iscsi.iscsi_auth_group_remove_secret(args.client, tag=args.tag, user=args.user) 1301 1302 p = subparsers.add_parser('iscsi_auth_group_remove_secret', 1303 help='Remove a secret from an authentication group.') 1304 p.add_argument('tag', help='Authentication group tag', type=int) 1305 p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True) 1306 p.set_defaults(func=iscsi_auth_group_remove_secret) 1307 1308 def iscsi_get_auth_groups(args): 1309 print_dict(rpc.iscsi.iscsi_get_auth_groups(args.client)) 1310 1311 p = subparsers.add_parser('iscsi_get_auth_groups', 1312 help='Display current authentication group configuration') 1313 p.set_defaults(func=iscsi_get_auth_groups) 1314 1315 def iscsi_get_portal_groups(args): 1316 print_dict(rpc.iscsi.iscsi_get_portal_groups(args.client)) 1317 1318 p = subparsers.add_parser('iscsi_get_portal_groups', help='Display current portal group configuration') 1319 p.set_defaults(func=iscsi_get_portal_groups) 1320 1321 def iscsi_get_initiator_groups(args): 1322 print_dict(rpc.iscsi.iscsi_get_initiator_groups(args.client)) 1323 1324 p = subparsers.add_parser('iscsi_get_initiator_groups', 1325 help='Display current initiator group configuration') 1326 p.set_defaults(func=iscsi_get_initiator_groups) 1327 1328 def iscsi_get_target_nodes(args): 1329 print_dict(rpc.iscsi.iscsi_get_target_nodes(args.client)) 1330 1331 p = subparsers.add_parser('iscsi_get_target_nodes', help='Display target nodes') 1332 p.set_defaults(func=iscsi_get_target_nodes) 1333 1334 def iscsi_create_target_node(args): 1335 luns = [] 1336 for u in args.bdev_name_id_pairs.strip().split(" "): 1337 bdev_name, lun_id = u.split(":") 1338 luns.append({"bdev_name": bdev_name, "lun_id": int(lun_id)}) 1339 1340 pg_ig_maps = [] 1341 for u in args.pg_ig_mappings.strip().split(" "): 1342 pg, ig = u.split(":") 1343 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1344 1345 rpc.iscsi.iscsi_create_target_node( 1346 args.client, 1347 luns=luns, 1348 pg_ig_maps=pg_ig_maps, 1349 name=args.name, 1350 alias_name=args.alias_name, 1351 queue_depth=args.queue_depth, 1352 chap_group=args.chap_group, 1353 disable_chap=args.disable_chap, 1354 require_chap=args.require_chap, 1355 mutual_chap=args.mutual_chap, 1356 header_digest=args.header_digest, 1357 data_digest=args.data_digest) 1358 1359 p = subparsers.add_parser('iscsi_create_target_node', help='Add a target node') 1360 p.add_argument('name', help='Target node name (ASCII)') 1361 p.add_argument('alias_name', help='Target node alias name (ASCII)') 1362 p.add_argument('bdev_name_id_pairs', help="""Whitespace-separated list of <bdev name:LUN ID> pairs enclosed 1363 in quotes. Format: 'bdev_name0:id0 bdev_name1:id1' etc 1364 Example: 'Malloc0:0 Malloc1:1 Malloc5:2' 1365 *** The bdevs must pre-exist *** 1366 *** LUN0 (id = 0) is required *** 1367 *** bdevs names cannot contain space or colon characters ***""") 1368 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1369 Whitespace separated, quoted, mapping defined with colon 1370 separated list of "tags" (int > 0) 1371 Example: '1:1 2:2 2:1' 1372 *** The Portal/Initiator Groups must be precreated ***""") 1373 p.add_argument('queue_depth', help='Desired target queue depth', type=int) 1374 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node. 1375 *** Authentication group must be precreated ***""", type=int, default=0) 1376 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node. 1377 *** Mutually exclusive with --require-chap ***""", action='store_true') 1378 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node. 1379 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1380 p.add_argument( 1381 '-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', action='store_true') 1382 p.add_argument('-H', '--header-digest', 1383 help='Header Digest should be required for this target node.', action='store_true') 1384 p.add_argument('-D', '--data-digest', 1385 help='Data Digest should be required for this target node.', action='store_true') 1386 p.set_defaults(func=iscsi_create_target_node) 1387 1388 def iscsi_target_node_add_lun(args): 1389 rpc.iscsi.iscsi_target_node_add_lun( 1390 args.client, 1391 name=args.name, 1392 bdev_name=args.bdev_name, 1393 lun_id=args.lun_id) 1394 1395 p = subparsers.add_parser('iscsi_target_node_add_lun', 1396 help='Add LUN to the target node') 1397 p.add_argument('name', help='Target node name (ASCII)') 1398 p.add_argument('bdev_name', help="""bdev name enclosed in quotes. 1399 *** bdev name cannot contain space or colon characters ***""") 1400 p.add_argument('-i', dest='lun_id', help="""LUN ID (integer >= 0) 1401 *** If LUN ID is omitted or -1, the lowest free one is assigned ***""", type=int, required=False) 1402 p.set_defaults(func=iscsi_target_node_add_lun) 1403 1404 def iscsi_target_node_set_auth(args): 1405 rpc.iscsi.iscsi_target_node_set_auth( 1406 args.client, 1407 name=args.name, 1408 chap_group=args.chap_group, 1409 disable_chap=args.disable_chap, 1410 require_chap=args.require_chap, 1411 mutual_chap=args.mutual_chap) 1412 1413 p = subparsers.add_parser('iscsi_target_node_set_auth', 1414 help='Set CHAP authentication for the target node') 1415 p.add_argument('name', help='Target node name (ASCII)') 1416 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node. 1417 *** Authentication group must be precreated ***""", type=int, default=0) 1418 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node. 1419 *** Mutually exclusive with --require-chap ***""", action='store_true') 1420 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node. 1421 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1422 p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', 1423 action='store_true') 1424 p.set_defaults(func=iscsi_target_node_set_auth) 1425 1426 def iscsi_target_node_add_pg_ig_maps(args): 1427 pg_ig_maps = [] 1428 for u in args.pg_ig_mappings.strip().split(" "): 1429 pg, ig = u.split(":") 1430 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1431 rpc.iscsi.iscsi_target_node_add_pg_ig_maps( 1432 args.client, 1433 pg_ig_maps=pg_ig_maps, 1434 name=args.name) 1435 1436 p = subparsers.add_parser('iscsi_target_node_add_pg_ig_maps', 1437 help='Add PG-IG maps to the target node') 1438 p.add_argument('name', help='Target node name (ASCII)') 1439 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1440 Whitespace separated, quoted, mapping defined with colon 1441 separated list of "tags" (int > 0) 1442 Example: '1:1 2:2 2:1' 1443 *** The Portal/Initiator Groups must be precreated ***""") 1444 p.set_defaults(func=iscsi_target_node_add_pg_ig_maps) 1445 1446 def iscsi_target_node_remove_pg_ig_maps(args): 1447 pg_ig_maps = [] 1448 for u in args.pg_ig_mappings.strip().split(" "): 1449 pg, ig = u.split(":") 1450 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1451 rpc.iscsi.iscsi_target_node_remove_pg_ig_maps( 1452 args.client, pg_ig_maps=pg_ig_maps, name=args.name) 1453 1454 p = subparsers.add_parser('iscsi_target_node_remove_pg_ig_maps', 1455 help='Delete PG-IG maps from the target node') 1456 p.add_argument('name', help='Target node name (ASCII)') 1457 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1458 Whitespace separated, quoted, mapping defined with colon 1459 separated list of "tags" (int > 0) 1460 Example: '1:1 2:2 2:1' 1461 *** The Portal/Initiator Groups must be precreated ***""") 1462 p.set_defaults(func=iscsi_target_node_remove_pg_ig_maps) 1463 1464 def iscsi_target_node_set_redirect(args): 1465 rpc.iscsi.iscsi_target_node_set_redirect( 1466 args.client, 1467 name=args.name, 1468 pg_tag=args.pg_tag, 1469 redirect_host=args.redirect_host, 1470 redirect_port=args.redirect_port) 1471 1472 p = subparsers.add_parser('iscsi_target_node_set_redirect', 1473 help="""Update redirect portal of the public portal group for the target node. 1474 Omit redirect host and port to clear previously set redirect settings.""") 1475 p.add_argument('name', help='Target node name (ASCII)') 1476 p.add_argument('pg_tag', help='Portal group tag (unique, integer > 0)', type=int) 1477 p.add_argument('-a', '--redirect-host', help='Numeric IP address for redirect portal', required=False) 1478 p.add_argument('-p', '--redirect-port', help='Numeric TCP port for redirect portal', required=False) 1479 p.set_defaults(func=iscsi_target_node_set_redirect) 1480 1481 def iscsi_target_node_request_logout(args): 1482 rpc.iscsi.iscsi_target_node_request_logout( 1483 args.client, 1484 name=args.name, 1485 pg_tag=args.pg_tag) 1486 1487 p = subparsers.add_parser('iscsi_target_node_request_logout', 1488 help="""For the target node, request connections whose portal group tag 1489 match to logout, or request all connections if portal group tag is omitted.""") 1490 p.add_argument('name', help='Target node name (ASCII)') 1491 p.add_argument('-t', '--pg-tag', help='Portal group tag (unique, integer > 0)', type=int, required=False) 1492 p.set_defaults(func=iscsi_target_node_request_logout) 1493 1494 def iscsi_create_portal_group(args): 1495 portals = [] 1496 for p in args.portal_list.strip().split(' '): 1497 ip, separator, port_cpumask = p.rpartition(':') 1498 split_port_cpumask = port_cpumask.split('@') 1499 if len(split_port_cpumask) == 1: 1500 port = port_cpumask 1501 portals.append({'host': ip, 'port': port}) 1502 else: 1503 port = split_port_cpumask[0] 1504 cpumask = split_port_cpumask[1] 1505 portals.append({'host': ip, 'port': port}) 1506 print("WARNING: Specifying a portal group with a CPU mask is no longer supported. Ignoring it.") 1507 rpc.iscsi.iscsi_create_portal_group( 1508 args.client, 1509 portals=portals, 1510 tag=args.tag, 1511 private=args.private, 1512 wait=args.wait) 1513 1514 p = subparsers.add_parser('iscsi_create_portal_group', 1515 help='Add a portal group') 1516 p.add_argument( 1517 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1518 p.add_argument('portal_list', help="""List of portals in host:port format, separated by whitespace 1519 Example: '192.168.100.100:3260 192.168.100.100:3261 192.168.100.100:3262""") 1520 p.add_argument('-p', '--private', help="""Public (false) or private (true) portal group. 1521 Private portal groups do not have their portals returned by a discovery session. A public 1522 portal group may optionally specify a redirect portal for non-discovery logins. This redirect 1523 portal must be from a private portal group.""", action='store_true') 1524 p.add_argument('-w', '--wait', help="""Do not listening on portals until it is started explicitly. 1525 One major iSCSI initiator may not retry login once it failed. Hence for such initiator, listening 1526 on portals should be allowed after all associated target nodes are created.""", action='store_true') 1527 p.set_defaults(func=iscsi_create_portal_group) 1528 1529 def iscsi_start_portal_group(args): 1530 rpc.iscsi.iscsi_start_portal_group(args.client, tag=args.tag) 1531 1532 p = subparsers.add_parser('iscsi_start_portal_group', 1533 help='Start listening on portals if it is not started yet.') 1534 p.add_argument( 1535 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1536 p.set_defaults(func=iscsi_start_portal_group) 1537 1538 def iscsi_create_initiator_group(args): 1539 initiators = [] 1540 netmasks = [] 1541 for i in args.initiator_list.strip().split(' '): 1542 initiators.append(i) 1543 for n in args.netmask_list.strip().split(' '): 1544 netmasks.append(n) 1545 rpc.iscsi.iscsi_create_initiator_group( 1546 args.client, 1547 tag=args.tag, 1548 initiators=initiators, 1549 netmasks=netmasks) 1550 1551 p = subparsers.add_parser('iscsi_create_initiator_group', 1552 help='Add an initiator group') 1553 p.add_argument( 1554 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1555 p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1556 enclosed in quotes. Example: 'ANY' or 'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""") 1557 p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1558 Example: '255.255.0.0 255.248.0.0' etc""") 1559 p.set_defaults(func=iscsi_create_initiator_group) 1560 1561 def iscsi_initiator_group_add_initiators(args): 1562 initiators = None 1563 netmasks = None 1564 if args.initiator_list: 1565 initiators = [] 1566 for i in args.initiator_list.strip().split(' '): 1567 initiators.append(i) 1568 if args.netmask_list: 1569 netmasks = [] 1570 for n in args.netmask_list.strip().split(' '): 1571 netmasks.append(n) 1572 rpc.iscsi.iscsi_initiator_group_add_initiators( 1573 args.client, 1574 tag=args.tag, 1575 initiators=initiators, 1576 netmasks=netmasks) 1577 1578 p = subparsers.add_parser('iscsi_initiator_group_add_initiators', 1579 help='Add initiators to an existing initiator group') 1580 p.add_argument( 1581 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1582 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1583 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or 1584 'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""", required=False) 1585 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1586 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""", required=False) 1587 p.set_defaults(func=iscsi_initiator_group_add_initiators) 1588 1589 def iscsi_initiator_group_remove_initiators(args): 1590 initiators = None 1591 netmasks = None 1592 if args.initiator_list: 1593 initiators = [] 1594 for i in args.initiator_list.strip().split(' '): 1595 initiators.append(i) 1596 if args.netmask_list: 1597 netmasks = [] 1598 for n in args.netmask_list.strip().split(' '): 1599 netmasks.append(n) 1600 rpc.iscsi.iscsi_initiator_group_remove_initiators( 1601 args.client, 1602 tag=args.tag, 1603 initiators=initiators, 1604 netmasks=netmasks) 1605 1606 p = subparsers.add_parser('iscsi_initiator_group_remove_initiators', 1607 help='Delete initiators from an existing initiator group') 1608 p.add_argument( 1609 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1610 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1611 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or 1612 'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""", required=False) 1613 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1614 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""", required=False) 1615 p.set_defaults(func=iscsi_initiator_group_remove_initiators) 1616 1617 def iscsi_delete_target_node(args): 1618 rpc.iscsi.iscsi_delete_target_node( 1619 args.client, target_node_name=args.target_node_name) 1620 1621 p = subparsers.add_parser('iscsi_delete_target_node', 1622 help='Delete a target node') 1623 p.add_argument('target_node_name', 1624 help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.') 1625 p.set_defaults(func=iscsi_delete_target_node) 1626 1627 def iscsi_delete_portal_group(args): 1628 rpc.iscsi.iscsi_delete_portal_group(args.client, tag=args.tag) 1629 1630 p = subparsers.add_parser('iscsi_delete_portal_group', 1631 help='Delete a portal group') 1632 p.add_argument( 1633 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1634 p.set_defaults(func=iscsi_delete_portal_group) 1635 1636 def iscsi_delete_initiator_group(args): 1637 rpc.iscsi.iscsi_delete_initiator_group(args.client, tag=args.tag) 1638 1639 p = subparsers.add_parser('iscsi_delete_initiator_group', 1640 help='Delete an initiator group') 1641 p.add_argument( 1642 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1643 p.set_defaults(func=iscsi_delete_initiator_group) 1644 1645 def iscsi_portal_group_set_auth(args): 1646 rpc.iscsi.iscsi_portal_group_set_auth( 1647 args.client, 1648 tag=args.tag, 1649 chap_group=args.chap_group, 1650 disable_chap=args.disable_chap, 1651 require_chap=args.require_chap, 1652 mutual_chap=args.mutual_chap) 1653 1654 p = subparsers.add_parser('iscsi_portal_group_set_auth', 1655 help='Set CHAP authentication for discovery sessions specific for the portal group') 1656 p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int) 1657 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this portal group. 1658 *** Authentication group must be precreated ***""", type=int, default=0) 1659 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this portal group. 1660 *** Mutually exclusive with --require-chap ***""", action='store_true') 1661 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this portal group. 1662 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1663 p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', 1664 action='store_true') 1665 p.set_defaults(func=iscsi_portal_group_set_auth) 1666 1667 def iscsi_get_connections(args): 1668 print_dict(rpc.iscsi.iscsi_get_connections(args.client)) 1669 1670 p = subparsers.add_parser('iscsi_get_connections', 1671 help='Display iSCSI connections') 1672 p.set_defaults(func=iscsi_get_connections) 1673 1674 def iscsi_get_options(args): 1675 print_dict(rpc.iscsi.iscsi_get_options(args.client)) 1676 1677 p = subparsers.add_parser('iscsi_get_options', 1678 help='Display iSCSI global parameters') 1679 p.set_defaults(func=iscsi_get_options) 1680 1681 def scsi_get_devices(args): 1682 print_dict(rpc.iscsi.scsi_get_devices(args.client)) 1683 1684 p = subparsers.add_parser('scsi_get_devices', help='Display SCSI devices') 1685 p.set_defaults(func=scsi_get_devices) 1686 1687 # trace 1688 def trace_enable_tpoint_group(args): 1689 rpc.trace.trace_enable_tpoint_group(args.client, name=args.name) 1690 1691 p = subparsers.add_parser('trace_enable_tpoint_group', aliases=['enable_tpoint_group'], 1692 help='enable trace on a specific tpoint group') 1693 p.add_argument( 1694 'name', help="""trace group name we want to enable in tpoint_group_mask. 1695 (for example "bdev" for bdev trace group, "all" for all trace groups).""") 1696 p.set_defaults(func=trace_enable_tpoint_group) 1697 1698 def trace_disable_tpoint_group(args): 1699 rpc.trace.trace_disable_tpoint_group(args.client, name=args.name) 1700 1701 p = subparsers.add_parser('trace_disable_tpoint_group', aliases=['disable_tpoint_group'], 1702 help='disable trace on a specific tpoint group') 1703 p.add_argument( 1704 'name', help="""trace group name we want to disable in tpoint_group_mask. 1705 (for example "bdev" for bdev trace group, "all" for all trace groups).""") 1706 p.set_defaults(func=trace_disable_tpoint_group) 1707 1708 def trace_set_tpoint_mask(args): 1709 rpc.trace.trace_set_tpoint_mask(args.client, name=args.name, tpoint_mask=args.tpoint_mask) 1710 1711 p = subparsers.add_parser('trace_set_tpoint_mask', 1712 help='enable tracepoint mask on a specific tpoint group') 1713 p.add_argument( 1714 'name', help="""trace group name we want to enable in tpoint_group_mask. 1715 (for example "bdev" for bdev trace group)""") 1716 p.add_argument( 1717 'tpoint_mask', help="""tracepoints to be enabled inside a given trace group. 1718 (for example value of "0x3" will enable only the first two tpoints in this group)""", 1719 type=lambda m: int(m, 16)) 1720 p.set_defaults(func=trace_set_tpoint_mask) 1721 1722 def trace_clear_tpoint_mask(args): 1723 rpc.trace.trace_clear_tpoint_mask(args.client, name=args.name, tpoint_mask=args.tpoint_mask) 1724 1725 p = subparsers.add_parser('trace_clear_tpoint_mask', 1726 help='disable tracepoint mask on a specific tpoint group') 1727 p.add_argument( 1728 'name', help="""trace group name we want to disable in tpoint_group_mask. 1729 (for example "bdev" for bdev trace group)""") 1730 p.add_argument( 1731 'tpoint_mask', help="""tracepoints to be disabled inside a given trace group. 1732 (for example value of "0x3" will disable the first two tpoints in this group)""", 1733 type=lambda m: int(m, 16)) 1734 p.set_defaults(func=trace_clear_tpoint_mask) 1735 1736 def trace_get_tpoint_group_mask(args): 1737 print_dict(rpc.trace.trace_get_tpoint_group_mask(args.client)) 1738 1739 p = subparsers.add_parser('trace_get_tpoint_group_mask', aliases=['get_tpoint_group_mask'], 1740 help='get trace point group mask') 1741 p.set_defaults(func=trace_get_tpoint_group_mask) 1742 1743 # log 1744 def log_set_flag(args): 1745 rpc.log.log_set_flag(args.client, flag=args.flag) 1746 1747 p = subparsers.add_parser('log_set_flag', help='set log flag', aliases=['set_log_flag']) 1748 p.add_argument( 1749 'flag', help='log flag we want to set. (for example "nvme").') 1750 p.set_defaults(func=log_set_flag) 1751 1752 def log_clear_flag(args): 1753 rpc.log.log_clear_flag(args.client, flag=args.flag) 1754 1755 p = subparsers.add_parser('log_clear_flag', help='clear log flag', aliases=['clear_log_flag']) 1756 p.add_argument( 1757 'flag', help='log flag we want to clear. (for example "nvme").') 1758 p.set_defaults(func=log_clear_flag) 1759 1760 def log_get_flags(args): 1761 print_dict(rpc.log.log_get_flags(args.client)) 1762 1763 p = subparsers.add_parser('log_get_flags', help='get log flags', aliases=['get_log_flags']) 1764 p.set_defaults(func=log_get_flags) 1765 1766 def log_set_level(args): 1767 rpc.log.log_set_level(args.client, level=args.level) 1768 1769 p = subparsers.add_parser('log_set_level', aliases=['set_log_level'], 1770 help='set log level') 1771 p.add_argument('level', help='log level we want to set. (for example "DEBUG").') 1772 p.set_defaults(func=log_set_level) 1773 1774 def log_get_level(args): 1775 print_dict(rpc.log.log_get_level(args.client)) 1776 1777 p = subparsers.add_parser('log_get_level', aliases=['get_log_level'], 1778 help='get log level') 1779 p.set_defaults(func=log_get_level) 1780 1781 def log_set_print_level(args): 1782 rpc.log.log_set_print_level(args.client, level=args.level) 1783 1784 p = subparsers.add_parser('log_set_print_level', aliases=['set_log_print_level'], 1785 help='set log print level') 1786 p.add_argument('level', help='log print level we want to set. (for example "DEBUG").') 1787 p.set_defaults(func=log_set_print_level) 1788 1789 def log_get_print_level(args): 1790 print_dict(rpc.log.log_get_print_level(args.client)) 1791 1792 p = subparsers.add_parser('log_get_print_level', aliases=['get_log_print_level'], 1793 help='get log print level') 1794 p.set_defaults(func=log_get_print_level) 1795 1796 # lvol 1797 def bdev_lvol_create_lvstore(args): 1798 print_json(rpc.lvol.bdev_lvol_create_lvstore(args.client, 1799 bdev_name=args.bdev_name, 1800 lvs_name=args.lvs_name, 1801 cluster_sz=args.cluster_sz, 1802 clear_method=args.clear_method)) 1803 1804 p = subparsers.add_parser('bdev_lvol_create_lvstore', aliases=['construct_lvol_store'], 1805 help='Add logical volume store on base bdev') 1806 p.add_argument('bdev_name', help='base bdev name') 1807 p.add_argument('lvs_name', help='name for lvol store') 1808 p.add_argument('-c', '--cluster-sz', help='size of cluster (in bytes)', type=int, required=False) 1809 p.add_argument('--clear-method', help="""Change clear method for data region. 1810 Available: none, unmap, write_zeroes""", required=False) 1811 p.set_defaults(func=bdev_lvol_create_lvstore) 1812 1813 def bdev_lvol_rename_lvstore(args): 1814 rpc.lvol.bdev_lvol_rename_lvstore(args.client, 1815 old_name=args.old_name, 1816 new_name=args.new_name) 1817 1818 p = subparsers.add_parser('bdev_lvol_rename_lvstore', aliases=['rename_lvol_store'], 1819 help='Change logical volume store name') 1820 p.add_argument('old_name', help='old name') 1821 p.add_argument('new_name', help='new name') 1822 p.set_defaults(func=bdev_lvol_rename_lvstore) 1823 1824 def bdev_lvol_create(args): 1825 print_json(rpc.lvol.bdev_lvol_create(args.client, 1826 lvol_name=args.lvol_name, 1827 size=args.size * 1024 * 1024, 1828 thin_provision=args.thin_provision, 1829 clear_method=args.clear_method, 1830 uuid=args.uuid, 1831 lvs_name=args.lvs_name)) 1832 1833 p = subparsers.add_parser('bdev_lvol_create', aliases=['construct_lvol_bdev'], 1834 help='Add a bdev with an logical volume backend') 1835 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 1836 p.add_argument('-l', '--lvs-name', help='lvol store name', required=False) 1837 p.add_argument('-t', '--thin-provision', action='store_true', help='create lvol bdev as thin provisioned') 1838 p.add_argument('-c', '--clear-method', help="""Change default data clusters clear method. 1839 Available: none, unmap, write_zeroes""", required=False) 1840 p.add_argument('lvol_name', help='name for this lvol') 1841 p.add_argument('size', help='size in MiB for this bdev', type=int) 1842 p.set_defaults(func=bdev_lvol_create) 1843 1844 def bdev_lvol_snapshot(args): 1845 print_json(rpc.lvol.bdev_lvol_snapshot(args.client, 1846 lvol_name=args.lvol_name, 1847 snapshot_name=args.snapshot_name)) 1848 1849 p = subparsers.add_parser('bdev_lvol_snapshot', aliases=['snapshot_lvol_bdev'], 1850 help='Create a snapshot of an lvol bdev') 1851 p.add_argument('lvol_name', help='lvol bdev name') 1852 p.add_argument('snapshot_name', help='lvol snapshot name') 1853 p.set_defaults(func=bdev_lvol_snapshot) 1854 1855 def bdev_lvol_clone(args): 1856 print_json(rpc.lvol.bdev_lvol_clone(args.client, 1857 snapshot_name=args.snapshot_name, 1858 clone_name=args.clone_name)) 1859 1860 p = subparsers.add_parser('bdev_lvol_clone', aliases=['clone_lvol_bdev'], 1861 help='Create a clone of an lvol snapshot') 1862 p.add_argument('snapshot_name', help='lvol snapshot name') 1863 p.add_argument('clone_name', help='lvol clone name') 1864 p.set_defaults(func=bdev_lvol_clone) 1865 1866 def bdev_lvol_rename(args): 1867 rpc.lvol.bdev_lvol_rename(args.client, 1868 old_name=args.old_name, 1869 new_name=args.new_name) 1870 1871 p = subparsers.add_parser('bdev_lvol_rename', aliases=['rename_lvol_bdev'], 1872 help='Change lvol bdev name') 1873 p.add_argument('old_name', help='lvol bdev name') 1874 p.add_argument('new_name', help='new lvol name') 1875 p.set_defaults(func=bdev_lvol_rename) 1876 1877 def bdev_lvol_inflate(args): 1878 rpc.lvol.bdev_lvol_inflate(args.client, 1879 name=args.name) 1880 1881 p = subparsers.add_parser('bdev_lvol_inflate', aliases=['inflate_lvol_bdev'], 1882 help='Make thin provisioned lvol a thick provisioned lvol') 1883 p.add_argument('name', help='lvol bdev name') 1884 p.set_defaults(func=bdev_lvol_inflate) 1885 1886 def bdev_lvol_decouple_parent(args): 1887 rpc.lvol.bdev_lvol_decouple_parent(args.client, 1888 name=args.name) 1889 1890 p = subparsers.add_parser('bdev_lvol_decouple_parent', aliases=['decouple_parent_lvol_bdev'], 1891 help='Decouple parent of lvol') 1892 p.add_argument('name', help='lvol bdev name') 1893 p.set_defaults(func=bdev_lvol_decouple_parent) 1894 1895 def bdev_lvol_resize(args): 1896 rpc.lvol.bdev_lvol_resize(args.client, 1897 name=args.name, 1898 size=args.size * 1024 * 1024) 1899 1900 p = subparsers.add_parser('bdev_lvol_resize', aliases=['resize_lvol_bdev'], 1901 help='Resize existing lvol bdev') 1902 p.add_argument('name', help='lvol bdev name') 1903 p.add_argument('size', help='new size in MiB for this bdev', type=int) 1904 p.set_defaults(func=bdev_lvol_resize) 1905 1906 def bdev_lvol_set_read_only(args): 1907 rpc.lvol.bdev_lvol_set_read_only(args.client, 1908 name=args.name) 1909 1910 p = subparsers.add_parser('bdev_lvol_set_read_only', aliases=['set_read_only_lvol_bdev'], 1911 help='Mark lvol bdev as read only') 1912 p.add_argument('name', help='lvol bdev name') 1913 p.set_defaults(func=bdev_lvol_set_read_only) 1914 1915 def bdev_lvol_delete(args): 1916 rpc.lvol.bdev_lvol_delete(args.client, 1917 name=args.name) 1918 1919 p = subparsers.add_parser('bdev_lvol_delete', aliases=['destroy_lvol_bdev'], 1920 help='Destroy a logical volume') 1921 p.add_argument('name', help='lvol bdev name') 1922 p.set_defaults(func=bdev_lvol_delete) 1923 1924 def bdev_lvol_delete_lvstore(args): 1925 rpc.lvol.bdev_lvol_delete_lvstore(args.client, 1926 uuid=args.uuid, 1927 lvs_name=args.lvs_name) 1928 1929 p = subparsers.add_parser('bdev_lvol_delete_lvstore', aliases=['destroy_lvol_store'], 1930 help='Destroy an logical volume store') 1931 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 1932 p.add_argument('-l', '--lvs-name', help='lvol store name', required=False) 1933 p.set_defaults(func=bdev_lvol_delete_lvstore) 1934 1935 def bdev_lvol_get_lvstores(args): 1936 print_dict(rpc.lvol.bdev_lvol_get_lvstores(args.client, 1937 uuid=args.uuid, 1938 lvs_name=args.lvs_name)) 1939 1940 p = subparsers.add_parser('bdev_lvol_get_lvstores', aliases=['get_lvol_stores'], 1941 help='Display current logical volume store list') 1942 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 1943 p.add_argument('-l', '--lvs-name', help='lvol store name', required=False) 1944 p.set_defaults(func=bdev_lvol_get_lvstores) 1945 1946 def bdev_raid_get_bdevs(args): 1947 print_array(rpc.bdev.bdev_raid_get_bdevs(args.client, 1948 category=args.category)) 1949 1950 p = subparsers.add_parser('bdev_raid_get_bdevs', aliases=['get_raid_bdevs'], 1951 help="""This is used to list all the raid bdev names based on the input category 1952 requested. Category should be one of 'all', 'online', 'configuring' or 'offline'. 'all' means all the raid bdevs whether 1953 they are online or configuring or offline. 'online' is the raid bdev which is registered with bdev layer. 'configuring' 1954 is the raid bdev which does not have full configuration discovered yet. 'offline' is the raid bdev which is not registered 1955 with bdev as of now and it has encountered any error or user has requested to offline the raid bdev""") 1956 p.add_argument('category', help='all or online or configuring or offline') 1957 p.set_defaults(func=bdev_raid_get_bdevs) 1958 1959 def bdev_raid_create(args): 1960 base_bdevs = [] 1961 for u in args.base_bdevs.strip().split(" "): 1962 base_bdevs.append(u) 1963 1964 rpc.bdev.bdev_raid_create(args.client, 1965 name=args.name, 1966 strip_size_kb=args.strip_size_kb, 1967 raid_level=args.raid_level, 1968 base_bdevs=base_bdevs) 1969 p = subparsers.add_parser('bdev_raid_create', aliases=['construct_raid_bdev'], 1970 help='Create new raid bdev') 1971 p.add_argument('-n', '--name', help='raid bdev name', required=True) 1972 p.add_argument('-z', '--strip-size-kb', help='strip size in KB', type=int) 1973 p.add_argument('-r', '--raid-level', help='raid level, raid0 and a special level concat are supported', required=True) 1974 p.add_argument('-b', '--base-bdevs', help='base bdevs name, whitespace separated list in quotes', required=True) 1975 p.set_defaults(func=bdev_raid_create) 1976 1977 def bdev_raid_delete(args): 1978 rpc.bdev.bdev_raid_delete(args.client, 1979 name=args.name) 1980 p = subparsers.add_parser('bdev_raid_delete', aliases=['destroy_raid_bdev'], 1981 help='Delete existing raid bdev') 1982 p.add_argument('name', help='raid bdev name') 1983 p.set_defaults(func=bdev_raid_delete) 1984 1985 # split 1986 def bdev_split_create(args): 1987 print_array(rpc.bdev.bdev_split_create(args.client, 1988 base_bdev=args.base_bdev, 1989 split_count=args.split_count, 1990 split_size_mb=args.split_size_mb)) 1991 1992 p = subparsers.add_parser('bdev_split_create', aliases=['construct_split_vbdev'], 1993 help="""Add given disk name to split config. If bdev with base_name 1994 name exist the split bdevs will be created right away, if not split bdevs will be created when base bdev became 1995 available (during examination process).""") 1996 p.add_argument('base_bdev', help='base bdev name') 1997 p.add_argument('-s', '--split-size-mb', help='size in MiB for each bdev', type=int, default=0) 1998 p.add_argument('split_count', help="""Optional - number of split bdevs to create. Total size * split_count must not 1999 exceed the base bdev size.""", type=int) 2000 p.set_defaults(func=bdev_split_create) 2001 2002 def bdev_split_delete(args): 2003 rpc.bdev.bdev_split_delete(args.client, 2004 base_bdev=args.base_bdev) 2005 2006 p = subparsers.add_parser('bdev_split_delete', aliases=['destruct_split_vbdev'], 2007 help="""Delete split config with all created splits.""") 2008 p.add_argument('base_bdev', help='base bdev name') 2009 p.set_defaults(func=bdev_split_delete) 2010 2011 # ftl 2012 ftl_valid_limits = ('crit', 'high', 'low', 'start') 2013 2014 def bdev_ftl_create(args): 2015 def parse_limits(limits, arg_dict, key_suffix=''): 2016 for limit in limits.split(','): 2017 key, value = limit.split(':', 1) 2018 if key in ftl_valid_limits: 2019 arg_dict['limit_' + key + key_suffix] = int(value) 2020 else: 2021 raise ValueError('Limit {} is not supported'.format(key)) 2022 2023 arg_limits = {} 2024 if args.limit_threshold: 2025 parse_limits(args.limit_threshold, arg_limits, '_threshold') 2026 2027 if args.limit: 2028 parse_limits(args.limit, arg_limits) 2029 2030 print_dict(rpc.bdev.bdev_ftl_create(args.client, 2031 name=args.name, 2032 base_bdev=args.base_bdev, 2033 uuid=args.uuid, 2034 cache=args.cache, 2035 allow_open_bands=args.allow_open_bands, 2036 overprovisioning=args.overprovisioning, 2037 l2p_path=args.l2p_path, 2038 use_append=args.use_append, 2039 **arg_limits)) 2040 2041 p = subparsers.add_parser('bdev_ftl_create', aliases=['construct_ftl_bdev'], help='Add FTL bdev') 2042 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2043 p.add_argument('-d', '--base-bdev', help='Name of zoned bdev used as underlying device', 2044 required=True) 2045 p.add_argument('-u', '--uuid', help='UUID of restored bdev (not applicable when creating new ' 2046 'instance): e.g. b286d19a-0059-4709-abcd-9f7732b1567d (optional)') 2047 p.add_argument('-c', '--cache', help='Name of the bdev to be used as a write buffer cache (optional)') 2048 p.add_argument('-o', '--allow-open-bands', help='Restoring after dirty shutdown without cache will' 2049 ' result in partial data recovery, instead of error', action='store_true') 2050 p.add_argument('--overprovisioning', help='Percentage of device used for relocation, not exposed' 2051 ' to user (optional)', type=int) 2052 p.add_argument('--l2p-path', help='Path to persistent memory file or device to store l2p onto, ' 2053 'by default l2p is kept in DRAM and is volatile (optional)') 2054 p.add_argument('--use-append', help='Use appends instead of writes', action='store_true') 2055 2056 limits = p.add_argument_group('Defrag limits', 'Configures defrag limits and thresholds for' 2057 ' levels ' + str(ftl_valid_limits)[1:-1]) 2058 limits.add_argument('--limit', help='Percentage of allowed user versus internal writes at given' 2059 ' levels, e.g. crit:0,high:20,low:80') 2060 limits.add_argument('--limit-threshold', help='Number of free bands triggering a given level of' 2061 ' write limiting e.g. crit:1,high:2,low:3,start:4') 2062 p.set_defaults(func=bdev_ftl_create) 2063 2064 def bdev_ftl_delete(args): 2065 print_dict(rpc.bdev.bdev_ftl_delete(args.client, name=args.name)) 2066 2067 p = subparsers.add_parser('bdev_ftl_delete', aliases=['delete_ftl_bdev'], 2068 help='Delete FTL bdev') 2069 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2070 p.set_defaults(func=bdev_ftl_delete) 2071 2072 # vmd 2073 def enable_vmd(args): 2074 print_dict(rpc.vmd.enable_vmd(args.client)) 2075 2076 p = subparsers.add_parser('enable_vmd', help='Enable VMD enumeration') 2077 p.set_defaults(func=enable_vmd) 2078 2079 # nbd 2080 def nbd_start_disk(args): 2081 print(rpc.nbd.nbd_start_disk(args.client, 2082 bdev_name=args.bdev_name, 2083 nbd_device=args.nbd_device)) 2084 2085 p = subparsers.add_parser('nbd_start_disk', 2086 help='Export a bdev as an nbd disk') 2087 p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.') 2088 p.add_argument('nbd_device', help='Nbd device name to be assigned. Example: /dev/nbd0.', nargs='?') 2089 p.set_defaults(func=nbd_start_disk) 2090 2091 def nbd_stop_disk(args): 2092 rpc.nbd.nbd_stop_disk(args.client, 2093 nbd_device=args.nbd_device) 2094 2095 p = subparsers.add_parser('nbd_stop_disk', 2096 help='Stop an nbd disk') 2097 p.add_argument('nbd_device', help='Nbd device name to be stopped. Example: /dev/nbd0.') 2098 p.set_defaults(func=nbd_stop_disk) 2099 2100 def nbd_get_disks(args): 2101 print_dict(rpc.nbd.nbd_get_disks(args.client, 2102 nbd_device=args.nbd_device)) 2103 2104 p = subparsers.add_parser('nbd_get_disks', 2105 help='Display full or specified nbd device list') 2106 p.add_argument('-n', '--nbd-device', help="Path of the nbd device. Example: /dev/nbd0", required=False) 2107 p.set_defaults(func=nbd_get_disks) 2108 2109 # NVMe-oF 2110 def nvmf_set_max_subsystems(args): 2111 rpc.nvmf.nvmf_set_max_subsystems(args.client, 2112 max_subsystems=args.max_subsystems) 2113 2114 p = subparsers.add_parser('nvmf_set_max_subsystems', aliases=['set_nvmf_target_max_subsystems'], 2115 help='Set the maximum number of NVMf target subsystems') 2116 p.add_argument('-x', '--max-subsystems', help='Max number of NVMf subsystems', type=int, required=True) 2117 p.set_defaults(func=nvmf_set_max_subsystems) 2118 2119 def nvmf_set_config(args): 2120 rpc.nvmf.nvmf_set_config(args.client, 2121 passthru_identify_ctrlr=args.passthru_identify_ctrlr, 2122 poll_groups_mask=args.poll_groups_mask, 2123 discovery_filter=args.discovery_filter) 2124 2125 p = subparsers.add_parser('nvmf_set_config', aliases=['set_nvmf_target_config'], 2126 help='Set NVMf target config') 2127 p.add_argument('-i', '--passthru-identify-ctrlr', help="""Passthrough fields like serial number and model number 2128 when the controller has a single namespace that is an NVMe bdev""", action='store_true') 2129 p.add_argument('-m', '--poll-groups-mask', help='Set cpumask for NVMf poll groups (optional)', type=str) 2130 p.add_argument('-d', '--discovery-filter', help="""Set discovery filter (optional), possible values are: `match_any` (default) or 2131 comma separated values: `transport`, `address`, `svcid`""", type=str) 2132 p.set_defaults(func=nvmf_set_config) 2133 2134 def nvmf_create_transport(args): 2135 rpc.nvmf.nvmf_create_transport(**vars(args)) 2136 2137 p = subparsers.add_parser('nvmf_create_transport', help='Create NVMf transport') 2138 p.add_argument('-t', '--trtype', help='Transport type (ex. RDMA)', type=str, required=True) 2139 p.add_argument('-g', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2140 p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/O per queue', type=int) 2141 p.add_argument('-m', '--max-io-qpairs-per-ctrlr', help='Max number of IO qpairs per controller', type=int) 2142 p.add_argument('-c', '--in-capsule-data-size', help='Max number of in-capsule data size', type=int) 2143 p.add_argument('-i', '--max-io-size', help='Max I/O size (bytes)', type=int) 2144 p.add_argument('-u', '--io-unit-size', help='I/O unit size (bytes)', type=int) 2145 p.add_argument('-a', '--max-aq-depth', help='Max number of admin cmds per AQ', type=int) 2146 p.add_argument('-n', '--num-shared-buffers', help='The number of pooled data buffers available to the transport', type=int) 2147 p.add_argument('-b', '--buf-cache-size', help='The number of shared buffers to reserve for each poll group', type=int) 2148 p.add_argument('-z', '--zcopy', action='store_true', help='''Use zero-copy operations if the 2149 underlying bdev supports them''') 2150 p.add_argument('-d', '--num-cqe', help="""The number of CQ entires. Only used when no_srq=true. 2151 Relevant only for RDMA transport""", type=int) 2152 p.add_argument('-s', '--max-srq-depth', help='Max number of outstanding I/O per SRQ. Relevant only for RDMA transport', type=int) 2153 p.add_argument('-r', '--no-srq', action='store_true', help='Disable per-thread shared receive queue. Relevant only for RDMA transport') 2154 p.add_argument('-o', '--c2h-success', action='store_false', help='Disable C2H success optimization. Relevant only for TCP transport') 2155 p.add_argument('-f', '--dif-insert-or-strip', action='store_true', help='Enable DIF insert/strip. Relevant only for TCP transport') 2156 p.add_argument('-y', '--sock-priority', help='The sock priority of the tcp connection. Relevant only for TCP transport', type=int) 2157 p.add_argument('-l', '--acceptor-backlog', help='Pending connections allowed at one time. Relevant only for RDMA transport', type=int) 2158 p.add_argument('-x', '--abort-timeout-sec', help='Abort execution timeout value, in seconds', type=int) 2159 p.add_argument('-w', '--no-wr-batching', action='store_true', help='Disable work requests batching. Relevant only for RDMA transport') 2160 p.add_argument('-e', '--control-msg-num', help="""The number of control messages per poll group. 2161 Relevant only for TCP transport""", type=int) 2162 p.add_argument('-M', '--disable-mappable-bar0', action='store_true', help="""Disable mmap() of BAR0. 2163 Relevant only for VFIO-USER transport""") 2164 p.add_argument('-I', '--disable-adaptive-irq', action='store_true', help="""Disable adaptive interrupt feature. 2165 Relevant only for VFIO-USER transport""") 2166 p.add_argument('-S', '--disable-shadow-doorbells', action='store_true', help="""Disable shadow doorbell support. 2167 Relevant only for VFIO-USER transport""") 2168 p.add_argument('--acceptor-poll-rate', help='Polling interval of the acceptor for incoming connections (usec)', type=int) 2169 p.set_defaults(func=nvmf_create_transport) 2170 2171 def nvmf_get_transports(args): 2172 print_dict(rpc.nvmf.nvmf_get_transports(args.client, trtype=args.trtype, tgt_name=args.tgt_name)) 2173 2174 p = subparsers.add_parser('nvmf_get_transports', aliases=['get_nvmf_transports'], 2175 help='Display nvmf transports or required transport') 2176 p.add_argument('--trtype', help='Transport type (optional)') 2177 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2178 p.set_defaults(func=nvmf_get_transports) 2179 2180 def nvmf_get_subsystems(args): 2181 print_dict(rpc.nvmf.nvmf_get_subsystems(args.client, nqn=args.nqn, tgt_name=args.tgt_name)) 2182 2183 p = subparsers.add_parser('nvmf_get_subsystems', aliases=['get_nvmf_subsystems'], 2184 help='Display nvmf subsystems or required subsystem') 2185 p.add_argument('nqn', help='Subsystem NQN (optional)', nargs="?", default=None) 2186 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2187 p.set_defaults(func=nvmf_get_subsystems) 2188 2189 def nvmf_create_subsystem(args): 2190 rpc.nvmf.nvmf_create_subsystem(args.client, 2191 nqn=args.nqn, 2192 tgt_name=args.tgt_name, 2193 serial_number=args.serial_number, 2194 model_number=args.model_number, 2195 allow_any_host=args.allow_any_host, 2196 max_namespaces=args.max_namespaces, 2197 ana_reporting=args.ana_reporting, 2198 min_cntlid=args.min_cntlid, 2199 max_cntlid=args.max_cntlid) 2200 2201 p = subparsers.add_parser('nvmf_create_subsystem', aliases=['nvmf_subsystem_create'], 2202 help='Create an NVMe-oF subsystem') 2203 p.add_argument('nqn', help='Subsystem NQN (ASCII)') 2204 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2205 p.add_argument("-s", "--serial-number", help=""" 2206 Format: 'sn' etc 2207 Example: 'SPDK00000000000001'""", default='00000000000000000000') 2208 p.add_argument("-d", "--model-number", help=""" 2209 Format: 'mn' etc 2210 Example: 'SPDK Controller'""", default='SPDK bdev Controller') 2211 p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce allowed host NQN list)") 2212 p.add_argument("-m", "--max-namespaces", help="Maximum number of namespaces allowed", 2213 type=int, default=0) 2214 p.add_argument("-r", "--ana-reporting", action='store_true', help="Enable ANA reporting feature") 2215 p.add_argument("-i", "--min_cntlid", help="Minimum controller ID", type=int, default=1) 2216 p.add_argument("-I", "--max_cntlid", help="Maximum controller ID", type=int, default=0xffef) 2217 p.set_defaults(func=nvmf_create_subsystem) 2218 2219 def nvmf_delete_subsystem(args): 2220 rpc.nvmf.nvmf_delete_subsystem(args.client, 2221 nqn=args.subsystem_nqn, 2222 tgt_name=args.tgt_name) 2223 2224 p = subparsers.add_parser('nvmf_delete_subsystem', aliases=['delete_nvmf_subsystem'], 2225 help='Delete a nvmf subsystem') 2226 p.add_argument('subsystem_nqn', 2227 help='subsystem nqn to be deleted. Example: nqn.2016-06.io.spdk:cnode1.') 2228 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2229 p.set_defaults(func=nvmf_delete_subsystem) 2230 2231 def nvmf_subsystem_add_listener(args): 2232 rpc.nvmf.nvmf_subsystem_add_listener(**vars(args)) 2233 2234 p = subparsers.add_parser('nvmf_subsystem_add_listener', help='Add a listener to an NVMe-oF subsystem') 2235 p.add_argument('nqn', help='NVMe-oF subsystem NQN (\'discovery\' can be used as shortcut for discovery NQN)') 2236 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2237 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2238 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2239 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2240 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for RDMA or TCP)') 2241 p.set_defaults(func=nvmf_subsystem_add_listener) 2242 2243 def nvmf_subsystem_remove_listener(args): 2244 rpc.nvmf.nvmf_subsystem_remove_listener(args.client, 2245 nqn=args.nqn, 2246 trtype=args.trtype, 2247 traddr=args.traddr, 2248 tgt_name=args.tgt_name, 2249 adrfam=args.adrfam, 2250 trsvcid=args.trsvcid) 2251 2252 p = subparsers.add_parser('nvmf_subsystem_remove_listener', help='Remove a listener from an NVMe-oF subsystem') 2253 p.add_argument('nqn', help='NVMe-oF subsystem NQN (\'discovery\' can be used as shortcut for discovery NQN)') 2254 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2255 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2256 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2257 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2258 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for TCP and RDMA transport types)') 2259 p.set_defaults(func=nvmf_subsystem_remove_listener) 2260 2261 def nvmf_subsystem_listener_set_ana_state(args): 2262 rpc.nvmf.nvmf_subsystem_listener_set_ana_state(args.client, 2263 nqn=args.nqn, 2264 ana_state=args.ana_state, 2265 trtype=args.trtype, 2266 traddr=args.traddr, 2267 tgt_name=args.tgt_name, 2268 adrfam=args.adrfam, 2269 trsvcid=args.trsvcid, 2270 anagrpid=args.anagrpid) 2271 2272 p = subparsers.add_parser('nvmf_subsystem_listener_set_ana_state', help='Set ANA state of a listener for an NVMe-oF subsystem') 2273 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2274 p.add_argument('-n', '--ana-state', help='ANA state to set: optimized, non_optimized, or inaccessible', required=True) 2275 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2276 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2277 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2278 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2279 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number') 2280 p.add_argument('-g', '--anagrpid', help='ANA group ID (optional)', type=int) 2281 p.set_defaults(func=nvmf_subsystem_listener_set_ana_state) 2282 2283 def nvmf_subsystem_add_ns(args): 2284 rpc.nvmf.nvmf_subsystem_add_ns(args.client, 2285 nqn=args.nqn, 2286 bdev_name=args.bdev_name, 2287 tgt_name=args.tgt_name, 2288 ptpl_file=args.ptpl_file, 2289 nsid=args.nsid, 2290 nguid=args.nguid, 2291 eui64=args.eui64, 2292 uuid=args.uuid, 2293 anagrpid=args.anagrpid) 2294 2295 p = subparsers.add_parser('nvmf_subsystem_add_ns', help='Add a namespace to an NVMe-oF subsystem') 2296 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2297 p.add_argument('bdev_name', help='The name of the bdev that will back this namespace') 2298 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2299 p.add_argument('-p', '--ptpl-file', help='The persistent reservation storage location (optional)', type=str) 2300 p.add_argument('-n', '--nsid', help='The requested NSID (optional)', type=int) 2301 p.add_argument('-g', '--nguid', help='Namespace globally unique identifier (optional)') 2302 p.add_argument('-e', '--eui64', help='Namespace EUI-64 identifier (optional)') 2303 p.add_argument('-u', '--uuid', help='Namespace UUID (optional)') 2304 p.add_argument('-a', '--anagrpid', help='ANA group ID (optional)', type=int) 2305 p.set_defaults(func=nvmf_subsystem_add_ns) 2306 2307 def nvmf_subsystem_remove_ns(args): 2308 rpc.nvmf.nvmf_subsystem_remove_ns(args.client, 2309 nqn=args.nqn, 2310 nsid=args.nsid, 2311 tgt_name=args.tgt_name) 2312 2313 p = subparsers.add_parser('nvmf_subsystem_remove_ns', help='Remove a namespace to an NVMe-oF subsystem') 2314 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2315 p.add_argument('nsid', help='The requested NSID', type=int) 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_remove_ns) 2318 2319 def nvmf_subsystem_add_host(args): 2320 rpc.nvmf.nvmf_subsystem_add_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_add_host', help='Add a host to an NVMe-oF subsystem') 2326 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2327 p.add_argument('host', help='Host NQN to allow') 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_add_host) 2330 2331 def nvmf_subsystem_remove_host(args): 2332 rpc.nvmf.nvmf_subsystem_remove_host(args.client, 2333 nqn=args.nqn, 2334 host=args.host, 2335 tgt_name=args.tgt_name) 2336 2337 p = subparsers.add_parser('nvmf_subsystem_remove_host', help='Remove a host from an NVMe-oF subsystem') 2338 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2339 p.add_argument('host', help='Host NQN to remove') 2340 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2341 p.set_defaults(func=nvmf_subsystem_remove_host) 2342 2343 def nvmf_subsystem_allow_any_host(args): 2344 rpc.nvmf.nvmf_subsystem_allow_any_host(args.client, 2345 nqn=args.nqn, 2346 disable=args.disable, 2347 tgt_name=args.tgt_name) 2348 2349 p = subparsers.add_parser('nvmf_subsystem_allow_any_host', help='Allow any host to connect to the subsystem') 2350 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2351 p.add_argument('-e', '--enable', action='store_true', help='Enable allowing any host') 2352 p.add_argument('-d', '--disable', action='store_true', help='Disable allowing any host') 2353 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2354 p.set_defaults(func=nvmf_subsystem_allow_any_host) 2355 2356 def nvmf_subsystem_get_controllers(args): 2357 print_dict(rpc.nvmf.nvmf_subsystem_get_controllers(args.client, 2358 nqn=args.nqn, 2359 tgt_name=args.tgt_name)) 2360 2361 p = subparsers.add_parser('nvmf_subsystem_get_controllers', 2362 help='Display controllers of an NVMe-oF subsystem.') 2363 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2364 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2365 p.set_defaults(func=nvmf_subsystem_get_controllers) 2366 2367 def nvmf_subsystem_get_qpairs(args): 2368 print_dict(rpc.nvmf.nvmf_subsystem_get_qpairs(args.client, 2369 nqn=args.nqn, 2370 tgt_name=args.tgt_name)) 2371 2372 p = subparsers.add_parser('nvmf_subsystem_get_qpairs', 2373 help='Display queue pairs of an NVMe-oF subsystem.') 2374 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2375 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2376 p.set_defaults(func=nvmf_subsystem_get_qpairs) 2377 2378 def nvmf_subsystem_get_listeners(args): 2379 print_dict(rpc.nvmf.nvmf_subsystem_get_listeners(args.client, 2380 nqn=args.nqn, 2381 tgt_name=args.tgt_name)) 2382 2383 p = subparsers.add_parser('nvmf_subsystem_get_listeners', 2384 help='Display listeners of an NVMe-oF subsystem.') 2385 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2386 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2387 p.set_defaults(func=nvmf_subsystem_get_listeners) 2388 2389 def nvmf_get_stats(args): 2390 print_dict(rpc.nvmf.nvmf_get_stats(args.client, tgt_name=args.tgt_name)) 2391 2392 p = subparsers.add_parser( 2393 'nvmf_get_stats', help='Display current statistics for NVMf subsystem') 2394 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2395 p.set_defaults(func=nvmf_get_stats) 2396 2397 def nvmf_set_crdt(args): 2398 print_dict(rpc.nvmf.nvmf_set_crdt(args.client, args.crdt1, args.crdt2, args.crdt3)) 2399 2400 p = subparsers.add_parser( 2401 'nvmf_set_crdt', 2402 help="""Set the 3 crdt (Command Retry Delay Time) values for NVMf subsystem. All 2403 values are in units of 100 milliseconds (same as the NVM Express specification).""") 2404 p.add_argument('-t1', '--crdt1', help='Command Retry Delay Time 1, in units of 100 milliseconds', type=int) 2405 p.add_argument('-t2', '--crdt2', help='Command Retry Delay Time 2, in units of 100 milliseconds', type=int) 2406 p.add_argument('-t3', '--crdt3', help='Command Retry Delay Time 3, in units of 100 milliseconds', type=int) 2407 p.set_defaults(func=nvmf_set_crdt) 2408 2409 # pmem 2410 def bdev_pmem_create_pool(args): 2411 num_blocks = int((args.total_size * 1024 * 1024) / args.block_size) 2412 rpc.pmem.bdev_pmem_create_pool(args.client, 2413 pmem_file=args.pmem_file, 2414 num_blocks=num_blocks, 2415 block_size=args.block_size) 2416 2417 p = subparsers.add_parser('bdev_pmem_create_pool', aliases=['create_pmem_pool'], 2418 help='Create pmem pool') 2419 p.add_argument('pmem_file', help='Path to pmemblk pool file') 2420 p.add_argument('total_size', help='Size of pmem bdev in MB (int > 0)', type=int) 2421 p.add_argument('block_size', help='Block size for this pmem pool', type=int) 2422 p.set_defaults(func=bdev_pmem_create_pool) 2423 2424 def bdev_pmem_get_pool_info(args): 2425 print_dict(rpc.pmem.bdev_pmem_get_pool_info(args.client, 2426 pmem_file=args.pmem_file)) 2427 2428 p = subparsers.add_parser('bdev_pmem_get_pool_info', aliases=['pmem_pool_info'], 2429 help='Display pmem pool info and check consistency') 2430 p.add_argument('pmem_file', help='Path to pmemblk pool file') 2431 p.set_defaults(func=bdev_pmem_get_pool_info) 2432 2433 def bdev_pmem_delete_pool(args): 2434 rpc.pmem.bdev_pmem_delete_pool(args.client, 2435 pmem_file=args.pmem_file) 2436 2437 p = subparsers.add_parser('bdev_pmem_delete_pool', aliases=['delete_pmem_pool'], 2438 help='Delete pmem pool') 2439 p.add_argument('pmem_file', help='Path to pmemblk pool file') 2440 p.set_defaults(func=bdev_pmem_delete_pool) 2441 2442 # subsystem 2443 def framework_get_subsystems(args): 2444 print_dict(rpc.subsystem.framework_get_subsystems(args.client)) 2445 2446 p = subparsers.add_parser('framework_get_subsystems', aliases=['get_subsystems'], 2447 help="""Print subsystems array in initialization order. Each subsystem 2448 entry contain (unsorted) array of subsystems it depends on.""") 2449 p.set_defaults(func=framework_get_subsystems) 2450 2451 def framework_get_config(args): 2452 print_dict(rpc.subsystem.framework_get_config(args.client, args.name)) 2453 2454 p = subparsers.add_parser('framework_get_config', aliases=['get_subsystem_config'], 2455 help="""Print subsystem configuration""") 2456 p.add_argument('name', help='Name of subsystem to query') 2457 p.set_defaults(func=framework_get_config) 2458 2459 # vhost 2460 def vhost_controller_set_coalescing(args): 2461 rpc.vhost.vhost_controller_set_coalescing(args.client, 2462 ctrlr=args.ctrlr, 2463 delay_base_us=args.delay_base_us, 2464 iops_threshold=args.iops_threshold) 2465 2466 p = subparsers.add_parser('vhost_controller_set_coalescing', aliases=['set_vhost_controller_coalescing'], 2467 help='Set vhost controller coalescing') 2468 p.add_argument('ctrlr', help='controller name') 2469 p.add_argument('delay_base_us', help='Base delay time', type=int) 2470 p.add_argument('iops_threshold', help='IOPS threshold when coalescing is enabled', type=int) 2471 p.set_defaults(func=vhost_controller_set_coalescing) 2472 2473 def vhost_create_scsi_controller(args): 2474 rpc.vhost.vhost_create_scsi_controller(args.client, 2475 ctrlr=args.ctrlr, 2476 cpumask=args.cpumask) 2477 2478 p = subparsers.add_parser( 2479 'vhost_create_scsi_controller', aliases=['construct_vhost_scsi_controller'], 2480 help='Add new vhost controller') 2481 p.add_argument('ctrlr', help='controller name') 2482 p.add_argument('--cpumask', help='cpu mask for this controller') 2483 p.set_defaults(func=vhost_create_scsi_controller) 2484 2485 def vhost_scsi_controller_add_target(args): 2486 print_json(rpc.vhost.vhost_scsi_controller_add_target(args.client, 2487 ctrlr=args.ctrlr, 2488 scsi_target_num=args.scsi_target_num, 2489 bdev_name=args.bdev_name)) 2490 2491 p = subparsers.add_parser('vhost_scsi_controller_add_target', 2492 aliases=['add_vhost_scsi_lun'], 2493 help='Add lun to vhost controller') 2494 p.add_argument('ctrlr', help='controller name where add lun') 2495 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 2496 p.add_argument('bdev_name', help='bdev name') 2497 p.set_defaults(func=vhost_scsi_controller_add_target) 2498 2499 def vhost_scsi_controller_remove_target(args): 2500 rpc.vhost.vhost_scsi_controller_remove_target(args.client, 2501 ctrlr=args.ctrlr, 2502 scsi_target_num=args.scsi_target_num) 2503 2504 p = subparsers.add_parser('vhost_scsi_controller_remove_target', 2505 aliases=['remove_vhost_scsi_target'], 2506 help='Remove target from vhost controller') 2507 p.add_argument('ctrlr', help='controller name to remove target from') 2508 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 2509 p.set_defaults(func=vhost_scsi_controller_remove_target) 2510 2511 def vhost_create_blk_controller(args): 2512 rpc.vhost.vhost_create_blk_controller(args.client, 2513 ctrlr=args.ctrlr, 2514 dev_name=args.dev_name, 2515 cpumask=args.cpumask, 2516 readonly=args.readonly, 2517 packed_ring=args.packed_ring, 2518 packed_ring_recovery=args.packed_ring_recovery) 2519 2520 p = subparsers.add_parser('vhost_create_blk_controller', 2521 aliases=['construct_vhost_blk_controller'], 2522 help='Add a new vhost block controller') 2523 p.add_argument('ctrlr', help='controller name') 2524 p.add_argument('dev_name', help='device name') 2525 p.add_argument('--cpumask', help='cpu mask for this controller') 2526 p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only') 2527 p.add_argument("-p", "--packed_ring", action='store_true', help='Set controller as packed ring supported') 2528 p.add_argument("-l", "--packed_ring_recovery", action='store_true', help='Enable packed ring live recovery') 2529 p.set_defaults(func=vhost_create_blk_controller) 2530 2531 def vhost_get_controllers(args): 2532 print_dict(rpc.vhost.vhost_get_controllers(args.client, args.name)) 2533 2534 p = subparsers.add_parser('vhost_get_controllers', aliases=['get_vhost_controllers'], 2535 help='List all or specific vhost controller(s)') 2536 p.add_argument('-n', '--name', help="Name of vhost controller", required=False) 2537 p.set_defaults(func=vhost_get_controllers) 2538 2539 def vhost_delete_controller(args): 2540 rpc.vhost.vhost_delete_controller(args.client, 2541 ctrlr=args.ctrlr) 2542 2543 p = subparsers.add_parser('vhost_delete_controller', aliases=['remove_vhost_controller'], 2544 help='Delete a vhost controller') 2545 p.add_argument('ctrlr', help='controller name') 2546 p.set_defaults(func=vhost_delete_controller) 2547 2548 def bdev_virtio_attach_controller(args): 2549 print_array(rpc.vhost.bdev_virtio_attach_controller(args.client, 2550 name=args.name, 2551 trtype=args.trtype, 2552 traddr=args.traddr, 2553 dev_type=args.dev_type, 2554 vq_count=args.vq_count, 2555 vq_size=args.vq_size)) 2556 2557 p = subparsers.add_parser('bdev_virtio_attach_controller', aliases=['construct_virtio_dev'], 2558 help="""Attach virtio controller using provided 2559 transport type and device type. This will also create bdevs for any block devices connected to the 2560 controller (for example, SCSI devices for a virtio-scsi controller). 2561 Result is array of added bdevs.""") 2562 p.add_argument('name', help="Use this name as base for new created bdevs") 2563 p.add_argument('-t', '--trtype', 2564 help='Virtio target transport type: pci or user', required=True) 2565 p.add_argument('-a', '--traddr', 2566 help='Transport type specific target address: e.g. UNIX domain socket path or BDF', required=True) 2567 p.add_argument('-d', '--dev-type', 2568 help='Device type: blk or scsi', required=True) 2569 p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int) 2570 p.add_argument('--vq-size', help='Size of each queue', type=int) 2571 p.set_defaults(func=bdev_virtio_attach_controller) 2572 2573 def bdev_virtio_scsi_get_devices(args): 2574 print_dict(rpc.vhost.bdev_virtio_scsi_get_devices(args.client)) 2575 2576 p = subparsers.add_parser('bdev_virtio_scsi_get_devices', aliases=['get_virtio_scsi_devs'], 2577 help='List all Virtio-SCSI devices.') 2578 p.set_defaults(func=bdev_virtio_scsi_get_devices) 2579 2580 def bdev_virtio_detach_controller(args): 2581 rpc.vhost.bdev_virtio_detach_controller(args.client, 2582 name=args.name) 2583 2584 p = subparsers.add_parser('bdev_virtio_detach_controller', aliases=['remove_virtio_bdev'], 2585 help="""Remove a Virtio device 2586 This will delete all bdevs exposed by this device""") 2587 p.add_argument('name', help='Virtio device name. E.g. VirtioUser0') 2588 p.set_defaults(func=bdev_virtio_detach_controller) 2589 2590 def bdev_virtio_blk_set_hotplug(args): 2591 rpc.vhost.bdev_virtio_blk_set_hotplug(args.client, enable=args.enable, period_us=args.period_us) 2592 2593 p = subparsers.add_parser('bdev_virtio_blk_set_hotplug', help='Set hotplug options for bdev virtio_blk type.') 2594 p.add_argument('-d', '--disable', dest='enable', default=False, action='store_false', help="Disable hotplug (default)") 2595 p.add_argument('-e', '--enable', dest='enable', action='store_true', help="Enable hotplug") 2596 p.add_argument('-r', '--period-us', 2597 help='How often the hotplug is processed for insert and remove events', type=int) 2598 p.set_defaults(func=bdev_virtio_blk_set_hotplug) 2599 2600 # ioat 2601 def ioat_scan_accel_engine(args): 2602 rpc.ioat.ioat_scan_accel_engine(args.client) 2603 2604 p = subparsers.add_parser('ioat_scan_accel_engine', 2605 aliases=['ioat_scan_copy_engine', 'scan_ioat_copy_engine'], 2606 help='Enable IOAT accel engine offload.') 2607 p.set_defaults(func=ioat_scan_accel_engine) 2608 2609 # idxd 2610 def idxd_scan_accel_engine(args): 2611 rpc.idxd.idxd_scan_accel_engine(args.client, config_kernel_mode=args.config_kernel_mode) 2612 2613 p = subparsers.add_parser('idxd_scan_accel_engine', 2614 help='Set config and enable idxd accel engine offload.') 2615 p.add_argument('-k', '--config-kernel-mode', help='Use Kernel mode idxd', 2616 action='store_true', dest='config_kernel_mode') 2617 p.set_defaults(func=idxd_scan_accel_engine, config_kernel_mode=None) 2618 2619 # opal 2620 def bdev_nvme_opal_init(args): 2621 rpc.nvme.bdev_nvme_opal_init(args.client, 2622 nvme_ctrlr_name=args.nvme_ctrlr_name, 2623 password=args.password) 2624 2625 p = subparsers.add_parser('bdev_nvme_opal_init', help='take ownership and activate') 2626 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name') 2627 p.add_argument('-p', '--password', help='password for admin') 2628 p.set_defaults(func=bdev_nvme_opal_init) 2629 2630 def bdev_nvme_opal_revert(args): 2631 rpc.nvme.bdev_nvme_opal_revert(args.client, 2632 nvme_ctrlr_name=args.nvme_ctrlr_name, 2633 password=args.password) 2634 p = subparsers.add_parser('bdev_nvme_opal_revert', help='Revert to default factory settings') 2635 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name') 2636 p.add_argument('-p', '--password', help='password') 2637 p.set_defaults(func=bdev_nvme_opal_revert) 2638 2639 def bdev_opal_create(args): 2640 print_json(rpc.bdev.bdev_opal_create(args.client, 2641 nvme_ctrlr_name=args.nvme_ctrlr_name, 2642 nsid=args.nsid, 2643 locking_range_id=args.locking_range_id, 2644 range_start=args.range_start, 2645 range_length=args.range_length, 2646 password=args.password)) 2647 2648 p = subparsers.add_parser('bdev_opal_create', help="""Create opal bdev on specified NVMe controller""") 2649 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name', required=True) 2650 p.add_argument('-n', '--nsid', help='namespace ID (only support nsid=1 for now)', type=int, required=True) 2651 p.add_argument('-i', '--locking-range-id', help='locking range id', type=int, required=True) 2652 p.add_argument('-s', '--range-start', help='locking range start LBA', type=int, required=True) 2653 p.add_argument('-l', '--range-length', help='locking range length (in blocks)', type=int, required=True) 2654 p.add_argument('-p', '--password', help='admin password', required=True) 2655 p.set_defaults(func=bdev_opal_create) 2656 2657 def bdev_opal_get_info(args): 2658 print_dict(rpc.bdev.bdev_opal_get_info(args.client, 2659 bdev_name=args.bdev_name, 2660 password=args.password)) 2661 2662 p = subparsers.add_parser('bdev_opal_get_info', help='get opal locking range info for this bdev') 2663 p.add_argument('-b', '--bdev-name', help='opal bdev') 2664 p.add_argument('-p', '--password', help='password') 2665 p.set_defaults(func=bdev_opal_get_info) 2666 2667 def bdev_opal_delete(args): 2668 rpc.bdev.bdev_opal_delete(args.client, 2669 bdev_name=args.bdev_name, 2670 password=args.password) 2671 2672 p = subparsers.add_parser('bdev_opal_delete', help="""delete a virtual opal bdev""") 2673 p.add_argument('-b', '--bdev-name', help='opal virtual bdev', required=True) 2674 p.add_argument('-p', '--password', help='admin password', required=True) 2675 p.set_defaults(func=bdev_opal_delete) 2676 2677 def bdev_opal_new_user(args): 2678 rpc.bdev.bdev_opal_new_user(args.client, 2679 bdev_name=args.bdev_name, 2680 admin_password=args.admin_password, 2681 user_id=args.user_id, 2682 user_password=args.user_password) 2683 2684 p = subparsers.add_parser('bdev_opal_new_user', help="""Add a user to opal bdev who can set lock state for this bdev""") 2685 p.add_argument('-b', '--bdev-name', help='opal bdev', required=True) 2686 p.add_argument('-p', '--admin-password', help='admin password', required=True) 2687 p.add_argument('-i', '--user-id', help='ID for new user', type=int, required=True) 2688 p.add_argument('-u', '--user-password', help='password set for this user', required=True) 2689 p.set_defaults(func=bdev_opal_new_user) 2690 2691 def bdev_opal_set_lock_state(args): 2692 rpc.bdev.bdev_opal_set_lock_state(args.client, 2693 bdev_name=args.bdev_name, 2694 user_id=args.user_id, 2695 password=args.password, 2696 lock_state=args.lock_state) 2697 2698 p = subparsers.add_parser('bdev_opal_set_lock_state', help="""set lock state for an opal bdev""") 2699 p.add_argument('-b', '--bdev-name', help='opal bdev', required=True) 2700 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', 2701 type=int, required=True) 2702 p.add_argument('-p', '--password', help='password of this user', required=True) 2703 p.add_argument('-l', '--lock-state', help='lock state to set, choose from {readwrite, readonly, rwlock}', required=True) 2704 p.set_defaults(func=bdev_opal_set_lock_state) 2705 2706 # bdev_nvme_send_cmd 2707 def bdev_nvme_send_cmd(args): 2708 print_dict(rpc.nvme.bdev_nvme_send_cmd(args.client, 2709 name=args.nvme_name, 2710 cmd_type=args.cmd_type, 2711 data_direction=args.data_direction, 2712 cmdbuf=args.cmdbuf, 2713 data=args.data, 2714 metadata=args.metadata, 2715 data_len=args.data_length, 2716 metadata_len=args.metadata_length, 2717 timeout_ms=args.timeout_ms)) 2718 2719 p = subparsers.add_parser('bdev_nvme_send_cmd', aliases=['send_nvme_cmd'], 2720 help='NVMe passthrough cmd.') 2721 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""") 2722 p.add_argument('-t', '--cmd-type', help="""Type of nvme cmd. Valid values are: admin, io""") 2723 p.add_argument('-r', '--data-direction', help="""Direction of data transfer. Valid values are: c2h, h2c""") 2724 p.add_argument('-c', '--cmdbuf', help="""NVMe command encoded by base64 urlsafe""") 2725 p.add_argument('-d', '--data', help="""Data transferring to controller from host, encoded by base64 urlsafe""") 2726 p.add_argument('-m', '--metadata', help="""Metadata transferring to controller from host, encoded by base64 urlsafe""") 2727 p.add_argument('-D', '--data-length', help="""Data length required to transfer from controller to host""", type=int) 2728 p.add_argument('-M', '--metadata-length', help="""Metadata length required to transfer from controller to host""", type=int) 2729 p.add_argument('-T', '--timeout-ms', 2730 help="""Command execution timeout value, in milliseconds, if 0, don't track timeout""", type=int, default=0) 2731 p.set_defaults(func=bdev_nvme_send_cmd) 2732 2733 # Notifications 2734 def notify_get_types(args): 2735 print_dict(rpc.notify.notify_get_types(args.client)) 2736 2737 p = subparsers.add_parser('notify_get_types', aliases=['get_notification_types'], 2738 help='List available notifications that user can subscribe to.') 2739 p.set_defaults(func=notify_get_types) 2740 2741 def notify_get_notifications(args): 2742 ret = rpc.notify.notify_get_notifications(args.client, 2743 id=args.id, 2744 max=args.max) 2745 print_dict(ret) 2746 2747 p = subparsers.add_parser('notify_get_notifications', aliases=['get_notifications'], 2748 help='Get notifications') 2749 p.add_argument('-i', '--id', help="""First ID to start fetching from""", type=int) 2750 p.add_argument('-n', '--max', help="""Maximum number of notifications to return in response""", type=int) 2751 p.set_defaults(func=notify_get_notifications) 2752 2753 def thread_get_stats(args): 2754 print_dict(rpc.app.thread_get_stats(args.client)) 2755 2756 p = subparsers.add_parser( 2757 'thread_get_stats', help='Display current statistics of all the threads') 2758 p.set_defaults(func=thread_get_stats) 2759 2760 def thread_set_cpumask(args): 2761 ret = rpc.app.thread_set_cpumask(args.client, 2762 id=args.id, 2763 cpumask=args.cpumask) 2764 p = subparsers.add_parser('thread_set_cpumask', 2765 help="""set the cpumask of the thread whose ID matches to the 2766 specified value. The thread may be migrated to one of the specified CPUs.""") 2767 p.add_argument('-i', '--id', type=int, help='thread ID') 2768 p.add_argument('-m', '--cpumask', help='cpumask for this thread') 2769 p.set_defaults(func=thread_set_cpumask) 2770 2771 def log_enable_timestamps(args): 2772 ret = rpc.app.log_enable_timestamps(args.client, 2773 enabled=args.enabled) 2774 p = subparsers.add_parser('log_enable_timestamps', 2775 help='Enable or disable timestamps.') 2776 p.add_argument('-d', '--disable', dest='enabled', default=False, action='store_false', help="Disable timestamps") 2777 p.add_argument('-e', '--enable', dest='enabled', action='store_true', help="Enable timestamps") 2778 p.set_defaults(func=log_enable_timestamps) 2779 2780 def thread_get_pollers(args): 2781 print_dict(rpc.app.thread_get_pollers(args.client)) 2782 2783 p = subparsers.add_parser( 2784 'thread_get_pollers', help='Display current pollers of all the threads') 2785 p.set_defaults(func=thread_get_pollers) 2786 2787 def thread_get_io_channels(args): 2788 print_dict(rpc.app.thread_get_io_channels(args.client)) 2789 2790 p = subparsers.add_parser( 2791 'thread_get_io_channels', help='Display current IO channels of all the threads') 2792 p.set_defaults(func=thread_get_io_channels) 2793 2794 def env_dpdk_get_mem_stats(args): 2795 print_dict(rpc.env_dpdk.env_dpdk_get_mem_stats(args.client)) 2796 2797 p = subparsers.add_parser( 2798 'env_dpdk_get_mem_stats', help='write the dpdk memory stats to a file.') 2799 p.set_defaults(func=env_dpdk_get_mem_stats) 2800 2801 # blobfs 2802 def blobfs_detect(args): 2803 print(rpc.blobfs.blobfs_detect(args.client, 2804 bdev_name=args.bdev_name)) 2805 2806 p = subparsers.add_parser('blobfs_detect', help='Detect whether a blobfs exists on bdev') 2807 p.add_argument('bdev_name', help='Blockdev name to detect blobfs. Example: Malloc0.') 2808 p.set_defaults(func=blobfs_detect) 2809 2810 def blobfs_create(args): 2811 print(rpc.blobfs.blobfs_create(args.client, 2812 bdev_name=args.bdev_name, 2813 cluster_sz=args.cluster_sz)) 2814 2815 p = subparsers.add_parser('blobfs_create', help='Build a blobfs on bdev') 2816 p.add_argument('bdev_name', help='Blockdev name to build blobfs. Example: Malloc0.') 2817 p.add_argument('-c', '--cluster-sz', 2818 help="""Size of cluster in bytes (Optional). Must be multiple of 4KB page size. Default and minimal value is 1M.""") 2819 p.set_defaults(func=blobfs_create) 2820 2821 def blobfs_mount(args): 2822 print(rpc.blobfs.blobfs_mount(args.client, 2823 bdev_name=args.bdev_name, 2824 mountpoint=args.mountpoint)) 2825 2826 p = subparsers.add_parser('blobfs_mount', help='Mount a blobfs on bdev to host path by FUSE') 2827 p.add_argument('bdev_name', help='Blockdev name where the blobfs is. Example: Malloc0.') 2828 p.add_argument('mountpoint', help='Mountpoint path in host to mount blobfs. Example: /mnt/.') 2829 p.set_defaults(func=blobfs_mount) 2830 2831 def blobfs_set_cache_size(args): 2832 print(rpc.blobfs.blobfs_set_cache_size(args.client, 2833 size_in_mb=args.size_in_mb)) 2834 2835 p = subparsers.add_parser('blobfs_set_cache_size', help='Set cache size for blobfs') 2836 p.add_argument('size_in_mb', help='Cache size for blobfs in megabytes.', type=int) 2837 p.set_defaults(func=blobfs_set_cache_size) 2838 2839 # sock 2840 def sock_impl_get_options(args): 2841 print_json(rpc.sock.sock_impl_get_options(args.client, 2842 impl_name=args.impl)) 2843 2844 p = subparsers.add_parser('sock_impl_get_options', help="""Get options of socket layer implementation""") 2845 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 2846 p.set_defaults(func=sock_impl_get_options) 2847 2848 def sock_impl_set_options(args): 2849 rpc.sock.sock_impl_set_options(args.client, 2850 impl_name=args.impl, 2851 recv_buf_size=args.recv_buf_size, 2852 send_buf_size=args.send_buf_size, 2853 enable_recv_pipe=args.enable_recv_pipe, 2854 enable_quickack=args.enable_quickack, 2855 enable_placement_id=args.enable_placement_id, 2856 enable_zerocopy_send_server=args.enable_zerocopy_send_server, 2857 enable_zerocopy_send_client=args.enable_zerocopy_send_client, 2858 zerocopy_threshold=args.zerocopy_threshold) 2859 2860 p = subparsers.add_parser('sock_impl_set_options', help="""Set options of socket layer implementation""") 2861 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 2862 p.add_argument('-r', '--recv-buf-size', help='Size of receive buffer on socket in bytes', type=int) 2863 p.add_argument('-s', '--send-buf-size', help='Size of send buffer on socket in bytes', type=int) 2864 p.add_argument('-p', '--enable-placement-id', help='Option for placement-id. 0:disable,1:incoming_napi,2:incoming_cpu', type=int) 2865 p.add_argument('--enable-recv-pipe', help='Enable receive pipe', 2866 action='store_true', dest='enable_recv_pipe') 2867 p.add_argument('--disable-recv-pipe', help='Disable receive pipe', 2868 action='store_false', dest='enable_recv_pipe') 2869 p.add_argument('--enable-quickack', help='Enable quick ACK', 2870 action='store_true', dest='enable_quickack') 2871 p.add_argument('--disable-quickack', help='Disable quick ACK', 2872 action='store_false', dest='enable_quickack') 2873 p.add_argument('--enable-zerocopy-send-server', help='Enable zerocopy on send for server sockets', 2874 action='store_true', dest='enable_zerocopy_send_server') 2875 p.add_argument('--disable-zerocopy-send-server', help='Disable zerocopy on send for server sockets', 2876 action='store_false', dest='enable_zerocopy_send_server') 2877 p.add_argument('--enable-zerocopy-send-client', help='Enable zerocopy on send for client sockets', 2878 action='store_true', dest='enable_zerocopy_send_client') 2879 p.add_argument('--disable-zerocopy-send-client', help='Disable zerocopy on send for client sockets', 2880 action='store_false', dest='enable_zerocopy_send_client') 2881 p.add_argument('--zerocopy-threshold', help='Set zerocopy_threshold in bytes', 2882 action='store_true', dest='zerocopy_threshold') 2883 p.set_defaults(func=sock_impl_set_options, enable_recv_pipe=None, enable_quickack=None, 2884 enable_placement_id=None, enable_zerocopy_send_server=None, enable_zerocopy_send_client=None, 2885 zerocopy_threshold=None) 2886 2887 def sock_set_default_impl(args): 2888 print_json(rpc.sock.sock_set_default_impl(args.client, 2889 impl_name=args.impl)) 2890 2891 p = subparsers.add_parser('sock_set_default_impl', help="""Set the default sock implementation""") 2892 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 2893 p.set_defaults(func=sock_set_default_impl) 2894 2895 def framework_get_pci_devices(args): 2896 def splitbuf(buf, step): 2897 return [buf[i:i+step] for i in range(0, len(buf), step)] 2898 2899 devices = rpc.subsystem.framework_get_pci_devices(args.client) 2900 if not args.format_lspci: 2901 print_json(devices) 2902 else: 2903 for devid, dev in enumerate(devices): 2904 print('{} device #{}'.format(dev['address'], devid)) 2905 for lineid, line in enumerate(splitbuf(dev['config_space'], 32)): 2906 print('{:02x}: {}'.format(lineid * 16, ' '.join(splitbuf(line.lower(), 2)))) 2907 print() 2908 2909 p = subparsers.add_parser('framework_get_pci_devices', help='''Get a list of attached PCI devices''') 2910 p.add_argument('--format-lspci', help='Format the output in a way to be consumed by lspci -F', 2911 action='store_true') 2912 p.set_defaults(func=framework_get_pci_devices) 2913 2914 # bdev_nvme_add_error_injection 2915 def bdev_nvme_add_error_injection(args): 2916 print_dict(rpc.nvme.bdev_nvme_add_error_injection(args.client, 2917 name=args.nvme_name, 2918 cmd_type=args.cmd_type, 2919 opc=args.opc, 2920 do_not_submit=args.do_not_submit, 2921 timeout_in_us=args.timeout_in_us, 2922 err_count=args.err_count, 2923 sct=args.sct, 2924 sc=args.sc)) 2925 p = subparsers.add_parser('bdev_nvme_add_error_injection', 2926 help='Add a NVMe command error injection.') 2927 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""", required=True) 2928 p.add_argument('-t', '--cmd-type', help="""Type of NVMe command. Valid values are: admin, io""", required=True) 2929 p.add_argument('-o', '--opc', help="""Opcode of the NVMe command.""", required=True, type=int) 2930 p.add_argument('-s', '--do-not-submit', 2931 help="""Set to true if request should not be submitted to the controller (default false)""", 2932 default=False, dest="do_not_submit", action='store_true') 2933 p.add_argument('-w', '--timeout-in-us', help="""Wait specified microseconds when do_not_submit is true""", type=int) 2934 p.add_argument('-e', '--err-count', help="""Number of matching NVMe commands to inject errors (default 1)""", type=int, default=1) 2935 p.add_argument('-u', '--sct', help="""Status code type""", type=int) 2936 p.add_argument('-c', '--sc', help="""Status code""", type=int) 2937 p.set_defaults(func=bdev_nvme_add_error_injection) 2938 2939 # bdev_nvme_remove_error_injection 2940 def bdev_nvme_remove_error_injection(args): 2941 print_dict(rpc.nvme.bdev_nvme_remove_error_injection(args.client, 2942 name=args.nvme_name, 2943 cmd_type=args.cmd_type, 2944 opc=args.opc)) 2945 p = subparsers.add_parser('bdev_nvme_remove_error_injection', 2946 help='Removes a NVMe command error injection.') 2947 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""", required=True) 2948 p.add_argument('-t', '--cmd-type', help="""Type of nvme cmd. Valid values are: admin, io""", required=True) 2949 p.add_argument('-o', '--opc', help="""Opcode of the nvme cmd.""", required=True, type=int) 2950 p.set_defaults(func=bdev_nvme_remove_error_injection) 2951 2952 def check_called_name(name): 2953 if name in deprecated_aliases: 2954 print("{} is deprecated, use {} instead.".format(name, deprecated_aliases[name]), file=sys.stderr) 2955 2956 class dry_run_client: 2957 def call(self, method, params=None): 2958 print("Request:\n" + json.dumps({"method": method, "params": params}, indent=2)) 2959 2960 def null_print(arg): 2961 pass 2962 2963 def call_rpc_func(args): 2964 args.func(args) 2965 check_called_name(args.called_rpc_name) 2966 2967 def execute_script(parser, client, fd): 2968 executed_rpc = "" 2969 for rpc_call in map(str.rstrip, fd): 2970 if not rpc_call.strip(): 2971 continue 2972 executed_rpc = "\n".join([executed_rpc, rpc_call]) 2973 rpc_args = shlex.split(rpc_call) 2974 if rpc_args[0][0] == '#': 2975 # Ignore lines starting with # - treat them as comments 2976 continue 2977 args = parser.parse_args(rpc_args) 2978 args.client = client 2979 try: 2980 call_rpc_func(args) 2981 except JSONRPCException as ex: 2982 print("Exception:") 2983 print(executed_rpc.strip() + " <<<") 2984 print(ex.message) 2985 exit(1) 2986 2987 def load_plugin(args): 2988 # Create temporary parser, pull out the plugin parameter, load the module, and then run the real argument parser 2989 plugin_parser = argparse.ArgumentParser(add_help=False) 2990 plugin_parser.add_argument('--plugin', dest='rpc_plugin', help='Module name of plugin with additional RPC commands') 2991 2992 rpc_module = plugin_parser.parse_known_args()[0].rpc_plugin 2993 if args is not None: 2994 rpc_module = plugin_parser.parse_known_args(args)[0].rpc_plugin 2995 2996 if rpc_module is not None: 2997 try: 2998 rpc_plugin = importlib.import_module(rpc_module) 2999 try: 3000 rpc_plugin.spdk_rpc_plugin_initialize(subparsers) 3001 except AttributeError: 3002 print("Module %s does not contain 'spdk_rpc_plugin_initialize' function" % rpc_module) 3003 except ModuleNotFoundError: 3004 print("Module %s not found" % rpc_module) 3005 3006 def replace_arg_underscores(args): 3007 # All option names are defined with dashes only - for example: --tgt-name 3008 # But if user used underscores, convert them to dashes (--tgt_name => --tgt-name) 3009 # SPDK was inconsistent previously and had some options with underscores, so 3010 # doing this conversion ensures backward compatibility with older scripts. 3011 for i in range(len(args)): 3012 arg = args[i] 3013 if arg.startswith('--') and "_" in arg: 3014 args[i] = arg.replace('_', '-') 3015 3016 load_plugin(None) 3017 3018 replace_arg_underscores(sys.argv) 3019 3020 args = parser.parse_args() 3021 3022 if sys.stdin.isatty() and not hasattr(args, 'func'): 3023 # No arguments and no data piped through stdin 3024 parser.print_help() 3025 exit(1) 3026 if args.is_server: 3027 for input in sys.stdin: 3028 cmd = shlex.split(input) 3029 replace_arg_underscores(cmd) 3030 try: 3031 load_plugin(cmd) 3032 tmp_args = parser.parse_args(cmd) 3033 except SystemExit as ex: 3034 print("**STATUS=1", flush=True) 3035 continue 3036 3037 try: 3038 tmp_args.client = rpc.client.JSONRPCClient( 3039 tmp_args.server_addr, tmp_args.port, tmp_args.timeout, 3040 log_level=getattr(logging, tmp_args.verbose.upper()), conn_retries=tmp_args.conn_retries) 3041 call_rpc_func(tmp_args) 3042 print("**STATUS=0", flush=True) 3043 except JSONRPCException as ex: 3044 print(ex.message) 3045 print("**STATUS=1", flush=True) 3046 exit(0) 3047 elif args.dry_run: 3048 args.client = dry_run_client() 3049 print_dict = null_print 3050 print_json = null_print 3051 print_array = null_print 3052 else: 3053 try: 3054 args.client = rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, 3055 log_level=getattr(logging, args.verbose.upper()), 3056 conn_retries=args.conn_retries) 3057 except JSONRPCException as ex: 3058 print(ex.message) 3059 exit(1) 3060 3061 if hasattr(args, 'func'): 3062 try: 3063 call_rpc_func(args) 3064 except JSONRPCException as ex: 3065 print(ex.message) 3066 exit(1) 3067 else: 3068 execute_script(parser, args.client, sys.stdin) 3069