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