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