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