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