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