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