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