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