1#!/usr/bin/env python3 2 3from rpc.client import print_dict, print_json, JSONRPCException 4from rpc.helpers import deprecated_aliases 5 6import logging 7import argparse 8import importlib 9import rpc 10import sys 11import shlex 12import json 13 14try: 15 from shlex import quote 16except ImportError: 17 from pipes import quote 18 19 20def print_array(a): 21 print(" ".join((quote(v) for v in a))) 22 23 24if __name__ == "__main__": 25 parser = argparse.ArgumentParser( 26 description='SPDK RPC command line interface', usage='%(prog)s [options]') 27 parser.add_argument('-s', dest='server_addr', 28 help='RPC domain socket path or IP address', default='/var/tmp/spdk.sock') 29 parser.add_argument('-p', dest='port', 30 help='RPC port number (if server_addr is IP address)', 31 default=5260, type=int) 32 parser.add_argument('-t', dest='timeout', 33 help='Timeout as a floating point number expressed in seconds waiting for response. Default: 60.0', 34 default=60.0, type=float) 35 parser.add_argument('-r', dest='conn_retries', 36 help='Retry connecting to the RPC server N times with 0.2s interval. Default: 0', 37 default=0, type=int) 38 parser.add_argument('-v', dest='verbose', action='store_const', const="INFO", 39 help='Set verbose mode to INFO', default="ERROR") 40 parser.add_argument('--verbose', dest='verbose', choices=['DEBUG', 'INFO', 'ERROR'], 41 help="""Set verbose level. """) 42 parser.add_argument('--dry_run', dest='dry_run', action='store_true', help="Display request and exit") 43 parser.set_defaults(dry_run=False) 44 parser.add_argument('--server', dest='is_server', action='store_true', 45 help="Start listening on stdin, parse each line as a regular rpc.py execution and create \ 46 a separate connection for each command. Each command's output ends with either \ 47 **STATUS=0 if the command succeeded or **STATUS=1 if it failed. --server is meant \ 48 to be used in conjunction with bash coproc, where stdin and stdout are connected to \ 49 pipes and can be used as a faster way to send RPC commands. If enabled, rpc.py \ 50 must be executed without any other parameters.") 51 parser.set_defaults(is_server=False) 52 parser.add_argument('--plugin', dest='rpc_plugin', help='Module name of plugin with additional RPC commands') 53 subparsers = parser.add_subparsers(help='RPC methods', dest='called_rpc_name', metavar='') 54 55 def framework_start_init(args): 56 rpc.framework_start_init(args.client) 57 58 p = subparsers.add_parser('framework_start_init', aliases=['start_subsystem_init'], 59 help='Start initialization of subsystems') 60 p.set_defaults(func=framework_start_init) 61 62 def framework_wait_init(args): 63 rpc.framework_wait_init(args.client) 64 65 p = subparsers.add_parser('framework_wait_init', aliases=['wait_subsystem_init'], 66 help='Block until subsystems have been initialized') 67 p.set_defaults(func=framework_wait_init) 68 69 def rpc_get_methods(args): 70 print_dict(rpc.rpc_get_methods(args.client, 71 current=args.current, 72 include_aliases=args.include_aliases)) 73 74 p = subparsers.add_parser('rpc_get_methods', aliases=['get_rpc_methods'], 75 help='Get list of supported RPC methods') 76 p.add_argument('-c', '--current', help='Get list of RPC methods only callable in the current state.', action='store_true') 77 p.add_argument('-i', '--include-aliases', help='include RPC aliases', action='store_true') 78 p.set_defaults(func=rpc_get_methods) 79 80 def spdk_get_version(args): 81 print_json(rpc.spdk_get_version(args.client)) 82 83 p = subparsers.add_parser('spdk_get_version', aliases=['get_spdk_version'], 84 help='Get SPDK version') 85 p.set_defaults(func=spdk_get_version) 86 87 def save_config(args): 88 rpc.save_config(args.client, 89 sys.stdout, 90 indent=args.indent) 91 92 p = subparsers.add_parser('save_config', help="""Write current (live) configuration of SPDK subsystems and targets to stdout. 93 """) 94 p.add_argument('-i', '--indent', help="""Indent level. Value less than 0 mean compact mode. Default indent level is 2. 95 """, type=int, default=2) 96 p.set_defaults(func=save_config) 97 98 def load_config(args): 99 rpc.load_config(args.client, args.json_conf, 100 include_aliases=args.include_aliases) 101 102 p = subparsers.add_parser('load_config', help="""Configure SPDK subsystems and targets using JSON RPC.""") 103 p.add_argument('-i', '--include-aliases', help='include RPC aliases', action='store_true') 104 p.add_argument('-j', '--json_conf', help='Valid JSON configuration', default=sys.stdin) 105 p.set_defaults(func=load_config) 106 107 def save_subsystem_config(args): 108 rpc.save_subsystem_config(args.client, 109 sys.stdout, 110 indent=args.indent, 111 name=args.name) 112 113 p = subparsers.add_parser('save_subsystem_config', help="""Write current (live) configuration of SPDK subsystem to stdout. 114 """) 115 p.add_argument('-i', '--indent', help="""Indent level. Value less than 0 mean compact mode. Default indent level is 2. 116 """, type=int, default=2) 117 p.add_argument('-n', '--name', help='Name of subsystem', required=True) 118 p.set_defaults(func=save_subsystem_config) 119 120 def load_subsystem_config(args): 121 rpc.load_subsystem_config(args.client, 122 args.json_conf) 123 124 p = subparsers.add_parser('load_subsystem_config', help="""Configure SPDK subsystem using JSON RPC.""") 125 p.add_argument('-j', '--json_conf', help='Valid JSON configuration', default=sys.stdin) 126 p.set_defaults(func=load_subsystem_config) 127 128 # app 129 def spdk_kill_instance(args): 130 rpc.app.spdk_kill_instance(args.client, 131 sig_name=args.sig_name) 132 133 p = subparsers.add_parser('spdk_kill_instance', aliases=['kill_instance'], 134 help='Send signal to instance') 135 p.add_argument('sig_name', help='signal will be sent to server.') 136 p.set_defaults(func=spdk_kill_instance) 137 138 def framework_monitor_context_switch(args): 139 enabled = None 140 if args.enable: 141 enabled = True 142 if args.disable: 143 enabled = False 144 print_dict(rpc.app.framework_monitor_context_switch(args.client, 145 enabled=enabled)) 146 147 p = subparsers.add_parser('framework_monitor_context_switch', aliases=['context_switch_monitor'], 148 help='Control whether the context switch monitor is enabled') 149 p.add_argument('-e', '--enable', action='store_true', help='Enable context switch monitoring') 150 p.add_argument('-d', '--disable', action='store_true', help='Disable context switch monitoring') 151 p.set_defaults(func=framework_monitor_context_switch) 152 153 def framework_get_reactors(args): 154 print_dict(rpc.app.framework_get_reactors(args.client)) 155 156 p = subparsers.add_parser( 157 'framework_get_reactors', help='Display list of all reactors') 158 p.set_defaults(func=framework_get_reactors) 159 160 def framework_set_scheduler(args): 161 rpc.app.framework_set_scheduler(args.client, 162 name=args.name, 163 period=args.period) 164 165 p = subparsers.add_parser( 166 'framework_set_scheduler', help='Select thread scheduler that will be activated and its period (experimental)') 167 p.add_argument('name', help="Name of a scheduler") 168 p.add_argument('-p', '--period', help="Scheduler period in microseconds", type=int) 169 p.set_defaults(func=framework_set_scheduler) 170 171 def framework_get_scheduler(args): 172 print_dict(rpc.app.framework_get_scheduler(args.client)) 173 174 p = subparsers.add_parser( 175 'framework_get_scheduler', help='Display currently set scheduler and its properties.') 176 p.set_defaults(func=framework_get_scheduler) 177 178 # bdev 179 def bdev_set_options(args): 180 rpc.bdev.bdev_set_options(args.client, 181 bdev_io_pool_size=args.bdev_io_pool_size, 182 bdev_io_cache_size=args.bdev_io_cache_size, 183 bdev_auto_examine=args.bdev_auto_examine, 184 small_buf_pool_size=args.small_buf_pool_size, 185 large_buf_pool_size=args.large_buf_pool_size) 186 187 p = subparsers.add_parser('bdev_set_options', aliases=['set_bdev_options'], 188 help="""Set options of bdev subsystem""") 189 p.add_argument('-p', '--bdev-io-pool-size', help='Number of bdev_io structures in shared buffer pool', type=int) 190 p.add_argument('-c', '--bdev-io-cache-size', help='Maximum number of bdev_io structures cached per thread', type=int) 191 p.add_argument('-s', '--small-buf-pool-size', help='Maximum number of small buf (i.e., 8KB) pool size', type=int) 192 p.add_argument('-l', '--large-buf-pool-size', help='Maximum number of large buf (i.e., 64KB) pool size', type=int) 193 group = p.add_mutually_exclusive_group() 194 group.add_argument('-e', '--enable-auto-examine', dest='bdev_auto_examine', help='Allow to auto examine', action='store_true') 195 group.add_argument('-d', '--disable-auto-examine', dest='bdev_auto_examine', help='Not allow to auto examine', action='store_false') 196 p.set_defaults(bdev_auto_examine=True) 197 p.set_defaults(func=bdev_set_options) 198 199 def bdev_examine(args): 200 rpc.bdev.bdev_examine(args.client, 201 name=args.name) 202 203 p = subparsers.add_parser('bdev_examine', 204 help="""examine a bdev if it exists, or will examine it after it is created""") 205 p.add_argument('-b', '--name', help='Name or alias of the bdev') 206 p.set_defaults(func=bdev_examine) 207 208 def bdev_wait_for_examine(args): 209 rpc.bdev.bdev_wait_for_examine(args.client) 210 211 p = subparsers.add_parser('bdev_wait_for_examine', 212 help="""Report when all bdevs have been examined""") 213 p.set_defaults(func=bdev_wait_for_examine) 214 215 def bdev_compress_create(args): 216 print_json(rpc.bdev.bdev_compress_create(args.client, 217 base_bdev_name=args.base_bdev_name, 218 pm_path=args.pm_path, 219 lb_size=args.lb_size)) 220 221 p = subparsers.add_parser('bdev_compress_create', aliases=['construct_compress_bdev'], 222 help='Add a compress vbdev') 223 p.add_argument('-b', '--base_bdev_name', help="Name of the base bdev") 224 p.add_argument('-p', '--pm_path', help="Path to persistent memory") 225 p.add_argument('-l', '--lb_size', help="Compressed vol logical block size (optional, if used must be 512 or 4096)", type=int, default=0) 226 p.set_defaults(func=bdev_compress_create) 227 228 def bdev_compress_delete(args): 229 rpc.bdev.bdev_compress_delete(args.client, 230 name=args.name) 231 232 p = subparsers.add_parser('bdev_compress_delete', aliases=['delete_compress_bdev'], 233 help='Delete a compress disk') 234 p.add_argument('name', help='compress bdev name') 235 p.set_defaults(func=bdev_compress_delete) 236 237 def bdev_compress_set_pmd(args): 238 rpc.bdev.bdev_compress_set_pmd(args.client, 239 pmd=args.pmd) 240 p = subparsers.add_parser('bdev_compress_set_pmd', aliases=['set_compress_pmd', 'compress_set_pmd'], 241 help='Set pmd option for a compress disk') 242 p.add_argument('-p', '--pmd', type=int, help='0 = auto-select, 1= QAT only, 2 = ISAL only') 243 p.set_defaults(func=bdev_compress_set_pmd) 244 245 def bdev_compress_get_orphans(args): 246 print_dict(rpc.bdev.bdev_compress_get_orphans(args.client, 247 name=args.name)) 248 p = subparsers.add_parser( 249 'bdev_compress_get_orphans', help='Display list of orphaned compress bdevs.') 250 p.add_argument('-b', '--name', help="Name of a comp bdev. Example: COMP_Nvme0n1", required=False) 251 p.set_defaults(func=bdev_compress_get_orphans) 252 253 def bdev_crypto_create(args): 254 print_json(rpc.bdev.bdev_crypto_create(args.client, 255 base_bdev_name=args.base_bdev_name, 256 name=args.name, 257 crypto_pmd=args.crypto_pmd, 258 key=args.key, 259 cipher=args.cipher, 260 key2=args.key2)) 261 p = subparsers.add_parser('bdev_crypto_create', aliases=['construct_crypto_bdev'], 262 help='Add a crypto vbdev') 263 p.add_argument('base_bdev_name', help="Name of the base bdev") 264 p.add_argument('name', help="Name of the crypto vbdev") 265 p.add_argument('crypto_pmd', help="Name of the crypto device driver") 266 p.add_argument('key', help="Key") 267 p.add_argument('-c', '--cipher', help="cipher to use, AES_CBC or AES_XTS (QAT only)", default="AES_CBC") 268 p.add_argument('-k2', '--key2', help="2nd key for cipher AET_XTS", default=None) 269 p.set_defaults(func=bdev_crypto_create) 270 271 def bdev_crypto_delete(args): 272 rpc.bdev.bdev_crypto_delete(args.client, 273 name=args.name) 274 275 p = subparsers.add_parser('bdev_crypto_delete', aliases=['delete_crypto_bdev'], 276 help='Delete a crypto disk') 277 p.add_argument('name', help='crypto bdev name') 278 p.set_defaults(func=bdev_crypto_delete) 279 280 def bdev_ocf_create(args): 281 print_json(rpc.bdev.bdev_ocf_create(args.client, 282 name=args.name, 283 mode=args.mode, 284 cache_line_size=args.cache_line_size, 285 cache_bdev_name=args.cache_bdev_name, 286 core_bdev_name=args.core_bdev_name)) 287 p = subparsers.add_parser('bdev_ocf_create', aliases=['construct_ocf_bdev'], 288 help='Add an OCF block device') 289 p.add_argument('name', help='Name of resulting OCF bdev') 290 p.add_argument('mode', help='OCF cache mode', choices=['wb', 'wt', 'pt', 'wa', 'wi', 'wo']) 291 p.add_argument( 292 '--cache-line-size', 293 help='OCF cache line size. The unit is KiB', 294 type=int, 295 choices=[4, 8, 16, 32, 64], 296 required=False, 297 default=0, 298 ) 299 p.add_argument('cache_bdev_name', help='Name of underlying cache bdev') 300 p.add_argument('core_bdev_name', help='Name of unerlying core bdev') 301 p.set_defaults(func=bdev_ocf_create) 302 303 def bdev_ocf_delete(args): 304 rpc.bdev.bdev_ocf_delete(args.client, 305 name=args.name) 306 307 p = subparsers.add_parser('bdev_ocf_delete', aliases=['delete_ocf_bdev'], 308 help='Delete an OCF block device') 309 p.add_argument('name', help='Name of OCF bdev') 310 p.set_defaults(func=bdev_ocf_delete) 311 312 def bdev_ocf_get_stats(args): 313 print_dict(rpc.bdev.bdev_ocf_get_stats(args.client, 314 name=args.name)) 315 p = subparsers.add_parser('bdev_ocf_get_stats', aliases=['get_ocf_stats'], 316 help='Get statistics of chosen OCF block device') 317 p.add_argument('name', help='Name of OCF bdev') 318 p.set_defaults(func=bdev_ocf_get_stats) 319 320 def bdev_ocf_get_bdevs(args): 321 print_dict(rpc.bdev.bdev_ocf_get_bdevs(args.client, 322 name=args.name)) 323 p = subparsers.add_parser('bdev_ocf_get_bdevs', aliases=['get_ocf_bdevs'], 324 help='Get list of OCF devices including unregistered ones') 325 p.add_argument('name', nargs='?', default=None, help='name of OCF vbdev or name of cache device or name of core device (optional)') 326 p.set_defaults(func=bdev_ocf_get_bdevs) 327 328 def bdev_ocf_set_cache_mode(args): 329 print_json(rpc.bdev.bdev_ocf_set_cache_mode(args.client, 330 name=args.name, 331 mode=args.mode)) 332 p = subparsers.add_parser('bdev_ocf_set_cache_mode', 333 help='Set cache mode of OCF block device') 334 p.add_argument('name', help='Name of OCF bdev') 335 p.add_argument('mode', help='OCF cache mode', choices=['wb', 'wt', 'pt', 'wa', 'wi', 'wo']) 336 p.set_defaults(func=bdev_ocf_set_cache_mode) 337 338 def bdev_malloc_create(args): 339 num_blocks = (args.total_size * 1024 * 1024) // args.block_size 340 print_json(rpc.bdev.bdev_malloc_create(args.client, 341 num_blocks=int(num_blocks), 342 block_size=args.block_size, 343 name=args.name, 344 uuid=args.uuid)) 345 p = subparsers.add_parser('bdev_malloc_create', aliases=['construct_malloc_bdev'], 346 help='Create a bdev with malloc backend') 347 p.add_argument('-b', '--name', help="Name of the bdev") 348 p.add_argument('-u', '--uuid', help="UUID of the bdev") 349 p.add_argument( 350 'total_size', help='Size of malloc bdev in MB (float > 0)', type=float) 351 p.add_argument('block_size', help='Block size for this bdev', type=int) 352 p.set_defaults(func=bdev_malloc_create) 353 354 def bdev_malloc_delete(args): 355 rpc.bdev.bdev_malloc_delete(args.client, 356 name=args.name) 357 358 p = subparsers.add_parser('bdev_malloc_delete', aliases=['delete_malloc_bdev'], 359 help='Delete a malloc disk') 360 p.add_argument('name', help='malloc bdev name') 361 p.set_defaults(func=bdev_malloc_delete) 362 363 def bdev_null_create(args): 364 num_blocks = (args.total_size * 1024 * 1024) // args.block_size 365 if args.dif_type and not args.md_size: 366 print("ERROR: --md-size must be > 0 when --dif-type is > 0") 367 exit(1) 368 print_json(rpc.bdev.bdev_null_create(args.client, 369 num_blocks=num_blocks, 370 block_size=args.block_size, 371 name=args.name, 372 uuid=args.uuid, 373 md_size=args.md_size, 374 dif_type=args.dif_type, 375 dif_is_head_of_md=args.dif_is_head_of_md)) 376 377 p = subparsers.add_parser('bdev_null_create', aliases=['construct_null_bdev'], 378 help='Add a bdev with null backend') 379 p.add_argument('name', help='Block device name') 380 p.add_argument('-u', '--uuid', help='UUID of the bdev') 381 p.add_argument('total_size', help='Size of null bdev in MB (int > 0). Includes only data blocks.', type=int) 382 p.add_argument('block_size', help='Block size for this bdev.' 383 'Should be a sum of block size and metadata size if --md-size is used.', type=int) 384 p.add_argument('-m', '--md-size', type=int, 385 help='Metadata size for this bdev. Default=0.') 386 p.add_argument('-t', '--dif-type', type=int, default=0, choices=[0, 1, 2, 3], 387 help='Protection information type. Parameter --md-size needs' 388 'to be set along --dif-type. Default=0 - no protection.') 389 p.add_argument('-d', '--dif-is-head-of-md', action='store_true', 390 help='Protection information is in the first 8 bytes of metadata. Default=false.') 391 p.set_defaults(func=bdev_null_create) 392 393 def bdev_null_delete(args): 394 rpc.bdev.bdev_null_delete(args.client, 395 name=args.name) 396 397 p = subparsers.add_parser('bdev_null_delete', aliases=['delete_null_bdev'], 398 help='Delete a null bdev') 399 p.add_argument('name', help='null bdev name') 400 p.set_defaults(func=bdev_null_delete) 401 402 def bdev_null_resize(args): 403 print_json(rpc.bdev.bdev_null_resize(args.client, 404 name=args.name, 405 new_size=int(args.new_size))) 406 407 p = subparsers.add_parser('bdev_null_resize', 408 help='Resize a null bdev') 409 p.add_argument('name', help='null bdev name') 410 p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB') 411 p.set_defaults(func=bdev_null_resize) 412 413 def bdev_aio_create(args): 414 print_json(rpc.bdev.bdev_aio_create(args.client, 415 filename=args.filename, 416 name=args.name, 417 block_size=args.block_size)) 418 419 p = subparsers.add_parser('bdev_aio_create', aliases=['construct_aio_bdev'], 420 help='Add a bdev with aio backend') 421 p.add_argument('filename', help='Path to device or file (ex: /dev/sda)') 422 p.add_argument('name', help='Block device name') 423 p.add_argument('block_size', help='Block size for this bdev', type=int, nargs='?', default=0) 424 p.set_defaults(func=bdev_aio_create) 425 426 def bdev_aio_delete(args): 427 rpc.bdev.bdev_aio_delete(args.client, 428 name=args.name) 429 430 p = subparsers.add_parser('bdev_aio_delete', aliases=['delete_aio_bdev'], 431 help='Delete an aio disk') 432 p.add_argument('name', help='aio bdev name') 433 p.set_defaults(func=bdev_aio_delete) 434 435 def bdev_uring_create(args): 436 print_json(rpc.bdev.bdev_uring_create(args.client, 437 filename=args.filename, 438 name=args.name, 439 block_size=args.block_size)) 440 441 p = subparsers.add_parser('bdev_uring_create', help='Create a bdev with io_uring backend') 442 p.add_argument('filename', help='Path to device or file (ex: /dev/nvme0n1)') 443 p.add_argument('name', help='bdev name') 444 p.add_argument('block_size', help='Block size for this bdev', type=int, nargs='?', default=0) 445 p.set_defaults(func=bdev_uring_create) 446 447 def bdev_uring_delete(args): 448 rpc.bdev.bdev_uring_delete(args.client, 449 name=args.name) 450 451 p = subparsers.add_parser('bdev_uring_delete', help='Delete a uring bdev') 452 p.add_argument('name', help='uring bdev name') 453 p.set_defaults(func=bdev_uring_delete) 454 455 def bdev_nvme_set_options(args): 456 rpc.bdev.bdev_nvme_set_options(args.client, 457 action_on_timeout=args.action_on_timeout, 458 timeout_us=args.timeout_us, 459 keep_alive_timeout_ms=args.keep_alive_timeout_ms, 460 retry_count=args.retry_count, 461 arbitration_burst=args.arbitration_burst, 462 low_priority_weight=args.low_priority_weight, 463 medium_priority_weight=args.medium_priority_weight, 464 high_priority_weight=args.high_priority_weight, 465 nvme_adminq_poll_period_us=args.nvme_adminq_poll_period_us, 466 nvme_ioq_poll_period_us=args.nvme_ioq_poll_period_us, 467 io_queue_requests=args.io_queue_requests, 468 delay_cmd_submit=args.delay_cmd_submit) 469 470 p = subparsers.add_parser('bdev_nvme_set_options', aliases=['set_bdev_nvme_options'], 471 help='Set options for the bdev nvme type. This is startup command.') 472 p.add_argument('-a', '--action-on-timeout', 473 help="Action to take on command time out. Valid valies are: none, reset, abort") 474 p.add_argument('-t', '--timeout-us', 475 help="Timeout for each command, in microseconds. If 0, don't track timeouts.", type=int) 476 p.add_argument('-k', '--keep-alive-timeout-ms', 477 help="Keep alive timeout period in millisecond. If 0, disable keep-alive.", type=int) 478 p.add_argument('-n', '--retry-count', 479 help='the number of attempts per I/O when an I/O fails', type=int) 480 p.add_argument('--arbitration-burst', 481 help='the value is expressed as a power of two', type=int) 482 p.add_argument('--low-priority-weight', 483 help='the maximum number of commands that the controller may launch at one time from a low priority queue', type=int) 484 p.add_argument('--medium-priority-weight', 485 help='the maximum number of commands that the controller may launch at one time from a medium priority queue', type=int) 486 p.add_argument('--high-priority-weight', 487 help='the maximum number of commands that the controller may launch at one time from a high priority queue', type=int) 488 p.add_argument('-p', '--nvme-adminq-poll-period-us', 489 help='How often the admin queue is polled for asynchronous events', type=int) 490 p.add_argument('-i', '--nvme-ioq-poll-period-us', 491 help='How often to poll I/O queues for completions', type=int) 492 p.add_argument('-s', '--io-queue-requests', 493 help='The number of requests allocated for each NVMe I/O queue. Default: 512', type=int) 494 p.add_argument('-d', '--disable-delay-cmd-submit', 495 help='Disable delaying NVMe command submission, i.e. no batching of multiple commands', 496 action='store_false', dest='delay_cmd_submit', default=True) 497 p.set_defaults(func=bdev_nvme_set_options) 498 499 def bdev_nvme_set_hotplug(args): 500 rpc.bdev.bdev_nvme_set_hotplug(args.client, enable=args.enable, period_us=args.period_us) 501 502 p = subparsers.add_parser('bdev_nvme_set_hotplug', aliases=['set_bdev_nvme_hotplug'], 503 help='Set hotplug options for bdev nvme type.') 504 p.add_argument('-d', '--disable', dest='enable', default=False, action='store_false', help="Disable hotplug (default)") 505 p.add_argument('-e', '--enable', dest='enable', action='store_true', help="Enable hotplug") 506 p.add_argument('-r', '--period-us', 507 help='How often the hotplug is processed for insert and remove events', type=int) 508 p.set_defaults(func=bdev_nvme_set_hotplug) 509 510 def bdev_nvme_attach_controller(args): 511 print_array(rpc.bdev.bdev_nvme_attach_controller(args.client, 512 name=args.name, 513 trtype=args.trtype, 514 traddr=args.traddr, 515 adrfam=args.adrfam, 516 trsvcid=args.trsvcid, 517 priority=args.priority, 518 subnqn=args.subnqn, 519 hostnqn=args.hostnqn, 520 hostaddr=args.hostaddr, 521 hostsvcid=args.hostsvcid, 522 prchk_reftag=args.prchk_reftag, 523 prchk_guard=args.prchk_guard, 524 hdgst=args.hdgst, 525 ddgst=args.ddgst)) 526 527 p = subparsers.add_parser('bdev_nvme_attach_controller', aliases=['construct_nvme_bdev'], 528 help='Add bdevs with nvme backend') 529 p.add_argument('-b', '--name', help="Name of the NVMe controller, prefix for each bdev name", required=True) 530 p.add_argument('-t', '--trtype', 531 help='NVMe-oF target trtype: e.g., rdma, pcie', required=True) 532 p.add_argument('-a', '--traddr', 533 help='NVMe-oF target address: e.g., an ip address or BDF', required=True) 534 p.add_argument('-f', '--adrfam', 535 help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 536 p.add_argument('-s', '--trsvcid', 537 help='NVMe-oF target trsvcid: e.g., a port number') 538 p.add_argument('-p', '--priority', 539 help='NVMe-oF connection priority: e.g., a priority number') 540 p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn') 541 p.add_argument('-q', '--hostnqn', help='NVMe-oF host subnqn') 542 p.add_argument('-i', '--hostaddr', 543 help='NVMe-oF host address: e.g., an ip address') 544 p.add_argument('-c', '--hostsvcid', 545 help='NVMe-oF host svcid: e.g., a port number') 546 p.add_argument('-r', '--prchk-reftag', 547 help='Enable checking of PI reference tag for I/O processing.', action='store_true') 548 p.add_argument('-g', '--prchk-guard', 549 help='Enable checking of PI guard for I/O processing.', action='store_true') 550 p.add_argument('-e', '--hdgst', 551 help='Enable TCP header digest.', action='store_true') 552 p.add_argument('-d', '--ddgst', 553 help='Enable TCP data digest.', action='store_true') 554 p.set_defaults(func=bdev_nvme_attach_controller) 555 556 def bdev_nvme_get_controllers(args): 557 print_dict(rpc.nvme.bdev_nvme_get_controllers(args.client, 558 name=args.name)) 559 560 p = subparsers.add_parser( 561 'bdev_nvme_get_controllers', aliases=['get_nvme_controllers'], 562 help='Display current NVMe controllers list or required NVMe controller') 563 p.add_argument('-n', '--name', help="Name of the NVMe controller. Example: Nvme0", required=False) 564 p.set_defaults(func=bdev_nvme_get_controllers) 565 566 def bdev_nvme_detach_controller(args): 567 rpc.bdev.bdev_nvme_detach_controller(args.client, 568 name=args.name, 569 trtype=args.trtype, 570 traddr=args.traddr, 571 adrfam=args.adrfam, 572 trsvcid=args.trsvcid, 573 subnqn=args.subnqn) 574 575 p = subparsers.add_parser('bdev_nvme_detach_controller', aliases=['delete_nvme_controller'], 576 help='Detach an NVMe controller and delete any associated bdevs') 577 p.add_argument('name', help="Name of the controller") 578 p.add_argument('-t', '--trtype', 579 help='NVMe-oF target trtype: e.g., rdma, pcie') 580 p.add_argument('-a', '--traddr', 581 help='NVMe-oF target address: e.g., an ip address or BDF') 582 p.add_argument('-f', '--adrfam', 583 help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 584 p.add_argument('-s', '--trsvcid', 585 help='NVMe-oF target trsvcid: e.g., a port number') 586 p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn') 587 p.set_defaults(func=bdev_nvme_detach_controller) 588 589 def bdev_nvme_cuse_register(args): 590 rpc.bdev.bdev_nvme_cuse_register(args.client, 591 name=args.name) 592 593 p = subparsers.add_parser('bdev_nvme_cuse_register', 594 help='Register CUSE devices on NVMe controller') 595 p.add_argument('-n', '--name', 596 help='Name of the NVMe controller. Example: Nvme0', required=True) 597 p.set_defaults(func=bdev_nvme_cuse_register) 598 599 def bdev_nvme_cuse_unregister(args): 600 rpc.bdev.bdev_nvme_cuse_unregister(args.client, 601 name=args.name) 602 603 p = subparsers.add_parser('bdev_nvme_cuse_unregister', 604 help='Unregister CUSE devices on NVMe controller') 605 p.add_argument('-n', '--name', 606 help='Name of the NVMe controller. Example: Nvme0', required=True) 607 p.set_defaults(func=bdev_nvme_cuse_unregister) 608 609 def bdev_zone_block_create(args): 610 print_json(rpc.bdev.bdev_zone_block_create(args.client, 611 name=args.name, 612 base_bdev=args.base_bdev, 613 zone_capacity=args.zone_capacity, 614 optimal_open_zones=args.optimal_open_zones)) 615 616 p = subparsers.add_parser('bdev_zone_block_create', 617 help='Create virtual zone namespace device with block device backend') 618 p.add_argument('-b', '--name', help="Name of the zone device", required=True) 619 p.add_argument('-n', '--base-bdev', help='Name of underlying, non-zoned bdev', required=True) 620 p.add_argument('-z', '--zone-capacity', help='Surfaced zone capacity in blocks', type=int, required=True) 621 p.add_argument('-o', '--optimal-open-zones', help='Number of zones required to reach optimal write speed', type=int, required=True) 622 p.set_defaults(func=bdev_zone_block_create) 623 624 def bdev_zone_block_delete(args): 625 rpc.bdev.bdev_zone_block_delete(args.client, 626 name=args.name) 627 628 p = subparsers.add_parser('bdev_zone_block_delete', help='Delete a virtual zone namespace device') 629 p.add_argument('name', help='Virtual zone bdev name') 630 p.set_defaults(func=bdev_zone_block_delete) 631 632 def bdev_rbd_register_cluster(args): 633 config_param = None 634 if args.config_param: 635 config_param = {} 636 for entry in args.config: 637 parts = entry.split('=', 1) 638 if len(parts) != 2: 639 raise Exception('--config %s not in key=value form' % entry) 640 config_param[parts[0]] = parts[1] 641 print_json(rpc.bdev.bdev_rbd_register_cluster(args.client, 642 name=args.name, 643 user=args.user, 644 config_param=config_param, 645 config_file=args.config_file)) 646 647 p = subparsers.add_parser('bdev_rbd_register_cluster', 648 help='Add a Rados cluster with ceph rbd backend') 649 p.add_argument('name', help="Name of the Rados cluster only known to rbd bdev") 650 p.add_argument('--user', help="Ceph user name (i.e. admin, not client.admin)", required=False) 651 p.add_argument('--config_param', action='append', metavar='key=value', 652 help="adds a key=value configuration option for rados_conf_set (default: rely on config file)") 653 p.add_argument('--config_file', help="The file path of the Rados configuration file", required=False) 654 p.set_defaults(func=bdev_rbd_register_cluster) 655 656 def bdev_rbd_unregister_cluster(args): 657 rpc.bdev.bdev_rbd_unregister_cluster(args.client, name=args.name) 658 659 p = subparsers.add_parser('bdev_rbd_unregister_cluster', 660 help='Unregister a Rados cluster object') 661 p.add_argument('name', help='Name of the Rados Cluster only known to rbd bdev') 662 p.set_defaults(func=bdev_rbd_unregister_cluster) 663 664 def bdev_rbd_get_clusters_info(args): 665 print_json(rpc.bdev.bdev_rbd_get_clusters_info(args.client, name=args.name)) 666 667 p = subparsers.add_parser('bdev_rbd_get_clusters_info', 668 help='Display registered Rados Cluster names and related info') 669 p.add_argument('-b', '--name', help="Name of the registered Rados Cluster Name. Example: Cluster1", required=False) 670 p.set_defaults(func=bdev_rbd_get_clusters_info) 671 672 def bdev_rbd_create(args): 673 config = None 674 if args.config: 675 config = {} 676 for entry in args.config: 677 parts = entry.split('=', 1) 678 if len(parts) != 2: 679 raise Exception('--config %s not in key=value form' % entry) 680 config[parts[0]] = parts[1] 681 print_json(rpc.bdev.bdev_rbd_create(args.client, 682 name=args.name, 683 user=args.user, 684 config=config, 685 pool_name=args.pool_name, 686 rbd_name=args.rbd_name, 687 block_size=args.block_size, 688 cluster_name=args.cluster_name)) 689 690 p = subparsers.add_parser('bdev_rbd_create', aliases=['construct_rbd_bdev'], 691 help='Add a bdev with ceph rbd backend') 692 p.add_argument('-b', '--name', help="Name of the bdev", required=False) 693 p.add_argument('--user', help="Ceph user name (i.e. admin, not client.admin)", required=False) 694 p.add_argument('--config', action='append', metavar='key=value', 695 help="adds a key=value configuration option for rados_conf_set (default: rely on config file)") 696 p.add_argument('pool_name', help='rbd pool name') 697 p.add_argument('rbd_name', help='rbd image name') 698 p.add_argument('block_size', help='rbd block size', type=int) 699 p.add_argument('-c', '--cluster_name', help="cluster name to identify the Rados cluster", required=False) 700 p.set_defaults(func=bdev_rbd_create) 701 702 def bdev_rbd_delete(args): 703 rpc.bdev.bdev_rbd_delete(args.client, 704 name=args.name) 705 706 p = subparsers.add_parser('bdev_rbd_delete', aliases=['delete_rbd_bdev'], 707 help='Delete a rbd bdev') 708 p.add_argument('name', help='rbd bdev name') 709 p.set_defaults(func=bdev_rbd_delete) 710 711 def bdev_rbd_resize(args): 712 print_json(rpc.bdev.bdev_rbd_resize(args.client, 713 name=args.name, 714 new_size=int(args.new_size))) 715 rpc.bdev.bdev_rbd_resize(args.client, 716 name=args.name, 717 new_size=int(args.new_size)) 718 719 p = subparsers.add_parser('bdev_rbd_resize', 720 help='Resize a rbd bdev') 721 p.add_argument('name', help='rbd bdev name') 722 p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB') 723 p.set_defaults(func=bdev_rbd_resize) 724 725 def bdev_delay_create(args): 726 print_json(rpc.bdev.bdev_delay_create(args.client, 727 base_bdev_name=args.base_bdev_name, 728 name=args.name, 729 avg_read_latency=args.avg_read_latency, 730 p99_read_latency=args.nine_nine_read_latency, 731 avg_write_latency=args.avg_write_latency, 732 p99_write_latency=args.nine_nine_write_latency)) 733 734 p = subparsers.add_parser('bdev_delay_create', 735 help='Add a delay bdev on existing bdev') 736 p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True) 737 p.add_argument('-d', '--name', help="Name of the delay bdev", required=True) 738 p.add_argument('-r', '--avg-read-latency', 739 help="Average latency to apply before completing read ops (in microseconds)", required=True, type=int) 740 p.add_argument('-t', '--nine-nine-read-latency', 741 help="latency to apply to 1 in 100 read ops (in microseconds)", required=True, type=int) 742 p.add_argument('-w', '--avg-write-latency', 743 help="Average latency to apply before completing write ops (in microseconds)", required=True, type=int) 744 p.add_argument('-n', '--nine-nine-write-latency', 745 help="latency to apply to 1 in 100 write ops (in microseconds)", required=True, type=int) 746 p.set_defaults(func=bdev_delay_create) 747 748 def bdev_delay_delete(args): 749 rpc.bdev.bdev_delay_delete(args.client, 750 name=args.name) 751 752 p = subparsers.add_parser('bdev_delay_delete', help='Delete a delay bdev') 753 p.add_argument('name', help='delay bdev name') 754 p.set_defaults(func=bdev_delay_delete) 755 756 def bdev_delay_update_latency(args): 757 print_json(rpc.bdev.bdev_delay_update_latency(args.client, 758 delay_bdev_name=args.delay_bdev_name, 759 latency_type=args.latency_type, 760 latency_us=args.latency_us)) 761 p = subparsers.add_parser('bdev_delay_update_latency', 762 help='Update one of the latency values for a given delay bdev') 763 p.add_argument('delay_bdev_name', help='The name of the given delay bdev') 764 p.add_argument('latency_type', help='one of: avg_read, avg_write, p99_read, p99_write. No other values accepted.') 765 p.add_argument('latency_us', help='new latency value in microseconds.', type=int) 766 p.set_defaults(func=bdev_delay_update_latency) 767 768 def bdev_error_create(args): 769 print_json(rpc.bdev.bdev_error_create(args.client, 770 base_name=args.base_name)) 771 772 p = subparsers.add_parser('bdev_error_create', aliases=['construct_error_bdev'], 773 help='Add bdev with error injection backend') 774 p.add_argument('base_name', help='base bdev name') 775 p.set_defaults(func=bdev_error_create) 776 777 def bdev_error_delete(args): 778 rpc.bdev.bdev_error_delete(args.client, 779 name=args.name) 780 781 p = subparsers.add_parser('bdev_error_delete', aliases=['delete_error_bdev'], 782 help='Delete an error bdev') 783 p.add_argument('name', help='error bdev name') 784 p.set_defaults(func=bdev_error_delete) 785 786 def bdev_iscsi_create(args): 787 print_json(rpc.bdev.bdev_iscsi_create(args.client, 788 name=args.name, 789 url=args.url, 790 initiator_iqn=args.initiator_iqn)) 791 792 p = subparsers.add_parser('bdev_iscsi_create', aliases=['construct_iscsi_bdev'], 793 help='Add bdev with iSCSI initiator backend') 794 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 795 p.add_argument('-i', '--initiator-iqn', help="Initiator IQN", required=True) 796 p.add_argument('--url', help="iSCSI Lun URL", required=True) 797 p.set_defaults(func=bdev_iscsi_create) 798 799 def bdev_iscsi_delete(args): 800 rpc.bdev.bdev_iscsi_delete(args.client, 801 name=args.name) 802 803 p = subparsers.add_parser('bdev_iscsi_delete', aliases=['delete_iscsi_bdev'], 804 help='Delete an iSCSI bdev') 805 p.add_argument('name', help='iSCSI bdev name') 806 p.set_defaults(func=bdev_iscsi_delete) 807 808 def bdev_pmem_create(args): 809 print_json(rpc.bdev.bdev_pmem_create(args.client, 810 pmem_file=args.pmem_file, 811 name=args.name)) 812 813 p = subparsers.add_parser('bdev_pmem_create', aliases=['construct_pmem_bdev'], 814 help='Add a bdev with pmem backend') 815 p.add_argument('pmem_file', help='Path to pmemblk pool file') 816 p.add_argument('-n', '--name', help='Block device name', required=True) 817 p.set_defaults(func=bdev_pmem_create) 818 819 def bdev_pmem_delete(args): 820 rpc.bdev.bdev_pmem_delete(args.client, 821 name=args.name) 822 823 p = subparsers.add_parser('bdev_pmem_delete', aliases=['delete_pmem_bdev'], 824 help='Delete a pmem bdev') 825 p.add_argument('name', help='pmem bdev name') 826 p.set_defaults(func=bdev_pmem_delete) 827 828 def bdev_passthru_create(args): 829 print_json(rpc.bdev.bdev_passthru_create(args.client, 830 base_bdev_name=args.base_bdev_name, 831 name=args.name)) 832 833 p = subparsers.add_parser('bdev_passthru_create', aliases=['construct_passthru_bdev'], 834 help='Add a pass through bdev on existing bdev') 835 p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True) 836 p.add_argument('-p', '--name', help="Name of the pass through bdev", required=True) 837 p.set_defaults(func=bdev_passthru_create) 838 839 def bdev_passthru_delete(args): 840 rpc.bdev.bdev_passthru_delete(args.client, 841 name=args.name) 842 843 p = subparsers.add_parser('bdev_passthru_delete', aliases=['delete_passthru_bdev'], 844 help='Delete a pass through bdev') 845 p.add_argument('name', help='pass through bdev name') 846 p.set_defaults(func=bdev_passthru_delete) 847 848 def bdev_get_bdevs(args): 849 print_dict(rpc.bdev.bdev_get_bdevs(args.client, 850 name=args.name)) 851 852 p = subparsers.add_parser('bdev_get_bdevs', aliases=['get_bdevs'], 853 help='Display current blockdev list or required blockdev') 854 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 855 p.set_defaults(func=bdev_get_bdevs) 856 857 def bdev_get_iostat(args): 858 print_dict(rpc.bdev.bdev_get_iostat(args.client, 859 name=args.name)) 860 861 p = subparsers.add_parser('bdev_get_iostat', aliases=['get_bdevs_iostat'], 862 help='Display current I/O statistics of all the blockdevs or required blockdev.') 863 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 864 p.set_defaults(func=bdev_get_iostat) 865 866 def bdev_enable_histogram(args): 867 rpc.bdev.bdev_enable_histogram(args.client, name=args.name, enable=args.enable) 868 869 p = subparsers.add_parser('bdev_enable_histogram', aliases=['enable_bdev_histogram'], 870 help='Enable or disable histogram for specified bdev') 871 p.add_argument('-e', '--enable', default=True, dest='enable', action='store_true', help='Enable histograms on specified device') 872 p.add_argument('-d', '--disable', dest='enable', action='store_false', help='Disable histograms on specified device') 873 p.add_argument('name', help='bdev name') 874 p.set_defaults(func=bdev_enable_histogram) 875 876 def bdev_get_histogram(args): 877 print_dict(rpc.bdev.bdev_get_histogram(args.client, name=args.name)) 878 879 p = subparsers.add_parser('bdev_get_histogram', aliases=['get_bdev_histogram'], 880 help='Get histogram for specified bdev') 881 p.add_argument('name', help='bdev name') 882 p.set_defaults(func=bdev_get_histogram) 883 884 def bdev_set_qd_sampling_period(args): 885 rpc.bdev.bdev_set_qd_sampling_period(args.client, 886 name=args.name, 887 period=args.period) 888 889 p = subparsers.add_parser('bdev_set_qd_sampling_period', aliases=['set_bdev_qd_sampling_period'], 890 help="Enable or disable tracking of a bdev's queue depth.") 891 p.add_argument('name', help='Blockdev name. Example: Malloc0') 892 p.add_argument('period', help='Period with which to poll the block device queue depth in microseconds.' 893 ' If set to 0, polling will be disabled.', 894 type=int) 895 p.set_defaults(func=bdev_set_qd_sampling_period) 896 897 def bdev_set_qos_limit(args): 898 rpc.bdev.bdev_set_qos_limit(args.client, 899 name=args.name, 900 rw_ios_per_sec=args.rw_ios_per_sec, 901 rw_mbytes_per_sec=args.rw_mbytes_per_sec, 902 r_mbytes_per_sec=args.r_mbytes_per_sec, 903 w_mbytes_per_sec=args.w_mbytes_per_sec) 904 905 p = subparsers.add_parser('bdev_set_qos_limit', aliases=['set_bdev_qos_limit'], 906 help='Set QoS rate limit on a blockdev') 907 p.add_argument('name', help='Blockdev name to set QoS. Example: Malloc0') 908 p.add_argument('--rw_ios_per_sec', 909 help='R/W IOs per second limit (>=1000, example: 20000). 0 means unlimited.', 910 type=int, required=False) 911 p.add_argument('--rw_mbytes_per_sec', 912 help="R/W megabytes per second limit (>=10, example: 100). 0 means unlimited.", 913 type=int, required=False) 914 p.add_argument('--r_mbytes_per_sec', 915 help="Read megabytes per second limit (>=10, example: 100). 0 means unlimited.", 916 type=int, required=False) 917 p.add_argument('--w_mbytes_per_sec', 918 help="Write megabytes per second limit (>=10, example: 100). 0 means unlimited.", 919 type=int, required=False) 920 p.set_defaults(func=bdev_set_qos_limit) 921 922 def bdev_error_inject_error(args): 923 rpc.bdev.bdev_error_inject_error(args.client, 924 name=args.name, 925 io_type=args.io_type, 926 error_type=args.error_type, 927 num=args.num) 928 929 p = subparsers.add_parser('bdev_error_inject_error', aliases=['bdev_inject_error'], 930 help='bdev inject error') 931 p.add_argument('name', help="""the name of the error injection bdev""") 932 p.add_argument('io_type', help="""io_type: 'clear' 'read' 'write' 'unmap' 'flush' 'all'""") 933 p.add_argument('error_type', help="""error_type: 'failure' 'pending'""") 934 p.add_argument( 935 '-n', '--num', help='the number of commands you want to fail', type=int, default=1) 936 p.set_defaults(func=bdev_error_inject_error) 937 938 def bdev_nvme_apply_firmware(args): 939 print_dict(rpc.bdev.bdev_nvme_apply_firmware(args.client, 940 bdev_name=args.bdev_name, 941 filename=args.filename)) 942 943 p = subparsers.add_parser('bdev_nvme_apply_firmware', aliases=['apply_firmware'], 944 help='Download and commit firmware to NVMe device') 945 p.add_argument('filename', help='filename of the firmware to download') 946 p.add_argument('bdev_name', help='name of the NVMe device') 947 p.set_defaults(func=bdev_nvme_apply_firmware) 948 949 def bdev_nvme_get_transport_statistics(args): 950 print_dict(rpc.bdev.bdev_nvme_get_transport_statistics(args.client)) 951 952 p = subparsers.add_parser('bdev_nvme_get_transport_statistics', 953 help='Get bdev_nvme poll group transport statistics') 954 p.set_defaults(func=bdev_nvme_get_transport_statistics) 955 956 # iSCSI 957 def iscsi_set_options(args): 958 rpc.iscsi.iscsi_set_options( 959 args.client, 960 auth_file=args.auth_file, 961 node_base=args.node_base, 962 nop_timeout=args.nop_timeout, 963 nop_in_interval=args.nop_in_interval, 964 disable_chap=args.disable_chap, 965 require_chap=args.require_chap, 966 mutual_chap=args.mutual_chap, 967 chap_group=args.chap_group, 968 max_sessions=args.max_sessions, 969 max_queue_depth=args.max_queue_depth, 970 max_connections_per_session=args.max_connections_per_session, 971 default_time2wait=args.default_time2wait, 972 default_time2retain=args.default_time2retain, 973 first_burst_length=args.first_burst_length, 974 immediate_data=args.immediate_data, 975 error_recovery_level=args.error_recovery_level, 976 allow_duplicated_isid=args.allow_duplicated_isid, 977 max_large_datain_per_connection=args.max_large_datain_per_connection, 978 max_r2t_per_connection=args.max_r2t_per_connection) 979 980 p = subparsers.add_parser('iscsi_set_options', aliases=['set_iscsi_options'], 981 help="""Set options of iSCSI subsystem""") 982 p.add_argument('-f', '--auth-file', help='Path to CHAP shared secret file') 983 p.add_argument('-b', '--node-base', help='Prefix of the name of iSCSI target node') 984 p.add_argument('-o', '--nop-timeout', help='Timeout in seconds to nop-in request to the initiator', type=int) 985 p.add_argument('-n', '--nop-in-interval', help='Time interval in secs between nop-in requests by the target', type=int) 986 p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled. 987 *** Mutually exclusive with --require-chap""", action='store_true') 988 p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required. 989 *** Mutually exclusive with --disable-chap""", action='store_true') 990 p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true') 991 p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session. 992 *** Authentication group must be precreated ***""", type=int) 993 p.add_argument('-a', '--max-sessions', help='Maximum number of sessions in the host.', type=int) 994 p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/Os per queue.', type=int) 995 p.add_argument('-c', '--max-connections-per-session', help='Negotiated parameter, MaxConnections.', type=int) 996 p.add_argument('-w', '--default-time2wait', help='Negotiated parameter, DefaultTime2Wait.', type=int) 997 p.add_argument('-v', '--default-time2retain', help='Negotiated parameter, DefaultTime2Retain.', type=int) 998 p.add_argument('-s', '--first-burst-length', help='Negotiated parameter, FirstBurstLength.', type=int) 999 p.add_argument('-i', '--immediate-data', help='Negotiated parameter, ImmediateData.', action='store_true') 1000 p.add_argument('-l', '--error-recovery-level', help='Negotiated parameter, ErrorRecoveryLevel', type=int) 1001 p.add_argument('-p', '--allow-duplicated-isid', help='Allow duplicated initiator session ID.', action='store_true') 1002 p.add_argument('-x', '--max-large-datain-per-connection', help='Max number of outstanding split read I/Os per connection', type=int) 1003 p.add_argument('-k', '--max-r2t-per-connection', help='Max number of outstanding R2Ts per connection', type=int) 1004 p.set_defaults(func=iscsi_set_options) 1005 1006 def iscsi_set_discovery_auth(args): 1007 rpc.iscsi.iscsi_set_discovery_auth( 1008 args.client, 1009 disable_chap=args.disable_chap, 1010 require_chap=args.require_chap, 1011 mutual_chap=args.mutual_chap, 1012 chap_group=args.chap_group) 1013 1014 p = subparsers.add_parser('iscsi_set_discovery_auth', aliases=['set_iscsi_discovery_auth'], 1015 help="""Set CHAP authentication for discovery session.""") 1016 p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled. 1017 *** Mutually exclusive with --require-chap""", action='store_true') 1018 p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required. 1019 *** Mutually exclusive with --disable-chap""", action='store_true') 1020 p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true') 1021 p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session. 1022 *** Authentication group must be precreated ***""", type=int) 1023 p.set_defaults(func=iscsi_set_discovery_auth) 1024 1025 def iscsi_create_auth_group(args): 1026 secrets = None 1027 if args.secrets: 1028 secrets = [dict(u.split(":") for u in a.split(" ")) for a in args.secrets.split(",")] 1029 1030 rpc.iscsi.iscsi_create_auth_group(args.client, tag=args.tag, secrets=secrets) 1031 1032 p = subparsers.add_parser('iscsi_create_auth_group', aliases=['add_iscsi_auth_group'], 1033 help='Create authentication group for CHAP authentication.') 1034 p.add_argument('tag', help='Authentication group tag (unique, integer > 0).', type=int) 1035 p.add_argument('-c', '--secrets', help="""Comma-separated list of CHAP secrets 1036<user:user_name secret:chap_secret muser:mutual_user_name msecret:mutual_chap_secret> enclosed in quotes. 1037Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 msecret:ms2'""", required=False) 1038 p.set_defaults(func=iscsi_create_auth_group) 1039 1040 def iscsi_delete_auth_group(args): 1041 rpc.iscsi.iscsi_delete_auth_group(args.client, tag=args.tag) 1042 1043 p = subparsers.add_parser('iscsi_delete_auth_group', aliases=['delete_iscsi_auth_group'], 1044 help='Delete an authentication group.') 1045 p.add_argument('tag', help='Authentication group tag', type=int) 1046 p.set_defaults(func=iscsi_delete_auth_group) 1047 1048 def iscsi_auth_group_add_secret(args): 1049 rpc.iscsi.iscsi_auth_group_add_secret( 1050 args.client, 1051 tag=args.tag, 1052 user=args.user, 1053 secret=args.secret, 1054 muser=args.muser, 1055 msecret=args.msecret) 1056 1057 p = subparsers.add_parser('iscsi_auth_group_add_secret', aliases=['add_secret_to_iscsi_auth_group'], 1058 help='Add a secret to an authentication group.') 1059 p.add_argument('tag', help='Authentication group tag', type=int) 1060 p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True) 1061 p.add_argument('-s', '--secret', help='Secret for one-way CHAP authentication', required=True) 1062 p.add_argument('-m', '--muser', help='User name for mutual CHAP authentication') 1063 p.add_argument('-r', '--msecret', help='Secret for mutual CHAP authentication') 1064 p.set_defaults(func=iscsi_auth_group_add_secret) 1065 1066 def iscsi_auth_group_remove_secret(args): 1067 rpc.iscsi.iscsi_auth_group_remove_secret(args.client, tag=args.tag, user=args.user) 1068 1069 p = subparsers.add_parser('iscsi_auth_group_remove_secret', aliases=['delete_secret_from_iscsi_auth_group'], 1070 help='Remove a secret from an authentication group.') 1071 p.add_argument('tag', help='Authentication group tag', type=int) 1072 p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True) 1073 p.set_defaults(func=iscsi_auth_group_remove_secret) 1074 1075 def iscsi_get_auth_groups(args): 1076 print_dict(rpc.iscsi.iscsi_get_auth_groups(args.client)) 1077 1078 p = subparsers.add_parser('iscsi_get_auth_groups', aliases=['get_iscsi_auth_groups'], 1079 help='Display current authentication group configuration') 1080 p.set_defaults(func=iscsi_get_auth_groups) 1081 1082 def iscsi_get_portal_groups(args): 1083 print_dict(rpc.iscsi.iscsi_get_portal_groups(args.client)) 1084 1085 p = subparsers.add_parser( 1086 'iscsi_get_portal_groups', aliases=['get_portal_groups'], 1087 help='Display current portal group configuration') 1088 p.set_defaults(func=iscsi_get_portal_groups) 1089 1090 def iscsi_get_initiator_groups(args): 1091 print_dict(rpc.iscsi.iscsi_get_initiator_groups(args.client)) 1092 1093 p = subparsers.add_parser('iscsi_get_initiator_groups', 1094 aliases=['get_initiator_groups'], 1095 help='Display current initiator group configuration') 1096 p.set_defaults(func=iscsi_get_initiator_groups) 1097 1098 def iscsi_get_target_nodes(args): 1099 print_dict(rpc.iscsi.iscsi_get_target_nodes(args.client)) 1100 1101 p = subparsers.add_parser('iscsi_get_target_nodes', aliases=['get_target_nodes'], 1102 help='Display target nodes') 1103 p.set_defaults(func=iscsi_get_target_nodes) 1104 1105 def iscsi_create_target_node(args): 1106 luns = [] 1107 for u in args.bdev_name_id_pairs.strip().split(" "): 1108 bdev_name, lun_id = u.split(":") 1109 luns.append({"bdev_name": bdev_name, "lun_id": int(lun_id)}) 1110 1111 pg_ig_maps = [] 1112 for u in args.pg_ig_mappings.strip().split(" "): 1113 pg, ig = u.split(":") 1114 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1115 1116 rpc.iscsi.iscsi_create_target_node( 1117 args.client, 1118 luns=luns, 1119 pg_ig_maps=pg_ig_maps, 1120 name=args.name, 1121 alias_name=args.alias_name, 1122 queue_depth=args.queue_depth, 1123 chap_group=args.chap_group, 1124 disable_chap=args.disable_chap, 1125 require_chap=args.require_chap, 1126 mutual_chap=args.mutual_chap, 1127 header_digest=args.header_digest, 1128 data_digest=args.data_digest) 1129 1130 p = subparsers.add_parser('iscsi_create_target_node', aliases=['construct_target_node'], 1131 help='Add a target node') 1132 p.add_argument('name', help='Target node name (ASCII)') 1133 p.add_argument('alias_name', help='Target node alias name (ASCII)') 1134 p.add_argument('bdev_name_id_pairs', help="""Whitespace-separated list of <bdev name:LUN ID> pairs enclosed 1135 in quotes. Format: 'bdev_name0:id0 bdev_name1:id1' etc 1136 Example: 'Malloc0:0 Malloc1:1 Malloc5:2' 1137 *** The bdevs must pre-exist *** 1138 *** LUN0 (id = 0) is required *** 1139 *** bdevs names cannot contain space or colon characters ***""") 1140 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1141 Whitespace separated, quoted, mapping defined with colon 1142 separated list of "tags" (int > 0) 1143 Example: '1:1 2:2 2:1' 1144 *** The Portal/Initiator Groups must be precreated ***""") 1145 p.add_argument('queue_depth', help='Desired target queue depth', type=int) 1146 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node. 1147 *** Authentication group must be precreated ***""", type=int, default=0) 1148 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node. 1149 *** Mutually exclusive with --require-chap ***""", action='store_true') 1150 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node. 1151 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1152 p.add_argument( 1153 '-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', action='store_true') 1154 p.add_argument('-H', '--header-digest', 1155 help='Header Digest should be required for this target node.', action='store_true') 1156 p.add_argument('-D', '--data-digest', 1157 help='Data Digest should be required for this target node.', action='store_true') 1158 p.set_defaults(func=iscsi_create_target_node) 1159 1160 def iscsi_target_node_add_lun(args): 1161 rpc.iscsi.iscsi_target_node_add_lun( 1162 args.client, 1163 name=args.name, 1164 bdev_name=args.bdev_name, 1165 lun_id=args.lun_id) 1166 1167 p = subparsers.add_parser('iscsi_target_node_add_lun', aliases=['target_node_add_lun'], 1168 help='Add LUN to the target node') 1169 p.add_argument('name', help='Target node name (ASCII)') 1170 p.add_argument('bdev_name', help="""bdev name enclosed in quotes. 1171 *** bdev name cannot contain space or colon characters ***""") 1172 p.add_argument('-i', dest='lun_id', help="""LUN ID (integer >= 0) 1173 *** If LUN ID is omitted or -1, the lowest free one is assigned ***""", type=int, required=False) 1174 p.set_defaults(func=iscsi_target_node_add_lun) 1175 1176 def iscsi_target_node_set_auth(args): 1177 rpc.iscsi.iscsi_target_node_set_auth( 1178 args.client, 1179 name=args.name, 1180 chap_group=args.chap_group, 1181 disable_chap=args.disable_chap, 1182 require_chap=args.require_chap, 1183 mutual_chap=args.mutual_chap) 1184 1185 p = subparsers.add_parser('iscsi_target_node_set_auth', aliases=['set_iscsi_target_node_auth'], 1186 help='Set CHAP authentication for the target node') 1187 p.add_argument('name', help='Target node name (ASCII)') 1188 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node. 1189 *** Authentication group must be precreated ***""", type=int, default=0) 1190 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node. 1191 *** Mutually exclusive with --require-chap ***""", action='store_true') 1192 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node. 1193 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1194 p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', 1195 action='store_true') 1196 p.set_defaults(func=iscsi_target_node_set_auth) 1197 1198 def iscsi_target_node_add_pg_ig_maps(args): 1199 pg_ig_maps = [] 1200 for u in args.pg_ig_mappings.strip().split(" "): 1201 pg, ig = u.split(":") 1202 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1203 rpc.iscsi.iscsi_target_node_add_pg_ig_maps( 1204 args.client, 1205 pg_ig_maps=pg_ig_maps, 1206 name=args.name) 1207 1208 p = subparsers.add_parser('iscsi_target_node_add_pg_ig_maps', 1209 aliases=['add_pg_ig_maps'], 1210 help='Add PG-IG maps to the target node') 1211 p.add_argument('name', help='Target node name (ASCII)') 1212 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1213 Whitespace separated, quoted, mapping defined with colon 1214 separated list of "tags" (int > 0) 1215 Example: '1:1 2:2 2:1' 1216 *** The Portal/Initiator Groups must be precreated ***""") 1217 p.set_defaults(func=iscsi_target_node_add_pg_ig_maps) 1218 1219 def iscsi_target_node_remove_pg_ig_maps(args): 1220 pg_ig_maps = [] 1221 for u in args.pg_ig_mappings.strip().split(" "): 1222 pg, ig = u.split(":") 1223 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1224 rpc.iscsi.iscsi_target_node_remove_pg_ig_maps( 1225 args.client, pg_ig_maps=pg_ig_maps, name=args.name) 1226 1227 p = subparsers.add_parser('iscsi_target_node_remove_pg_ig_maps', 1228 aliases=['delete_pg_ig_maps'], 1229 help='Delete PG-IG maps from the target node') 1230 p.add_argument('name', help='Target node name (ASCII)') 1231 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1232 Whitespace separated, quoted, mapping defined with colon 1233 separated list of "tags" (int > 0) 1234 Example: '1:1 2:2 2:1' 1235 *** The Portal/Initiator Groups must be precreated ***""") 1236 p.set_defaults(func=iscsi_target_node_remove_pg_ig_maps) 1237 1238 def iscsi_target_node_set_redirect(args): 1239 rpc.iscsi.iscsi_target_node_set_redirect( 1240 args.client, 1241 name=args.name, 1242 pg_tag=args.pg_tag, 1243 redirect_host=args.redirect_host, 1244 redirect_port=args.redirect_port) 1245 1246 p = subparsers.add_parser('iscsi_target_node_set_redirect', 1247 help="""Update redirect portal of the public portal group for the target node. 1248 Omit redirect host and port to clear previously set redirect settings.""") 1249 p.add_argument('name', help='Target node name (ASCII)') 1250 p.add_argument('pg_tag', help='Portal group tag (unique, integer > 0)', type=int) 1251 p.add_argument('-a', '--redirect_host', help='Numeric IP address for redirect portal', required=False) 1252 p.add_argument('-p', '--redirect_port', help='Numeric TCP port for redirect portal', required=False) 1253 p.set_defaults(func=iscsi_target_node_set_redirect) 1254 1255 def iscsi_target_node_request_logout(args): 1256 rpc.iscsi.iscsi_target_node_request_logout( 1257 args.client, 1258 name=args.name, 1259 pg_tag=args.pg_tag) 1260 1261 p = subparsers.add_parser('iscsi_target_node_request_logout', 1262 help="""For the target node, request connections whose portal group tag 1263 match to logout, or request all connections if portal group tag is omitted.""") 1264 p.add_argument('name', help='Target node name (ASCII)') 1265 p.add_argument('-t', '--pg-tag', help='Portal group tag (unique, integer > 0)', type=int, required=False) 1266 p.set_defaults(func=iscsi_target_node_request_logout) 1267 1268 def iscsi_create_portal_group(args): 1269 portals = [] 1270 for p in args.portal_list.strip().split(' '): 1271 ip, separator, port_cpumask = p.rpartition(':') 1272 split_port_cpumask = port_cpumask.split('@') 1273 if len(split_port_cpumask) == 1: 1274 port = port_cpumask 1275 portals.append({'host': ip, 'port': port}) 1276 else: 1277 port = split_port_cpumask[0] 1278 cpumask = split_port_cpumask[1] 1279 portals.append({'host': ip, 'port': port}) 1280 print("WARNING: Specifying a portal group with a CPU mask is no longer supported. Ignoring it.") 1281 rpc.iscsi.iscsi_create_portal_group( 1282 args.client, 1283 portals=portals, 1284 tag=args.tag, 1285 private=args.private, 1286 wait=args.wait) 1287 1288 p = subparsers.add_parser('iscsi_create_portal_group', aliases=['add_portal_group'], 1289 help='Add a portal group') 1290 p.add_argument( 1291 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1292 p.add_argument('portal_list', help="""List of portals in host:port format, separated by whitespace 1293 Example: '192.168.100.100:3260 192.168.100.100:3261 192.168.100.100:3262""") 1294 p.add_argument('-p', '--private', help="""Public (false) or private (true) portal group. 1295 Private portal groups do not have their portals returned by a discovery session. A public 1296 portal group may optionally specify a redirect portal for non-discovery logins. This redirect 1297 portal must be from a private portal group.""", action='store_true') 1298 p.add_argument('-w', '--wait', help="""Do not listening on portals until it is started explicitly. 1299 One major iSCSI initiator may not retry login once it failed. Hence for such initiator, listening 1300 on portals should be allowed after all associated target nodes are created.""", action='store_true') 1301 p.set_defaults(func=iscsi_create_portal_group) 1302 1303 def iscsi_start_portal_group(args): 1304 rpc.iscsi.iscsi_start_portal_group(args.client, tag=args.tag) 1305 1306 p = subparsers.add_parser('iscsi_start_portal_group', 1307 help='Start listening on portals if it is not started yet.') 1308 p.add_argument( 1309 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1310 p.set_defaults(func=iscsi_start_portal_group) 1311 1312 def iscsi_create_initiator_group(args): 1313 initiators = [] 1314 netmasks = [] 1315 for i in args.initiator_list.strip().split(' '): 1316 initiators.append(i) 1317 for n in args.netmask_list.strip().split(' '): 1318 netmasks.append(n) 1319 rpc.iscsi.iscsi_create_initiator_group( 1320 args.client, 1321 tag=args.tag, 1322 initiators=initiators, 1323 netmasks=netmasks) 1324 1325 p = subparsers.add_parser('iscsi_create_initiator_group', aliases=['add_initiator_group'], 1326 help='Add an initiator group') 1327 p.add_argument( 1328 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1329 p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1330 enclosed in quotes. Example: 'ANY' or '127.0.0.1 192.168.200.100'""") 1331 p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1332 Example: '255.255.0.0 255.248.0.0' etc""") 1333 p.set_defaults(func=iscsi_create_initiator_group) 1334 1335 def iscsi_initiator_group_add_initiators(args): 1336 initiators = None 1337 netmasks = None 1338 if args.initiator_list: 1339 initiators = [] 1340 for i in args.initiator_list.strip().split(' '): 1341 initiators.append(i) 1342 if args.netmask_list: 1343 netmasks = [] 1344 for n in args.netmask_list.strip().split(' '): 1345 netmasks.append(n) 1346 rpc.iscsi.iscsi_initiator_group_add_initiators( 1347 args.client, 1348 tag=args.tag, 1349 initiators=initiators, 1350 netmasks=netmasks) 1351 1352 p = subparsers.add_parser('iscsi_initiator_group_add_initiators', 1353 aliases=['add_initiators_to_initiator_group'], 1354 help='Add initiators to an existing initiator group') 1355 p.add_argument( 1356 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1357 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1358 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or '127.0.0.1 192.168.200.100'""", required=False) 1359 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1360 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""", required=False) 1361 p.set_defaults(func=iscsi_initiator_group_add_initiators) 1362 1363 def iscsi_initiator_group_remove_initiators(args): 1364 initiators = None 1365 netmasks = None 1366 if args.initiator_list: 1367 initiators = [] 1368 for i in args.initiator_list.strip().split(' '): 1369 initiators.append(i) 1370 if args.netmask_list: 1371 netmasks = [] 1372 for n in args.netmask_list.strip().split(' '): 1373 netmasks.append(n) 1374 rpc.iscsi.iscsi_initiator_group_remove_initiators( 1375 args.client, 1376 tag=args.tag, 1377 initiators=initiators, 1378 netmasks=netmasks) 1379 1380 p = subparsers.add_parser('iscsi_initiator_group_remove_initiators', 1381 aliases=['delete_initiators_from_initiator_group'], 1382 help='Delete initiators from an existing initiator group') 1383 p.add_argument( 1384 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1385 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1386 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or '127.0.0.1 192.168.200.100'""", required=False) 1387 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1388 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""", required=False) 1389 p.set_defaults(func=iscsi_initiator_group_remove_initiators) 1390 1391 def iscsi_delete_target_node(args): 1392 rpc.iscsi.iscsi_delete_target_node( 1393 args.client, target_node_name=args.target_node_name) 1394 1395 p = subparsers.add_parser('iscsi_delete_target_node', aliases=['delete_target_node'], 1396 help='Delete a target node') 1397 p.add_argument('target_node_name', 1398 help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.') 1399 p.set_defaults(func=iscsi_delete_target_node) 1400 1401 def iscsi_delete_portal_group(args): 1402 rpc.iscsi.iscsi_delete_portal_group(args.client, tag=args.tag) 1403 1404 p = subparsers.add_parser('iscsi_delete_portal_group', 1405 aliases=['delete_portal_group'], 1406 help='Delete a portal group') 1407 p.add_argument( 1408 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1409 p.set_defaults(func=iscsi_delete_portal_group) 1410 1411 def iscsi_delete_initiator_group(args): 1412 rpc.iscsi.iscsi_delete_initiator_group(args.client, tag=args.tag) 1413 1414 p = subparsers.add_parser('iscsi_delete_initiator_group', 1415 aliases=['delete_initiator_group'], 1416 help='Delete an initiator group') 1417 p.add_argument( 1418 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1419 p.set_defaults(func=iscsi_delete_initiator_group) 1420 1421 def iscsi_portal_group_set_auth(args): 1422 rpc.iscsi.iscsi_portal_group_set_auth( 1423 args.client, 1424 tag=args.tag, 1425 chap_group=args.chap_group, 1426 disable_chap=args.disable_chap, 1427 require_chap=args.require_chap, 1428 mutual_chap=args.mutual_chap) 1429 1430 p = subparsers.add_parser('iscsi_portal_group_set_auth', 1431 help='Set CHAP authentication for discovery sessions specific for the portal group') 1432 p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int) 1433 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this portal group. 1434 *** Authentication group must be precreated ***""", type=int, default=0) 1435 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this portal group. 1436 *** Mutually exclusive with --require-chap ***""", action='store_true') 1437 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this portal group. 1438 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1439 p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', 1440 action='store_true') 1441 p.set_defaults(func=iscsi_portal_group_set_auth) 1442 1443 def iscsi_get_connections(args): 1444 print_dict(rpc.iscsi.iscsi_get_connections(args.client)) 1445 1446 p = subparsers.add_parser('iscsi_get_connections', aliases=['get_iscsi_connections'], 1447 help='Display iSCSI connections') 1448 p.set_defaults(func=iscsi_get_connections) 1449 1450 def iscsi_get_options(args): 1451 print_dict(rpc.iscsi.iscsi_get_options(args.client)) 1452 1453 p = subparsers.add_parser('iscsi_get_options', aliases=['get_iscsi_global_params'], 1454 help='Display iSCSI global parameters') 1455 p.set_defaults(func=iscsi_get_options) 1456 1457 def scsi_get_devices(args): 1458 print_dict(rpc.iscsi.scsi_get_devices(args.client)) 1459 1460 p = subparsers.add_parser('scsi_get_devices', aliases=['get_scsi_devices'], 1461 help='Display SCSI devices') 1462 p.set_defaults(func=scsi_get_devices) 1463 1464 # trace 1465 def trace_enable_tpoint_group(args): 1466 rpc.trace.trace_enable_tpoint_group(args.client, name=args.name) 1467 1468 p = subparsers.add_parser('trace_enable_tpoint_group', aliases=['enable_tpoint_group'], 1469 help='enable trace on a specific tpoint group') 1470 p.add_argument( 1471 'name', help="""trace group name we want to enable in tpoint_group_mask. 1472 (for example "bdev" for bdev trace group, "all" for all trace groups).""") 1473 p.set_defaults(func=trace_enable_tpoint_group) 1474 1475 def trace_disable_tpoint_group(args): 1476 rpc.trace.trace_disable_tpoint_group(args.client, name=args.name) 1477 1478 p = subparsers.add_parser('trace_disable_tpoint_group', aliases=['disable_tpoint_group'], 1479 help='disable trace on a specific tpoint group') 1480 p.add_argument( 1481 'name', help="""trace group name we want to disable in tpoint_group_mask. 1482 (for example "bdev" for bdev trace group, "all" for all trace groups).""") 1483 p.set_defaults(func=trace_disable_tpoint_group) 1484 1485 def trace_get_tpoint_group_mask(args): 1486 print_dict(rpc.trace.trace_get_tpoint_group_mask(args.client)) 1487 1488 p = subparsers.add_parser('trace_get_tpoint_group_mask', aliases=['get_tpoint_group_mask'], 1489 help='get trace point group mask') 1490 p.set_defaults(func=trace_get_tpoint_group_mask) 1491 1492 # log 1493 def log_set_flag(args): 1494 rpc.log.log_set_flag(args.client, flag=args.flag) 1495 1496 p = subparsers.add_parser('log_set_flag', help='set log flag', aliases=['set_log_flag']) 1497 p.add_argument( 1498 'flag', help='log flag we want to set. (for example "nvme").') 1499 p.set_defaults(func=log_set_flag) 1500 1501 def log_clear_flag(args): 1502 rpc.log.log_clear_flag(args.client, flag=args.flag) 1503 1504 p = subparsers.add_parser('log_clear_flag', help='clear log flag', aliases=['clear_log_flag']) 1505 p.add_argument( 1506 'flag', help='log flag we want to clear. (for example "nvme").') 1507 p.set_defaults(func=log_clear_flag) 1508 1509 def log_get_flags(args): 1510 print_dict(rpc.log.log_get_flags(args.client)) 1511 1512 p = subparsers.add_parser('log_get_flags', help='get log flags', aliases=['get_log_flags']) 1513 p.set_defaults(func=log_get_flags) 1514 1515 def log_set_level(args): 1516 rpc.log.log_set_level(args.client, level=args.level) 1517 1518 p = subparsers.add_parser('log_set_level', aliases=['set_log_level'], 1519 help='set log level') 1520 p.add_argument('level', help='log level we want to set. (for example "DEBUG").') 1521 p.set_defaults(func=log_set_level) 1522 1523 def log_get_level(args): 1524 print_dict(rpc.log.log_get_level(args.client)) 1525 1526 p = subparsers.add_parser('log_get_level', aliases=['get_log_level'], 1527 help='get log level') 1528 p.set_defaults(func=log_get_level) 1529 1530 def log_set_print_level(args): 1531 rpc.log.log_set_print_level(args.client, level=args.level) 1532 1533 p = subparsers.add_parser('log_set_print_level', aliases=['set_log_print_level'], 1534 help='set log print level') 1535 p.add_argument('level', help='log print level we want to set. (for example "DEBUG").') 1536 p.set_defaults(func=log_set_print_level) 1537 1538 def log_get_print_level(args): 1539 print_dict(rpc.log.log_get_print_level(args.client)) 1540 1541 p = subparsers.add_parser('log_get_print_level', aliases=['get_log_print_level'], 1542 help='get log print level') 1543 p.set_defaults(func=log_get_print_level) 1544 1545 # lvol 1546 def bdev_lvol_create_lvstore(args): 1547 print_json(rpc.lvol.bdev_lvol_create_lvstore(args.client, 1548 bdev_name=args.bdev_name, 1549 lvs_name=args.lvs_name, 1550 cluster_sz=args.cluster_sz, 1551 clear_method=args.clear_method)) 1552 1553 p = subparsers.add_parser('bdev_lvol_create_lvstore', aliases=['construct_lvol_store'], 1554 help='Add logical volume store on base bdev') 1555 p.add_argument('bdev_name', help='base bdev name') 1556 p.add_argument('lvs_name', help='name for lvol store') 1557 p.add_argument('-c', '--cluster-sz', help='size of cluster (in bytes)', type=int, required=False) 1558 p.add_argument('--clear-method', help="""Change clear method for data region. 1559 Available: none, unmap, write_zeroes""", required=False) 1560 p.set_defaults(func=bdev_lvol_create_lvstore) 1561 1562 def bdev_lvol_rename_lvstore(args): 1563 rpc.lvol.bdev_lvol_rename_lvstore(args.client, 1564 old_name=args.old_name, 1565 new_name=args.new_name) 1566 1567 p = subparsers.add_parser('bdev_lvol_rename_lvstore', aliases=['rename_lvol_store'], 1568 help='Change logical volume store name') 1569 p.add_argument('old_name', help='old name') 1570 p.add_argument('new_name', help='new name') 1571 p.set_defaults(func=bdev_lvol_rename_lvstore) 1572 1573 def bdev_lvol_create(args): 1574 print_json(rpc.lvol.bdev_lvol_create(args.client, 1575 lvol_name=args.lvol_name, 1576 size=args.size * 1024 * 1024, 1577 thin_provision=args.thin_provision, 1578 clear_method=args.clear_method, 1579 uuid=args.uuid, 1580 lvs_name=args.lvs_name)) 1581 1582 p = subparsers.add_parser('bdev_lvol_create', aliases=['construct_lvol_bdev'], 1583 help='Add a bdev with an logical volume backend') 1584 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 1585 p.add_argument('-l', '--lvs-name', help='lvol store name', required=False) 1586 p.add_argument('-t', '--thin-provision', action='store_true', help='create lvol bdev as thin provisioned') 1587 p.add_argument('-c', '--clear-method', help="""Change default data clusters clear method. 1588 Available: none, unmap, write_zeroes""", required=False) 1589 p.add_argument('lvol_name', help='name for this lvol') 1590 p.add_argument('size', help='size in MiB for this bdev', type=int) 1591 p.set_defaults(func=bdev_lvol_create) 1592 1593 def bdev_lvol_snapshot(args): 1594 print_json(rpc.lvol.bdev_lvol_snapshot(args.client, 1595 lvol_name=args.lvol_name, 1596 snapshot_name=args.snapshot_name)) 1597 1598 p = subparsers.add_parser('bdev_lvol_snapshot', aliases=['snapshot_lvol_bdev'], 1599 help='Create a snapshot of an lvol bdev') 1600 p.add_argument('lvol_name', help='lvol bdev name') 1601 p.add_argument('snapshot_name', help='lvol snapshot name') 1602 p.set_defaults(func=bdev_lvol_snapshot) 1603 1604 def bdev_lvol_clone(args): 1605 print_json(rpc.lvol.bdev_lvol_clone(args.client, 1606 snapshot_name=args.snapshot_name, 1607 clone_name=args.clone_name)) 1608 1609 p = subparsers.add_parser('bdev_lvol_clone', aliases=['clone_lvol_bdev'], 1610 help='Create a clone of an lvol snapshot') 1611 p.add_argument('snapshot_name', help='lvol snapshot name') 1612 p.add_argument('clone_name', help='lvol clone name') 1613 p.set_defaults(func=bdev_lvol_clone) 1614 1615 def bdev_lvol_rename(args): 1616 rpc.lvol.bdev_lvol_rename(args.client, 1617 old_name=args.old_name, 1618 new_name=args.new_name) 1619 1620 p = subparsers.add_parser('bdev_lvol_rename', aliases=['rename_lvol_bdev'], 1621 help='Change lvol bdev name') 1622 p.add_argument('old_name', help='lvol bdev name') 1623 p.add_argument('new_name', help='new lvol name') 1624 p.set_defaults(func=bdev_lvol_rename) 1625 1626 def bdev_lvol_inflate(args): 1627 rpc.lvol.bdev_lvol_inflate(args.client, 1628 name=args.name) 1629 1630 p = subparsers.add_parser('bdev_lvol_inflate', aliases=['inflate_lvol_bdev'], 1631 help='Make thin provisioned lvol a thick provisioned lvol') 1632 p.add_argument('name', help='lvol bdev name') 1633 p.set_defaults(func=bdev_lvol_inflate) 1634 1635 def bdev_lvol_decouple_parent(args): 1636 rpc.lvol.bdev_lvol_decouple_parent(args.client, 1637 name=args.name) 1638 1639 p = subparsers.add_parser('bdev_lvol_decouple_parent', aliases=['decouple_parent_lvol_bdev'], 1640 help='Decouple parent of lvol') 1641 p.add_argument('name', help='lvol bdev name') 1642 p.set_defaults(func=bdev_lvol_decouple_parent) 1643 1644 def bdev_lvol_resize(args): 1645 rpc.lvol.bdev_lvol_resize(args.client, 1646 name=args.name, 1647 size=args.size * 1024 * 1024) 1648 1649 p = subparsers.add_parser('bdev_lvol_resize', aliases=['resize_lvol_bdev'], 1650 help='Resize existing lvol bdev') 1651 p.add_argument('name', help='lvol bdev name') 1652 p.add_argument('size', help='new size in MiB for this bdev', type=int) 1653 p.set_defaults(func=bdev_lvol_resize) 1654 1655 def bdev_lvol_set_read_only(args): 1656 rpc.lvol.bdev_lvol_set_read_only(args.client, 1657 name=args.name) 1658 1659 p = subparsers.add_parser('bdev_lvol_set_read_only', aliases=['set_read_only_lvol_bdev'], 1660 help='Mark lvol bdev as read only') 1661 p.add_argument('name', help='lvol bdev name') 1662 p.set_defaults(func=bdev_lvol_set_read_only) 1663 1664 def bdev_lvol_delete(args): 1665 rpc.lvol.bdev_lvol_delete(args.client, 1666 name=args.name) 1667 1668 p = subparsers.add_parser('bdev_lvol_delete', aliases=['destroy_lvol_bdev'], 1669 help='Destroy a logical volume') 1670 p.add_argument('name', help='lvol bdev name') 1671 p.set_defaults(func=bdev_lvol_delete) 1672 1673 def bdev_lvol_delete_lvstore(args): 1674 rpc.lvol.bdev_lvol_delete_lvstore(args.client, 1675 uuid=args.uuid, 1676 lvs_name=args.lvs_name) 1677 1678 p = subparsers.add_parser('bdev_lvol_delete_lvstore', aliases=['destroy_lvol_store'], 1679 help='Destroy an logical volume store') 1680 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 1681 p.add_argument('-l', '--lvs-name', help='lvol store name', required=False) 1682 p.set_defaults(func=bdev_lvol_delete_lvstore) 1683 1684 def bdev_lvol_get_lvstores(args): 1685 print_dict(rpc.lvol.bdev_lvol_get_lvstores(args.client, 1686 uuid=args.uuid, 1687 lvs_name=args.lvs_name)) 1688 1689 p = subparsers.add_parser('bdev_lvol_get_lvstores', aliases=['get_lvol_stores'], 1690 help='Display current logical volume store list') 1691 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 1692 p.add_argument('-l', '--lvs-name', help='lvol store name', required=False) 1693 p.set_defaults(func=bdev_lvol_get_lvstores) 1694 1695 def bdev_raid_get_bdevs(args): 1696 print_array(rpc.bdev.bdev_raid_get_bdevs(args.client, 1697 category=args.category)) 1698 1699 p = subparsers.add_parser('bdev_raid_get_bdevs', aliases=['get_raid_bdevs'], 1700 help="""This is used to list all the raid bdev names based on the input category 1701 requested. Category should be one of 'all', 'online', 'configuring' or 'offline'. 'all' means all the raid bdevs whether 1702 they are online or configuring or offline. 'online' is the raid bdev which is registered with bdev layer. 'configuring' 1703 is the raid bdev which does not have full configuration discovered yet. 'offline' is the raid bdev which is not registered 1704 with bdev as of now and it has encountered any error or user has requested to offline the raid bdev""") 1705 p.add_argument('category', help='all or online or configuring or offline') 1706 p.set_defaults(func=bdev_raid_get_bdevs) 1707 1708 def bdev_raid_create(args): 1709 base_bdevs = [] 1710 for u in args.base_bdevs.strip().split(" "): 1711 base_bdevs.append(u) 1712 1713 rpc.bdev.bdev_raid_create(args.client, 1714 name=args.name, 1715 strip_size_kb=args.strip_size_kb, 1716 raid_level=args.raid_level, 1717 base_bdevs=base_bdevs) 1718 p = subparsers.add_parser('bdev_raid_create', aliases=['construct_raid_bdev'], 1719 help='Create new raid bdev') 1720 p.add_argument('-n', '--name', help='raid bdev name', required=True) 1721 p.add_argument('-z', '--strip-size_kb', help='strip size in KB', type=int) 1722 p.add_argument('-r', '--raid-level', help='raid level, only raid level 0 is supported', required=True) 1723 p.add_argument('-b', '--base-bdevs', help='base bdevs name, whitespace separated list in quotes', required=True) 1724 p.set_defaults(func=bdev_raid_create) 1725 1726 def bdev_raid_delete(args): 1727 rpc.bdev.bdev_raid_delete(args.client, 1728 name=args.name) 1729 p = subparsers.add_parser('bdev_raid_delete', aliases=['destroy_raid_bdev'], 1730 help='Delete existing raid bdev') 1731 p.add_argument('name', help='raid bdev name') 1732 p.set_defaults(func=bdev_raid_delete) 1733 1734 # split 1735 def bdev_split_create(args): 1736 print_array(rpc.bdev.bdev_split_create(args.client, 1737 base_bdev=args.base_bdev, 1738 split_count=args.split_count, 1739 split_size_mb=args.split_size_mb)) 1740 1741 p = subparsers.add_parser('bdev_split_create', aliases=['construct_split_vbdev'], 1742 help="""Add given disk name to split config. If bdev with base_name 1743 name exist the split bdevs will be created right away, if not split bdevs will be created when base bdev became 1744 available (during examination process).""") 1745 p.add_argument('base_bdev', help='base bdev name') 1746 p.add_argument('-s', '--split-size-mb', help='size in MiB for each bdev', type=int, default=0) 1747 p.add_argument('split_count', help="""Optional - number of split bdevs to create. Total size * split_count must not 1748 exceed the base bdev size.""", type=int) 1749 p.set_defaults(func=bdev_split_create) 1750 1751 def bdev_split_delete(args): 1752 rpc.bdev.bdev_split_delete(args.client, 1753 base_bdev=args.base_bdev) 1754 1755 p = subparsers.add_parser('bdev_split_delete', aliases=['destruct_split_vbdev'], 1756 help="""Delete split config with all created splits.""") 1757 p.add_argument('base_bdev', help='base bdev name') 1758 p.set_defaults(func=bdev_split_delete) 1759 1760 # ftl 1761 ftl_valid_limits = ('crit', 'high', 'low', 'start') 1762 1763 def bdev_ftl_create(args): 1764 def parse_limits(limits, arg_dict, key_suffix=''): 1765 for limit in limits.split(','): 1766 key, value = limit.split(':', 1) 1767 if key in ftl_valid_limits: 1768 arg_dict['limit_' + key + key_suffix] = int(value) 1769 else: 1770 raise ValueError('Limit {} is not supported'.format(key)) 1771 1772 arg_limits = {} 1773 if args.limit_threshold: 1774 parse_limits(args.limit_threshold, arg_limits, '_threshold') 1775 1776 if args.limit: 1777 parse_limits(args.limit, arg_limits) 1778 1779 print_dict(rpc.bdev.bdev_ftl_create(args.client, 1780 name=args.name, 1781 base_bdev=args.base_bdev, 1782 uuid=args.uuid, 1783 cache=args.cache, 1784 allow_open_bands=args.allow_open_bands, 1785 overprovisioning=args.overprovisioning, 1786 l2p_path=args.l2p_path, 1787 use_append=args.use_append, 1788 **arg_limits)) 1789 1790 p = subparsers.add_parser('bdev_ftl_create', aliases=['construct_ftl_bdev'], help='Add FTL bdev') 1791 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 1792 p.add_argument('-d', '--base_bdev', help='Name of zoned bdev used as underlying device', 1793 required=True) 1794 p.add_argument('-u', '--uuid', help='UUID of restored bdev (not applicable when creating new ' 1795 'instance): e.g. b286d19a-0059-4709-abcd-9f7732b1567d (optional)') 1796 p.add_argument('-c', '--cache', help='Name of the bdev to be used as a write buffer cache (optional)') 1797 p.add_argument('-o', '--allow_open_bands', help='Restoring after dirty shutdown without cache will' 1798 ' result in partial data recovery, instead of error', action='store_true') 1799 p.add_argument('--overprovisioning', help='Percentage of device used for relocation, not exposed' 1800 ' to user (optional)', type=int) 1801 p.add_argument('--l2p_path', help='Path to persistent memory file or device to store l2p onto, ' 1802 'by default l2p is kept in DRAM and is volatile (optional)') 1803 p.add_argument('--use_append', help='Use appends instead of writes', action='store_true') 1804 1805 limits = p.add_argument_group('Defrag limits', 'Configures defrag limits and thresholds for' 1806 ' levels ' + str(ftl_valid_limits)[1:-1]) 1807 limits.add_argument('--limit', help='Percentage of allowed user versus internal writes at given' 1808 ' levels, e.g. crit:0,high:20,low:80') 1809 limits.add_argument('--limit-threshold', help='Number of free bands triggering a given level of' 1810 ' write limiting e.g. crit:1,high:2,low:3,start:4') 1811 p.set_defaults(func=bdev_ftl_create) 1812 1813 def bdev_ftl_delete(args): 1814 print_dict(rpc.bdev.bdev_ftl_delete(args.client, name=args.name)) 1815 1816 p = subparsers.add_parser('bdev_ftl_delete', aliases=['delete_ftl_bdev'], 1817 help='Delete FTL bdev') 1818 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 1819 p.set_defaults(func=bdev_ftl_delete) 1820 1821 # vmd 1822 def enable_vmd(args): 1823 print_dict(rpc.vmd.enable_vmd(args.client)) 1824 1825 p = subparsers.add_parser('enable_vmd', help='Enable VMD enumeration') 1826 p.set_defaults(func=enable_vmd) 1827 1828 # nbd 1829 def nbd_start_disk(args): 1830 print(rpc.nbd.nbd_start_disk(args.client, 1831 bdev_name=args.bdev_name, 1832 nbd_device=args.nbd_device)) 1833 1834 p = subparsers.add_parser('nbd_start_disk', aliases=['start_nbd_disk'], 1835 help='Export a bdev as an nbd disk') 1836 p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.') 1837 p.add_argument('nbd_device', help='Nbd device name to be assigned. Example: /dev/nbd0.', nargs='?') 1838 p.set_defaults(func=nbd_start_disk) 1839 1840 def nbd_stop_disk(args): 1841 rpc.nbd.nbd_stop_disk(args.client, 1842 nbd_device=args.nbd_device) 1843 1844 p = subparsers.add_parser('nbd_stop_disk', aliases=['stop_nbd_disk'], 1845 help='Stop an nbd disk') 1846 p.add_argument('nbd_device', help='Nbd device name to be stopped. Example: /dev/nbd0.') 1847 p.set_defaults(func=nbd_stop_disk) 1848 1849 def nbd_get_disks(args): 1850 print_dict(rpc.nbd.nbd_get_disks(args.client, 1851 nbd_device=args.nbd_device)) 1852 1853 p = subparsers.add_parser('nbd_get_disks', aliases=['get_nbd_disks'], 1854 help='Display full or specified nbd device list') 1855 p.add_argument('-n', '--nbd-device', help="Path of the nbd device. Example: /dev/nbd0", required=False) 1856 p.set_defaults(func=nbd_get_disks) 1857 1858 # net 1859 def net_interface_add_ip_address(args): 1860 rpc.net.net_interface_add_ip_address(args.client, ifc_index=args.ifc_index, ip_addr=args.ip_addr) 1861 1862 p = subparsers.add_parser('net_interface_add_ip_address', aliases=['add_ip_address'], 1863 help='Add IP address') 1864 p.add_argument('ifc_index', help='ifc index of the nic device.', type=int) 1865 p.add_argument('ip_addr', help='ip address will be added.') 1866 p.set_defaults(func=net_interface_add_ip_address) 1867 1868 def net_interface_delete_ip_address(args): 1869 rpc.net.net_interface_delete_ip_address(args.client, ifc_index=args.ifc_index, ip_addr=args.ip_addr) 1870 1871 p = subparsers.add_parser('net_interface_delete_ip_address', aliases=['delete_ip_address'], 1872 help='Delete IP address') 1873 p.add_argument('ifc_index', help='ifc index of the nic device.', type=int) 1874 p.add_argument('ip_addr', help='ip address will be deleted.') 1875 p.set_defaults(func=net_interface_delete_ip_address) 1876 1877 def net_get_interfaces(args): 1878 print_dict(rpc.net.net_get_interfaces(args.client)) 1879 1880 p = subparsers.add_parser( 1881 'net_get_interfaces', aliases=['get_interfaces'], help='Display current interface list') 1882 p.set_defaults(func=net_get_interfaces) 1883 1884 # NVMe-oF 1885 def nvmf_set_max_subsystems(args): 1886 rpc.nvmf.nvmf_set_max_subsystems(args.client, 1887 max_subsystems=args.max_subsystems) 1888 1889 p = subparsers.add_parser('nvmf_set_max_subsystems', aliases=['set_nvmf_target_max_subsystems'], 1890 help='Set the maximum number of NVMf target subsystems') 1891 p.add_argument('-x', '--max-subsystems', help='Max number of NVMf subsystems', type=int, required=True) 1892 p.set_defaults(func=nvmf_set_max_subsystems) 1893 1894 def nvmf_set_config(args): 1895 rpc.nvmf.nvmf_set_config(args.client, 1896 acceptor_poll_rate=args.acceptor_poll_rate, 1897 conn_sched=args.conn_sched, 1898 passthru_identify_ctrlr=args.passthru_identify_ctrlr) 1899 1900 p = subparsers.add_parser('nvmf_set_config', aliases=['set_nvmf_target_config'], 1901 help='Set NVMf target config') 1902 p.add_argument('-r', '--acceptor-poll-rate', help='Polling interval of the acceptor for incoming connections (usec)', type=int) 1903 p.add_argument('-s', '--conn-sched', help='(Deprecated). Ignored.') 1904 p.add_argument('-i', '--passthru-identify-ctrlr', help="""Passthrough fields like serial number and model number 1905 when the controller has a single namespace that is an NVMe bdev""", action='store_true') 1906 p.set_defaults(func=nvmf_set_config) 1907 1908 def nvmf_create_transport(args): 1909 rpc.nvmf.nvmf_create_transport(**vars(args)) 1910 1911 p = subparsers.add_parser('nvmf_create_transport', help='Create NVMf transport') 1912 p.add_argument('-t', '--trtype', help='Transport type (ex. RDMA)', type=str, required=True) 1913 p.add_argument('-g', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 1914 p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/O per queue', type=int) 1915 p.add_argument('-p', '--max-qpairs-per-ctrlr', help="""Max number of SQ and CQ per controller. 1916 Deprecated, use max-io-qpairs-per-ctrlr""", type=int) 1917 p.add_argument('-m', '--max-io-qpairs-per-ctrlr', help='Max number of IO qpairs per controller', type=int) 1918 p.add_argument('-c', '--in-capsule-data-size', help='Max number of in-capsule data size', type=int) 1919 p.add_argument('-i', '--max-io-size', help='Max I/O size (bytes)', type=int) 1920 p.add_argument('-u', '--io-unit-size', help='I/O unit size (bytes)', type=int) 1921 p.add_argument('-a', '--max-aq-depth', help='Max number of admin cmds per AQ', type=int) 1922 p.add_argument('-n', '--num-shared-buffers', help='The number of pooled data buffers available to the transport', type=int) 1923 p.add_argument('-b', '--buf-cache-size', help='The number of shared buffers to reserve for each poll group', type=int) 1924 p.add_argument('-d', '--num_cqe', help="""The number of CQ entires. Only used when no_srq=true. 1925 Relevant only for RDMA transport""", type=int) 1926 p.add_argument('-s', '--max-srq-depth', help='Max number of outstanding I/O per SRQ. Relevant only for RDMA transport', type=int) 1927 p.add_argument('-r', '--no-srq', action='store_true', help='Disable per-thread shared receive queue. Relevant only for RDMA transport') 1928 p.add_argument('-o', '--c2h-success', action='store_false', help='Disable C2H success optimization. Relevant only for TCP transport') 1929 p.add_argument('-f', '--dif-insert-or-strip', action='store_true', help='Enable DIF insert/strip. Relevant only for TCP transport') 1930 p.add_argument('-y', '--sock-priority', help='The sock priority of the tcp connection. Relevant only for TCP transport', type=int) 1931 p.add_argument('-l', '--acceptor_backlog', help='Pending connections allowed at one time. Relevant only for RDMA transport', type=int) 1932 p.add_argument('-x', '--abort-timeout-sec', help='Abort execution timeout value, in seconds', type=int) 1933 p.add_argument('-w', '--no-wr-batching', action='store_true', help='Disable work requests batching. Relevant only for RDMA transport') 1934 p.add_argument('-e', '--control_msg_num', help="""The number of control messages per poll group. 1935 Relevant only for TCP transport""", type=int) 1936 p.set_defaults(func=nvmf_create_transport) 1937 1938 def nvmf_get_transports(args): 1939 print_dict(rpc.nvmf.nvmf_get_transports(args.client, tgt_name=args.tgt_name)) 1940 1941 p = subparsers.add_parser('nvmf_get_transports', aliases=['get_nvmf_transports'], 1942 help='Display nvmf transports') 1943 p.add_argument('-t', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 1944 p.set_defaults(func=nvmf_get_transports) 1945 1946 def nvmf_get_subsystems(args): 1947 print_dict(rpc.nvmf.nvmf_get_subsystems(args.client, tgt_name=args.tgt_name)) 1948 1949 p = subparsers.add_parser('nvmf_get_subsystems', aliases=['get_nvmf_subsystems'], 1950 help='Display nvmf subsystems') 1951 p.add_argument('-t', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 1952 p.set_defaults(func=nvmf_get_subsystems) 1953 1954 def nvmf_create_subsystem(args): 1955 rpc.nvmf.nvmf_create_subsystem(args.client, 1956 nqn=args.nqn, 1957 tgt_name=args.tgt_name, 1958 serial_number=args.serial_number, 1959 model_number=args.model_number, 1960 allow_any_host=args.allow_any_host, 1961 max_namespaces=args.max_namespaces, 1962 ana_reporting=args.ana_reporting, 1963 min_cntlid=args.min_cntlid, 1964 max_cntlid=args.max_cntlid) 1965 1966 p = subparsers.add_parser('nvmf_create_subsystem', aliases=['nvmf_subsystem_create'], 1967 help='Create an NVMe-oF subsystem') 1968 p.add_argument('nqn', help='Subsystem NQN (ASCII)') 1969 p.add_argument('-t', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 1970 p.add_argument("-s", "--serial-number", help=""" 1971 Format: 'sn' etc 1972 Example: 'SPDK00000000000001'""", default='00000000000000000000') 1973 p.add_argument("-d", "--model-number", help=""" 1974 Format: 'mn' etc 1975 Example: 'SPDK Controller'""", default='SPDK bdev Controller') 1976 p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce allowed host NQN list)") 1977 p.add_argument("-m", "--max-namespaces", help="Maximum number of namespaces allowed", 1978 type=int, default=0) 1979 p.add_argument("-r", "--ana-reporting", action='store_true', help="Enable ANA reporting feature") 1980 p.add_argument("-i", "--min_cntlid", help="Minimum controller ID", type=int, default=1) 1981 p.add_argument("-I", "--max_cntlid", help="Maximum controller ID", type=int, default=0xffef) 1982 p.set_defaults(func=nvmf_create_subsystem) 1983 1984 def nvmf_delete_subsystem(args): 1985 rpc.nvmf.nvmf_delete_subsystem(args.client, 1986 nqn=args.subsystem_nqn, 1987 tgt_name=args.tgt_name) 1988 1989 p = subparsers.add_parser('nvmf_delete_subsystem', aliases=['delete_nvmf_subsystem'], 1990 help='Delete a nvmf subsystem') 1991 p.add_argument('subsystem_nqn', 1992 help='subsystem nqn to be deleted. Example: nqn.2016-06.io.spdk:cnode1.') 1993 p.add_argument('-t', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 1994 p.set_defaults(func=nvmf_delete_subsystem) 1995 1996 def nvmf_subsystem_add_listener(args): 1997 rpc.nvmf.nvmf_subsystem_add_listener(**vars(args)) 1998 1999 p = subparsers.add_parser('nvmf_subsystem_add_listener', help='Add a listener to an NVMe-oF subsystem') 2000 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2001 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2002 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2003 p.add_argument('-p', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 2004 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2005 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for RDMA or TCP)') 2006 p.set_defaults(func=nvmf_subsystem_add_listener) 2007 2008 def nvmf_subsystem_remove_listener(args): 2009 rpc.nvmf.nvmf_subsystem_remove_listener(args.client, 2010 nqn=args.nqn, 2011 trtype=args.trtype, 2012 traddr=args.traddr, 2013 tgt_name=args.tgt_name, 2014 adrfam=args.adrfam, 2015 trsvcid=args.trsvcid) 2016 2017 p = subparsers.add_parser('nvmf_subsystem_remove_listener', help='Remove a listener from an NVMe-oF subsystem') 2018 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2019 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2020 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2021 p.add_argument('-p', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 2022 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2023 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number') 2024 p.set_defaults(func=nvmf_subsystem_remove_listener) 2025 2026 def nvmf_subsystem_listener_set_ana_state(args): 2027 rpc.nvmf.nvmf_subsystem_listener_set_ana_state(args.client, 2028 nqn=args.nqn, 2029 ana_state=args.ana_state, 2030 trtype=args.trtype, 2031 traddr=args.traddr, 2032 tgt_name=args.tgt_name, 2033 adrfam=args.adrfam, 2034 trsvcid=args.trsvcid) 2035 2036 p = subparsers.add_parser('nvmf_subsystem_listener_set_ana_state', help='Set ANA state of a listener for an NVMe-oF subsystem') 2037 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2038 p.add_argument('-n', '--ana-state', help='ANA state to set: optimized, non-optimized, or inaccessible', required=True) 2039 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2040 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2041 p.add_argument('-p', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 2042 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2043 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number') 2044 p.set_defaults(func=nvmf_subsystem_listener_set_ana_state) 2045 2046 def nvmf_subsystem_add_ns(args): 2047 rpc.nvmf.nvmf_subsystem_add_ns(args.client, 2048 nqn=args.nqn, 2049 bdev_name=args.bdev_name, 2050 tgt_name=args.tgt_name, 2051 ptpl_file=args.ptpl_file, 2052 nsid=args.nsid, 2053 nguid=args.nguid, 2054 eui64=args.eui64, 2055 uuid=args.uuid) 2056 2057 p = subparsers.add_parser('nvmf_subsystem_add_ns', help='Add a namespace to an NVMe-oF subsystem') 2058 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2059 p.add_argument('bdev_name', help='The name of the bdev that will back this namespace') 2060 p.add_argument('-t', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 2061 p.add_argument('-p', '--ptpl-file', help='The persistent reservation storage location (optional)', type=str) 2062 p.add_argument('-n', '--nsid', help='The requested NSID (optional)', type=int) 2063 p.add_argument('-g', '--nguid', help='Namespace globally unique identifier (optional)') 2064 p.add_argument('-e', '--eui64', help='Namespace EUI-64 identifier (optional)') 2065 p.add_argument('-u', '--uuid', help='Namespace UUID (optional)') 2066 p.set_defaults(func=nvmf_subsystem_add_ns) 2067 2068 def nvmf_subsystem_remove_ns(args): 2069 rpc.nvmf.nvmf_subsystem_remove_ns(args.client, 2070 nqn=args.nqn, 2071 nsid=args.nsid, 2072 tgt_name=args.tgt_name) 2073 2074 p = subparsers.add_parser('nvmf_subsystem_remove_ns', help='Remove a namespace to an NVMe-oF subsystem') 2075 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2076 p.add_argument('nsid', help='The requested NSID', type=int) 2077 p.add_argument('-t', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 2078 p.set_defaults(func=nvmf_subsystem_remove_ns) 2079 2080 def nvmf_subsystem_add_host(args): 2081 rpc.nvmf.nvmf_subsystem_add_host(args.client, 2082 nqn=args.nqn, 2083 host=args.host, 2084 tgt_name=args.tgt_name) 2085 2086 p = subparsers.add_parser('nvmf_subsystem_add_host', help='Add a host to an NVMe-oF subsystem') 2087 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2088 p.add_argument('host', help='Host NQN to allow') 2089 p.add_argument('-t', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 2090 p.set_defaults(func=nvmf_subsystem_add_host) 2091 2092 def nvmf_subsystem_remove_host(args): 2093 rpc.nvmf.nvmf_subsystem_remove_host(args.client, 2094 nqn=args.nqn, 2095 host=args.host, 2096 tgt_name=args.tgt_name) 2097 2098 p = subparsers.add_parser('nvmf_subsystem_remove_host', help='Remove a host from an NVMe-oF subsystem') 2099 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2100 p.add_argument('host', help='Host NQN to remove') 2101 p.add_argument('-t', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 2102 p.set_defaults(func=nvmf_subsystem_remove_host) 2103 2104 def nvmf_subsystem_allow_any_host(args): 2105 rpc.nvmf.nvmf_subsystem_allow_any_host(args.client, 2106 nqn=args.nqn, 2107 disable=args.disable, 2108 tgt_name=args.tgt_name) 2109 2110 p = subparsers.add_parser('nvmf_subsystem_allow_any_host', help='Allow any host to connect to the subsystem') 2111 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2112 p.add_argument('-e', '--enable', action='store_true', help='Enable allowing any host') 2113 p.add_argument('-d', '--disable', action='store_true', help='Disable allowing any host') 2114 p.add_argument('-t', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 2115 p.set_defaults(func=nvmf_subsystem_allow_any_host) 2116 2117 def nvmf_subsystem_get_controllers(args): 2118 print_dict(rpc.nvmf.nvmf_subsystem_get_controllers(args.client, 2119 nqn=args.nqn, 2120 tgt_name=args.tgt_name)) 2121 2122 p = subparsers.add_parser('nvmf_subsystem_get_controllers', 2123 help='Display controllers of an NVMe-oF subsystem.') 2124 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2125 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2126 p.set_defaults(func=nvmf_subsystem_get_controllers) 2127 2128 def nvmf_subsystem_get_qpairs(args): 2129 print_dict(rpc.nvmf.nvmf_subsystem_get_qpairs(args.client, 2130 nqn=args.nqn, 2131 tgt_name=args.tgt_name)) 2132 2133 p = subparsers.add_parser('nvmf_subsystem_get_qpairs', 2134 help='Display queue pairs of an NVMe-oF subsystem.') 2135 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2136 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2137 p.set_defaults(func=nvmf_subsystem_get_qpairs) 2138 2139 def nvmf_subsystem_get_listeners(args): 2140 print_dict(rpc.nvmf.nvmf_subsystem_get_listeners(args.client, 2141 nqn=args.nqn, 2142 tgt_name=args.tgt_name)) 2143 2144 p = subparsers.add_parser('nvmf_subsystem_get_listeners', 2145 help='Display listeners of an NVMe-oF subsystem.') 2146 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2147 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2148 p.set_defaults(func=nvmf_subsystem_get_listeners) 2149 2150 def nvmf_get_stats(args): 2151 print_dict(rpc.nvmf.nvmf_get_stats(args.client, tgt_name=args.tgt_name)) 2152 2153 p = subparsers.add_parser( 2154 'nvmf_get_stats', help='Display current statistics for NVMf subsystem') 2155 p.add_argument('-t', '--tgt_name', help='The name of the parent NVMe-oF target (optional)', type=str) 2156 p.set_defaults(func=nvmf_get_stats) 2157 2158 # pmem 2159 def bdev_pmem_create_pool(args): 2160 num_blocks = int((args.total_size * 1024 * 1024) / args.block_size) 2161 rpc.pmem.bdev_pmem_create_pool(args.client, 2162 pmem_file=args.pmem_file, 2163 num_blocks=num_blocks, 2164 block_size=args.block_size) 2165 2166 p = subparsers.add_parser('bdev_pmem_create_pool', aliases=['create_pmem_pool'], 2167 help='Create pmem pool') 2168 p.add_argument('pmem_file', help='Path to pmemblk pool file') 2169 p.add_argument('total_size', help='Size of malloc bdev in MB (int > 0)', type=int) 2170 p.add_argument('block_size', help='Block size for this pmem pool', type=int) 2171 p.set_defaults(func=bdev_pmem_create_pool) 2172 2173 def bdev_pmem_get_pool_info(args): 2174 print_dict(rpc.pmem.bdev_pmem_get_pool_info(args.client, 2175 pmem_file=args.pmem_file)) 2176 2177 p = subparsers.add_parser('bdev_pmem_get_pool_info', aliases=['pmem_pool_info'], 2178 help='Display pmem pool info and check consistency') 2179 p.add_argument('pmem_file', help='Path to pmemblk pool file') 2180 p.set_defaults(func=bdev_pmem_get_pool_info) 2181 2182 def bdev_pmem_delete_pool(args): 2183 rpc.pmem.bdev_pmem_delete_pool(args.client, 2184 pmem_file=args.pmem_file) 2185 2186 p = subparsers.add_parser('bdev_pmem_delete_pool', aliases=['delete_pmem_pool'], 2187 help='Delete pmem pool') 2188 p.add_argument('pmem_file', help='Path to pmemblk pool file') 2189 p.set_defaults(func=bdev_pmem_delete_pool) 2190 2191 # subsystem 2192 def framework_get_subsystems(args): 2193 print_dict(rpc.subsystem.framework_get_subsystems(args.client)) 2194 2195 p = subparsers.add_parser('framework_get_subsystems', aliases=['get_subsystems'], 2196 help="""Print subsystems array in initialization order. Each subsystem 2197 entry contain (unsorted) array of subsystems it depends on.""") 2198 p.set_defaults(func=framework_get_subsystems) 2199 2200 def framework_get_config(args): 2201 print_dict(rpc.subsystem.framework_get_config(args.client, args.name)) 2202 2203 p = subparsers.add_parser('framework_get_config', aliases=['get_subsystem_config'], 2204 help="""Print subsystem configuration""") 2205 p.add_argument('name', help='Name of subsystem to query') 2206 p.set_defaults(func=framework_get_config) 2207 2208 # vhost 2209 def vhost_controller_set_coalescing(args): 2210 rpc.vhost.vhost_controller_set_coalescing(args.client, 2211 ctrlr=args.ctrlr, 2212 delay_base_us=args.delay_base_us, 2213 iops_threshold=args.iops_threshold) 2214 2215 p = subparsers.add_parser('vhost_controller_set_coalescing', aliases=['set_vhost_controller_coalescing'], 2216 help='Set vhost controller coalescing') 2217 p.add_argument('ctrlr', help='controller name') 2218 p.add_argument('delay_base_us', help='Base delay time', type=int) 2219 p.add_argument('iops_threshold', help='IOPS threshold when coalescing is enabled', type=int) 2220 p.set_defaults(func=vhost_controller_set_coalescing) 2221 2222 def vhost_create_scsi_controller(args): 2223 rpc.vhost.vhost_create_scsi_controller(args.client, 2224 ctrlr=args.ctrlr, 2225 cpumask=args.cpumask) 2226 2227 p = subparsers.add_parser( 2228 'vhost_create_scsi_controller', aliases=['construct_vhost_scsi_controller'], 2229 help='Add new vhost controller') 2230 p.add_argument('ctrlr', help='controller name') 2231 p.add_argument('--cpumask', help='cpu mask for this controller') 2232 p.set_defaults(func=vhost_create_scsi_controller) 2233 2234 def vhost_scsi_controller_add_target(args): 2235 print_json(rpc.vhost.vhost_scsi_controller_add_target(args.client, 2236 ctrlr=args.ctrlr, 2237 scsi_target_num=args.scsi_target_num, 2238 bdev_name=args.bdev_name)) 2239 2240 p = subparsers.add_parser('vhost_scsi_controller_add_target', 2241 aliases=['add_vhost_scsi_lun'], 2242 help='Add lun to vhost controller') 2243 p.add_argument('ctrlr', help='conntroller name where add lun') 2244 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 2245 p.add_argument('bdev_name', help='bdev name') 2246 p.set_defaults(func=vhost_scsi_controller_add_target) 2247 2248 def vhost_scsi_controller_remove_target(args): 2249 rpc.vhost.vhost_scsi_controller_remove_target(args.client, 2250 ctrlr=args.ctrlr, 2251 scsi_target_num=args.scsi_target_num) 2252 2253 p = subparsers.add_parser('vhost_scsi_controller_remove_target', 2254 aliases=['remove_vhost_scsi_target'], 2255 help='Remove target from vhost controller') 2256 p.add_argument('ctrlr', help='controller name to remove target from') 2257 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 2258 p.set_defaults(func=vhost_scsi_controller_remove_target) 2259 2260 def vhost_create_blk_controller(args): 2261 rpc.vhost.vhost_create_blk_controller(args.client, 2262 ctrlr=args.ctrlr, 2263 dev_name=args.dev_name, 2264 cpumask=args.cpumask, 2265 readonly=args.readonly, 2266 packed_ring=args.packed_ring, 2267 packed_ring_recovery=args.packed_ring_recovery) 2268 2269 p = subparsers.add_parser('vhost_create_blk_controller', 2270 aliases=['construct_vhost_blk_controller'], 2271 help='Add a new vhost block controller') 2272 p.add_argument('ctrlr', help='controller name') 2273 p.add_argument('dev_name', help='device name') 2274 p.add_argument('--cpumask', help='cpu mask for this controller') 2275 p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only') 2276 p.add_argument("-p", "--packed_ring", action='store_true', help='Set controller as packed ring supported') 2277 p.add_argument("-l", "--packed_ring_recovery", action='store_true', help='Enable packed ring live reocvery') 2278 p.set_defaults(func=vhost_create_blk_controller) 2279 2280 def vhost_get_controllers(args): 2281 print_dict(rpc.vhost.vhost_get_controllers(args.client, args.name)) 2282 2283 p = subparsers.add_parser('vhost_get_controllers', aliases=['get_vhost_controllers'], 2284 help='List all or specific vhost controller(s)') 2285 p.add_argument('-n', '--name', help="Name of vhost controller", required=False) 2286 p.set_defaults(func=vhost_get_controllers) 2287 2288 def vhost_delete_controller(args): 2289 rpc.vhost.vhost_delete_controller(args.client, 2290 ctrlr=args.ctrlr) 2291 2292 p = subparsers.add_parser('vhost_delete_controller', aliases=['remove_vhost_controller'], 2293 help='Delete a vhost controller') 2294 p.add_argument('ctrlr', help='controller name') 2295 p.set_defaults(func=vhost_delete_controller) 2296 2297 def bdev_virtio_attach_controller(args): 2298 print_array(rpc.vhost.bdev_virtio_attach_controller(args.client, 2299 name=args.name, 2300 trtype=args.trtype, 2301 traddr=args.traddr, 2302 dev_type=args.dev_type, 2303 vq_count=args.vq_count, 2304 vq_size=args.vq_size)) 2305 2306 p = subparsers.add_parser('bdev_virtio_attach_controller', aliases=['construct_virtio_dev'], 2307 help="""Attach virtio controller using provided 2308 transport type and device type. This will also create bdevs for any block devices connected to the 2309 controller (for example, SCSI devices for a virtio-scsi controller). 2310 Result is array of added bdevs.""") 2311 p.add_argument('name', help="Use this name as base for new created bdevs") 2312 p.add_argument('-t', '--trtype', 2313 help='Virtio target transport type: pci or user', required=True) 2314 p.add_argument('-a', '--traddr', 2315 help='Transport type specific target address: e.g. UNIX domain socket path or BDF', required=True) 2316 p.add_argument('-d', '--dev-type', 2317 help='Device type: blk or scsi', required=True) 2318 p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int) 2319 p.add_argument('--vq-size', help='Size of each queue', type=int) 2320 p.set_defaults(func=bdev_virtio_attach_controller) 2321 2322 def bdev_virtio_scsi_get_devices(args): 2323 print_dict(rpc.vhost.bdev_virtio_scsi_get_devices(args.client)) 2324 2325 p = subparsers.add_parser('bdev_virtio_scsi_get_devices', aliases=['get_virtio_scsi_devs'], 2326 help='List all Virtio-SCSI devices.') 2327 p.set_defaults(func=bdev_virtio_scsi_get_devices) 2328 2329 def bdev_virtio_detach_controller(args): 2330 rpc.vhost.bdev_virtio_detach_controller(args.client, 2331 name=args.name) 2332 2333 p = subparsers.add_parser('bdev_virtio_detach_controller', aliases=['remove_virtio_bdev'], 2334 help="""Remove a Virtio device 2335 This will delete all bdevs exposed by this device""") 2336 p.add_argument('name', help='Virtio device name. E.g. VirtioUser0') 2337 p.set_defaults(func=bdev_virtio_detach_controller) 2338 2339 def bdev_virtio_blk_set_hotplug(args): 2340 rpc.vhost.bdev_virtio_blk_set_hotplug(args.client, enable=args.enable, period_us=args.period_us) 2341 2342 p = subparsers.add_parser('bdev_virtio_blk_set_hotplug', help='Set hotplug options for bdev virtio_blk type.') 2343 p.add_argument('-d', '--disable', dest='enable', default=False, action='store_false', help="Disable hotplug (default)") 2344 p.add_argument('-e', '--enable', dest='enable', action='store_true', help="Enable hotplug") 2345 p.add_argument('-r', '--period-us', 2346 help='How often the hotplug is processed for insert and remove events', type=int) 2347 p.set_defaults(func=bdev_virtio_blk_set_hotplug) 2348 2349 # OCSSD 2350 def bdev_ocssd_create(args): 2351 nsid = int(args.nsid) if args.nsid is not None else None 2352 print_json(rpc.bdev.bdev_ocssd_create(args.client, 2353 ctrlr_name=args.ctrlr_name, 2354 bdev_name=args.name, 2355 nsid=nsid)) 2356 2357 p = subparsers.add_parser('bdev_ocssd_create', 2358 help='Creates zoned bdev on specified Open Channel controller') 2359 p.add_argument('-c', '--ctrlr_name', help='Name of the OC NVMe controller', required=True) 2360 p.add_argument('-b', '--name', help='Name of the bdev to create', required=True) 2361 p.add_argument('-n', '--nsid', help='Namespace ID', required=False) 2362 p.set_defaults(func=bdev_ocssd_create) 2363 2364 def bdev_ocssd_delete(args): 2365 print_json(rpc.bdev.bdev_ocssd_delete(args.client, 2366 name=args.name)) 2367 2368 p = subparsers.add_parser('bdev_ocssd_delete', 2369 help='Deletes Open Channel bdev') 2370 p.add_argument('name', help='Name of the Open Channel bdev') 2371 p.set_defaults(func=bdev_ocssd_delete) 2372 2373 # ioat 2374 def ioat_scan_accel_engine(args): 2375 rpc.ioat.ioat_scan_accel_engine(args.client) 2376 2377 p = subparsers.add_parser('ioat_scan_accel_engine', 2378 aliases=['ioat_scan_copy_engine', 'scan_ioat_copy_engine'], 2379 help='Enable IOAT accel engine offload.') 2380 p.set_defaults(func=ioat_scan_accel_engine) 2381 2382 # idxd 2383 def idxd_scan_accel_engine(args): 2384 rpc.idxd.idxd_scan_accel_engine(args.client, config_number=args.config_number) 2385 2386 p = subparsers.add_parser('idxd_scan_accel_engine', 2387 help='Set config and enable idxd accel engine offload.') 2388 p.add_argument('-c', '--config-number', help="""Pre-defined configuration number to use. See docs.""", type=int) 2389 p.set_defaults(func=idxd_scan_accel_engine) 2390 2391 # opal 2392 def bdev_nvme_opal_init(args): 2393 rpc.nvme.bdev_nvme_opal_init(args.client, 2394 nvme_ctrlr_name=args.nvme_ctrlr_name, 2395 password=args.password) 2396 2397 p = subparsers.add_parser('bdev_nvme_opal_init', help='take ownership and activate') 2398 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name') 2399 p.add_argument('-p', '--password', help='password for admin') 2400 p.set_defaults(func=bdev_nvme_opal_init) 2401 2402 def bdev_nvme_opal_revert(args): 2403 rpc.nvme.bdev_nvme_opal_revert(args.client, 2404 nvme_ctrlr_name=args.nvme_ctrlr_name, 2405 password=args.password) 2406 p = subparsers.add_parser('bdev_nvme_opal_revert', help='Revert to default factory settings') 2407 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name') 2408 p.add_argument('-p', '--password', help='password') 2409 p.set_defaults(func=bdev_nvme_opal_revert) 2410 2411 def bdev_opal_create(args): 2412 print_json(rpc.bdev.bdev_opal_create(args.client, 2413 nvme_ctrlr_name=args.nvme_ctrlr_name, 2414 nsid=args.nsid, 2415 locking_range_id=args.locking_range_id, 2416 range_start=args.range_start, 2417 range_length=args.range_length, 2418 password=args.password)) 2419 2420 p = subparsers.add_parser('bdev_opal_create', help="""Create opal bdev on specified NVMe controller""") 2421 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name', required=True) 2422 p.add_argument('-n', '--nsid', help='namespace ID (only support nsid=1 for now)', type=int, required=True) 2423 p.add_argument('-i', '--locking-range-id', help='locking range id', type=int, required=True) 2424 p.add_argument('-s', '--range-start', help='locking range start LBA', type=int, required=True) 2425 p.add_argument('-l', '--range-length', help='locking range length (in blocks)', type=int, required=True) 2426 p.add_argument('-p', '--password', help='admin password', required=True) 2427 p.set_defaults(func=bdev_opal_create) 2428 2429 def bdev_opal_get_info(args): 2430 print_dict(rpc.bdev.bdev_opal_get_info(args.client, 2431 bdev_name=args.bdev_name, 2432 password=args.password)) 2433 2434 p = subparsers.add_parser('bdev_opal_get_info', help='get opal locking range info for this bdev') 2435 p.add_argument('-b', '--bdev-name', help='opal bdev') 2436 p.add_argument('-p', '--password', help='password') 2437 p.set_defaults(func=bdev_opal_get_info) 2438 2439 def bdev_opal_delete(args): 2440 rpc.bdev.bdev_opal_delete(args.client, 2441 bdev_name=args.bdev_name, 2442 password=args.password) 2443 2444 p = subparsers.add_parser('bdev_opal_delete', help="""delete a virtual opal bdev""") 2445 p.add_argument('-b', '--bdev-name', help='opal virtual bdev', required=True) 2446 p.add_argument('-p', '--password', help='admin password', required=True) 2447 p.set_defaults(func=bdev_opal_delete) 2448 2449 def bdev_opal_new_user(args): 2450 rpc.bdev.bdev_opal_new_user(args.client, 2451 bdev_name=args.bdev_name, 2452 admin_password=args.admin_password, 2453 user_id=args.user_id, 2454 user_password=args.user_password) 2455 2456 p = subparsers.add_parser('bdev_opal_new_user', help="""Add a user to opal bdev who can set lock state for this bdev""") 2457 p.add_argument('-b', '--bdev-name', help='opal bdev', required=True) 2458 p.add_argument('-p', '--admin-password', help='admin password', required=True) 2459 p.add_argument('-i', '--user-id', help='ID for new user', type=int, required=True) 2460 p.add_argument('-u', '--user-password', help='password set for this user', required=True) 2461 p.set_defaults(func=bdev_opal_new_user) 2462 2463 def bdev_opal_set_lock_state(args): 2464 rpc.bdev.bdev_opal_set_lock_state(args.client, 2465 bdev_name=args.bdev_name, 2466 user_id=args.user_id, 2467 password=args.password, 2468 lock_state=args.lock_state) 2469 2470 p = subparsers.add_parser('bdev_opal_set_lock_state', help="""set lock state for an opal bdev""") 2471 p.add_argument('-b', '--bdev-name', help='opal bdev', required=True) 2472 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', 2473 type=int, required=True) 2474 p.add_argument('-p', '--password', help='password of this user', required=True) 2475 p.add_argument('-l', '--lock-state', help='lock state to set, choose from {readwrite, readonly, rwlock}', required=True) 2476 p.set_defaults(func=bdev_opal_set_lock_state) 2477 2478 # bdev_nvme_send_cmd 2479 def bdev_nvme_send_cmd(args): 2480 print_dict(rpc.nvme.bdev_nvme_send_cmd(args.client, 2481 name=args.nvme_name, 2482 cmd_type=args.cmd_type, 2483 data_direction=args.data_direction, 2484 cmdbuf=args.cmdbuf, 2485 data=args.data, 2486 metadata=args.metadata, 2487 data_len=args.data_length, 2488 metadata_len=args.metadata_length, 2489 timeout_ms=args.timeout_ms)) 2490 2491 p = subparsers.add_parser('bdev_nvme_send_cmd', aliases=['send_nvme_cmd'], 2492 help='NVMe passthrough cmd.') 2493 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""") 2494 p.add_argument('-t', '--cmd-type', help="""Type of nvme cmd. Valid values are: admin, io""") 2495 p.add_argument('-r', '--data-direction', help="""Direction of data transfer. Valid values are: c2h, h2c""") 2496 p.add_argument('-c', '--cmdbuf', help="""NVMe command encoded by base64 urlsafe""") 2497 p.add_argument('-d', '--data', help="""Data transferring to controller from host, encoded by base64 urlsafe""") 2498 p.add_argument('-m', '--metadata', help="""Metadata transferring to controller from host, encoded by base64 urlsafe""") 2499 p.add_argument('-D', '--data-length', help="""Data length required to transfer from controller to host""", type=int) 2500 p.add_argument('-M', '--metadata-length', help="""Metadata length required to transfer from controller to host""", type=int) 2501 p.add_argument('-T', '--timeout-ms', 2502 help="""Command execution timeout value, in milliseconds, if 0, don't track timeout""", type=int, default=0) 2503 p.set_defaults(func=bdev_nvme_send_cmd) 2504 2505 # Notifications 2506 def notify_get_types(args): 2507 print_dict(rpc.notify.notify_get_types(args.client)) 2508 2509 p = subparsers.add_parser('notify_get_types', aliases=['get_notification_types'], 2510 help='List available notifications that user can subscribe to.') 2511 p.set_defaults(func=notify_get_types) 2512 2513 def notify_get_notifications(args): 2514 ret = rpc.notify.notify_get_notifications(args.client, 2515 id=args.id, 2516 max=args.max) 2517 print_dict(ret) 2518 2519 p = subparsers.add_parser('notify_get_notifications', aliases=['get_notifications'], 2520 help='Get notifications') 2521 p.add_argument('-i', '--id', help="""First ID to start fetching from""", type=int) 2522 p.add_argument('-n', '--max', help="""Maximum number of notifications to return in response""", type=int) 2523 p.set_defaults(func=notify_get_notifications) 2524 2525 def thread_get_stats(args): 2526 print_dict(rpc.app.thread_get_stats(args.client)) 2527 2528 p = subparsers.add_parser( 2529 'thread_get_stats', help='Display current statistics of all the threads') 2530 p.set_defaults(func=thread_get_stats) 2531 2532 def thread_set_cpumask(args): 2533 ret = rpc.app.thread_set_cpumask(args.client, 2534 id=args.id, 2535 cpumask=args.cpumask) 2536 p = subparsers.add_parser('thread_set_cpumask', 2537 help="""set the cpumask of the thread whose ID matches to the 2538 specified value. The thread may be migrated to one of the specified CPUs.""") 2539 p.add_argument('-i', '--id', type=int, help='thread ID') 2540 p.add_argument('-m', '--cpumask', help='cpumask for this thread') 2541 p.set_defaults(func=thread_set_cpumask) 2542 2543 def log_enable_timestamps(args): 2544 ret = rpc.app.log_enable_timestamps(args.client, 2545 enabled=args.enabled) 2546 p = subparsers.add_parser('log_enable_timestamps', 2547 help='Enable or disable timestamps.') 2548 p.add_argument('-d', '--disable', dest='enabled', default=False, action='store_false', help="Disable timestamps") 2549 p.add_argument('-e', '--enable', dest='enabled', action='store_true', help="Enable timestamps") 2550 p.set_defaults(func=log_enable_timestamps) 2551 2552 def thread_get_pollers(args): 2553 print_dict(rpc.app.thread_get_pollers(args.client)) 2554 2555 p = subparsers.add_parser( 2556 'thread_get_pollers', help='Display current pollers of all the threads') 2557 p.set_defaults(func=thread_get_pollers) 2558 2559 def thread_get_io_channels(args): 2560 print_dict(rpc.app.thread_get_io_channels(args.client)) 2561 2562 p = subparsers.add_parser( 2563 'thread_get_io_channels', help='Display current IO channels of all the threads') 2564 p.set_defaults(func=thread_get_io_channels) 2565 2566 def env_dpdk_get_mem_stats(args): 2567 print_dict(rpc.env_dpdk.env_dpdk_get_mem_stats(args.client)) 2568 2569 p = subparsers.add_parser( 2570 'env_dpdk_get_mem_stats', help='write the dpdk memory stats to a file.') 2571 p.set_defaults(func=env_dpdk_get_mem_stats) 2572 2573 # blobfs 2574 def blobfs_detect(args): 2575 print(rpc.blobfs.blobfs_detect(args.client, 2576 bdev_name=args.bdev_name)) 2577 2578 p = subparsers.add_parser('blobfs_detect', help='Detect whether a blobfs exists on bdev') 2579 p.add_argument('bdev_name', help='Blockdev name to detect blobfs. Example: Malloc0.') 2580 p.set_defaults(func=blobfs_detect) 2581 2582 def blobfs_create(args): 2583 print(rpc.blobfs.blobfs_create(args.client, 2584 bdev_name=args.bdev_name, 2585 cluster_sz=args.cluster_sz)) 2586 2587 p = subparsers.add_parser('blobfs_create', help='Build a blobfs on bdev') 2588 p.add_argument('bdev_name', help='Blockdev name to build blobfs. Example: Malloc0.') 2589 p.add_argument('-c', '--cluster_sz', 2590 help="""Size of cluster in bytes (Optional). Must be multiple of 4KB page size. Default and minimal value is 1M.""") 2591 p.set_defaults(func=blobfs_create) 2592 2593 def blobfs_mount(args): 2594 print(rpc.blobfs.blobfs_mount(args.client, 2595 bdev_name=args.bdev_name, 2596 mountpoint=args.mountpoint)) 2597 2598 p = subparsers.add_parser('blobfs_mount', help='Mount a blobfs on bdev to host path by FUSE') 2599 p.add_argument('bdev_name', help='Blockdev name where the blobfs is. Example: Malloc0.') 2600 p.add_argument('mountpoint', help='Mountpoint path in host to mount blobfs. Example: /mnt/.') 2601 p.set_defaults(func=blobfs_mount) 2602 2603 def blobfs_set_cache_size(args): 2604 print(rpc.blobfs.blobfs_set_cache_size(args.client, 2605 size_in_mb=args.size_in_mb)) 2606 2607 p = subparsers.add_parser('blobfs_set_cache_size', help='Set cache size for blobfs') 2608 p.add_argument('size_in_mb', help='Cache size for blobfs in megabytes.', type=int) 2609 p.set_defaults(func=blobfs_set_cache_size) 2610 2611 # sock 2612 def sock_impl_get_options(args): 2613 print_json(rpc.sock.sock_impl_get_options(args.client, 2614 impl_name=args.impl)) 2615 2616 p = subparsers.add_parser('sock_impl_get_options', help="""Get options of socket layer implementation""") 2617 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 2618 p.set_defaults(func=sock_impl_get_options) 2619 2620 def sock_impl_set_options(args): 2621 rpc.sock.sock_impl_set_options(args.client, 2622 impl_name=args.impl, 2623 recv_buf_size=args.recv_buf_size, 2624 send_buf_size=args.send_buf_size, 2625 enable_recv_pipe=args.enable_recv_pipe, 2626 enable_zerocopy_send=args.enable_zerocopy_send, 2627 enable_quickack=args.enable_quickack, 2628 enable_placement_id=args.enable_placement_id, 2629 enable_zerocopy_send_server=args.enable_zerocopy_send_server, 2630 enable_zerocopy_send_client=args.enable_zerocopy_send_client) 2631 2632 p = subparsers.add_parser('sock_impl_set_options', help="""Set options of socket layer implementation""") 2633 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 2634 p.add_argument('-r', '--recv-buf-size', help='Size of receive buffer on socket in bytes', type=int) 2635 p.add_argument('-s', '--send-buf-size', help='Size of send buffer on socket in bytes', type=int) 2636 p.add_argument('-p', '--enable-placement-id', help='Option for placement-id. 0:disable,1:incoming_napi,2:incoming_cpu', type=int) 2637 p.add_argument('--enable-recv-pipe', help='Enable receive pipe', 2638 action='store_true', dest='enable_recv_pipe') 2639 p.add_argument('--disable-recv-pipe', help='Disable receive pipe', 2640 action='store_false', dest='enable_recv_pipe') 2641 p.add_argument('--enable-zerocopy-send', help="""Enable zerocopy on send 2642 (Deprecated, use enable-zerocopy-send-server or enable-zerocopy-send-client)""", 2643 action='store_true', dest='enable_zerocopy_send') 2644 p.add_argument('--disable-zerocopy-send', help="""Enable zerocopy on send 2645 (Deprecated, use disable-zerocopy-send-server or disable-zerocopy-send-client)""", 2646 action='store_false', dest='enable_zerocopy_send') 2647 p.add_argument('--enable-quickack', help='Enable quick ACK', 2648 action='store_true', dest='enable_quickack') 2649 p.add_argument('--disable-quickack', help='Disable quick ACK', 2650 action='store_false', dest='enable_quickack') 2651 p.add_argument('--enable-zerocopy-send-server', help='Enable zerocopy on send for server sockets', 2652 action='store_true', dest='enable_zerocopy_send_server') 2653 p.add_argument('--disable-zerocopy-send-server', help='Disable zerocopy on send for server sockets', 2654 action='store_false', dest='enable_zerocopy_server_client') 2655 p.add_argument('--enable-zerocopy-send-client', help='Enable zerocopy on send for client sockets', 2656 action='store_true', dest='enable_zerocopy_send_client') 2657 p.add_argument('--disable-zerocopy-send-client', help='Disable zerocopy on send for client sockets', 2658 action='store_false', dest='enable_zerocopy_send_client') 2659 p.set_defaults(func=sock_impl_set_options, enable_recv_pipe=None, enable_zerocopy_send=None, 2660 enable_quickack=None, enable_placement_id=None, enable_zerocopy_send_server=None, 2661 enable_zerocopy_send_client=None) 2662 2663 def sock_set_default_impl(args): 2664 print_json(rpc.sock.sock_set_default_impl(args.client, 2665 impl_name=args.impl)) 2666 2667 p = subparsers.add_parser('sock_set_default_impl', help="""Set the default sock implementation""") 2668 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 2669 p.set_defaults(func=sock_set_default_impl) 2670 2671 def check_called_name(name): 2672 if name in deprecated_aliases: 2673 print("{} is deprecated, use {} instead.".format(name, deprecated_aliases[name]), file=sys.stderr) 2674 2675 class dry_run_client: 2676 def call(self, method, params=None): 2677 print("Request:\n" + json.dumps({"method": method, "params": params}, indent=2)) 2678 2679 def null_print(arg): 2680 pass 2681 2682 def call_rpc_func(args): 2683 args.func(args) 2684 check_called_name(args.called_rpc_name) 2685 2686 def execute_script(parser, client, fd): 2687 executed_rpc = "" 2688 for rpc_call in map(str.rstrip, fd): 2689 if not rpc_call.strip(): 2690 continue 2691 executed_rpc = "\n".join([executed_rpc, rpc_call]) 2692 args = parser.parse_args(shlex.split(rpc_call)) 2693 args.client = client 2694 try: 2695 call_rpc_func(args) 2696 except JSONRPCException as ex: 2697 print("Exception:") 2698 print(executed_rpc.strip() + " <<<") 2699 print(ex.message) 2700 exit(1) 2701 2702 def load_plugin(args): 2703 # Create temporary parser, pull out the plugin parameter, load the module, and then run the real argument parser 2704 plugin_parser = argparse.ArgumentParser(add_help=False) 2705 plugin_parser.add_argument('--plugin', dest='rpc_plugin', help='Module name of plugin with additional RPC commands') 2706 2707 rpc_module = plugin_parser.parse_known_args()[0].rpc_plugin 2708 if args is not None: 2709 rpc_module = plugin_parser.parse_known_args(args)[0].rpc_plugin 2710 2711 if rpc_module is not None: 2712 try: 2713 rpc_plugin = importlib.import_module(rpc_module) 2714 try: 2715 rpc_plugin.spdk_rpc_plugin_initialize(subparsers) 2716 except AttributeError: 2717 print("Module %s does not contain 'spdk_rpc_plugin_initialize' function" % rpc_module) 2718 except ModuleNotFoundError: 2719 print("Module %s not found" % rpc_module) 2720 2721 load_plugin(None) 2722 2723 args = parser.parse_args() 2724 2725 if sys.stdin.isatty() and not hasattr(args, 'func'): 2726 # No arguments and no data piped through stdin 2727 parser.print_help() 2728 exit(1) 2729 if args.is_server: 2730 for input in sys.stdin: 2731 cmd = shlex.split(input) 2732 try: 2733 load_plugin(cmd) 2734 tmp_args = parser.parse_args(cmd) 2735 except SystemExit as ex: 2736 print("**STATUS=1", flush=True) 2737 continue 2738 2739 try: 2740 tmp_args.client = rpc.client.JSONRPCClient( 2741 tmp_args.server_addr, tmp_args.port, tmp_args.timeout, 2742 log_level=getattr(logging, tmp_args.verbose.upper()), conn_retries=tmp_args.conn_retries) 2743 call_rpc_func(tmp_args) 2744 print("**STATUS=0", flush=True) 2745 except JSONRPCException as ex: 2746 print(ex.message) 2747 print("**STATUS=1", flush=True) 2748 exit(0) 2749 elif args.dry_run: 2750 args.client = dry_run_client() 2751 print_dict = null_print 2752 print_json = null_print 2753 print_array = null_print 2754 else: 2755 try: 2756 args.client = rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, 2757 log_level=getattr(logging, args.verbose.upper()), 2758 conn_retries=args.conn_retries) 2759 except JSONRPCException as ex: 2760 print(ex.message) 2761 exit(1) 2762 2763 if hasattr(args, 'func'): 2764 try: 2765 call_rpc_func(args) 2766 except JSONRPCException as ex: 2767 print(ex.message) 2768 exit(1) 2769 else: 2770 execute_script(parser, args.client, sys.stdin) 2771