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