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_zone_block_create(args): 1020 print_json(rpc.bdev.bdev_zone_block_create(args.client, 1021 name=args.name, 1022 base_bdev=args.base_bdev, 1023 zone_capacity=args.zone_capacity, 1024 optimal_open_zones=args.optimal_open_zones)) 1025 1026 p = subparsers.add_parser('bdev_zone_block_create', 1027 help='Create virtual zone namespace device with block device backend') 1028 p.add_argument('-b', '--name', help="Name of the zone device", required=True) 1029 p.add_argument('-n', '--base-bdev', help='Name of underlying, non-zoned bdev', required=True) 1030 p.add_argument('-z', '--zone-capacity', help='Surfaced zone capacity in blocks', type=int, required=True) 1031 p.add_argument('-o', '--optimal-open-zones', help='Number of zones required to reach optimal write speed', type=int, required=True) 1032 p.set_defaults(func=bdev_zone_block_create) 1033 1034 def bdev_zone_block_delete(args): 1035 rpc.bdev.bdev_zone_block_delete(args.client, 1036 name=args.name) 1037 1038 p = subparsers.add_parser('bdev_zone_block_delete', help='Delete a virtual zone namespace device') 1039 p.add_argument('name', help='Virtual zone bdev name') 1040 p.set_defaults(func=bdev_zone_block_delete) 1041 1042 def bdev_rbd_register_cluster(args): 1043 config_param = None 1044 if args.config_param: 1045 config_param = {} 1046 for entry in args.config_param: 1047 parts = entry.split('=', 1) 1048 if len(parts) != 2: 1049 raise Exception('--config %s not in key=value form' % entry) 1050 config_param[parts[0]] = parts[1] 1051 print_json(rpc.bdev.bdev_rbd_register_cluster(args.client, 1052 name=args.name, 1053 user_id=args.user, 1054 config_param=config_param, 1055 config_file=args.config_file, 1056 key_file=args.key_file, 1057 core_mask=args.core_mask)) 1058 1059 p = subparsers.add_parser('bdev_rbd_register_cluster', 1060 help='Add a Rados cluster with ceph rbd backend') 1061 p.add_argument('name', help="Name of the Rados cluster only known to rbd bdev") 1062 p.add_argument('--user', help="Ceph user name (i.e. admin, not client.admin)") 1063 p.add_argument('--config-param', action='append', metavar='key=value', 1064 help="adds a key=value configuration option for rados_conf_set (default: rely on config file)") 1065 p.add_argument('--config-file', help="The file path of the Rados configuration file") 1066 p.add_argument('--key-file', help="The file path of the Rados keyring file") 1067 p.add_argument('--core-mask', help="Set core mask for librbd IO context threads") 1068 p.set_defaults(func=bdev_rbd_register_cluster) 1069 1070 def bdev_rbd_unregister_cluster(args): 1071 rpc.bdev.bdev_rbd_unregister_cluster(args.client, name=args.name) 1072 1073 p = subparsers.add_parser('bdev_rbd_unregister_cluster', 1074 help='Unregister a Rados cluster object') 1075 p.add_argument('name', help='Name of the Rados Cluster only known to rbd bdev') 1076 p.set_defaults(func=bdev_rbd_unregister_cluster) 1077 1078 def bdev_rbd_get_clusters_info(args): 1079 print_json(rpc.bdev.bdev_rbd_get_clusters_info(args.client, name=args.name)) 1080 1081 p = subparsers.add_parser('bdev_rbd_get_clusters_info', 1082 help='Display registered Rados Cluster names and related info') 1083 p.add_argument('-b', '--name', help="Name of the registered Rados Cluster Name. Example: Cluster1") 1084 p.set_defaults(func=bdev_rbd_get_clusters_info) 1085 1086 def bdev_rbd_create(args): 1087 config = None 1088 if args.config: 1089 config = {} 1090 for entry in args.config: 1091 parts = entry.split('=', 1) 1092 if len(parts) != 2: 1093 raise Exception('--config %s not in key=value form' % entry) 1094 config[parts[0]] = parts[1] 1095 print_json(rpc.bdev.bdev_rbd_create(args.client, 1096 name=args.name, 1097 user_id=args.user, 1098 config=config, 1099 pool_name=args.pool_name, 1100 rbd_name=args.rbd_name, 1101 block_size=args.block_size, 1102 cluster_name=args.cluster_name, 1103 uuid=args.uuid)) 1104 1105 p = subparsers.add_parser('bdev_rbd_create', help='Add a bdev with ceph rbd backend') 1106 p.add_argument('-b', '--name', help="Name of the bdev") 1107 p.add_argument('--user', help="Ceph user name (i.e. admin, not client.admin)") 1108 p.add_argument('--config', action='append', metavar='key=value', 1109 help="adds a key=value configuration option for rados_conf_set (default: rely on config file)") 1110 p.add_argument('pool_name', help='rbd pool name') 1111 p.add_argument('rbd_name', help='rbd image name') 1112 p.add_argument('block_size', help='rbd block size', type=int) 1113 p.add_argument('-c', '--cluster-name', help="cluster name to identify the Rados cluster") 1114 p.add_argument('-u', '--uuid', help="UUID of the bdev") 1115 p.set_defaults(func=bdev_rbd_create) 1116 1117 def bdev_rbd_delete(args): 1118 rpc.bdev.bdev_rbd_delete(args.client, 1119 name=args.name) 1120 1121 p = subparsers.add_parser('bdev_rbd_delete', help='Delete a rbd bdev') 1122 p.add_argument('name', help='rbd bdev name') 1123 p.set_defaults(func=bdev_rbd_delete) 1124 1125 def bdev_rbd_resize(args): 1126 print_json(rpc.bdev.bdev_rbd_resize(args.client, 1127 name=args.name, 1128 new_size=int(args.new_size))) 1129 1130 p = subparsers.add_parser('bdev_rbd_resize', 1131 help='Resize a rbd bdev') 1132 p.add_argument('name', help='rbd bdev name') 1133 p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB') 1134 p.set_defaults(func=bdev_rbd_resize) 1135 1136 def bdev_delay_create(args): 1137 print_json(rpc.bdev.bdev_delay_create(args.client, 1138 base_bdev_name=args.base_bdev_name, 1139 name=args.name, 1140 uuid=args.uuid, 1141 avg_read_latency=args.avg_read_latency, 1142 p99_read_latency=args.nine_nine_read_latency, 1143 avg_write_latency=args.avg_write_latency, 1144 p99_write_latency=args.nine_nine_write_latency)) 1145 1146 p = subparsers.add_parser('bdev_delay_create', 1147 help='Add a delay bdev on existing bdev') 1148 p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True) 1149 p.add_argument('-d', '--name', help="Name of the delay bdev", required=True) 1150 p.add_argument('-u', '--uuid', help='UUID of the bdev (optional)') 1151 p.add_argument('-r', '--avg-read-latency', 1152 help="Average latency to apply before completing read ops (in microseconds)", required=True, type=int) 1153 p.add_argument('-t', '--nine-nine-read-latency', 1154 help="latency to apply to 1 in 100 read ops (in microseconds)", required=True, type=int) 1155 p.add_argument('-w', '--avg-write-latency', 1156 help="Average latency to apply before completing write ops (in microseconds)", required=True, type=int) 1157 p.add_argument('-n', '--nine-nine-write-latency', 1158 help="latency to apply to 1 in 100 write ops (in microseconds)", required=True, type=int) 1159 p.set_defaults(func=bdev_delay_create) 1160 1161 def bdev_delay_delete(args): 1162 rpc.bdev.bdev_delay_delete(args.client, 1163 name=args.name) 1164 1165 p = subparsers.add_parser('bdev_delay_delete', help='Delete a delay bdev') 1166 p.add_argument('name', help='delay bdev name') 1167 p.set_defaults(func=bdev_delay_delete) 1168 1169 def bdev_delay_update_latency(args): 1170 print_json(rpc.bdev.bdev_delay_update_latency(args.client, 1171 delay_bdev_name=args.delay_bdev_name, 1172 latency_type=args.latency_type, 1173 latency_us=args.latency_us)) 1174 p = subparsers.add_parser('bdev_delay_update_latency', 1175 help='Update one of the latency values for a given delay bdev') 1176 p.add_argument('delay_bdev_name', help='The name of the given delay bdev') 1177 p.add_argument('latency_type', help='one of: avg_read, avg_write, p99_read, p99_write. No other values accepted.') 1178 p.add_argument('latency_us', help='new latency value in microseconds.', type=int) 1179 p.set_defaults(func=bdev_delay_update_latency) 1180 1181 def bdev_error_create(args): 1182 print_json(rpc.bdev.bdev_error_create(args.client, 1183 base_name=args.base_name, 1184 uuid=args.uuid)) 1185 1186 p = subparsers.add_parser('bdev_error_create', help='Add bdev with error injection backend') 1187 p.add_argument('base_name', help='base bdev name') 1188 p.add_argument('--uuid', help='UUID for this bdev') 1189 p.set_defaults(func=bdev_error_create) 1190 1191 def bdev_error_delete(args): 1192 rpc.bdev.bdev_error_delete(args.client, 1193 name=args.name) 1194 1195 p = subparsers.add_parser('bdev_error_delete', help='Delete an error bdev') 1196 p.add_argument('name', help='error bdev name') 1197 p.set_defaults(func=bdev_error_delete) 1198 1199 def bdev_iscsi_set_options(args): 1200 rpc.bdev.bdev_iscsi_set_options(args.client, 1201 timeout_sec=args.timeout_sec) 1202 1203 p = subparsers.add_parser('bdev_iscsi_set_options', help='Set options for the bdev iscsi type.') 1204 p.add_argument('-t', '--timeout-sec', help="Timeout for command, in seconds, if 0, don't track timeout.", type=int) 1205 p.set_defaults(func=bdev_iscsi_set_options) 1206 1207 def bdev_iscsi_create(args): 1208 print_json(rpc.bdev.bdev_iscsi_create(args.client, 1209 name=args.name, 1210 url=args.url, 1211 initiator_iqn=args.initiator_iqn)) 1212 1213 p = subparsers.add_parser('bdev_iscsi_create', 1214 help='Add bdev with iSCSI initiator backend') 1215 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 1216 p.add_argument('-i', '--initiator-iqn', help="Initiator IQN", required=True) 1217 p.add_argument('--url', help="iSCSI Lun URL", required=True) 1218 p.set_defaults(func=bdev_iscsi_create) 1219 1220 def bdev_iscsi_delete(args): 1221 rpc.bdev.bdev_iscsi_delete(args.client, 1222 name=args.name) 1223 1224 p = subparsers.add_parser('bdev_iscsi_delete', help='Delete an iSCSI bdev') 1225 p.add_argument('name', help='iSCSI bdev name') 1226 p.set_defaults(func=bdev_iscsi_delete) 1227 1228 def bdev_passthru_create(args): 1229 print_json(rpc.bdev.bdev_passthru_create(args.client, 1230 base_bdev_name=args.base_bdev_name, 1231 name=args.name, 1232 uuid=args.uuid)) 1233 1234 p = subparsers.add_parser('bdev_passthru_create', help='Add a pass through bdev on existing bdev') 1235 p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True) 1236 p.add_argument('-p', '--name', help="Name of the pass through bdev", required=True) 1237 p.add_argument('-u', '--uuid', help="UUID of the bdev") 1238 p.set_defaults(func=bdev_passthru_create) 1239 1240 def bdev_passthru_delete(args): 1241 rpc.bdev.bdev_passthru_delete(args.client, 1242 name=args.name) 1243 1244 p = subparsers.add_parser('bdev_passthru_delete', help='Delete a pass through bdev') 1245 p.add_argument('name', help='pass through bdev name') 1246 p.set_defaults(func=bdev_passthru_delete) 1247 1248 def bdev_get_bdevs(args): 1249 print_dict(rpc.bdev.bdev_get_bdevs(args.client, 1250 name=args.name, timeout=args.timeout_ms)) 1251 1252 p = subparsers.add_parser('bdev_get_bdevs', 1253 help='Display current blockdev list or required blockdev') 1254 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1") 1255 p.add_argument('-t', '--timeout-ms', help="""Time in ms to wait for the bdev to appear (only used 1256 with the -b|--name option). The default timeout is 0, meaning the RPC returns immediately 1257 whether the bdev exists or not.""", 1258 type=int) 1259 p.set_defaults(func=bdev_get_bdevs) 1260 1261 def bdev_get_iostat(args): 1262 print_dict(rpc.bdev.bdev_get_iostat(args.client, 1263 name=args.name, 1264 per_channel=args.per_channel)) 1265 1266 p = subparsers.add_parser('bdev_get_iostat', 1267 help='Display current I/O statistics of all the blockdevs or specified blockdev.') 1268 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1") 1269 p.add_argument('-c', '--per-channel', default=False, dest='per_channel', help='Display per channel IO stats for specified device', 1270 action='store_true') 1271 p.set_defaults(func=bdev_get_iostat) 1272 1273 def bdev_reset_iostat(args): 1274 rpc.bdev.bdev_reset_iostat(args.client, name=args.name, mode=args.mode) 1275 1276 p = subparsers.add_parser('bdev_reset_iostat', 1277 help='Reset I/O statistics of all the blockdevs or specified blockdev.') 1278 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1") 1279 p.add_argument('-m', '--mode', help="Mode to reset I/O statistics", choices=['all', 'maxmin']) 1280 p.set_defaults(func=bdev_reset_iostat) 1281 1282 def bdev_enable_histogram(args): 1283 rpc.bdev.bdev_enable_histogram(args.client, name=args.name, enable=args.enable, opc=args.opc) 1284 1285 p = subparsers.add_parser('bdev_enable_histogram', 1286 help='Enable or disable histogram for specified bdev') 1287 p.add_argument('-e', '--enable', default=True, dest='enable', action='store_true', help='Enable histograms on specified device') 1288 p.add_argument('-d', '--disable', dest='enable', action='store_false', help='Disable histograms on specified device') 1289 p.add_argument('-o', '--opc', help='Enable histogram for specified io type. Defaults to all io types if not specified.' 1290 ' Refer to bdev_get_bdevs RPC for the list of io types.') 1291 p.add_argument('name', help='bdev name') 1292 p.set_defaults(func=bdev_enable_histogram) 1293 1294 def bdev_get_histogram(args): 1295 print_dict(rpc.bdev.bdev_get_histogram(args.client, name=args.name)) 1296 1297 p = subparsers.add_parser('bdev_get_histogram', 1298 help='Get histogram for specified bdev') 1299 p.add_argument('name', help='bdev name') 1300 p.set_defaults(func=bdev_get_histogram) 1301 1302 def bdev_set_qd_sampling_period(args): 1303 rpc.bdev.bdev_set_qd_sampling_period(args.client, 1304 name=args.name, 1305 period=args.period) 1306 1307 p = subparsers.add_parser('bdev_set_qd_sampling_period', 1308 help="Enable or disable tracking of a bdev's queue depth.") 1309 p.add_argument('name', help='Blockdev name. Example: Malloc0') 1310 p.add_argument('period', help='Period with which to poll the block device queue depth in microseconds.' 1311 ' If set to 0, polling will be disabled.', 1312 type=int) 1313 p.set_defaults(func=bdev_set_qd_sampling_period) 1314 1315 def bdev_set_qos_limit(args): 1316 rpc.bdev.bdev_set_qos_limit(args.client, 1317 name=args.name, 1318 rw_ios_per_sec=args.rw_ios_per_sec, 1319 rw_mbytes_per_sec=args.rw_mbytes_per_sec, 1320 r_mbytes_per_sec=args.r_mbytes_per_sec, 1321 w_mbytes_per_sec=args.w_mbytes_per_sec) 1322 1323 p = subparsers.add_parser('bdev_set_qos_limit', 1324 help='Set QoS rate limit on a blockdev') 1325 p.add_argument('name', help='Blockdev name to set QoS. Example: Malloc0') 1326 p.add_argument('--rw-ios-per-sec', 1327 help='R/W IOs per second limit (>=1000, example: 20000). 0 means unlimited.', 1328 type=int) 1329 p.add_argument('--rw-mbytes-per-sec', 1330 help="R/W megabytes per second limit (>=1, example: 100). 0 means unlimited.", 1331 type=int) 1332 p.add_argument('--r-mbytes-per-sec', 1333 help="Read megabytes per second limit (>=1, example: 100). 0 means unlimited.", 1334 type=int) 1335 p.add_argument('--w-mbytes-per-sec', 1336 help="Write megabytes per second limit (>=1, example: 100). 0 means unlimited.", 1337 type=int) 1338 p.set_defaults(func=bdev_set_qos_limit) 1339 1340 def bdev_error_inject_error(args): 1341 rpc.bdev.bdev_error_inject_error(args.client, 1342 name=args.name, 1343 io_type=args.io_type, 1344 error_type=args.error_type, 1345 num=args.num, 1346 queue_depth=args.queue_depth, 1347 corrupt_offset=args.corrupt_offset, 1348 corrupt_value=args.corrupt_value) 1349 1350 p = subparsers.add_parser('bdev_error_inject_error', help='bdev inject error') 1351 p.add_argument('name', help="""the name of the error injection bdev""") 1352 p.add_argument('io_type', help="""io_type: 'clear' 'read' 'write' 'unmap' 'flush' 'all'""") 1353 p.add_argument('error_type', help="""error_type: 'failure' 'pending' 'corrupt_data' 'nomem'""") 1354 p.add_argument( 1355 '-n', '--num', help='the number of commands you want to fail', type=int) 1356 p.add_argument( 1357 '-q', '--queue-depth', help='the queue depth at which to trigger the error', type=int) 1358 p.add_argument( 1359 '-o', '--corrupt-offset', help='the offset in bytes to xor with corrupt_value', type=int) 1360 p.add_argument( 1361 '-v', '--corrupt-value', help='the value for xor (1-255, 0 is invalid)', type=int) 1362 p.set_defaults(func=bdev_error_inject_error) 1363 1364 def bdev_nvme_apply_firmware(args): 1365 print_dict(rpc.bdev.bdev_nvme_apply_firmware(args.client, 1366 bdev_name=args.bdev_name, 1367 filename=args.filename)) 1368 1369 p = subparsers.add_parser('bdev_nvme_apply_firmware', help='Download and commit firmware to NVMe device') 1370 p.add_argument('filename', help='filename of the firmware to download') 1371 p.add_argument('bdev_name', help='name of the NVMe device') 1372 p.set_defaults(func=bdev_nvme_apply_firmware) 1373 1374 def bdev_nvme_get_transport_statistics(args): 1375 print_dict(rpc.bdev.bdev_nvme_get_transport_statistics(args.client)) 1376 1377 p = subparsers.add_parser('bdev_nvme_get_transport_statistics', 1378 help='Get bdev_nvme poll group transport statistics') 1379 p.set_defaults(func=bdev_nvme_get_transport_statistics) 1380 1381 def bdev_nvme_get_controller_health_info(args): 1382 print_dict(rpc.bdev.bdev_nvme_get_controller_health_info(args.client, 1383 name=args.name)) 1384 1385 p = subparsers.add_parser('bdev_nvme_get_controller_health_info', 1386 help='Display health log of the required NVMe bdev controller.') 1387 p.add_argument('-c', '--name', help="Name of the NVMe bdev controller. Example: Nvme0", required=True) 1388 p.set_defaults(func=bdev_nvme_get_controller_health_info) 1389 1390 # iSCSI 1391 def iscsi_set_options(args): 1392 rpc.iscsi.iscsi_set_options( 1393 args.client, 1394 auth_file=args.auth_file, 1395 node_base=args.node_base, 1396 nop_timeout=args.nop_timeout, 1397 nop_in_interval=args.nop_in_interval, 1398 disable_chap=args.disable_chap, 1399 require_chap=args.require_chap, 1400 mutual_chap=args.mutual_chap, 1401 chap_group=args.chap_group, 1402 max_sessions=args.max_sessions, 1403 max_queue_depth=args.max_queue_depth, 1404 max_connections_per_session=args.max_connections_per_session, 1405 default_time2wait=args.default_time2wait, 1406 default_time2retain=args.default_time2retain, 1407 first_burst_length=args.first_burst_length, 1408 immediate_data=args.immediate_data, 1409 error_recovery_level=args.error_recovery_level, 1410 allow_duplicated_isid=args.allow_duplicated_isid, 1411 max_large_datain_per_connection=args.max_large_datain_per_connection, 1412 max_r2t_per_connection=args.max_r2t_per_connection, 1413 pdu_pool_size=args.pdu_pool_size, 1414 immediate_data_pool_size=args.immediate_data_pool_size, 1415 data_out_pool_size=args.data_out_pool_size) 1416 1417 p = subparsers.add_parser('iscsi_set_options', 1418 help="""Set options of iSCSI subsystem""") 1419 p.add_argument('-f', '--auth-file', help='Path to CHAP shared secret file') 1420 p.add_argument('-b', '--node-base', help='Prefix of the name of iSCSI target node') 1421 p.add_argument('-o', '--nop-timeout', help='Timeout in seconds to nop-in request to the initiator', type=int) 1422 p.add_argument('-n', '--nop-in-interval', help='Time interval in secs between nop-in requests by the target', type=int) 1423 p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled. 1424 *** Mutually exclusive with --require-chap""", action='store_true') 1425 p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required. 1426 *** Mutually exclusive with --disable-chap""", action='store_true') 1427 p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true') 1428 p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session. 1429 *** Authentication group must be precreated ***""", type=int) 1430 p.add_argument('-a', '--max-sessions', help='Maximum number of sessions in the host.', type=int) 1431 p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/Os per queue.', type=int) 1432 p.add_argument('-c', '--max-connections-per-session', help='Negotiated parameter, MaxConnections.', type=int) 1433 p.add_argument('-w', '--default-time2wait', help='Negotiated parameter, DefaultTime2Wait.', type=int) 1434 p.add_argument('-v', '--default-time2retain', help='Negotiated parameter, DefaultTime2Retain.', type=int) 1435 p.add_argument('-s', '--first-burst-length', help='Negotiated parameter, FirstBurstLength.', type=int) 1436 p.add_argument('-i', '--immediate-data', help='Negotiated parameter, ImmediateData.', action='store_true') 1437 p.add_argument('-l', '--error-recovery-level', help='Negotiated parameter, ErrorRecoveryLevel', type=int) 1438 p.add_argument('-p', '--allow-duplicated-isid', help='Allow duplicated initiator session ID.', action='store_true') 1439 p.add_argument('-x', '--max-large-datain-per-connection', help='Max number of outstanding split read I/Os per connection', type=int) 1440 p.add_argument('-k', '--max-r2t-per-connection', help='Max number of outstanding R2Ts per connection', type=int) 1441 p.add_argument('-u', '--pdu-pool-size', help='Number of PDUs in the pool', type=int) 1442 p.add_argument('-j', '--immediate-data-pool-size', help='Number of immediate data buffers in the pool', type=int) 1443 p.add_argument('-z', '--data-out-pool-size', help='Number of data out buffers in the pool', type=int) 1444 p.set_defaults(func=iscsi_set_options) 1445 1446 def iscsi_set_discovery_auth(args): 1447 rpc.iscsi.iscsi_set_discovery_auth( 1448 args.client, 1449 disable_chap=args.disable_chap, 1450 require_chap=args.require_chap, 1451 mutual_chap=args.mutual_chap, 1452 chap_group=args.chap_group) 1453 1454 p = subparsers.add_parser('iscsi_set_discovery_auth', 1455 help="""Set CHAP authentication for discovery session.""") 1456 p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled. 1457 *** Mutually exclusive with --require-chap""", action='store_true') 1458 p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required. 1459 *** Mutually exclusive with --disable-chap""", action='store_true') 1460 p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true') 1461 p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session. 1462 *** Authentication group must be precreated ***""", type=int) 1463 p.set_defaults(func=iscsi_set_discovery_auth) 1464 1465 def iscsi_create_auth_group(args): 1466 secrets = None 1467 if args.secrets: 1468 secrets = [dict(u.split(":") for u in a.split(" ")) for a in args.secrets.split(",")] 1469 1470 rpc.iscsi.iscsi_create_auth_group(args.client, tag=args.tag, secrets=secrets) 1471 1472 p = subparsers.add_parser('iscsi_create_auth_group', 1473 help='Create authentication group for CHAP authentication.') 1474 p.add_argument('tag', help='Authentication group tag (unique, integer > 0).', type=int) 1475 p.add_argument('-c', '--secrets', help="""Comma-separated list of CHAP secrets 1476<user:user_name secret:chap_secret muser:mutual_user_name msecret:mutual_chap_secret> enclosed in quotes. 1477Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 msecret:ms2'""") 1478 p.set_defaults(func=iscsi_create_auth_group) 1479 1480 def iscsi_delete_auth_group(args): 1481 rpc.iscsi.iscsi_delete_auth_group(args.client, tag=args.tag) 1482 1483 p = subparsers.add_parser('iscsi_delete_auth_group', 1484 help='Delete an authentication group.') 1485 p.add_argument('tag', help='Authentication group tag', type=int) 1486 p.set_defaults(func=iscsi_delete_auth_group) 1487 1488 def iscsi_auth_group_add_secret(args): 1489 rpc.iscsi.iscsi_auth_group_add_secret( 1490 args.client, 1491 tag=args.tag, 1492 user=args.user, 1493 secret=args.secret, 1494 muser=args.muser, 1495 msecret=args.msecret) 1496 1497 p = subparsers.add_parser('iscsi_auth_group_add_secret', 1498 help='Add a secret to an authentication group.') 1499 p.add_argument('tag', help='Authentication group tag', type=int) 1500 p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True) 1501 p.add_argument('-s', '--secret', help='Secret for one-way CHAP authentication', required=True) 1502 p.add_argument('-m', '--muser', help='User name for mutual CHAP authentication') 1503 p.add_argument('-r', '--msecret', help='Secret for mutual CHAP authentication') 1504 p.set_defaults(func=iscsi_auth_group_add_secret) 1505 1506 def iscsi_auth_group_remove_secret(args): 1507 rpc.iscsi.iscsi_auth_group_remove_secret(args.client, tag=args.tag, user=args.user) 1508 1509 p = subparsers.add_parser('iscsi_auth_group_remove_secret', 1510 help='Remove a secret from an authentication group.') 1511 p.add_argument('tag', help='Authentication group tag', type=int) 1512 p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True) 1513 p.set_defaults(func=iscsi_auth_group_remove_secret) 1514 1515 def iscsi_get_auth_groups(args): 1516 print_dict(rpc.iscsi.iscsi_get_auth_groups(args.client)) 1517 1518 p = subparsers.add_parser('iscsi_get_auth_groups', 1519 help='Display current authentication group configuration') 1520 p.set_defaults(func=iscsi_get_auth_groups) 1521 1522 def iscsi_get_portal_groups(args): 1523 print_dict(rpc.iscsi.iscsi_get_portal_groups(args.client)) 1524 1525 p = subparsers.add_parser('iscsi_get_portal_groups', help='Display current portal group configuration') 1526 p.set_defaults(func=iscsi_get_portal_groups) 1527 1528 def iscsi_get_initiator_groups(args): 1529 print_dict(rpc.iscsi.iscsi_get_initiator_groups(args.client)) 1530 1531 p = subparsers.add_parser('iscsi_get_initiator_groups', 1532 help='Display current initiator group configuration') 1533 p.set_defaults(func=iscsi_get_initiator_groups) 1534 1535 def iscsi_get_target_nodes(args): 1536 print_dict(rpc.iscsi.iscsi_get_target_nodes(args.client)) 1537 1538 p = subparsers.add_parser('iscsi_get_target_nodes', help='Display target nodes') 1539 p.set_defaults(func=iscsi_get_target_nodes) 1540 1541 def iscsi_enable_histogram(args): 1542 rpc.iscsi.iscsi_enable_histogram(args.client, name=args.name, enable=args.enable) 1543 1544 p = subparsers.add_parser('iscsi_enable_histogram', 1545 help='Enable or disable histogram for specified iscsi target') 1546 p.add_argument('-e', '--enable', default=True, dest='enable', action='store_true', help='Enable histograms on specified iscsi target') 1547 p.add_argument('-d', '--disable', dest='enable', action='store_false', help='Disable histograms on specified iscsi target') 1548 p.add_argument('name', help='iscsi target name') 1549 p.set_defaults(func=iscsi_enable_histogram) 1550 1551 def iscsi_get_histogram(args): 1552 print_dict(rpc.iscsi.iscsi_get_histogram(args.client, name=args.name)) 1553 1554 p = subparsers.add_parser('iscsi_get_histogram', 1555 help='Get histogram for specified iscsi target') 1556 p.add_argument('name', help='target name') 1557 p.set_defaults(func=iscsi_get_histogram) 1558 1559 def iscsi_create_target_node(args): 1560 luns = [] 1561 for u in args.bdev_name_id_pairs.strip().split(" "): 1562 bdev_name, lun_id = u.split(":") 1563 luns.append({"bdev_name": bdev_name, "lun_id": int(lun_id)}) 1564 1565 pg_ig_maps = [] 1566 for u in args.pg_ig_mappings.strip().split(" "): 1567 pg, ig = u.split(":") 1568 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1569 1570 rpc.iscsi.iscsi_create_target_node( 1571 args.client, 1572 luns=luns, 1573 pg_ig_maps=pg_ig_maps, 1574 name=args.name, 1575 alias_name=args.alias_name, 1576 queue_depth=args.queue_depth, 1577 chap_group=args.chap_group, 1578 disable_chap=args.disable_chap, 1579 require_chap=args.require_chap, 1580 mutual_chap=args.mutual_chap, 1581 header_digest=args.header_digest, 1582 data_digest=args.data_digest) 1583 1584 p = subparsers.add_parser('iscsi_create_target_node', help='Add a target node') 1585 p.add_argument('name', help='Target node name (ASCII)') 1586 p.add_argument('alias_name', help='Target node alias name (ASCII)') 1587 p.add_argument('bdev_name_id_pairs', help="""Whitespace-separated list of <bdev name:LUN ID> pairs enclosed 1588 in quotes. Format: 'bdev_name0:id0 bdev_name1:id1' etc 1589 Example: 'Malloc0:0 Malloc1:1 Malloc5:2' 1590 *** The bdevs must pre-exist *** 1591 *** LUN0 (id = 0) is required *** 1592 *** bdevs names cannot contain space or colon characters ***""") 1593 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1594 Whitespace separated, quoted, mapping defined with colon 1595 separated list of "tags" (int > 0) 1596 Example: '1:1 2:2 2:1' 1597 *** The Portal/Initiator Groups must be precreated ***""") 1598 p.add_argument('queue_depth', help='Desired target queue depth', type=int) 1599 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node. 1600 *** Authentication group must be precreated ***""", type=int) 1601 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node. 1602 *** Mutually exclusive with --require-chap ***""", action='store_true') 1603 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node. 1604 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1605 p.add_argument( 1606 '-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', action='store_true') 1607 p.add_argument('-H', '--header-digest', 1608 help='Header Digest should be required for this target node.', action='store_true') 1609 p.add_argument('-D', '--data-digest', 1610 help='Data Digest should be required for this target node.', action='store_true') 1611 p.set_defaults(func=iscsi_create_target_node) 1612 1613 def iscsi_target_node_add_lun(args): 1614 rpc.iscsi.iscsi_target_node_add_lun( 1615 args.client, 1616 name=args.name, 1617 bdev_name=args.bdev_name, 1618 lun_id=args.lun_id) 1619 1620 p = subparsers.add_parser('iscsi_target_node_add_lun', 1621 help='Add LUN to the target node') 1622 p.add_argument('name', help='Target node name (ASCII)') 1623 p.add_argument('bdev_name', help="""bdev name enclosed in quotes. 1624 *** bdev name cannot contain space or colon characters ***""") 1625 p.add_argument('-i', dest='lun_id', help="""LUN ID (integer >= 0) 1626 *** If LUN ID is omitted or -1, the lowest free one is assigned ***""", type=int) 1627 p.set_defaults(func=iscsi_target_node_add_lun) 1628 1629 def iscsi_target_node_set_auth(args): 1630 rpc.iscsi.iscsi_target_node_set_auth( 1631 args.client, 1632 name=args.name, 1633 chap_group=args.chap_group, 1634 disable_chap=args.disable_chap, 1635 require_chap=args.require_chap, 1636 mutual_chap=args.mutual_chap) 1637 1638 p = subparsers.add_parser('iscsi_target_node_set_auth', 1639 help='Set CHAP authentication for the target node') 1640 p.add_argument('name', help='Target node name (ASCII)') 1641 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node. 1642 *** Authentication group must be precreated ***""", type=int) 1643 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node. 1644 *** Mutually exclusive with --require-chap ***""", action='store_true') 1645 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node. 1646 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1647 p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', 1648 action='store_true') 1649 p.set_defaults(func=iscsi_target_node_set_auth) 1650 1651 def iscsi_target_node_add_pg_ig_maps(args): 1652 pg_ig_maps = [] 1653 for u in args.pg_ig_mappings.strip().split(" "): 1654 pg, ig = u.split(":") 1655 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1656 rpc.iscsi.iscsi_target_node_add_pg_ig_maps( 1657 args.client, 1658 pg_ig_maps=pg_ig_maps, 1659 name=args.name) 1660 1661 p = subparsers.add_parser('iscsi_target_node_add_pg_ig_maps', 1662 help='Add PG-IG maps to the target node') 1663 p.add_argument('name', help='Target node name (ASCII)') 1664 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1665 Whitespace separated, quoted, mapping defined with colon 1666 separated list of "tags" (int > 0) 1667 Example: '1:1 2:2 2:1' 1668 *** The Portal/Initiator Groups must be precreated ***""") 1669 p.set_defaults(func=iscsi_target_node_add_pg_ig_maps) 1670 1671 def iscsi_target_node_remove_pg_ig_maps(args): 1672 pg_ig_maps = [] 1673 for u in args.pg_ig_mappings.strip().split(" "): 1674 pg, ig = u.split(":") 1675 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1676 rpc.iscsi.iscsi_target_node_remove_pg_ig_maps( 1677 args.client, pg_ig_maps=pg_ig_maps, name=args.name) 1678 1679 p = subparsers.add_parser('iscsi_target_node_remove_pg_ig_maps', 1680 help='Delete PG-IG maps from the target node') 1681 p.add_argument('name', help='Target node name (ASCII)') 1682 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1683 Whitespace separated, quoted, mapping defined with colon 1684 separated list of "tags" (int > 0) 1685 Example: '1:1 2:2 2:1' 1686 *** The Portal/Initiator Groups must be precreated ***""") 1687 p.set_defaults(func=iscsi_target_node_remove_pg_ig_maps) 1688 1689 def iscsi_target_node_set_redirect(args): 1690 rpc.iscsi.iscsi_target_node_set_redirect( 1691 args.client, 1692 name=args.name, 1693 pg_tag=args.pg_tag, 1694 redirect_host=args.redirect_host, 1695 redirect_port=args.redirect_port) 1696 1697 p = subparsers.add_parser('iscsi_target_node_set_redirect', 1698 help="""Update redirect portal of the public portal group for the target node. 1699 Omit redirect host and port to clear previously set redirect settings.""") 1700 p.add_argument('name', help='Target node name (ASCII)') 1701 p.add_argument('pg_tag', help='Portal group tag (unique, integer > 0)', type=int) 1702 p.add_argument('-a', '--redirect-host', help='Numeric IP address for redirect portal') 1703 p.add_argument('-p', '--redirect-port', help='Numeric TCP port for redirect portal') 1704 p.set_defaults(func=iscsi_target_node_set_redirect) 1705 1706 def iscsi_target_node_request_logout(args): 1707 rpc.iscsi.iscsi_target_node_request_logout( 1708 args.client, 1709 name=args.name, 1710 pg_tag=args.pg_tag) 1711 1712 p = subparsers.add_parser('iscsi_target_node_request_logout', 1713 help="""For the target node, request connections whose portal group tag 1714 match to logout, or request all connections if portal group tag is omitted.""") 1715 p.add_argument('name', help='Target node name (ASCII)') 1716 p.add_argument('-t', '--pg-tag', help='Portal group tag (unique, integer > 0)', type=int) 1717 p.set_defaults(func=iscsi_target_node_request_logout) 1718 1719 def iscsi_create_portal_group(args): 1720 portals = [] 1721 for p in args.portal_list.strip().split(' '): 1722 ip, separator, port_cpumask = p.rpartition(':') 1723 split_port_cpumask = port_cpumask.split('@') 1724 if len(split_port_cpumask) == 1: 1725 port = port_cpumask 1726 portals.append({'host': ip, 'port': port}) 1727 else: 1728 port = split_port_cpumask[0] 1729 cpumask = split_port_cpumask[1] 1730 portals.append({'host': ip, 'port': port}) 1731 print("WARNING: Specifying a portal group with a CPU mask is no longer supported. Ignoring it.") 1732 rpc.iscsi.iscsi_create_portal_group( 1733 args.client, 1734 portals=portals, 1735 tag=args.tag, 1736 private=args.private, 1737 wait=args.wait) 1738 1739 p = subparsers.add_parser('iscsi_create_portal_group', 1740 help='Add a portal group') 1741 p.add_argument( 1742 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1743 p.add_argument('portal_list', help="""List of portals in host:port format, separated by whitespace 1744 Example: '192.168.100.100:3260 192.168.100.100:3261 192.168.100.100:3262""") 1745 p.add_argument('-p', '--private', help="""Public (false) or private (true) portal group. 1746 Private portal groups do not have their portals returned by a discovery session. A public 1747 portal group may optionally specify a redirect portal for non-discovery logins. This redirect 1748 portal must be from a private portal group.""", action='store_true') 1749 p.add_argument('-w', '--wait', help="""Do not listening on portals until it is started explicitly. 1750 One major iSCSI initiator may not retry login once it failed. Hence for such initiator, listening 1751 on portals should be allowed after all associated target nodes are created.""", action='store_true') 1752 p.set_defaults(func=iscsi_create_portal_group) 1753 1754 def iscsi_start_portal_group(args): 1755 rpc.iscsi.iscsi_start_portal_group(args.client, tag=args.tag) 1756 1757 p = subparsers.add_parser('iscsi_start_portal_group', 1758 help='Start listening on portals if it is not started yet.') 1759 p.add_argument( 1760 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1761 p.set_defaults(func=iscsi_start_portal_group) 1762 1763 def iscsi_create_initiator_group(args): 1764 initiators = [] 1765 netmasks = [] 1766 for i in args.initiator_list.strip().split(' '): 1767 initiators.append(i) 1768 for n in args.netmask_list.strip().split(' '): 1769 netmasks.append(n) 1770 rpc.iscsi.iscsi_create_initiator_group( 1771 args.client, 1772 tag=args.tag, 1773 initiators=initiators, 1774 netmasks=netmasks) 1775 1776 p = subparsers.add_parser('iscsi_create_initiator_group', 1777 help='Add an initiator group') 1778 p.add_argument( 1779 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1780 p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1781 enclosed in quotes. Example: 'ANY' or 'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""") 1782 p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1783 Example: '255.255.0.0 255.248.0.0' etc""") 1784 p.set_defaults(func=iscsi_create_initiator_group) 1785 1786 def iscsi_initiator_group_add_initiators(args): 1787 initiators = None 1788 netmasks = None 1789 if args.initiator_list: 1790 initiators = [] 1791 for i in args.initiator_list.strip().split(' '): 1792 initiators.append(i) 1793 if args.netmask_list: 1794 netmasks = [] 1795 for n in args.netmask_list.strip().split(' '): 1796 netmasks.append(n) 1797 rpc.iscsi.iscsi_initiator_group_add_initiators( 1798 args.client, 1799 tag=args.tag, 1800 initiators=initiators, 1801 netmasks=netmasks) 1802 1803 p = subparsers.add_parser('iscsi_initiator_group_add_initiators', 1804 help='Add initiators to an existing initiator group') 1805 p.add_argument( 1806 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1807 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1808 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or 1809 'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""") 1810 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1811 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""") 1812 p.set_defaults(func=iscsi_initiator_group_add_initiators) 1813 1814 def iscsi_initiator_group_remove_initiators(args): 1815 initiators = None 1816 netmasks = None 1817 if args.initiator_list: 1818 initiators = [] 1819 for i in args.initiator_list.strip().split(' '): 1820 initiators.append(i) 1821 if args.netmask_list: 1822 netmasks = [] 1823 for n in args.netmask_list.strip().split(' '): 1824 netmasks.append(n) 1825 rpc.iscsi.iscsi_initiator_group_remove_initiators( 1826 args.client, 1827 tag=args.tag, 1828 initiators=initiators, 1829 netmasks=netmasks) 1830 1831 p = subparsers.add_parser('iscsi_initiator_group_remove_initiators', 1832 help='Delete initiators from an existing initiator group') 1833 p.add_argument( 1834 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1835 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1836 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or 1837 'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""") 1838 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1839 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""") 1840 p.set_defaults(func=iscsi_initiator_group_remove_initiators) 1841 1842 def iscsi_delete_target_node(args): 1843 rpc.iscsi.iscsi_delete_target_node( 1844 args.client, target_node_name=args.target_node_name) 1845 1846 p = subparsers.add_parser('iscsi_delete_target_node', 1847 help='Delete a target node') 1848 p.add_argument('target_node_name', 1849 help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.') 1850 p.set_defaults(func=iscsi_delete_target_node) 1851 1852 def iscsi_delete_portal_group(args): 1853 rpc.iscsi.iscsi_delete_portal_group(args.client, tag=args.tag) 1854 1855 p = subparsers.add_parser('iscsi_delete_portal_group', 1856 help='Delete a portal group') 1857 p.add_argument( 1858 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1859 p.set_defaults(func=iscsi_delete_portal_group) 1860 1861 def iscsi_delete_initiator_group(args): 1862 rpc.iscsi.iscsi_delete_initiator_group(args.client, tag=args.tag) 1863 1864 p = subparsers.add_parser('iscsi_delete_initiator_group', 1865 help='Delete an initiator group') 1866 p.add_argument( 1867 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1868 p.set_defaults(func=iscsi_delete_initiator_group) 1869 1870 def iscsi_portal_group_set_auth(args): 1871 rpc.iscsi.iscsi_portal_group_set_auth( 1872 args.client, 1873 tag=args.tag, 1874 chap_group=args.chap_group, 1875 disable_chap=args.disable_chap, 1876 require_chap=args.require_chap, 1877 mutual_chap=args.mutual_chap) 1878 1879 p = subparsers.add_parser('iscsi_portal_group_set_auth', 1880 help='Set CHAP authentication for discovery sessions specific for the portal group') 1881 p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int) 1882 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this portal group. 1883 *** Authentication group must be precreated ***""", type=int) 1884 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this portal group. 1885 *** Mutually exclusive with --require-chap ***""", action='store_true') 1886 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this portal group. 1887 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1888 p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', 1889 action='store_true') 1890 p.set_defaults(func=iscsi_portal_group_set_auth) 1891 1892 def iscsi_get_connections(args): 1893 print_dict(rpc.iscsi.iscsi_get_connections(args.client)) 1894 1895 p = subparsers.add_parser('iscsi_get_connections', 1896 help='Display iSCSI connections') 1897 p.set_defaults(func=iscsi_get_connections) 1898 1899 def iscsi_get_stats(args): 1900 print_dict(rpc.iscsi.iscsi_get_stats(args.client)) 1901 1902 p = subparsers.add_parser('iscsi_get_stats', 1903 help='Display stat information of iSCSI connections.') 1904 p.set_defaults(func=iscsi_get_stats) 1905 1906 def iscsi_get_options(args): 1907 print_dict(rpc.iscsi.iscsi_get_options(args.client)) 1908 1909 p = subparsers.add_parser('iscsi_get_options', 1910 help='Display iSCSI global parameters') 1911 p.set_defaults(func=iscsi_get_options) 1912 1913 def scsi_get_devices(args): 1914 print_dict(rpc.iscsi.scsi_get_devices(args.client)) 1915 1916 p = subparsers.add_parser('scsi_get_devices', help='Display SCSI devices') 1917 p.set_defaults(func=scsi_get_devices) 1918 1919 # trace 1920 def trace_enable_tpoint_group(args): 1921 rpc.trace.trace_enable_tpoint_group(args.client, name=args.name) 1922 1923 p = subparsers.add_parser('trace_enable_tpoint_group', 1924 help='enable trace on a specific tpoint group') 1925 p.add_argument( 1926 'name', help="""trace group name we want to enable in tpoint_group_mask. 1927 (for example "bdev" for bdev trace group, "all" for all trace groups).""") 1928 p.set_defaults(func=trace_enable_tpoint_group) 1929 1930 def trace_disable_tpoint_group(args): 1931 rpc.trace.trace_disable_tpoint_group(args.client, name=args.name) 1932 1933 p = subparsers.add_parser('trace_disable_tpoint_group', 1934 help='disable trace on a specific tpoint group') 1935 p.add_argument( 1936 'name', help="""trace group name we want to disable in tpoint_group_mask. 1937 (for example "bdev" for bdev trace group, "all" for all trace groups).""") 1938 p.set_defaults(func=trace_disable_tpoint_group) 1939 1940 def trace_set_tpoint_mask(args): 1941 rpc.trace.trace_set_tpoint_mask(args.client, name=args.name, tpoint_mask=args.tpoint_mask) 1942 1943 p = subparsers.add_parser('trace_set_tpoint_mask', 1944 help='enable tracepoint mask on a specific tpoint group') 1945 p.add_argument( 1946 'name', help="""trace group name we want to enable in tpoint_group_mask. 1947 (for example "bdev" for bdev trace group)""") 1948 p.add_argument( 1949 'tpoint_mask', help="""tracepoints to be enabled inside a given trace group. 1950 (for example value of "0x3" will enable only the first two tpoints in this group)""", 1951 type=lambda m: int(m, 16)) 1952 p.set_defaults(func=trace_set_tpoint_mask) 1953 1954 def trace_clear_tpoint_mask(args): 1955 rpc.trace.trace_clear_tpoint_mask(args.client, name=args.name, tpoint_mask=args.tpoint_mask) 1956 1957 p = subparsers.add_parser('trace_clear_tpoint_mask', 1958 help='disable tracepoint mask on a specific tpoint group') 1959 p.add_argument( 1960 'name', help="""trace group name we want to disable in tpoint_group_mask. 1961 (for example "bdev" for bdev trace group)""") 1962 p.add_argument( 1963 'tpoint_mask', help="""tracepoints to be disabled inside a given trace group. 1964 (for example value of "0x3" will disable the first two tpoints in this group)""", 1965 type=lambda m: int(m, 16)) 1966 p.set_defaults(func=trace_clear_tpoint_mask) 1967 1968 def trace_get_tpoint_group_mask(args): 1969 print_dict(rpc.trace.trace_get_tpoint_group_mask(args.client)) 1970 1971 p = subparsers.add_parser('trace_get_tpoint_group_mask', help='get trace point group mask') 1972 p.set_defaults(func=trace_get_tpoint_group_mask) 1973 1974 def trace_get_info(args): 1975 print_dict(rpc.trace.trace_get_info(args.client)) 1976 1977 p = subparsers.add_parser('trace_get_info', 1978 help='get name of shared memory file and list of the available trace point groups') 1979 p.set_defaults(func=trace_get_info) 1980 1981 # log 1982 def log_set_flag(args): 1983 rpc.log.log_set_flag(args.client, flag=args.flag) 1984 1985 p = subparsers.add_parser('log_set_flag', help='set log flag') 1986 p.add_argument( 1987 'flag', help='log flag we want to set. (for example "nvme").') 1988 p.set_defaults(func=log_set_flag) 1989 1990 def log_clear_flag(args): 1991 rpc.log.log_clear_flag(args.client, flag=args.flag) 1992 1993 p = subparsers.add_parser('log_clear_flag', help='clear log flag') 1994 p.add_argument( 1995 'flag', help='log flag we want to clear. (for example "nvme").') 1996 p.set_defaults(func=log_clear_flag) 1997 1998 def log_get_flags(args): 1999 print_dict(rpc.log.log_get_flags(args.client)) 2000 2001 p = subparsers.add_parser('log_get_flags', help='get log flags') 2002 p.set_defaults(func=log_get_flags) 2003 2004 def log_set_level(args): 2005 rpc.log.log_set_level(args.client, level=args.level) 2006 2007 p = subparsers.add_parser('log_set_level', help='set log level') 2008 p.add_argument('level', help='log level we want to set. (for example "DEBUG").') 2009 p.set_defaults(func=log_set_level) 2010 2011 def log_get_level(args): 2012 print_dict(rpc.log.log_get_level(args.client)) 2013 2014 p = subparsers.add_parser('log_get_level', help='get log level') 2015 p.set_defaults(func=log_get_level) 2016 2017 def log_set_print_level(args): 2018 rpc.log.log_set_print_level(args.client, level=args.level) 2019 2020 p = subparsers.add_parser('log_set_print_level', help='set log print level') 2021 p.add_argument('level', help='log print level we want to set. (for example "DEBUG").') 2022 p.set_defaults(func=log_set_print_level) 2023 2024 def log_get_print_level(args): 2025 print_dict(rpc.log.log_get_print_level(args.client)) 2026 2027 p = subparsers.add_parser('log_get_print_level', help='get log print level') 2028 p.set_defaults(func=log_get_print_level) 2029 2030 # lvol 2031 def bdev_lvol_create_lvstore(args): 2032 # The default unmap clear method may take over 60.0 sec. 2033 if args.timeout is None: 2034 args.client.timeout = 90.0 2035 print_json(rpc.lvol.bdev_lvol_create_lvstore(args.client, 2036 bdev_name=args.bdev_name, 2037 lvs_name=args.lvs_name, 2038 cluster_sz=args.cluster_sz, 2039 clear_method=args.clear_method, 2040 num_md_pages_per_cluster_ratio=args.md_pages_per_cluster_ratio)) 2041 2042 p = subparsers.add_parser('bdev_lvol_create_lvstore', help='Add logical volume store on base bdev') 2043 p.add_argument('bdev_name', help='base bdev name') 2044 p.add_argument('lvs_name', help='name for lvol store') 2045 p.add_argument('-c', '--cluster-sz', help='size of cluster (in bytes)', type=int) 2046 p.add_argument('--clear-method', help="""Change clear method for data region. 2047 Available: none, unmap, write_zeroes""") 2048 p.add_argument('-m', '--md-pages-per-cluster-ratio', help='reserved metadata pages for each cluster', type=int) 2049 p.set_defaults(func=bdev_lvol_create_lvstore) 2050 2051 def bdev_lvol_rename_lvstore(args): 2052 rpc.lvol.bdev_lvol_rename_lvstore(args.client, 2053 old_name=args.old_name, 2054 new_name=args.new_name) 2055 2056 p = subparsers.add_parser('bdev_lvol_rename_lvstore', help='Change logical volume store name') 2057 p.add_argument('old_name', help='old name') 2058 p.add_argument('new_name', help='new name') 2059 p.set_defaults(func=bdev_lvol_rename_lvstore) 2060 2061 def bdev_lvol_grow_lvstore(args): 2062 print_dict(rpc.lvol.bdev_lvol_grow_lvstore(args.client, 2063 uuid=args.uuid, 2064 lvs_name=args.lvs_name)) 2065 2066 p = subparsers.add_parser('bdev_lvol_grow_lvstore', 2067 help='Grow the lvstore size to the underlying bdev size') 2068 p.add_argument('-u', '--uuid', help='lvol store UUID') 2069 p.add_argument('-l', '--lvs-name', help='lvol store name') 2070 p.set_defaults(func=bdev_lvol_grow_lvstore) 2071 2072 def bdev_lvol_create(args): 2073 print_json(rpc.lvol.bdev_lvol_create(args.client, 2074 lvol_name=args.lvol_name, 2075 size_in_mib=args.size_in_mib, 2076 thin_provision=args.thin_provision, 2077 clear_method=args.clear_method, 2078 uuid=args.uuid, 2079 lvs_name=args.lvs_name)) 2080 2081 p = subparsers.add_parser('bdev_lvol_create', help='Add a bdev with an logical volume backend') 2082 p.add_argument('-u', '--uuid', help='lvol store UUID') 2083 p.add_argument('-l', '--lvs-name', help='lvol store name') 2084 p.add_argument('-t', '--thin-provision', action='store_true', help='create lvol bdev as thin provisioned') 2085 p.add_argument('-c', '--clear-method', help="""Change default data clusters clear method. 2086 Available: none, unmap, write_zeroes""") 2087 p.add_argument('lvol_name', help='name for this lvol') 2088 p.add_argument('size_in_mib', help='size in MiB for this bdev', type=int) 2089 p.set_defaults(func=bdev_lvol_create) 2090 2091 def bdev_lvol_snapshot(args): 2092 print_json(rpc.lvol.bdev_lvol_snapshot(args.client, 2093 lvol_name=args.lvol_name, 2094 snapshot_name=args.snapshot_name)) 2095 2096 p = subparsers.add_parser('bdev_lvol_snapshot', help='Create a snapshot of an lvol bdev') 2097 p.add_argument('lvol_name', help='lvol bdev name') 2098 p.add_argument('snapshot_name', help='lvol snapshot name') 2099 p.set_defaults(func=bdev_lvol_snapshot) 2100 2101 def bdev_lvol_clone(args): 2102 print_json(rpc.lvol.bdev_lvol_clone(args.client, 2103 snapshot_name=args.snapshot_name, 2104 clone_name=args.clone_name)) 2105 2106 p = subparsers.add_parser('bdev_lvol_clone', help='Create a clone of an lvol snapshot') 2107 p.add_argument('snapshot_name', help='lvol snapshot name') 2108 p.add_argument('clone_name', help='lvol clone name') 2109 p.set_defaults(func=bdev_lvol_clone) 2110 2111 def bdev_lvol_clone_bdev(args): 2112 print_json(rpc.lvol.bdev_lvol_clone_bdev(args.client, 2113 bdev=args.bdev, 2114 lvs_name=args.lvs_name, 2115 clone_name=args.clone_name)) 2116 2117 p = subparsers.add_parser('bdev_lvol_clone_bdev', 2118 help='Create a clone of a non-lvol bdev') 2119 p.add_argument('bdev', help='bdev to clone') 2120 p.add_argument('lvs_name', help='logical volume store name') 2121 p.add_argument('clone_name', help='lvol clone name') 2122 p.set_defaults(func=bdev_lvol_clone_bdev) 2123 2124 def bdev_lvol_rename(args): 2125 rpc.lvol.bdev_lvol_rename(args.client, 2126 old_name=args.old_name, 2127 new_name=args.new_name) 2128 2129 p = subparsers.add_parser('bdev_lvol_rename', help='Change lvol bdev name') 2130 p.add_argument('old_name', help='lvol bdev name') 2131 p.add_argument('new_name', help='new lvol name') 2132 p.set_defaults(func=bdev_lvol_rename) 2133 2134 def bdev_lvol_inflate(args): 2135 rpc.lvol.bdev_lvol_inflate(args.client, 2136 name=args.name) 2137 2138 p = subparsers.add_parser('bdev_lvol_inflate', help='Make thin provisioned lvol a thick provisioned lvol') 2139 p.add_argument('name', help='lvol bdev name') 2140 p.set_defaults(func=bdev_lvol_inflate) 2141 2142 def bdev_lvol_decouple_parent(args): 2143 rpc.lvol.bdev_lvol_decouple_parent(args.client, 2144 name=args.name) 2145 2146 p = subparsers.add_parser('bdev_lvol_decouple_parent', help='Decouple parent of lvol') 2147 p.add_argument('name', help='lvol bdev name') 2148 p.set_defaults(func=bdev_lvol_decouple_parent) 2149 2150 def bdev_lvol_resize(args): 2151 rpc.lvol.bdev_lvol_resize(args.client, 2152 name=args.name, 2153 size_in_mib=args.size_in_mib) 2154 2155 p = subparsers.add_parser('bdev_lvol_resize', help='Resize existing lvol bdev') 2156 p.add_argument('name', help='lvol bdev name') 2157 p.add_argument('size_in_mib', help='new size in MiB for this bdev', type=int) 2158 p.set_defaults(func=bdev_lvol_resize) 2159 2160 def bdev_lvol_set_read_only(args): 2161 rpc.lvol.bdev_lvol_set_read_only(args.client, 2162 name=args.name) 2163 2164 p = subparsers.add_parser('bdev_lvol_set_read_only', help='Mark lvol bdev as read only') 2165 p.add_argument('name', help='lvol bdev name') 2166 p.set_defaults(func=bdev_lvol_set_read_only) 2167 2168 def bdev_lvol_delete(args): 2169 rpc.lvol.bdev_lvol_delete(args.client, 2170 name=args.name) 2171 2172 p = subparsers.add_parser('bdev_lvol_delete', help='Destroy a logical volume') 2173 p.add_argument('name', help='lvol bdev name') 2174 p.set_defaults(func=bdev_lvol_delete) 2175 2176 def bdev_lvol_start_shallow_copy(args): 2177 print_json(rpc.lvol.bdev_lvol_start_shallow_copy(args.client, 2178 src_lvol_name=args.src_lvol_name, 2179 dst_bdev_name=args.dst_bdev_name)) 2180 2181 p = subparsers.add_parser('bdev_lvol_start_shallow_copy', 2182 help="""Start a shallow copy of an lvol over a given bdev. The status of the operation 2183 can be obtained with bdev_lvol_check_shallow_copy""") 2184 p.add_argument('src_lvol_name', help='source lvol name') 2185 p.add_argument('dst_bdev_name', help='destination bdev name') 2186 p.set_defaults(func=bdev_lvol_start_shallow_copy) 2187 2188 def bdev_lvol_check_shallow_copy(args): 2189 print_json(rpc.lvol.bdev_lvol_check_shallow_copy(args.client, 2190 operation_id=args.operation_id)) 2191 2192 p = subparsers.add_parser('bdev_lvol_check_shallow_copy', help='Get shallow copy status') 2193 p.add_argument('operation_id', help='operation identifier', type=int) 2194 p.set_defaults(func=bdev_lvol_check_shallow_copy) 2195 2196 def bdev_lvol_set_parent(args): 2197 rpc.lvol.bdev_lvol_set_parent(args.client, 2198 lvol_name=args.lvol_name, 2199 parent_name=args.parent_name) 2200 2201 p = subparsers.add_parser('bdev_lvol_set_parent', help='Set the parent snapshot of a lvol') 2202 p.add_argument('lvol_name', help='lvol name') 2203 p.add_argument('parent_name', help='parent snapshot name') 2204 p.set_defaults(func=bdev_lvol_set_parent) 2205 2206 def bdev_lvol_set_parent_bdev(args): 2207 rpc.lvol.bdev_lvol_set_parent_bdev(args.client, 2208 lvol_name=args.lvol_name, 2209 parent_name=args.parent_name) 2210 2211 p = subparsers.add_parser('bdev_lvol_set_parent_bdev', help='Set the parent external snapshot of a lvol') 2212 p.add_argument('lvol_name', help='lvol name') 2213 p.add_argument('parent_name', help='parent external snapshot name') 2214 p.set_defaults(func=bdev_lvol_set_parent_bdev) 2215 2216 def bdev_lvol_delete_lvstore(args): 2217 rpc.lvol.bdev_lvol_delete_lvstore(args.client, 2218 uuid=args.uuid, 2219 lvs_name=args.lvs_name) 2220 2221 p = subparsers.add_parser('bdev_lvol_delete_lvstore', help='Destroy an logical volume store') 2222 p.add_argument('-u', '--uuid', help='lvol store UUID') 2223 p.add_argument('-l', '--lvs-name', help='lvol store name') 2224 p.set_defaults(func=bdev_lvol_delete_lvstore) 2225 2226 def bdev_lvol_get_lvstores(args): 2227 print_dict(rpc.lvol.bdev_lvol_get_lvstores(args.client, 2228 uuid=args.uuid, 2229 lvs_name=args.lvs_name)) 2230 2231 p = subparsers.add_parser('bdev_lvol_get_lvstores', help='Display current logical volume store list') 2232 p.add_argument('-u', '--uuid', help='lvol store UUID') 2233 p.add_argument('-l', '--lvs-name', help='lvol store name') 2234 p.set_defaults(func=bdev_lvol_get_lvstores) 2235 2236 def bdev_lvol_get_lvols(args): 2237 print_dict(rpc.lvol.bdev_lvol_get_lvols(args.client, 2238 lvs_uuid=args.lvs_uuid, 2239 lvs_name=args.lvs_name)) 2240 2241 p = subparsers.add_parser('bdev_lvol_get_lvols', help='Display current logical volume list') 2242 p.add_argument('-u', '--lvs-uuid', help='only lvols in lvol store UUID') 2243 p.add_argument('-l', '--lvs-name', help='only lvols in lvol store name') 2244 p.set_defaults(func=bdev_lvol_get_lvols) 2245 2246 def bdev_raid_set_options(args): 2247 rpc.bdev.bdev_raid_set_options(args.client, 2248 process_window_size_kb=args.process_window_size_kb, 2249 process_max_bandwidth_mb_sec=args.process_max_bandwidth_mb_sec) 2250 2251 p = subparsers.add_parser('bdev_raid_set_options', 2252 help='Set options for bdev raid.') 2253 p.add_argument('-w', '--process-window-size-kb', type=int, 2254 help="Background process (e.g. rebuild) window size in KiB") 2255 p.add_argument('-b', '--process-max-bandwidth-mb-sec', type=int, 2256 help="Background process (e.g. rebuild) maximum bandwidth in MiB/Sec") 2257 2258 p.set_defaults(func=bdev_raid_set_options) 2259 2260 def bdev_raid_get_bdevs(args): 2261 print_json(rpc.bdev.bdev_raid_get_bdevs(args.client, 2262 category=args.category)) 2263 2264 p = subparsers.add_parser('bdev_raid_get_bdevs', 2265 help="""This is used to list all the raid bdev details based on the input category 2266 requested. Category should be one of 'all', 'online', 'configuring' or 'offline'. 'all' means all the raid bdevs whether 2267 they are online or configuring or offline. 'online' is the raid bdev which is registered with bdev layer. 'configuring' 2268 is the raid bdev which does not have full configuration discovered yet. 'offline' is the raid bdev which is not registered 2269 with bdev as of now and it has encountered any error or user has requested to offline the raid bdev""") 2270 p.add_argument('category', help='all or online or configuring or offline') 2271 p.set_defaults(func=bdev_raid_get_bdevs) 2272 2273 def bdev_raid_create(args): 2274 base_bdevs = [] 2275 for u in args.base_bdevs.strip().split(): 2276 base_bdevs.append(u) 2277 2278 rpc.bdev.bdev_raid_create(args.client, 2279 name=args.name, 2280 strip_size_kb=args.strip_size_kb, 2281 raid_level=args.raid_level, 2282 base_bdevs=base_bdevs, 2283 uuid=args.uuid, 2284 superblock=args.superblock) 2285 p = subparsers.add_parser('bdev_raid_create', help='Create new raid bdev') 2286 p.add_argument('-n', '--name', help='raid bdev name', required=True) 2287 p.add_argument('-z', '--strip-size-kb', help='strip size in KB', type=int) 2288 p.add_argument('-r', '--raid-level', help='raid level, raid0, raid1 and a special level concat are supported', required=True) 2289 p.add_argument('-b', '--base-bdevs', help='base bdevs name, whitespace separated list in quotes', required=True) 2290 p.add_argument('--uuid', help='UUID for this raid bdev') 2291 p.add_argument('-s', '--superblock', help='information about raid bdev will be stored in superblock on each base bdev, ' 2292 'disabled by default due to backward compatibility', action='store_true') 2293 p.set_defaults(func=bdev_raid_create) 2294 2295 def bdev_raid_delete(args): 2296 rpc.bdev.bdev_raid_delete(args.client, 2297 name=args.name) 2298 p = subparsers.add_parser('bdev_raid_delete', help='Delete existing raid bdev') 2299 p.add_argument('name', help='raid bdev name') 2300 p.set_defaults(func=bdev_raid_delete) 2301 2302 def bdev_raid_add_base_bdev(args): 2303 rpc.bdev.bdev_raid_add_base_bdev(args.client, 2304 raid_bdev=args.raid_bdev, 2305 base_bdev=args.base_bdev) 2306 p = subparsers.add_parser('bdev_raid_add_base_bdev', help='Add base bdev to existing raid bdev') 2307 p.add_argument('raid_bdev', help='raid bdev name') 2308 p.add_argument('base_bdev', help='base bdev name') 2309 p.set_defaults(func=bdev_raid_add_base_bdev) 2310 2311 def bdev_raid_remove_base_bdev(args): 2312 rpc.bdev.bdev_raid_remove_base_bdev(args.client, 2313 name=args.name) 2314 p = subparsers.add_parser('bdev_raid_remove_base_bdev', help='Remove base bdev from existing raid bdev') 2315 p.add_argument('name', help='base bdev name') 2316 p.set_defaults(func=bdev_raid_remove_base_bdev) 2317 2318 # split 2319 def bdev_split_create(args): 2320 print_array(rpc.bdev.bdev_split_create(args.client, 2321 base_bdev=args.base_bdev, 2322 split_count=args.split_count, 2323 split_size_mb=args.split_size_mb)) 2324 2325 p = subparsers.add_parser('bdev_split_create', 2326 help="""Add given disk name to split config. If bdev with base_name 2327 name exist the split bdevs will be created right away, if not split bdevs will be created when base bdev became 2328 available (during examination process).""") 2329 p.add_argument('base_bdev', help='base bdev name') 2330 p.add_argument('-s', '--split-size-mb', help='size in MiB for each bdev', type=int) 2331 p.add_argument('split_count', help="""Optional - number of split bdevs to create. Total size * split_count must not 2332 exceed the base bdev size.""", type=int) 2333 p.set_defaults(func=bdev_split_create) 2334 2335 def bdev_split_delete(args): 2336 rpc.bdev.bdev_split_delete(args.client, 2337 base_bdev=args.base_bdev) 2338 2339 p = subparsers.add_parser('bdev_split_delete', help="""Delete split config with all created splits.""") 2340 p.add_argument('base_bdev', help='base bdev name') 2341 p.set_defaults(func=bdev_split_delete) 2342 2343 # ftl 2344 def bdev_ftl_create(args): 2345 print_dict(rpc.bdev.bdev_ftl_create(args.client, 2346 name=args.name, 2347 base_bdev=args.base_bdev, 2348 uuid=args.uuid, 2349 cache=args.cache, 2350 overprovisioning=args.overprovisioning, 2351 l2p_dram_limit=args.l2p_dram_limit, 2352 core_mask=args.core_mask, 2353 fast_shutdown=args.fast_shutdown)) 2354 2355 p = subparsers.add_parser('bdev_ftl_create', help='Add FTL bdev') 2356 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2357 p.add_argument('-d', '--base-bdev', help='Name of bdev used as underlying device', 2358 required=True) 2359 p.add_argument('-u', '--uuid', help='UUID of restored bdev (not applicable when creating new ' 2360 'instance): e.g. b286d19a-0059-4709-abcd-9f7732b1567d (optional)') 2361 p.add_argument('-c', '--cache', help='Name of the bdev to be used as a write buffer cache', 2362 required=True) 2363 p.add_argument('--overprovisioning', help='Percentage of device used for relocation, not exposed' 2364 ' to user (optional); default 20', type=int) 2365 p.add_argument('--l2p-dram-limit', help='l2p size that could reside in DRAM (optional); default 2048', 2366 type=int) 2367 p.add_argument('--core-mask', help='CPU core mask - which cores will be used for ftl core thread, ' 2368 'by default core thread will be set to the main application core (optional)') 2369 p.add_argument('-f', '--fast-shutdown', help="Enable fast shutdown", action='store_true') 2370 p.set_defaults(func=bdev_ftl_create) 2371 2372 def bdev_ftl_load(args): 2373 print_dict(rpc.bdev.bdev_ftl_load(args.client, 2374 name=args.name, 2375 base_bdev=args.base_bdev, 2376 uuid=args.uuid, 2377 cache=args.cache, 2378 overprovisioning=args.overprovisioning, 2379 l2p_dram_limit=args.l2p_dram_limit, 2380 core_mask=args.core_mask, 2381 fast_shutdown=args.fast_shutdown)) 2382 2383 p = subparsers.add_parser('bdev_ftl_load', help='Load FTL bdev') 2384 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2385 p.add_argument('-d', '--base-bdev', help='Name of bdev used as underlying device', 2386 required=True) 2387 p.add_argument('-u', '--uuid', help='UUID of restored bdev', required=True) 2388 p.add_argument('-c', '--cache', help='Name of the bdev to be used as a write buffer cache', 2389 required=True) 2390 p.add_argument('--overprovisioning', help='Percentage of device used for relocation, not exposed' 2391 ' to user (optional); default 20', type=int) 2392 p.add_argument('--l2p-dram-limit', help='l2p size that could reside in DRAM (optional); default 2048', 2393 type=int) 2394 p.add_argument('--core-mask', help='CPU core mask - which cores will be used for ftl core thread, ' 2395 'by default core thread will be set to the main application core (optional)') 2396 p.add_argument('-f', '--fast-shutdown', help="Enable fast shutdown", action='store_true') 2397 p.set_defaults(func=bdev_ftl_load) 2398 2399 def bdev_ftl_unload(args): 2400 print_dict(rpc.bdev.bdev_ftl_unload(args.client, name=args.name, fast_shutdown=args.fast_shutdown)) 2401 2402 p = subparsers.add_parser('bdev_ftl_unload', help='Unload FTL bdev') 2403 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2404 p.add_argument('-f', '--fast-shutdown', help="Fast shutdown", action='store_true') 2405 p.set_defaults(func=bdev_ftl_unload) 2406 2407 def bdev_ftl_delete(args): 2408 print_dict(rpc.bdev.bdev_ftl_delete(args.client, name=args.name, fast_shutdown=args.fast_shutdown)) 2409 2410 p = subparsers.add_parser('bdev_ftl_delete', help='Delete FTL bdev') 2411 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2412 p.add_argument('-f', '--fast-shutdown', help="Fast shutdown", action='store_true') 2413 p.set_defaults(func=bdev_ftl_delete) 2414 2415 def bdev_ftl_unmap(args): 2416 print_dict(rpc.bdev.bdev_ftl_unmap(args.client, name=args.name, 2417 lba=args.lba, 2418 num_blocks=args.num_blocks)) 2419 2420 p = subparsers.add_parser('bdev_ftl_unmap', help='FTL unmap') 2421 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2422 p.add_argument('--lba', help='start LBA', required=True, type=int) 2423 p.add_argument('--num-blocks', help='num blocks', required=True, type=int) 2424 p.set_defaults(func=bdev_ftl_unmap) 2425 2426 def bdev_ftl_get_stats(args): 2427 print_dict(rpc.bdev.bdev_ftl_get_stats(args.client, name=args.name)) 2428 2429 p = subparsers.add_parser('bdev_ftl_get_stats', help='print ftl stats') 2430 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2431 p.set_defaults(func=bdev_ftl_get_stats) 2432 2433 def bdev_ftl_get_properties(args): 2434 print_dict(rpc.bdev.bdev_ftl_get_properties(args.client, name=args.name)) 2435 2436 p = subparsers.add_parser('bdev_ftl_get_properties', help='Print FTL properties') 2437 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2438 p.set_defaults(func=bdev_ftl_get_properties) 2439 2440 def bdev_ftl_set_property(args): 2441 print_dict(rpc.bdev.bdev_ftl_set_property(args.client, name=args.name, 2442 ftl_property=args.property, 2443 value=args.value)) 2444 2445 p = subparsers.add_parser('bdev_ftl_set_property', help='Set FTL property') 2446 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2447 p.add_argument('-p', '--property', help="Name of the property to be set", required=True) 2448 p.add_argument('-v', '--value', help="Value of the property", required=True) 2449 p.set_defaults(func=bdev_ftl_set_property) 2450 2451 # vmd 2452 def vmd_enable(args): 2453 print_dict(rpc.vmd.vmd_enable(args.client)) 2454 2455 p = subparsers.add_parser('vmd_enable', aliases=['enable_vmd'], help='Enable VMD enumeration') 2456 p.set_defaults(func=vmd_enable) 2457 2458 def vmd_remove_device(args): 2459 print_dict(rpc.vmd.vmd_remove_device(args.client, addr=args.addr)) 2460 2461 p = subparsers.add_parser('vmd_remove_device', help='Remove a device behind VMD') 2462 p.add_argument('addr', help='Address of the device to remove', type=str) 2463 p.set_defaults(func=vmd_remove_device) 2464 2465 def vmd_rescan(args): 2466 print_dict(rpc.vmd.vmd_rescan(args.client)) 2467 2468 p = subparsers.add_parser('vmd_rescan', help='Force a rescan of the devices behind VMD') 2469 p.set_defaults(func=vmd_rescan) 2470 2471 # ublk 2472 def ublk_create_target(args): 2473 rpc.ublk.ublk_create_target(args.client, 2474 cpumask=args.cpumask, 2475 disable_user_copy=args.disable_user_copy) 2476 p = subparsers.add_parser('ublk_create_target', 2477 help='Create spdk ublk target for ublk dev') 2478 p.add_argument('-m', '--cpumask', help='cpu mask for ublk dev') 2479 p.add_argument('--disable-user-copy', help='Disable user copy feature', action='store_true') 2480 p.set_defaults(func=ublk_create_target) 2481 2482 def ublk_destroy_target(args): 2483 rpc.ublk.ublk_destroy_target(args.client) 2484 p = subparsers.add_parser('ublk_destroy_target', 2485 help='Destroy spdk ublk target for ublk dev') 2486 p.set_defaults(func=ublk_destroy_target) 2487 2488 def ublk_start_disk(args): 2489 print(rpc.ublk.ublk_start_disk(args.client, 2490 bdev_name=args.bdev_name, 2491 ublk_id=args.ublk_id, 2492 num_queues=args.num_queues, 2493 queue_depth=args.queue_depth)) 2494 2495 p = subparsers.add_parser('ublk_start_disk', 2496 help='Export a bdev as a ublk device') 2497 p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.') 2498 p.add_argument('ublk_id', help='ublk device id to be assigned. Example: 1.', type=int) 2499 p.add_argument('-q', '--num-queues', help="the total number of queues. Example: 1", type=int) 2500 p.add_argument('-d', '--queue-depth', help="queue depth. Example: 128", type=int) 2501 p.set_defaults(func=ublk_start_disk) 2502 2503 def ublk_stop_disk(args): 2504 rpc.ublk.ublk_stop_disk(args.client, 2505 ublk_id=args.ublk_id) 2506 2507 p = subparsers.add_parser('ublk_stop_disk', 2508 help='Stop a ublk device') 2509 p.add_argument('ublk_id', help='ublk device id to be deleted. Example: 1.', type=int) 2510 p.set_defaults(func=ublk_stop_disk) 2511 2512 def ublk_recover_disk(args): 2513 print(rpc.ublk.ublk_recover_disk(args.client, 2514 bdev_name=args.bdev_name, 2515 ublk_id=args.ublk_id)) 2516 2517 p = subparsers.add_parser('ublk_recover_disk', 2518 help='Recover ublk device') 2519 p.add_argument('bdev_name', help='Blockdev name to be recovered. Example: Malloc0.') 2520 p.add_argument('ublk_id', help='ublk device id to be recovered. Example: 1.', type=int) 2521 p.set_defaults(func=ublk_recover_disk) 2522 2523 def ublk_get_disks(args): 2524 print_dict(rpc.ublk.ublk_get_disks(args.client, 2525 ublk_id=args.ublk_id)) 2526 2527 p = subparsers.add_parser('ublk_get_disks', 2528 help='Display full or specified ublk device list') 2529 p.add_argument('-n', '--ublk-id', help="ublk device id. Example: 1", type=int) 2530 p.set_defaults(func=ublk_get_disks) 2531 2532 # nbd 2533 def nbd_start_disk(args): 2534 print(rpc.nbd.nbd_start_disk(args.client, 2535 bdev_name=args.bdev_name, 2536 nbd_device=args.nbd_device)) 2537 2538 p = subparsers.add_parser('nbd_start_disk', 2539 help='Export a bdev as an nbd disk') 2540 p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.') 2541 p.add_argument('nbd_device', help='Nbd device name to be assigned. Example: /dev/nbd0.', nargs='?') 2542 p.set_defaults(func=nbd_start_disk) 2543 2544 def nbd_stop_disk(args): 2545 rpc.nbd.nbd_stop_disk(args.client, 2546 nbd_device=args.nbd_device) 2547 2548 p = subparsers.add_parser('nbd_stop_disk', 2549 help='Stop an nbd disk') 2550 p.add_argument('nbd_device', help='Nbd device name to be stopped. Example: /dev/nbd0.') 2551 p.set_defaults(func=nbd_stop_disk) 2552 2553 def nbd_get_disks(args): 2554 print_dict(rpc.nbd.nbd_get_disks(args.client, 2555 nbd_device=args.nbd_device)) 2556 2557 p = subparsers.add_parser('nbd_get_disks', 2558 help='Display full or specified nbd device list') 2559 p.add_argument('-n', '--nbd-device', help="Path of the nbd device. Example: /dev/nbd0") 2560 p.set_defaults(func=nbd_get_disks) 2561 2562 # NVMe-oF 2563 def nvmf_set_max_subsystems(args): 2564 rpc.nvmf.nvmf_set_max_subsystems(args.client, 2565 max_subsystems=args.max_subsystems) 2566 2567 p = subparsers.add_parser('nvmf_set_max_subsystems', 2568 help='Set the maximum number of NVMf target subsystems') 2569 p.add_argument('-x', '--max-subsystems', help='Max number of NVMf subsystems', type=int, required=True) 2570 p.set_defaults(func=nvmf_set_max_subsystems) 2571 2572 def nvmf_set_config(args): 2573 rpc.nvmf.nvmf_set_config(args.client, 2574 passthru_identify_ctrlr=args.passthru_identify_ctrlr, 2575 poll_groups_mask=args.poll_groups_mask, 2576 discovery_filter=args.discovery_filter, 2577 dhchap_digests=args.dhchap_digests, 2578 dhchap_dhgroups=args.dhchap_dhgroups) 2579 2580 p = subparsers.add_parser('nvmf_set_config', help='Set NVMf target config') 2581 p.add_argument('-i', '--passthru-identify-ctrlr', help="""Passthrough fields like serial number and model number 2582 when the controller has a single namespace that is an NVMe bdev""", action='store_true') 2583 p.add_argument('-m', '--poll-groups-mask', help='Set cpumask for NVMf poll groups (optional)', type=str) 2584 p.add_argument('-d', '--discovery-filter', help="""Set discovery filter (optional), possible values are: `match_any` (default) or 2585 comma separated values: `transport`, `address`, `svcid`""", type=str) 2586 p.add_argument('--dhchap-digests', help='Comma-separated list of allowed DH-HMAC-CHAP digests', 2587 type=lambda d: d.split(',')) 2588 p.add_argument('--dhchap-dhgroups', help='Comma-separated list of allowed DH-HMAC-CHAP DH groups', 2589 type=lambda d: d.split(',')) 2590 p.set_defaults(func=nvmf_set_config) 2591 2592 def nvmf_create_transport(args): 2593 rpc.nvmf.nvmf_create_transport(**vars(args)) 2594 2595 p = subparsers.add_parser('nvmf_create_transport', help='Create NVMf transport') 2596 p.add_argument('-t', '--trtype', help='Transport type (ex. RDMA)', type=str, required=True) 2597 p.add_argument('-g', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2598 p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/O per queue', type=int) 2599 p.add_argument('-m', '--max-io-qpairs-per-ctrlr', help='Max number of IO qpairs per controller', type=int) 2600 p.add_argument('-c', '--in-capsule-data-size', help='Max number of in-capsule data size', type=int) 2601 p.add_argument('-i', '--max-io-size', help='Max I/O size (bytes)', type=int) 2602 p.add_argument('-u', '--io-unit-size', help='I/O unit size (bytes)', type=int) 2603 p.add_argument('-a', '--max-aq-depth', help='Max number of admin cmds per AQ', type=int) 2604 p.add_argument('-n', '--num-shared-buffers', help='The number of pooled data buffers available to the transport', type=int) 2605 p.add_argument('-b', '--buf-cache-size', help='The number of shared buffers to reserve for each poll group', type=int) 2606 p.add_argument('-z', '--zcopy', action='store_true', help='''Use zero-copy operations if the 2607 underlying bdev supports them''') 2608 p.add_argument('-d', '--num-cqe', help="""The number of CQ entries. Only used when no_srq=true. 2609 Relevant only for RDMA transport""", type=int) 2610 p.add_argument('-s', '--max-srq-depth', help='Max number of outstanding I/O per SRQ. Relevant only for RDMA transport', type=int) 2611 p.add_argument('-r', '--no-srq', action='store_true', help='Disable per-thread shared receive queue. Relevant only for RDMA transport') 2612 p.add_argument('-o', '--c2h-success', action='store_false', help='Disable C2H success optimization. Relevant only for TCP transport') 2613 p.add_argument('-f', '--dif-insert-or-strip', action='store_true', help='Enable DIF insert/strip. Relevant only for TCP transport') 2614 p.add_argument('-y', '--sock-priority', help='The sock priority of the tcp connection. Relevant only for TCP transport', type=int) 2615 p.add_argument('-l', '--acceptor-backlog', help='Pending connections allowed at one time. Relevant only for RDMA transport', type=int) 2616 p.add_argument('-x', '--abort-timeout-sec', help='Abort execution timeout value, in seconds', type=int) 2617 p.add_argument('-w', '--no-wr-batching', action='store_true', help='Disable work requests batching. Relevant only for RDMA transport') 2618 p.add_argument('-e', '--control-msg-num', help="""The number of control messages per poll group. 2619 Relevant only for TCP transport""", type=int) 2620 p.add_argument('-M', '--disable-mappable-bar0', action='store_true', help="""Disable mmap() of BAR0. 2621 Relevant only for VFIO-USER transport""") 2622 p.add_argument('-I', '--disable-adaptive-irq', action='store_true', help="""Disable adaptive interrupt feature. 2623 Relevant only for VFIO-USER transport""") 2624 p.add_argument('-S', '--disable-shadow-doorbells', action='store_true', help="""Disable shadow doorbell support. 2625 Relevant only for VFIO-USER transport""") 2626 p.add_argument('--acceptor-poll-rate', help='Polling interval of the acceptor for incoming connections (usec)', type=int) 2627 p.add_argument('--ack-timeout', help='ACK timeout in milliseconds', type=int) 2628 p.add_argument('--data-wr-pool-size', help='RDMA data WR pool size. Relevant only for RDMA transport', type=int) 2629 p.add_argument('--disable-command-passthru', help='Disallow command passthru', action='store_true') 2630 p.set_defaults(func=nvmf_create_transport) 2631 2632 def nvmf_get_transports(args): 2633 print_dict(rpc.nvmf.nvmf_get_transports(args.client, trtype=args.trtype, tgt_name=args.tgt_name)) 2634 2635 p = subparsers.add_parser('nvmf_get_transports', help='Display nvmf transports or required transport') 2636 p.add_argument('--trtype', help='Transport type (optional)') 2637 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2638 p.set_defaults(func=nvmf_get_transports) 2639 2640 def nvmf_get_subsystems(args): 2641 print_dict(rpc.nvmf.nvmf_get_subsystems(args.client, nqn=args.nqn, tgt_name=args.tgt_name)) 2642 2643 p = subparsers.add_parser('nvmf_get_subsystems', help='Display nvmf subsystems or required subsystem') 2644 p.add_argument('nqn', help='Subsystem NQN (optional)', nargs="?") 2645 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2646 p.set_defaults(func=nvmf_get_subsystems) 2647 2648 def nvmf_create_subsystem(args): 2649 rpc.nvmf.nvmf_create_subsystem(args.client, 2650 nqn=args.nqn, 2651 tgt_name=args.tgt_name, 2652 serial_number=args.serial_number, 2653 model_number=args.model_number, 2654 allow_any_host=args.allow_any_host, 2655 max_namespaces=args.max_namespaces, 2656 ana_reporting=args.ana_reporting, 2657 min_cntlid=args.min_cntlid, 2658 max_cntlid=args.max_cntlid, 2659 max_discard_size_kib=args.max_discard_size, 2660 max_write_zeroes_size_kib=args.max_write_zeroes_size, 2661 passthrough=args.passthrough) 2662 2663 p = subparsers.add_parser('nvmf_create_subsystem', help='Create an NVMe-oF subsystem') 2664 p.add_argument('nqn', help='Subsystem NQN (ASCII)') 2665 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2666 p.add_argument("-s", "--serial-number", help=""" 2667 Format: 'sn' etc 2668 Example: 'SPDK00000000000001'""") 2669 p.add_argument("-d", "--model-number", help=""" 2670 Format: 'mn' etc 2671 Example: 'SPDK Controller'""") 2672 p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce allowed host NQN list)") 2673 p.add_argument("-m", "--max-namespaces", help="Maximum number of namespaces allowed", 2674 type=int) 2675 p.add_argument("-r", "--ana-reporting", action='store_true', help="Enable ANA reporting feature") 2676 p.add_argument("-i", "--min_cntlid", help="Minimum controller ID", type=int) 2677 p.add_argument("-I", "--max_cntlid", help="Maximum controller ID", type=int) 2678 p.add_argument("--max-discard-size", help="Maximum discard size (Kib)", type=int) 2679 p.add_argument("--max-write-zeroes-size", help="Maximum write_zeroes size (Kib)", type=int) 2680 p.add_argument("-p", "--passthrough", action='store_true', help="""Use NVMe passthrough for all I/O commands and namespace-directed 2681 admin commands""") 2682 p.set_defaults(func=nvmf_create_subsystem) 2683 2684 def nvmf_delete_subsystem(args): 2685 rpc.nvmf.nvmf_delete_subsystem(args.client, 2686 nqn=args.subsystem_nqn, 2687 tgt_name=args.tgt_name) 2688 2689 p = subparsers.add_parser('nvmf_delete_subsystem', help='Delete a nvmf subsystem') 2690 p.add_argument('subsystem_nqn', 2691 help='subsystem nqn to be deleted. Example: nqn.2016-06.io.spdk:cnode1.') 2692 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2693 p.set_defaults(func=nvmf_delete_subsystem) 2694 2695 def nvmf_subsystem_add_listener(args): 2696 rpc.nvmf.nvmf_subsystem_add_listener(**vars(args)) 2697 2698 p = subparsers.add_parser('nvmf_subsystem_add_listener', help='Add a listener to an NVMe-oF subsystem') 2699 p.add_argument('nqn', help='NVMe-oF subsystem NQN (\'discovery\' can be used as shortcut for discovery NQN)') 2700 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2701 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2702 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2703 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2704 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for RDMA or TCP)') 2705 p.add_argument('-k', '--secure-channel', help='Immediately establish a secure channel', action="store_true") 2706 p.add_argument('-n', '--ana-state', help='ANA state to set: optimized, non_optimized, or inaccessible', type=str) 2707 p.add_argument('-S', '--sock-impl', help='The socket implementation to use for the listener (ex. posix)', type=str) 2708 p.set_defaults(func=nvmf_subsystem_add_listener) 2709 2710 def nvmf_subsystem_remove_listener(args): 2711 rpc.nvmf.nvmf_subsystem_remove_listener(args.client, 2712 nqn=args.nqn, 2713 trtype=args.trtype, 2714 traddr=args.traddr, 2715 tgt_name=args.tgt_name, 2716 adrfam=args.adrfam, 2717 trsvcid=args.trsvcid) 2718 2719 p = subparsers.add_parser('nvmf_subsystem_remove_listener', help='Remove a listener from an NVMe-oF subsystem') 2720 p.add_argument('nqn', help='NVMe-oF subsystem NQN (\'discovery\' can be used as shortcut for discovery NQN)') 2721 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2722 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2723 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2724 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2725 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for TCP and RDMA transport types)') 2726 p.set_defaults(func=nvmf_subsystem_remove_listener) 2727 2728 def nvmf_subsystem_listener_set_ana_state(args): 2729 rpc.nvmf.nvmf_subsystem_listener_set_ana_state(args.client, 2730 nqn=args.nqn, 2731 ana_state=args.ana_state, 2732 trtype=args.trtype, 2733 traddr=args.traddr, 2734 tgt_name=args.tgt_name, 2735 adrfam=args.adrfam, 2736 trsvcid=args.trsvcid, 2737 anagrpid=args.anagrpid) 2738 2739 p = subparsers.add_parser('nvmf_subsystem_listener_set_ana_state', help='Set ANA state of a listener for an NVMe-oF subsystem') 2740 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2741 p.add_argument('-n', '--ana-state', help='ANA state to set: optimized, non_optimized, or inaccessible', required=True) 2742 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2743 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2744 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2745 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2746 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number') 2747 p.add_argument('-g', '--anagrpid', help='ANA group ID (optional)', type=int) 2748 p.set_defaults(func=nvmf_subsystem_listener_set_ana_state) 2749 2750 def nvmf_discovery_add_referral(args): 2751 rpc.nvmf.nvmf_discovery_add_referral(**vars(args)) 2752 2753 p = subparsers.add_parser('nvmf_discovery_add_referral', help='Add a discovery service referral to an NVMe-oF target') 2754 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2755 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2756 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2757 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2758 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for RDMA or TCP)') 2759 p.add_argument('-k', '--secure-channel', help='The connection to that discovery subsystem requires a secure channel', 2760 action="store_true") 2761 p.add_argument('-n', '--subnqn', help='Subsystem NQN') 2762 p.set_defaults(func=nvmf_discovery_add_referral) 2763 2764 def nvmf_discovery_remove_referral(args): 2765 rpc.nvmf.nvmf_discovery_remove_referral(args.client, 2766 trtype=args.trtype, 2767 traddr=args.traddr, 2768 tgt_name=args.tgt_name, 2769 adrfam=args.adrfam, 2770 trsvcid=args.trsvcid, 2771 subnqn=args.subnqn) 2772 2773 p = subparsers.add_parser('nvmf_discovery_remove_referral', help='Remove a discovery service referral from an NVMe-oF target') 2774 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2775 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2776 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2777 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2778 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for TCP and RDMA transport types)') 2779 p.add_argument('-n', '--subnqn', help='Subsystem NQN') 2780 p.set_defaults(func=nvmf_discovery_remove_referral) 2781 2782 def nvmf_discovery_get_referrals(args): 2783 print_dict(rpc.nvmf.nvmf_discovery_get_referrals(args.client, 2784 tgt_name=args.tgt_name)) 2785 2786 p = subparsers.add_parser('nvmf_discovery_get_referrals', 2787 help='Display discovery subsystem referrals of an NVMe-oF target') 2788 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2789 p.set_defaults(func=nvmf_discovery_get_referrals) 2790 2791 def nvmf_subsystem_add_ns(args): 2792 rpc.nvmf.nvmf_subsystem_add_ns(**vars(args)) 2793 2794 p = subparsers.add_parser('nvmf_subsystem_add_ns', help='Add a namespace to an NVMe-oF subsystem') 2795 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2796 p.add_argument('bdev_name', help='The name of the bdev that will back this namespace') 2797 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2798 p.add_argument('-p', '--ptpl-file', help='The persistent reservation storage location (optional)', type=str) 2799 p.add_argument('-n', '--nsid', help='The requested NSID (optional)', type=int) 2800 p.add_argument('-g', '--nguid', help='Namespace globally unique identifier (optional)') 2801 p.add_argument('-e', '--eui64', help='Namespace EUI-64 identifier (optional)') 2802 p.add_argument('-u', '--uuid', help='Namespace UUID (optional)') 2803 p.add_argument('-a', '--anagrpid', help='ANA group ID (optional)', type=int) 2804 p.add_argument('-i', '--no-auto-visible', action='store_true', 2805 help='Do not auto make namespace visible to controllers (optional)') 2806 p.set_defaults(func=nvmf_subsystem_add_ns) 2807 2808 def nvmf_subsystem_set_ns_ana_group(args): 2809 rpc.nvmf.nvmf_subsystem_set_ns_ana_group(args.client, 2810 nqn=args.nqn, 2811 nsid=args.nsid, 2812 anagrpid=args.anagrpid, 2813 tgt_name=args.tgt_name) 2814 2815 p = subparsers.add_parser('nvmf_subsystem_set_ns_ana_group', help='Change ANA group ID of a namespace') 2816 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2817 p.add_argument('nsid', help='The requested NSID', type=int) 2818 p.add_argument('anagrpid', help='ANA group ID', type=int) 2819 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2820 p.set_defaults(func=nvmf_subsystem_set_ns_ana_group) 2821 2822 def nvmf_subsystem_remove_ns(args): 2823 rpc.nvmf.nvmf_subsystem_remove_ns(args.client, 2824 nqn=args.nqn, 2825 nsid=args.nsid, 2826 tgt_name=args.tgt_name) 2827 2828 p = subparsers.add_parser('nvmf_subsystem_remove_ns', help='Remove a namespace to an NVMe-oF subsystem') 2829 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2830 p.add_argument('nsid', help='The requested NSID', type=int) 2831 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2832 p.set_defaults(func=nvmf_subsystem_remove_ns) 2833 2834 def nvmf_ns_add_host(args): 2835 rpc.nvmf.nvmf_ns_visible(True, 2836 args.client, 2837 nqn=args.nqn, 2838 nsid=args.nsid, 2839 host=args.host, 2840 tgt_name=args.tgt_name) 2841 2842 def nvmf_ns_visible_add_args(p): 2843 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2844 p.add_argument('nsid', help='The requested NSID', type=int) 2845 p.add_argument('host', help='Host NQN to make namespace visible to') 2846 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2847 2848 p = subparsers.add_parser('nvmf_ns_add_host', help='Make namespace visible to controllers of host') 2849 nvmf_ns_visible_add_args(p) 2850 p.set_defaults(func=nvmf_ns_add_host) 2851 2852 def nvmf_ns_remove_host(args): 2853 rpc.nvmf.nvmf_ns_visible(False, 2854 args.client, 2855 nqn=args.nqn, 2856 nsid=args.nsid, 2857 host=args.host, 2858 tgt_name=args.tgt_name) 2859 2860 p = subparsers.add_parser('nvmf_ns_remove_host', help='Make namespace not visible to controllers of host') 2861 nvmf_ns_visible_add_args(p) 2862 p.set_defaults(func=nvmf_ns_remove_host) 2863 2864 def nvmf_subsystem_add_host(args): 2865 rpc.nvmf.nvmf_subsystem_add_host(args.client, 2866 nqn=args.nqn, 2867 host=args.host, 2868 tgt_name=args.tgt_name, 2869 psk=args.psk, 2870 dhchap_key=args.dhchap_key, 2871 dhchap_ctrlr_key=args.dhchap_ctrlr_key) 2872 2873 p = subparsers.add_parser('nvmf_subsystem_add_host', help='Add a host to an NVMe-oF subsystem') 2874 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2875 p.add_argument('host', help='Host NQN to allow') 2876 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2877 p.add_argument('--psk', help='Path to PSK file for TLS authentication (optional). Only applicable for TCP transport.', type=str) 2878 p.add_argument('--dhchap-key', help='DH-HMAC-CHAP key name (optional)') 2879 p.add_argument('--dhchap-ctrlr-key', help='DH-HMAC-CHAP controller key name (optional)') 2880 p.set_defaults(func=nvmf_subsystem_add_host) 2881 2882 def nvmf_subsystem_remove_host(args): 2883 rpc.nvmf.nvmf_subsystem_remove_host(args.client, 2884 nqn=args.nqn, 2885 host=args.host, 2886 tgt_name=args.tgt_name) 2887 2888 p = subparsers.add_parser('nvmf_subsystem_remove_host', help='Remove a host from an NVMe-oF subsystem') 2889 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2890 p.add_argument('host', help='Host NQN to remove') 2891 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2892 p.set_defaults(func=nvmf_subsystem_remove_host) 2893 2894 def nvmf_subsystem_set_keys(args): 2895 rpc.nvmf.nvmf_subsystem_set_keys(args.client, 2896 nqn=args.nqn, 2897 host=args.host, 2898 tgt_name=args.tgt_name, 2899 dhchap_key=args.dhchap_key, 2900 dhchap_ctrlr_key=args.dhchap_ctrlr_key) 2901 2902 p = subparsers.add_parser('nvmf_subsystem_set_keys', help='Set keys required for a host to connect to a given subsystem') 2903 p.add_argument('nqn', help='Subsystem NQN') 2904 p.add_argument('host', help='Host NQN') 2905 p.add_argument('-t', '--tgt-name', help='Name of the NVMe-oF target') 2906 p.add_argument('--dhchap-key', help='DH-HMAC-CHAP key name') 2907 p.add_argument('--dhchap-ctrlr-key', help='DH-HMAC-CHAP controller key name') 2908 p.set_defaults(func=nvmf_subsystem_set_keys) 2909 2910 def nvmf_subsystem_allow_any_host(args): 2911 rpc.nvmf.nvmf_subsystem_allow_any_host(args.client, 2912 nqn=args.nqn, 2913 disable=args.disable, 2914 tgt_name=args.tgt_name) 2915 2916 p = subparsers.add_parser('nvmf_subsystem_allow_any_host', help='Allow any host to connect to the subsystem') 2917 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2918 p.add_argument('-e', '--enable', action='store_true', help='Enable allowing any host') 2919 p.add_argument('-d', '--disable', action='store_true', help='Disable allowing any host') 2920 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2921 p.set_defaults(func=nvmf_subsystem_allow_any_host) 2922 2923 def nvmf_subsystem_get_controllers(args): 2924 print_dict(rpc.nvmf.nvmf_subsystem_get_controllers(args.client, 2925 nqn=args.nqn, 2926 tgt_name=args.tgt_name)) 2927 2928 p = subparsers.add_parser('nvmf_subsystem_get_controllers', 2929 help='Display controllers of an NVMe-oF subsystem.') 2930 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 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_get_controllers) 2933 2934 def nvmf_subsystem_get_qpairs(args): 2935 print_dict(rpc.nvmf.nvmf_subsystem_get_qpairs(args.client, 2936 nqn=args.nqn, 2937 tgt_name=args.tgt_name)) 2938 2939 p = subparsers.add_parser('nvmf_subsystem_get_qpairs', 2940 help='Display queue pairs 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_qpairs) 2944 2945 def nvmf_subsystem_get_listeners(args): 2946 print_dict(rpc.nvmf.nvmf_subsystem_get_listeners(args.client, 2947 nqn=args.nqn, 2948 tgt_name=args.tgt_name)) 2949 2950 p = subparsers.add_parser('nvmf_subsystem_get_listeners', 2951 help='Display listeners 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_listeners) 2955 2956 def nvmf_get_stats(args): 2957 print_dict(rpc.nvmf.nvmf_get_stats(args.client, tgt_name=args.tgt_name)) 2958 2959 p = subparsers.add_parser( 2960 'nvmf_get_stats', help='Display current statistics for NVMf subsystem') 2961 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2962 p.set_defaults(func=nvmf_get_stats) 2963 2964 def nvmf_set_crdt(args): 2965 print_dict(rpc.nvmf.nvmf_set_crdt(args.client, args.crdt1, args.crdt2, args.crdt3)) 2966 2967 p = subparsers.add_parser( 2968 'nvmf_set_crdt', 2969 help="""Set the 3 crdt (Command Retry Delay Time) values for NVMf subsystem. All 2970 values are in units of 100 milliseconds (same as the NVM Express specification).""") 2971 p.add_argument('-t1', '--crdt1', help='Command Retry Delay Time 1, in units of 100 milliseconds', type=int) 2972 p.add_argument('-t2', '--crdt2', help='Command Retry Delay Time 2, in units of 100 milliseconds', type=int) 2973 p.add_argument('-t3', '--crdt3', help='Command Retry Delay Time 3, in units of 100 milliseconds', type=int) 2974 p.set_defaults(func=nvmf_set_crdt) 2975 2976 def nvmf_publish_mdns_prr(args): 2977 rpc.nvmf.nvmf_publish_mdns_prr(args.client, args.tgt_name) 2978 2979 p = subparsers.add_parser('nvmf_publish_mdns_prr', 2980 help='Publish pull registration request through mdns') 2981 p.add_argument('-t', '--tgt-name', help='The name of the NVMe-oF target (optional)', type=str) 2982 p.set_defaults(func=nvmf_publish_mdns_prr) 2983 2984 def nvmf_stop_mdns_prr(args): 2985 rpc.nvmf.nvmf_stop_mdns_prr(args.client, args.tgt_name) 2986 2987 p = subparsers.add_parser('nvmf_stop_mdns_prr', 2988 help='Stop publishing pull registration request through mdns') 2989 p.add_argument('-t', '--tgt-name', help='The name of the NVMe-oF target (optional)', type=str) 2990 p.set_defaults(func=nvmf_stop_mdns_prr) 2991 2992 # subsystem 2993 def framework_get_subsystems(args): 2994 print_dict(rpc.subsystem.framework_get_subsystems(args.client)) 2995 2996 p = subparsers.add_parser('framework_get_subsystems', 2997 help="""Print subsystems array in initialization order. Each subsystem 2998 entry contain (unsorted) array of subsystems it depends on.""") 2999 p.set_defaults(func=framework_get_subsystems) 3000 3001 def framework_get_config(args): 3002 print_dict(rpc.subsystem.framework_get_config(args.client, args.name)) 3003 3004 p = subparsers.add_parser('framework_get_config', help="""Print subsystem configuration""") 3005 p.add_argument('name', help='Name of subsystem to query') 3006 p.set_defaults(func=framework_get_config) 3007 3008 # vhost 3009 def vhost_controller_set_coalescing(args): 3010 rpc.vhost.vhost_controller_set_coalescing(args.client, 3011 ctrlr=args.ctrlr, 3012 delay_base_us=args.delay_base_us, 3013 iops_threshold=args.iops_threshold) 3014 3015 p = subparsers.add_parser('vhost_controller_set_coalescing', help='Set vhost controller coalescing') 3016 p.add_argument('ctrlr', help='controller name') 3017 p.add_argument('delay_base_us', help='Base delay time', type=int) 3018 p.add_argument('iops_threshold', help='IOPS threshold when coalescing is enabled', type=int) 3019 p.set_defaults(func=vhost_controller_set_coalescing) 3020 3021 def virtio_blk_create_transport(args): 3022 rpc.vhost.virtio_blk_create_transport(**vars(args)) 3023 3024 p = subparsers.add_parser('virtio_blk_create_transport', 3025 help='Create virtio blk transport') 3026 p.add_argument('name', help='transport name') 3027 p.set_defaults(func=virtio_blk_create_transport) 3028 3029 def virtio_blk_get_transports(args): 3030 print_dict(rpc.vhost.virtio_blk_get_transports(args.client, name=args.name)) 3031 3032 p = subparsers.add_parser('virtio_blk_get_transports', help='Display virtio-blk transports or requested transport') 3033 p.add_argument('--name', help='Transport name (optional)', type=str) 3034 p.set_defaults(func=virtio_blk_get_transports) 3035 3036 def vhost_create_scsi_controller(args): 3037 rpc.vhost.vhost_create_scsi_controller(args.client, 3038 ctrlr=args.ctrlr, 3039 cpumask=args.cpumask, 3040 delay=args.delay) 3041 3042 p = subparsers.add_parser('vhost_create_scsi_controller', help='Add new vhost controller') 3043 p.add_argument('ctrlr', help='controller name') 3044 p.add_argument('--cpumask', help='cpu mask for this controller') 3045 p.add_argument("--delay", action='store_true', help='whether delay starting controller or not') 3046 p.set_defaults(func=vhost_create_scsi_controller) 3047 3048 def vhost_start_scsi_controller(args): 3049 rpc.vhost.vhost_start_scsi_controller(args.client, 3050 ctrlr=args.ctrlr) 3051 3052 p = subparsers.add_parser('vhost_start_scsi_controller', help='Start vhost scsi controller') 3053 p.add_argument('ctrlr', help='controller name') 3054 p.set_defaults(func=vhost_start_scsi_controller) 3055 3056 def vhost_scsi_controller_add_target(args): 3057 print_json(rpc.vhost.vhost_scsi_controller_add_target(args.client, 3058 ctrlr=args.ctrlr, 3059 scsi_target_num=args.scsi_target_num, 3060 bdev_name=args.bdev_name)) 3061 3062 p = subparsers.add_parser('vhost_scsi_controller_add_target', help='Add lun to vhost controller') 3063 p.add_argument('ctrlr', help='controller name where add lun') 3064 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 3065 p.add_argument('bdev_name', help='bdev name') 3066 p.set_defaults(func=vhost_scsi_controller_add_target) 3067 3068 def vhost_scsi_controller_remove_target(args): 3069 rpc.vhost.vhost_scsi_controller_remove_target(args.client, 3070 ctrlr=args.ctrlr, 3071 scsi_target_num=args.scsi_target_num) 3072 3073 p = subparsers.add_parser('vhost_scsi_controller_remove_target', 3074 help='Remove target from vhost controller') 3075 p.add_argument('ctrlr', help='controller name to remove target from') 3076 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 3077 p.set_defaults(func=vhost_scsi_controller_remove_target) 3078 3079 def vhost_create_blk_controller(args): 3080 rpc.vhost.vhost_create_blk_controller(**vars(args)) 3081 3082 p = subparsers.add_parser('vhost_create_blk_controller', help='Add a new vhost block controller') 3083 p.add_argument('ctrlr', help='controller name') 3084 p.add_argument('dev_name', help='device name') 3085 p.add_argument('--cpumask', help='cpu mask for this controller') 3086 p.add_argument('--transport', help='virtio blk transport name (default: vhost_user_blk)') 3087 p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only') 3088 p.add_argument("-p", "--packed_ring", action='store_true', help='Set controller as packed ring supported') 3089 p.set_defaults(func=vhost_create_blk_controller) 3090 3091 def vhost_get_controllers(args): 3092 print_dict(rpc.vhost.vhost_get_controllers(args.client, args.name)) 3093 3094 p = subparsers.add_parser('vhost_get_controllers', help='List all or specific vhost controller(s)') 3095 p.add_argument('-n', '--name', help="Name of vhost controller") 3096 p.set_defaults(func=vhost_get_controllers) 3097 3098 def vhost_delete_controller(args): 3099 rpc.vhost.vhost_delete_controller(args.client, 3100 ctrlr=args.ctrlr) 3101 3102 p = subparsers.add_parser('vhost_delete_controller', help='Delete a vhost controller') 3103 p.add_argument('ctrlr', help='controller name') 3104 p.set_defaults(func=vhost_delete_controller) 3105 3106 def bdev_virtio_attach_controller(args): 3107 print_array(rpc.vhost.bdev_virtio_attach_controller(args.client, 3108 name=args.name, 3109 trtype=args.trtype, 3110 traddr=args.traddr, 3111 dev_type=args.dev_type, 3112 vq_count=args.vq_count, 3113 vq_size=args.vq_size)) 3114 3115 p = subparsers.add_parser('bdev_virtio_attach_controller', 3116 help="""Attach virtio controller using provided 3117 transport type and device type. This will also create bdevs for any block devices connected to the 3118 controller (for example, SCSI devices for a virtio-scsi controller). 3119 Result is array of added bdevs.""") 3120 p.add_argument('name', help="Use this name as base for new created bdevs") 3121 p.add_argument('-t', '--trtype', 3122 help='Virtio target transport type: pci or user', required=True) 3123 p.add_argument('-a', '--traddr', 3124 help='Transport type specific target address: e.g. UNIX domain socket path or BDF', required=True) 3125 p.add_argument('-d', '--dev-type', 3126 help='Device type: blk or scsi', required=True) 3127 p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int) 3128 p.add_argument('--vq-size', help='Size of each queue', type=int) 3129 p.set_defaults(func=bdev_virtio_attach_controller) 3130 3131 def bdev_virtio_scsi_get_devices(args): 3132 print_dict(rpc.vhost.bdev_virtio_scsi_get_devices(args.client)) 3133 3134 p = subparsers.add_parser('bdev_virtio_scsi_get_devices', help='List all Virtio-SCSI devices.') 3135 p.set_defaults(func=bdev_virtio_scsi_get_devices) 3136 3137 def bdev_virtio_detach_controller(args): 3138 rpc.vhost.bdev_virtio_detach_controller(args.client, 3139 name=args.name) 3140 3141 p = subparsers.add_parser('bdev_virtio_detach_controller', help="""Remove a Virtio device 3142 This will delete all bdevs exposed by this device""") 3143 p.add_argument('name', help='Virtio device name. E.g. VirtioUser0') 3144 p.set_defaults(func=bdev_virtio_detach_controller) 3145 3146 def bdev_virtio_blk_set_hotplug(args): 3147 rpc.vhost.bdev_virtio_blk_set_hotplug(args.client, enable=args.enable, period_us=args.period_us) 3148 3149 p = subparsers.add_parser('bdev_virtio_blk_set_hotplug', help='Set hotplug options for bdev virtio_blk type.') 3150 p.add_argument('-d', '--disable', dest='enable', default=False, action='store_false', help="Disable hotplug (default)") 3151 p.add_argument('-e', '--enable', dest='enable', action='store_true', help="Enable hotplug") 3152 p.add_argument('-r', '--period-us', 3153 help='How often the hotplug is processed for insert and remove events', type=int) 3154 p.set_defaults(func=bdev_virtio_blk_set_hotplug) 3155 3156 # vfio-user target 3157 def vfu_tgt_set_base_path(args): 3158 rpc.vfio_user.vfu_tgt_set_base_path(args.client, path=args.path) 3159 3160 p = subparsers.add_parser('vfu_tgt_set_base_path', help='Set socket base path.') 3161 p.add_argument('path', help='socket base path') 3162 p.set_defaults(func=vfu_tgt_set_base_path) 3163 3164 def vfu_virtio_delete_endpoint(args): 3165 rpc.vfio_user.vfu_virtio_delete_endpoint(args.client, name=args.name) 3166 3167 p = subparsers.add_parser('vfu_virtio_delete_endpoint', help='Delete the PCI device via endpoint name.') 3168 p.add_argument('name', help='Endpoint name') 3169 p.set_defaults(func=vfu_virtio_delete_endpoint) 3170 3171 def vfu_virtio_create_blk_endpoint(args): 3172 rpc.vfio_user.vfu_virtio_create_blk_endpoint(args.client, 3173 name=args.name, 3174 bdev_name=args.bdev_name, 3175 cpumask=args.cpumask, 3176 num_queues=args.num_queues, 3177 qsize=args.qsize, 3178 packed_ring=args.packed_ring) 3179 3180 p = subparsers.add_parser('vfu_virtio_create_blk_endpoint', help='Create virtio-blk endpoint.') 3181 p.add_argument('name', help='Name of the endpoint') 3182 p.add_argument('--bdev-name', help='block device name', type=str, required=True) 3183 p.add_argument('--cpumask', help='CPU masks') 3184 p.add_argument('--num-queues', help='number of vrings', type=int, default=0) 3185 p.add_argument('--qsize', help='number of element for each vring', type=int, default=0) 3186 p.add_argument("--packed-ring", action='store_true', help='Enable packed ring') 3187 p.set_defaults(func=vfu_virtio_create_blk_endpoint) 3188 3189 def vfu_virtio_scsi_add_target(args): 3190 rpc.vfio_user.vfu_virtio_scsi_add_target(args.client, 3191 name=args.name, 3192 scsi_target_num=args.scsi_target_num, 3193 bdev_name=args.bdev_name) 3194 3195 p = subparsers.add_parser('vfu_virtio_scsi_add_target', help='Attach a block device to SCSI target of PCI endpoint.') 3196 p.add_argument('name', help='Name of the endpoint') 3197 p.add_argument('--scsi-target-num', help='number of SCSI Target', type=int, required=True) 3198 p.add_argument('--bdev-name', help='block device name', type=str, required=True) 3199 p.set_defaults(func=vfu_virtio_scsi_add_target) 3200 3201 def vfu_virtio_scsi_remove_target(args): 3202 rpc.vfio_user.vfu_virtio_scsi_remove_target(args.client, 3203 name=args.name, 3204 scsi_target_num=args.scsi_target_num) 3205 3206 p = subparsers.add_parser('vfu_virtio_scsi_remove_target', help='Remove the specified 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.set_defaults(func=vfu_virtio_scsi_remove_target) 3210 3211 def vfu_virtio_create_scsi_endpoint(args): 3212 rpc.vfio_user.vfu_virtio_create_scsi_endpoint(args.client, 3213 name=args.name, 3214 cpumask=args.cpumask, 3215 num_io_queues=args.num_io_queues, 3216 qsize=args.qsize, 3217 packed_ring=args.packed_ring) 3218 3219 p = subparsers.add_parser('vfu_virtio_create_scsi_endpoint', help='Create virtio-scsi endpoint.') 3220 p.add_argument('name', help='Name of the endpoint') 3221 p.add_argument('--cpumask', help='CPU masks') 3222 p.add_argument('--num-io-queues', help='number of IO vrings', type=int, default=0) 3223 p.add_argument('--qsize', help='number of element for each vring', type=int, default=0) 3224 p.add_argument("--packed-ring", action='store_true', help='Enable packed ring') 3225 p.set_defaults(func=vfu_virtio_create_scsi_endpoint) 3226 3227 def vfu_virtio_create_fs_endpoint(args): 3228 rpc.vfio_user.vfu_virtio_create_fs_endpoint(args.client, 3229 name=args.name, 3230 fsdev_name=args.fsdev_name, 3231 tag=args.tag, 3232 cpumask=args.cpumask, 3233 num_queues=args.num_queues, 3234 qsize=args.qsize, 3235 packed_ring=args.packed_ring) 3236 3237 p = subparsers.add_parser('vfu_virtio_create_fs_endpoint', help='Create virtio-fs endpoint.') 3238 p.add_argument('name', help='Name of the endpoint') 3239 p.add_argument('--fsdev-name', help='fsdev name', type=str, required=True) 3240 p.add_argument('--tag', help='virtiofs tag', type=str, required=True) 3241 p.add_argument('--cpumask', help='CPU masks') 3242 p.add_argument('--num-queues', help='number of vrings', type=int, default=0) 3243 p.add_argument('--qsize', help='number of element for each vring', type=int, default=0) 3244 p.add_argument("--packed-ring", action='store_true', help='Enable packed ring') 3245 p.set_defaults(func=vfu_virtio_create_fs_endpoint) 3246 3247 # accel_fw 3248 def accel_get_opc_assignments(args): 3249 print_dict(rpc.accel.accel_get_opc_assignments(args.client)) 3250 3251 p = subparsers.add_parser('accel_get_opc_assignments', help='Get list of opcode name to module assignments.') 3252 p.set_defaults(func=accel_get_opc_assignments) 3253 3254 def accel_get_module_info(args): 3255 print_dict(rpc.accel.accel_get_module_info(args.client)) 3256 3257 p = subparsers.add_parser('accel_get_module_info', aliases=['accel_get_engine_info'], 3258 help='Get list of valid module names and their operations.') 3259 p.set_defaults(func=accel_get_module_info) 3260 3261 def accel_assign_opc(args): 3262 rpc.accel.accel_assign_opc(args.client, opname=args.opname, module=args.module) 3263 3264 p = subparsers.add_parser('accel_assign_opc', help='Manually assign an operation to a module.') 3265 p.add_argument('-o', '--opname', help='opname') 3266 p.add_argument('-m', '--module', help='name of module') 3267 p.set_defaults(func=accel_assign_opc) 3268 3269 def accel_crypto_key_create(args): 3270 print_dict(rpc.accel.accel_crypto_key_create(args.client, 3271 cipher=args.cipher, 3272 key=args.key, 3273 key2=args.key2, 3274 tweak_mode=args.tweak_mode, 3275 name=args.name)) 3276 3277 p = subparsers.add_parser('accel_crypto_key_create', help='Create encryption key') 3278 p.add_argument('-c', '--cipher', help='cipher', required=True) 3279 p.add_argument('-k', '--key', help='key', required=True) 3280 p.add_argument('-e', '--key2', help='key2', default=None) 3281 p.add_argument('-t', '--tweak-mode', help='tweak mode', default=None) 3282 p.add_argument('-n', '--name', help='key name', required=True) 3283 p.set_defaults(func=accel_crypto_key_create) 3284 3285 def accel_crypto_key_destroy(args): 3286 print_dict(rpc.accel.accel_crypto_key_destroy(args.client, 3287 key_name=args.name)) 3288 3289 p = subparsers.add_parser('accel_crypto_key_destroy', help='Destroy encryption key') 3290 p.add_argument('-n', '--name', help='key name', required=True, type=str) 3291 p.set_defaults(func=accel_crypto_key_destroy) 3292 3293 def accel_crypto_keys_get(args): 3294 print_dict(rpc.accel.accel_crypto_keys_get(args.client, 3295 key_name=args.key_name)) 3296 3297 p = subparsers.add_parser('accel_crypto_keys_get', help='Get a list of the crypto keys') 3298 p.add_argument('-k', '--key-name', help='Get information about a specific key', type=str) 3299 p.set_defaults(func=accel_crypto_keys_get) 3300 3301 def accel_set_driver(args): 3302 rpc.accel.accel_set_driver(args.client, name=args.name) 3303 3304 p = subparsers.add_parser('accel_set_driver', help='Select accel platform driver to execute ' + 3305 'operation chains') 3306 p.add_argument('name', help='name of the platform driver') 3307 p.set_defaults(func=accel_set_driver) 3308 3309 def accel_set_options(args): 3310 rpc.accel.accel_set_options(args.client, args.small_cache_size, args.large_cache_size, 3311 args.task_count, args.sequence_count, args.buf_count) 3312 3313 p = subparsers.add_parser('accel_set_options', help='Set accel framework\'s options') 3314 p.add_argument('--small-cache-size', type=int, help='Size of the small iobuf cache') 3315 p.add_argument('--large-cache-size', type=int, help='Size of the large iobuf cache') 3316 p.add_argument('--task-count', type=int, help='Maximum number of tasks per IO channel') 3317 p.add_argument('--sequence-count', type=int, help='Maximum number of sequences per IO channel') 3318 p.add_argument('--buf-count', type=int, help='Maximum number of buffers per IO channel') 3319 p.set_defaults(func=accel_set_options) 3320 3321 def accel_get_stats(args): 3322 print_dict(rpc.accel.accel_get_stats(args.client)) 3323 3324 p = subparsers.add_parser('accel_get_stats', help='Display accel framework\'s statistics') 3325 p.set_defaults(func=accel_get_stats) 3326 3327 # ioat 3328 def ioat_scan_accel_module(args): 3329 rpc.ioat.ioat_scan_accel_module(args.client) 3330 3331 p = subparsers.add_parser('ioat_scan_accel_module', aliases=['ioat_scan_accel_engine'], 3332 help='Enable IOAT accel module offload.') 3333 p.set_defaults(func=ioat_scan_accel_module) 3334 3335 # dpdk compressdev 3336 def compressdev_scan_accel_module(args): 3337 rpc.compressdev.compressdev_scan_accel_module(args.client, pmd=args.pmd) 3338 3339 p = subparsers.add_parser('compressdev_scan_accel_module', help='Scan and enable compressdev module and set pmd option.') 3340 p.add_argument('-p', '--pmd', type=int, help='0 = auto-select, 1= QAT only, 2 = mlx5_pci only, 3 = uadk only') 3341 p.set_defaults(func=compressdev_scan_accel_module) 3342 3343 # dsa 3344 def dsa_scan_accel_module(args): 3345 rpc.dsa.dsa_scan_accel_module(args.client, config_kernel_mode=args.config_kernel_mode) 3346 3347 p = subparsers.add_parser('dsa_scan_accel_module', aliases=['dsa_scan_accel_engine'], 3348 help='Set config and enable dsa accel module offload.') 3349 p.add_argument('-k', '--config-kernel-mode', help='Use Kernel mode dsa', 3350 action='store_true', dest='config_kernel_mode') 3351 p.set_defaults(func=dsa_scan_accel_module, config_kernel_mode=None) 3352 3353 # iaa 3354 def iaa_scan_accel_module(args): 3355 rpc.iaa.iaa_scan_accel_module(args.client) 3356 3357 p = subparsers.add_parser('iaa_scan_accel_module', aliases=['iaa_scan_accel_engine'], 3358 help='Set config and enable iaa accel module offload.') 3359 p.set_defaults(func=iaa_scan_accel_module) 3360 3361 def dpdk_cryptodev_scan_accel_module(args): 3362 rpc.dpdk_cryptodev.dpdk_cryptodev_scan_accel_module(args.client) 3363 3364 p = subparsers.add_parser('dpdk_cryptodev_scan_accel_module', 3365 help='Enable dpdk_cryptodev accel module offload.') 3366 p.set_defaults(func=dpdk_cryptodev_scan_accel_module) 3367 3368 def dpdk_cryptodev_set_driver(args): 3369 rpc.dpdk_cryptodev.dpdk_cryptodev_set_driver(args.client, 3370 driver_name=args.driver_name) 3371 3372 p = subparsers.add_parser('dpdk_cryptodev_set_driver', 3373 help='Set the DPDK cryptodev driver.') 3374 p.add_argument('-d', '--driver-name', help='The driver, can be one of crypto_aesni_mb, crypto_qat or mlx5_pci', type=str) 3375 p.set_defaults(func=dpdk_cryptodev_set_driver) 3376 3377 def dpdk_cryptodev_get_driver(args): 3378 print_dict(rpc.dpdk_cryptodev.dpdk_cryptodev_get_driver(args.client)) 3379 3380 p = subparsers.add_parser('dpdk_cryptodev_get_driver', help='Get the DPDK cryptodev driver') 3381 p.set_defaults(func=dpdk_cryptodev_get_driver) 3382 3383 # mlx5 3384 def mlx5_scan_accel_module(args): 3385 rpc.mlx5.mlx5_scan_accel_module(args.client, 3386 qp_size=args.qp_size, 3387 num_requests=args.num_requests, 3388 allowed_devs=args.allowed_devs, 3389 crypto_split_blocks=args.crypto_split_blocks) 3390 3391 p = subparsers.add_parser('mlx5_scan_accel_module', help='Enable mlx5 accel module.') 3392 p.add_argument('-q', '--qp-size', type=int, help='QP size') 3393 p.add_argument('-r', '--num-requests', type=int, help='Size of the shared requests pool') 3394 p.add_argument('-d', '--allowed-devs', help="Comma separated list of allowed device names, e.g. mlx5_0,mlx5_1") 3395 p.add_argument('-s', '--crypto-split-blocks', type=int, 3396 help="Number of data blocks to be processed in 1 crypto UMR. [0-65535], 0 means no limit") 3397 p.set_defaults(func=mlx5_scan_accel_module) 3398 3399 def accel_mlx5_dump_stats(args): 3400 print_dict(rpc.mlx5.accel_mlx5_dump_stats(args.client, level=args.level)) 3401 3402 p = subparsers.add_parser('accel_mlx5_dump_stats', help='Dump accel mlx5 module statistics.') 3403 p.add_argument('-l', '--level', type=str, help='Verbose level, one of \"total\", \"channel\" or \"device\"') 3404 p.set_defaults(func=accel_mlx5_dump_stats) 3405 3406 # accel_error 3407 def accel_error_inject_error(args): 3408 rpc.accel.accel_error_inject_error(args.client, opcode=args.opcode, 3409 type=args.type, count=args.count, 3410 interval=args.interval, errcode=args.errcode) 3411 3412 p = subparsers.add_parser('accel_error_inject_error', 3413 help='Inject an error to processing accel operation') 3414 p.add_argument('-o', '--opcode', help='Opcode') 3415 p.add_argument('-t', '--type', 3416 help='Error type ("corrupt": corrupt the data, "failure": fail the operation, "disable": disable error injection)') 3417 p.add_argument('-c', '--count', type=int, 3418 help='Number of errors to inject on each IO channel (0 to disable error injection)') 3419 p.add_argument('-i', '--interval', type=int, help='Interval between injections') 3420 p.add_argument('--errcode', type=int, help='Error code to inject (only relevant for type=failure)') 3421 p.set_defaults(func=accel_error_inject_error) 3422 3423 # opal 3424 def bdev_nvme_opal_init(args): 3425 rpc.nvme.bdev_nvme_opal_init(args.client, 3426 nvme_ctrlr_name=args.nvme_ctrlr_name, 3427 password=args.password) 3428 3429 p = subparsers.add_parser('bdev_nvme_opal_init', help='take ownership and activate') 3430 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name') 3431 p.add_argument('-p', '--password', help='password for admin') 3432 p.set_defaults(func=bdev_nvme_opal_init) 3433 3434 def bdev_nvme_opal_revert(args): 3435 rpc.nvme.bdev_nvme_opal_revert(args.client, 3436 nvme_ctrlr_name=args.nvme_ctrlr_name, 3437 password=args.password) 3438 p = subparsers.add_parser('bdev_nvme_opal_revert', help='Revert to default factory settings') 3439 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name') 3440 p.add_argument('-p', '--password', help='password') 3441 p.set_defaults(func=bdev_nvme_opal_revert) 3442 3443 def bdev_opal_create(args): 3444 print_json(rpc.bdev.bdev_opal_create(args.client, 3445 nvme_ctrlr_name=args.nvme_ctrlr_name, 3446 nsid=args.nsid, 3447 locking_range_id=args.locking_range_id, 3448 range_start=args.range_start, 3449 range_length=args.range_length, 3450 password=args.password)) 3451 3452 p = subparsers.add_parser('bdev_opal_create', help="""Create opal bdev on specified NVMe controller""") 3453 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name', required=True) 3454 p.add_argument('-n', '--nsid', help='namespace ID (only support nsid=1 for now)', type=int, required=True) 3455 p.add_argument('-i', '--locking-range-id', help='locking range id', type=int, required=True) 3456 p.add_argument('-s', '--range-start', help='locking range start LBA', type=int, required=True) 3457 p.add_argument('-l', '--range-length', help='locking range length (in blocks)', type=int, required=True) 3458 p.add_argument('-p', '--password', help='admin password', required=True) 3459 p.set_defaults(func=bdev_opal_create) 3460 3461 def bdev_opal_get_info(args): 3462 print_dict(rpc.bdev.bdev_opal_get_info(args.client, 3463 bdev_name=args.bdev_name, 3464 password=args.password)) 3465 3466 p = subparsers.add_parser('bdev_opal_get_info', help='get opal locking range info for this bdev') 3467 p.add_argument('-b', '--bdev-name', help='opal bdev') 3468 p.add_argument('-p', '--password', help='password') 3469 p.set_defaults(func=bdev_opal_get_info) 3470 3471 def bdev_opal_delete(args): 3472 rpc.bdev.bdev_opal_delete(args.client, 3473 bdev_name=args.bdev_name, 3474 password=args.password) 3475 3476 p = subparsers.add_parser('bdev_opal_delete', help="""delete a virtual opal bdev""") 3477 p.add_argument('-b', '--bdev-name', help='opal virtual bdev', required=True) 3478 p.add_argument('-p', '--password', help='admin password', required=True) 3479 p.set_defaults(func=bdev_opal_delete) 3480 3481 def bdev_opal_new_user(args): 3482 rpc.bdev.bdev_opal_new_user(args.client, 3483 bdev_name=args.bdev_name, 3484 admin_password=args.admin_password, 3485 user_id=args.user_id, 3486 user_password=args.user_password) 3487 3488 p = subparsers.add_parser('bdev_opal_new_user', help="""Add a user to opal bdev who can set lock state for this bdev""") 3489 p.add_argument('-b', '--bdev-name', help='opal bdev', required=True) 3490 p.add_argument('-p', '--admin-password', help='admin password', required=True) 3491 p.add_argument('-i', '--user-id', help='ID for new user', type=int, required=True) 3492 p.add_argument('-u', '--user-password', help='password set for this user', required=True) 3493 p.set_defaults(func=bdev_opal_new_user) 3494 3495 def bdev_opal_set_lock_state(args): 3496 rpc.bdev.bdev_opal_set_lock_state(args.client, 3497 bdev_name=args.bdev_name, 3498 user_id=args.user_id, 3499 password=args.password, 3500 lock_state=args.lock_state) 3501 3502 p = subparsers.add_parser('bdev_opal_set_lock_state', help="""set lock state for an opal bdev""") 3503 p.add_argument('-b', '--bdev-name', help='opal bdev', required=True) 3504 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', 3505 type=int, required=True) 3506 p.add_argument('-p', '--password', help='password of this user', required=True) 3507 p.add_argument('-l', '--lock-state', help='lock state to set, choose from {readwrite, readonly, rwlock}', required=True) 3508 p.set_defaults(func=bdev_opal_set_lock_state) 3509 3510 # bdev_nvme_send_cmd 3511 def bdev_nvme_send_cmd(args): 3512 print_dict(rpc.nvme.bdev_nvme_send_cmd(args.client, 3513 name=args.nvme_name, 3514 cmd_type=args.cmd_type, 3515 data_direction=args.data_direction, 3516 cmdbuf=args.cmdbuf, 3517 data=args.data, 3518 metadata=args.metadata, 3519 data_len=args.data_length, 3520 metadata_len=args.metadata_length, 3521 timeout_ms=args.timeout_ms)) 3522 3523 p = subparsers.add_parser('bdev_nvme_send_cmd', help='NVMe passthrough cmd.') 3524 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""") 3525 p.add_argument('-t', '--cmd-type', help="""Type of nvme cmd. Valid values are: admin, io""") 3526 p.add_argument('-r', '--data-direction', help="""Direction of data transfer. Valid values are: c2h, h2c""") 3527 p.add_argument('-c', '--cmdbuf', help="""NVMe command encoded by base64 urlsafe""") 3528 p.add_argument('-d', '--data', help="""Data transferring to controller from host, encoded by base64 urlsafe""") 3529 p.add_argument('-m', '--metadata', help="""Metadata transferring to controller from host, encoded by base64 urlsafe""") 3530 p.add_argument('-D', '--data-length', help="""Data length required to transfer from controller to host""", type=int) 3531 p.add_argument('-M', '--metadata-length', help="""Metadata length required to transfer from controller to host""", type=int) 3532 p.add_argument('-T', '--timeout-ms', 3533 help="""Command execution timeout value, in milliseconds, if 0, don't track timeout""", type=int) 3534 p.set_defaults(func=bdev_nvme_send_cmd) 3535 3536 # Notifications 3537 def notify_get_types(args): 3538 print_dict(rpc.notify.notify_get_types(args.client)) 3539 3540 p = subparsers.add_parser('notify_get_types', help='List available notifications that user can subscribe to.') 3541 p.set_defaults(func=notify_get_types) 3542 3543 def notify_get_notifications(args): 3544 ret = rpc.notify.notify_get_notifications(args.client, 3545 id=args.id, 3546 max=args.max) 3547 print_dict(ret) 3548 3549 p = subparsers.add_parser('notify_get_notifications', help='Get notifications') 3550 p.add_argument('-i', '--id', help="""First ID to start fetching from""", type=int) 3551 p.add_argument('-n', '--max', help="""Maximum number of notifications to return in response""", type=int) 3552 p.set_defaults(func=notify_get_notifications) 3553 3554 def thread_get_stats(args): 3555 print_dict(rpc.app.thread_get_stats(args.client)) 3556 3557 p = subparsers.add_parser( 3558 'thread_get_stats', help='Display current statistics of all the threads') 3559 p.set_defaults(func=thread_get_stats) 3560 3561 def thread_set_cpumask(args): 3562 ret = rpc.app.thread_set_cpumask(args.client, 3563 id=args.id, 3564 cpumask=args.cpumask) 3565 p = subparsers.add_parser('thread_set_cpumask', 3566 help="""set the cpumask of the thread whose ID matches to the 3567 specified value. The thread may be migrated to one of the specified CPUs.""") 3568 p.add_argument('-i', '--id', type=int, help='thread ID') 3569 p.add_argument('-m', '--cpumask', help='cpumask for this thread') 3570 p.set_defaults(func=thread_set_cpumask) 3571 3572 def log_enable_timestamps(args): 3573 ret = rpc.app.log_enable_timestamps(args.client, 3574 enabled=args.enabled) 3575 p = subparsers.add_parser('log_enable_timestamps', 3576 help='Enable or disable timestamps.') 3577 p.add_argument('-d', '--disable', dest='enabled', default=False, action='store_false', help="Disable timestamps") 3578 p.add_argument('-e', '--enable', dest='enabled', action='store_true', help="Enable timestamps") 3579 p.set_defaults(func=log_enable_timestamps) 3580 3581 def thread_get_pollers(args): 3582 print_dict(rpc.app.thread_get_pollers(args.client)) 3583 3584 p = subparsers.add_parser( 3585 'thread_get_pollers', help='Display current pollers of all the threads') 3586 p.set_defaults(func=thread_get_pollers) 3587 3588 def thread_get_io_channels(args): 3589 print_dict(rpc.app.thread_get_io_channels(args.client)) 3590 3591 p = subparsers.add_parser( 3592 'thread_get_io_channels', help='Display current IO channels of all the threads') 3593 p.set_defaults(func=thread_get_io_channels) 3594 3595 def env_dpdk_get_mem_stats(args): 3596 print_dict(rpc.env_dpdk.env_dpdk_get_mem_stats(args.client)) 3597 3598 p = subparsers.add_parser( 3599 'env_dpdk_get_mem_stats', help='write the dpdk memory stats to a file.') 3600 p.set_defaults(func=env_dpdk_get_mem_stats) 3601 3602 # blobfs 3603 def blobfs_detect(args): 3604 print(rpc.blobfs.blobfs_detect(args.client, 3605 bdev_name=args.bdev_name)) 3606 3607 p = subparsers.add_parser('blobfs_detect', help='Detect whether a blobfs exists on bdev') 3608 p.add_argument('bdev_name', help='Blockdev name to detect blobfs. Example: Malloc0.') 3609 p.set_defaults(func=blobfs_detect) 3610 3611 def blobfs_create(args): 3612 print(rpc.blobfs.blobfs_create(args.client, 3613 bdev_name=args.bdev_name, 3614 cluster_sz=args.cluster_sz)) 3615 3616 p = subparsers.add_parser('blobfs_create', help='Build a blobfs on bdev') 3617 p.add_argument('bdev_name', help='Blockdev name to build blobfs. Example: Malloc0.') 3618 p.add_argument('-c', '--cluster-sz', 3619 help="""Size of cluster in bytes (Optional). Must be multiple of 4KB page size. Default and minimal value is 1M.""") 3620 p.set_defaults(func=blobfs_create) 3621 3622 def blobfs_mount(args): 3623 print(rpc.blobfs.blobfs_mount(args.client, 3624 bdev_name=args.bdev_name, 3625 mountpoint=args.mountpoint)) 3626 3627 p = subparsers.add_parser('blobfs_mount', help='Mount a blobfs on bdev to host path by FUSE') 3628 p.add_argument('bdev_name', help='Blockdev name where the blobfs is. Example: Malloc0.') 3629 p.add_argument('mountpoint', help='Mountpoint path in host to mount blobfs. Example: /mnt/.') 3630 p.set_defaults(func=blobfs_mount) 3631 3632 def blobfs_set_cache_size(args): 3633 print(rpc.blobfs.blobfs_set_cache_size(args.client, 3634 size_in_mb=args.size_in_mb)) 3635 3636 p = subparsers.add_parser('blobfs_set_cache_size', help='Set cache size for blobfs') 3637 p.add_argument('size_in_mb', help='Cache size for blobfs in megabytes.', type=int) 3638 p.set_defaults(func=blobfs_set_cache_size) 3639 3640 # fsdev 3641 def fsdev_get_opts(args): 3642 print_json(rpc.fsdev.fsdev_get_opts(args.client)) 3643 3644 p = subparsers.add_parser('fsdev_get_opts', help='Get the fsdev subsystem options') 3645 p.set_defaults(func=fsdev_get_opts) 3646 3647 def fsdev_set_opts(args): 3648 print(rpc.fsdev.fsdev_set_opts(args.client, fsdev_io_pool_size=args.fsdev_io_pool_size, 3649 fsdev_io_cache_size=args.fsdev_io_cache_size)) 3650 3651 p = subparsers.add_parser('fsdev_set_opts', help='Set the fsdev subsystem options') 3652 p.add_argument('fsdev-io-pool-size', help='Size of fsdev IO objects pool', type=int) 3653 p.add_argument('fsdev-io-cache-size', help='Size of fsdev IO objects cache per thread', type=int) 3654 p.set_defaults(func=fsdev_set_opts) 3655 3656 def fsdev_aio_create(args): 3657 print(rpc.fsdev.fsdev_aio_create(args.client, name=args.name, root_path=args.root_path, 3658 enable_xattr=args.enable_xattr, enable_writeback_cache=args.enable_writeback_cache, 3659 max_write=args.max_write)) 3660 3661 p = subparsers.add_parser('fsdev_aio_create', help='Create a aio filesystem') 3662 p.add_argument('name', help='Filesystem name. Example: aio0.') 3663 p.add_argument('root_path', help='Path on the system fs to expose as SPDK filesystem') 3664 3665 group = p.add_mutually_exclusive_group() 3666 group.add_argument('--enable-xattr', help='Enable extended attributes', action='store_true', default=None) 3667 group.add_argument('--disable-xattr', help='Disable extended attributes', dest='enable_xattr', action='store_false', default=None) 3668 3669 group = p.add_mutually_exclusive_group() 3670 group.add_argument('--enable-writeback-cache', help='Enable writeback cache', action='store_true', default=None) 3671 group.add_argument('--disable-writeback-cache', help='Disable writeback cache', dest='enable_writeback_cache', action='store_false', 3672 default=None) 3673 3674 p.add_argument('-w', '--max-write', help='Max write size in bytes', type=int) 3675 p.set_defaults(func=fsdev_aio_create) 3676 3677 def fsdev_aio_delete(args): 3678 print(rpc.fsdev.fsdev_aio_delete(args.client, name=args.name)) 3679 3680 p = subparsers.add_parser('fsdev_aio_delete', help='Delete a aio filesystem') 3681 p.add_argument('name', help='Filesystem name. Example: aio0.') 3682 p.set_defaults(func=fsdev_aio_delete) 3683 3684 # sock 3685 def sock_impl_get_options(args): 3686 print_json(rpc.sock.sock_impl_get_options(args.client, 3687 impl_name=args.impl)) 3688 3689 p = subparsers.add_parser('sock_impl_get_options', help="""Get options of socket layer implementation""") 3690 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 3691 p.set_defaults(func=sock_impl_get_options) 3692 3693 def sock_impl_set_options(args): 3694 rpc.sock.sock_impl_set_options(args.client, 3695 impl_name=args.impl, 3696 recv_buf_size=args.recv_buf_size, 3697 send_buf_size=args.send_buf_size, 3698 enable_recv_pipe=args.enable_recv_pipe, 3699 enable_quickack=args.enable_quickack, 3700 enable_placement_id=args.enable_placement_id, 3701 enable_zerocopy_send_server=args.enable_zerocopy_send_server, 3702 enable_zerocopy_send_client=args.enable_zerocopy_send_client, 3703 zerocopy_threshold=args.zerocopy_threshold, 3704 tls_version=args.tls_version, 3705 enable_ktls=args.enable_ktls) 3706 3707 p = subparsers.add_parser('sock_impl_set_options', help="""Set options of socket layer implementation""") 3708 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 3709 p.add_argument('-r', '--recv-buf-size', help='Size of receive buffer on socket in bytes', type=int) 3710 p.add_argument('-s', '--send-buf-size', help='Size of send buffer on socket in bytes', type=int) 3711 p.add_argument('-p', '--enable-placement-id', help='Option for placement-id. 0:disable,1:incoming_napi,2:incoming_cpu', type=int) 3712 p.add_argument('--enable-recv-pipe', help='Enable receive pipe', 3713 action='store_true', dest='enable_recv_pipe') 3714 p.add_argument('--disable-recv-pipe', help='Disable receive pipe', 3715 action='store_false', dest='enable_recv_pipe') 3716 p.add_argument('--enable-quickack', help='Enable quick ACK', 3717 action='store_true', dest='enable_quickack') 3718 p.add_argument('--disable-quickack', help='Disable quick ACK', 3719 action='store_false', dest='enable_quickack') 3720 p.add_argument('--enable-zerocopy-send-server', help='Enable zerocopy on send for server sockets', 3721 action='store_true', dest='enable_zerocopy_send_server') 3722 p.add_argument('--disable-zerocopy-send-server', help='Disable zerocopy on send for server sockets', 3723 action='store_false', dest='enable_zerocopy_send_server') 3724 p.add_argument('--enable-zerocopy-send-client', help='Enable zerocopy on send for client sockets', 3725 action='store_true', dest='enable_zerocopy_send_client') 3726 p.add_argument('--disable-zerocopy-send-client', help='Disable zerocopy on send for client sockets', 3727 action='store_false', dest='enable_zerocopy_send_client') 3728 p.add_argument('--zerocopy-threshold', help='Set zerocopy_threshold in bytes', type=int) 3729 p.add_argument('--tls-version', help='TLS protocol version', type=int) 3730 p.add_argument('--enable-ktls', help='Enable Kernel TLS', 3731 action='store_true', dest='enable_ktls') 3732 p.add_argument('--disable-ktls', help='Disable Kernel TLS', 3733 action='store_false', dest='enable_ktls') 3734 p.set_defaults(func=sock_impl_set_options, enable_recv_pipe=None, enable_quickack=None, 3735 enable_placement_id=None, enable_zerocopy_send_server=None, enable_zerocopy_send_client=None, 3736 zerocopy_threshold=None, tls_version=None, enable_ktls=None) 3737 3738 def sock_set_default_impl(args): 3739 print_json(rpc.sock.sock_set_default_impl(args.client, 3740 impl_name=args.impl)) 3741 3742 p = subparsers.add_parser('sock_set_default_impl', help="""Set the default sock implementation""") 3743 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 3744 p.set_defaults(func=sock_set_default_impl) 3745 3746 def sock_get_default_impl(args): 3747 print_json(rpc.sock.sock_get_default_impl(args.client)) 3748 3749 p = subparsers.add_parser('sock_get_default_impl', help="Get the default sock implementation name") 3750 p.set_defaults(func=sock_get_default_impl) 3751 3752 def framework_get_pci_devices(args): 3753 def splitbuf(buf, step): 3754 return [buf[i:i+step] for i in range(0, len(buf), step)] 3755 3756 devices = rpc.subsystem.framework_get_pci_devices(args.client) 3757 if not args.format_lspci: 3758 print_json(devices) 3759 else: 3760 for devid, dev in enumerate(devices): 3761 print('{} device #{}'.format(dev['address'], devid)) 3762 for lineid, line in enumerate(splitbuf(dev['config_space'], 32)): 3763 print('{:02x}: {}'.format(lineid * 16, ' '.join(splitbuf(line.lower(), 2)))) 3764 print() 3765 3766 p = subparsers.add_parser('framework_get_pci_devices', help='''Get a list of attached PCI devices''') 3767 p.add_argument('--format-lspci', help='Format the output in a way to be consumed by lspci -F', 3768 action='store_true') 3769 p.set_defaults(func=framework_get_pci_devices) 3770 3771 # bdev_nvme_add_error_injection 3772 def bdev_nvme_add_error_injection(args): 3773 print_dict(rpc.nvme.bdev_nvme_add_error_injection(args.client, 3774 name=args.nvme_name, 3775 cmd_type=args.cmd_type, 3776 opc=args.opc, 3777 do_not_submit=args.do_not_submit, 3778 timeout_in_us=args.timeout_in_us, 3779 err_count=args.err_count, 3780 sct=args.sct, 3781 sc=args.sc)) 3782 p = subparsers.add_parser('bdev_nvme_add_error_injection', 3783 help='Add a NVMe command error injection.') 3784 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""", required=True) 3785 p.add_argument('-t', '--cmd-type', help="""Type of NVMe command. Valid values are: admin, io""", required=True) 3786 p.add_argument('-o', '--opc', help="""Opcode of the NVMe command.""", required=True, type=int) 3787 p.add_argument('-s', '--do-not-submit', 3788 help="""Set to true if request should not be submitted to the controller""", 3789 dest="do_not_submit", action='store_true') 3790 p.add_argument('-w', '--timeout-in-us', help="""Wait specified microseconds when do_not_submit is true""", type=int) 3791 p.add_argument('-e', '--err-count', help="""Number of matching NVMe commands to inject errors""", type=int) 3792 p.add_argument('-u', '--sct', help="""Status code type""", type=int) 3793 p.add_argument('-c', '--sc', help="""Status code""", type=int) 3794 p.set_defaults(func=bdev_nvme_add_error_injection) 3795 3796 # bdev_nvme_remove_error_injection 3797 def bdev_nvme_remove_error_injection(args): 3798 print_dict(rpc.nvme.bdev_nvme_remove_error_injection(args.client, 3799 name=args.nvme_name, 3800 cmd_type=args.cmd_type, 3801 opc=args.opc)) 3802 p = subparsers.add_parser('bdev_nvme_remove_error_injection', 3803 help='Removes a NVMe command error injection.') 3804 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""", required=True) 3805 p.add_argument('-t', '--cmd-type', help="""Type of nvme cmd. Valid values are: admin, io""", required=True) 3806 p.add_argument('-o', '--opc', help="""Opcode of the nvme cmd.""", required=True, type=int) 3807 p.set_defaults(func=bdev_nvme_remove_error_injection) 3808 3809 def bdev_daos_create(args): 3810 num_blocks = (args.total_size * 1024 * 1024) // args.block_size 3811 print_json(rpc.bdev.bdev_daos_create(args.client, 3812 num_blocks=int(num_blocks), 3813 block_size=args.block_size, 3814 name=args.name, 3815 uuid=args.uuid, 3816 pool=args.pool, 3817 cont=args.cont, 3818 oclass=args.oclass)) 3819 p = subparsers.add_parser('bdev_daos_create', 3820 help='Create a bdev with DAOS backend') 3821 p.add_argument('name', help="Name of the bdev") 3822 p.add_argument('pool', help="UUID of the DAOS pool") 3823 p.add_argument('cont', help="UUID of the DAOS container") 3824 p.add_argument( 3825 'total_size', help='Size of DAOS bdev in MB (float > 0)', type=float) 3826 p.add_argument('block_size', help='Block size for this bdev', type=int) 3827 p.add_argument('-u', '--uuid', help="UUID of the bdev") 3828 p.add_argument('-o', '--oclass', help="DAOS object class") 3829 p.set_defaults(func=bdev_daos_create) 3830 3831 def bdev_daos_delete(args): 3832 rpc.bdev.bdev_daos_delete(args.client, 3833 name=args.name) 3834 3835 p = subparsers.add_parser('bdev_daos_delete', 3836 help='Delete a DAOS disk') 3837 p.add_argument('name', help='DAOS bdev name') 3838 p.set_defaults(func=bdev_daos_delete) 3839 3840 def bdev_daos_resize(args): 3841 print_json(rpc.bdev.bdev_daos_resize(args.client, 3842 name=args.name, 3843 new_size=int(args.new_size))) 3844 3845 p = subparsers.add_parser('bdev_daos_resize', 3846 help='Resize a DAOS bdev') 3847 p.add_argument('name', help='DAOS bdev name') 3848 p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB') 3849 p.set_defaults(func=bdev_daos_resize) 3850 3851 def iobuf_set_options(args): 3852 rpc.iobuf.iobuf_set_options(args.client, 3853 small_pool_count=args.small_pool_count, 3854 large_pool_count=args.large_pool_count, 3855 small_bufsize=args.small_bufsize, 3856 large_bufsize=args.large_bufsize) 3857 p = subparsers.add_parser('iobuf_set_options', help='Set iobuf pool options') 3858 p.add_argument('--small-pool-count', help='number of small buffers in the global pool', type=int) 3859 p.add_argument('--large-pool-count', help='number of large buffers in the global pool', type=int) 3860 p.add_argument('--small-bufsize', help='size of a small buffer', type=int) 3861 p.add_argument('--large-bufsize', help='size of a large buffer', type=int) 3862 p.set_defaults(func=iobuf_set_options) 3863 3864 def iobuf_get_stats(args): 3865 print_dict(rpc.iobuf.iobuf_get_stats(args.client)) 3866 3867 p = subparsers.add_parser('iobuf_get_stats', help='Display iobuf statistics') 3868 p.set_defaults(func=iobuf_get_stats) 3869 3870 def bdev_nvme_start_mdns_discovery(args): 3871 rpc.bdev.bdev_nvme_start_mdns_discovery(args.client, 3872 name=args.name, 3873 svcname=args.svcname, 3874 hostnqn=args.hostnqn) 3875 3876 p = subparsers.add_parser('bdev_nvme_start_mdns_discovery', help='Start mdns based automatic discovery') 3877 p.add_argument('-b', '--name', help="Name of the NVMe controller prefix for each bdev name", required=True) 3878 p.add_argument('-s', '--svcname', help='Service type to discover: e.g., _nvme-disc._tcp', required=True) 3879 p.add_argument('-q', '--hostnqn', help='NVMe-oF host subnqn') 3880 p.set_defaults(func=bdev_nvme_start_mdns_discovery) 3881 3882 def bdev_nvme_stop_mdns_discovery(args): 3883 rpc.bdev.bdev_nvme_stop_mdns_discovery(args.client, name=args.name) 3884 3885 p = subparsers.add_parser('bdev_nvme_stop_mdns_discovery', help='Stop automatic mdns discovery') 3886 p.add_argument('-b', '--name', help="Name of the service to stop", required=True) 3887 p.set_defaults(func=bdev_nvme_stop_mdns_discovery) 3888 3889 def bdev_nvme_get_mdns_discovery_info(args): 3890 print_dict(rpc.bdev.bdev_nvme_get_mdns_discovery_info(args.client)) 3891 3892 p = subparsers.add_parser('bdev_nvme_get_mdns_discovery_info', help='Get information about the automatic mdns discovery') 3893 p.set_defaults(func=bdev_nvme_get_mdns_discovery_info) 3894 3895 def keyring_file_add_key(args): 3896 rpc.keyring.keyring_file_add_key(args.client, args.name, args.path) 3897 3898 p = subparsers.add_parser('keyring_file_add_key', help='Add a file-based key to the keyring') 3899 p.add_argument('name', help='Name of the key to add') 3900 p.add_argument('path', help='Path of the file containing the key') 3901 p.set_defaults(func=keyring_file_add_key) 3902 3903 def keyring_file_remove_key(args): 3904 rpc.keyring.keyring_file_remove_key(args.client, args.name) 3905 3906 p = subparsers.add_parser('keyring_file_remove_key', help='Remove a file-based key from the keyring') 3907 p.add_argument('name', help='Name of the key to remove') 3908 p.set_defaults(func=keyring_file_remove_key) 3909 3910 def keyring_get_keys(args): 3911 print_dict(rpc.keyring.keyring_get_keys(args.client)) 3912 3913 p = subparsers.add_parser('keyring_get_keys', help='Get a list of registered keys') 3914 p.set_defaults(func=keyring_get_keys) 3915 3916 def keyring_linux_set_options(args): 3917 rpc.keyring.keyring_linux_set_options(args.client, args.enable) 3918 3919 p = subparsers.add_parser('keyring_linux_set_options', help='Set options of the keyring_linux module') 3920 p.add_argument('-e', '--enable', help='Enable keyring_linux module', action='store_true') 3921 p.set_defaults(func=keyring_linux_set_options) 3922 3923 def check_called_name(name): 3924 if name in deprecated_aliases: 3925 print("{} is deprecated, use {} instead.".format(name, deprecated_aliases[name]), file=sys.stderr) 3926 3927 class dry_run_client: 3928 def call(self, method, params=None): 3929 print("Request:\n" + json.dumps({"method": method, "params": params}, indent=2)) 3930 3931 def null_print(arg): 3932 pass 3933 3934 def call_rpc_func(args): 3935 args.func(args) 3936 check_called_name(args.called_rpc_name) 3937 3938 def execute_script(parser, client, timeout, fd): 3939 executed_rpc = "" 3940 for rpc_call in map(str.rstrip, fd): 3941 if not rpc_call.strip(): 3942 continue 3943 executed_rpc = "\n".join([executed_rpc, rpc_call]) 3944 rpc_args = shlex.split(rpc_call) 3945 if rpc_args[0][0] == '#': 3946 # Ignore lines starting with # - treat them as comments 3947 continue 3948 args = parser.parse_args(rpc_args) 3949 args.client = client 3950 args.timeout = timeout 3951 try: 3952 call_rpc_func(args) 3953 except JSONRPCException as ex: 3954 print("Exception:") 3955 print(executed_rpc.strip() + " <<<") 3956 print(ex.message) 3957 exit(1) 3958 3959 def load_plugin(args): 3960 # Create temporary parser, pull out the plugin parameter, load the module, and then run the real argument parser 3961 plugin_parser = argparse.ArgumentParser(add_help=False) 3962 plugin_parser.add_argument('--plugin', dest='rpc_plugin', help='Module name of plugin with additional RPC commands') 3963 3964 rpc_module = plugin_parser.parse_known_args()[0].rpc_plugin 3965 if args is not None: 3966 rpc_module = plugin_parser.parse_known_args(args)[0].rpc_plugin 3967 3968 if rpc_module in plugins: 3969 return 3970 3971 if rpc_module is not None: 3972 try: 3973 rpc_plugin = importlib.import_module(rpc_module) 3974 try: 3975 rpc_plugin.spdk_rpc_plugin_initialize(subparsers) 3976 plugins.append(rpc_module) 3977 except AttributeError: 3978 print("Module %s does not contain 'spdk_rpc_plugin_initialize' function" % rpc_module) 3979 except ModuleNotFoundError: 3980 print("Module %s not found" % rpc_module) 3981 3982 def replace_arg_underscores(args): 3983 # All option names are defined with dashes only - for example: --tgt-name 3984 # But if user used underscores, convert them to dashes (--tgt_name => --tgt-name) 3985 # SPDK was inconsistent previously and had some options with underscores, so 3986 # doing this conversion ensures backward compatibility with older scripts. 3987 for i in range(len(args)): 3988 arg = args[i] 3989 if arg.startswith('--') and "_" in arg: 3990 opt, *vals = arg.split('=') 3991 args[i] = '='.join([opt.replace('_', '-'), *vals]) 3992 3993 plugins = [] 3994 load_plugin(None) 3995 3996 replace_arg_underscores(sys.argv) 3997 3998 args = parser.parse_args() 3999 4000 try: 4001 use_go_client = int(os.getenv('SPDK_JSONRPC_GO_CLIENT', 0)) == 1 4002 except ValueError: 4003 use_go_client = False 4004 4005 if sys.stdin.isatty() and not hasattr(args, 'func'): 4006 # No arguments and no data piped through stdin 4007 parser.print_help() 4008 exit(1) 4009 if args.is_server: 4010 for input in sys.stdin: 4011 cmd = shlex.split(input) 4012 replace_arg_underscores(cmd) 4013 try: 4014 load_plugin(cmd) 4015 tmp_args = parser.parse_args(cmd) 4016 except SystemExit as ex: 4017 print("**STATUS=1", flush=True) 4018 continue 4019 4020 try: 4021 if use_go_client: 4022 tmp_args.client = rpc.client.JSONRPCGoClient(tmp_args.server_addr, 4023 log_level=getattr(logging, tmp_args.verbose.upper())) 4024 else: 4025 tmp_args.client = rpc.client.JSONRPCClient( 4026 tmp_args.server_addr, tmp_args.port, tmp_args.timeout, 4027 log_level=getattr(logging, tmp_args.verbose.upper()), conn_retries=tmp_args.conn_retries) 4028 call_rpc_func(tmp_args) 4029 print("**STATUS=0", flush=True) 4030 except JSONRPCException as ex: 4031 print(ex.message) 4032 print("**STATUS=1", flush=True) 4033 exit(0) 4034 elif args.dry_run: 4035 args.client = dry_run_client() 4036 print_dict = null_print 4037 print_json = null_print 4038 print_array = null_print 4039 elif args.go_client or use_go_client: 4040 try: 4041 args.client = rpc.client.JSONRPCGoClient(args.server_addr, 4042 log_level=getattr(logging, args.verbose.upper())) 4043 except JSONRPCException as ex: 4044 print(ex.message) 4045 exit(1) 4046 else: 4047 try: 4048 args.client = rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, 4049 log_level=getattr(logging, args.verbose.upper()), 4050 conn_retries=args.conn_retries) 4051 except JSONRPCException as ex: 4052 print(ex.message) 4053 exit(1) 4054 4055 if hasattr(args, 'func'): 4056 try: 4057 call_rpc_func(args) 4058 except JSONRPCException as ex: 4059 print(ex.message) 4060 exit(1) 4061 else: 4062 execute_script(parser, args.client, args.timeout, sys.stdin) 4063