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