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