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