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