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