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