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