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