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