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