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