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