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